Submit intake form
curl --request POST \
--url https://api.clinikapi.com/v1/intakes \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"items": [
{
"linkId": "<string>",
"definition": "<string>",
"text": "<string>",
"answer": [
{
"valueString": "<string>",
"valueBoolean": true,
"valueInteger": 123,
"valueDecimal": 123,
"valueDate": "<string>",
"valueDateTime": "<string>",
"valueTime": "<string>",
"valueCoding": {
"system": "<string>",
"code": "<string>",
"display": "<string>"
},
"valueQuantity": {
"value": 123,
"unit": "<string>"
},
"valueUri": "<string>"
}
],
"items": [
{
"linkId": "<string>",
"definition": "<string>",
"text": "<string>",
"answer": [
{}
]
}
]
}
],
"encounterId": "<string>",
"authorId": "<string>",
"sourceId": "<string>",
"questionnaire": "<string>",
"authored": "2023-11-07T05:31:56Z",
"basedOn": [
"<string>"
],
"partOf": [
"<string>"
]
}
'import requests
url = "https://api.clinikapi.com/v1/intakes"
payload = {
"patientId": "<string>",
"items": [
{
"linkId": "<string>",
"definition": "<string>",
"text": "<string>",
"answer": [
{
"valueString": "<string>",
"valueBoolean": True,
"valueInteger": 123,
"valueDecimal": 123,
"valueDate": "<string>",
"valueDateTime": "<string>",
"valueTime": "<string>",
"valueCoding": {
"system": "<string>",
"code": "<string>",
"display": "<string>"
},
"valueQuantity": {
"value": 123,
"unit": "<string>"
},
"valueUri": "<string>"
}
],
"items": [
{
"linkId": "<string>",
"definition": "<string>",
"text": "<string>",
"answer": [{}]
}
]
}
],
"encounterId": "<string>",
"authorId": "<string>",
"sourceId": "<string>",
"questionnaire": "<string>",
"authored": "2023-11-07T05:31:56Z",
"basedOn": ["<string>"],
"partOf": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
patientId: '<string>',
items: [
{
linkId: '<string>',
definition: '<string>',
text: '<string>',
answer: [
{
valueString: '<string>',
valueBoolean: true,
valueInteger: 123,
valueDecimal: 123,
valueDate: '<string>',
valueDateTime: '<string>',
valueTime: '<string>',
valueCoding: {system: '<string>', code: '<string>', display: '<string>'},
valueQuantity: {value: 123, unit: '<string>'},
valueUri: '<string>'
}
],
items: [{linkId: '<string>', definition: '<string>', text: '<string>', answer: [{}]}]
}
],
encounterId: '<string>',
authorId: '<string>',
sourceId: '<string>',
questionnaire: '<string>',
authored: '2023-11-07T05:31:56Z',
basedOn: ['<string>'],
partOf: ['<string>']
})
};
fetch('https://api.clinikapi.com/v1/intakes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.clinikapi.com/v1/intakes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'patientId' => '<string>',
'items' => [
[
'linkId' => '<string>',
'definition' => '<string>',
'text' => '<string>',
'answer' => [
[
'valueString' => '<string>',
'valueBoolean' => true,
'valueInteger' => 123,
'valueDecimal' => 123,
'valueDate' => '<string>',
'valueDateTime' => '<string>',
'valueTime' => '<string>',
'valueCoding' => [
'system' => '<string>',
'code' => '<string>',
'display' => '<string>'
],
'valueQuantity' => [
'value' => 123,
'unit' => '<string>'
],
'valueUri' => '<string>'
]
],
'items' => [
[
'linkId' => '<string>',
'definition' => '<string>',
'text' => '<string>',
'answer' => [
[
]
]
]
]
]
],
'encounterId' => '<string>',
'authorId' => '<string>',
'sourceId' => '<string>',
'questionnaire' => '<string>',
'authored' => '2023-11-07T05:31:56Z',
'basedOn' => [
'<string>'
],
'partOf' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.clinikapi.com/v1/intakes"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"items\": [\n {\n \"linkId\": \"<string>\",\n \"definition\": \"<string>\",\n \"text\": \"<string>\",\n \"answer\": [\n {\n \"valueString\": \"<string>\",\n \"valueBoolean\": true,\n \"valueInteger\": 123,\n \"valueDecimal\": 123,\n \"valueDate\": \"<string>\",\n \"valueDateTime\": \"<string>\",\n \"valueTime\": \"<string>\",\n \"valueCoding\": {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n },\n \"valueQuantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"valueUri\": \"<string>\"\n }\n ],\n \"items\": [\n {\n \"linkId\": \"<string>\",\n \"definition\": \"<string>\",\n \"text\": \"<string>\",\n \"answer\": [\n {}\n ]\n }\n ]\n }\n ],\n \"encounterId\": \"<string>\",\n \"authorId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"questionnaire\": \"<string>\",\n \"authored\": \"2023-11-07T05:31:56Z\",\n \"basedOn\": [\n \"<string>\"\n ],\n \"partOf\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.clinikapi.com/v1/intakes")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"items\": [\n {\n \"linkId\": \"<string>\",\n \"definition\": \"<string>\",\n \"text\": \"<string>\",\n \"answer\": [\n {\n \"valueString\": \"<string>\",\n \"valueBoolean\": true,\n \"valueInteger\": 123,\n \"valueDecimal\": 123,\n \"valueDate\": \"<string>\",\n \"valueDateTime\": \"<string>\",\n \"valueTime\": \"<string>\",\n \"valueCoding\": {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n },\n \"valueQuantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"valueUri\": \"<string>\"\n }\n ],\n \"items\": [\n {\n \"linkId\": \"<string>\",\n \"definition\": \"<string>\",\n \"text\": \"<string>\",\n \"answer\": [\n {}\n ]\n }\n ]\n }\n ],\n \"encounterId\": \"<string>\",\n \"authorId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"questionnaire\": \"<string>\",\n \"authored\": \"2023-11-07T05:31:56Z\",\n \"basedOn\": [\n \"<string>\"\n ],\n \"partOf\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/intakes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"patientId\": \"<string>\",\n \"items\": [\n {\n \"linkId\": \"<string>\",\n \"definition\": \"<string>\",\n \"text\": \"<string>\",\n \"answer\": [\n {\n \"valueString\": \"<string>\",\n \"valueBoolean\": true,\n \"valueInteger\": 123,\n \"valueDecimal\": 123,\n \"valueDate\": \"<string>\",\n \"valueDateTime\": \"<string>\",\n \"valueTime\": \"<string>\",\n \"valueCoding\": {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n },\n \"valueQuantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"valueUri\": \"<string>\"\n }\n ],\n \"items\": [\n {\n \"linkId\": \"<string>\",\n \"definition\": \"<string>\",\n \"text\": \"<string>\",\n \"answer\": [\n {}\n ]\n }\n ]\n }\n ],\n \"encounterId\": \"<string>\",\n \"authorId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"questionnaire\": \"<string>\",\n \"authored\": \"2023-11-07T05:31:56Z\",\n \"basedOn\": [\n \"<string>\"\n ],\n \"partOf\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_bodyIntakes
Submit Intake
POST
/
v1
/
intakes
Submit intake form
curl --request POST \
--url https://api.clinikapi.com/v1/intakes \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"items": [
{
"linkId": "<string>",
"definition": "<string>",
"text": "<string>",
"answer": [
{
"valueString": "<string>",
"valueBoolean": true,
"valueInteger": 123,
"valueDecimal": 123,
"valueDate": "<string>",
"valueDateTime": "<string>",
"valueTime": "<string>",
"valueCoding": {
"system": "<string>",
"code": "<string>",
"display": "<string>"
},
"valueQuantity": {
"value": 123,
"unit": "<string>"
},
"valueUri": "<string>"
}
],
"items": [
{
"linkId": "<string>",
"definition": "<string>",
"text": "<string>",
"answer": [
{}
]
}
]
}
],
"encounterId": "<string>",
"authorId": "<string>",
"sourceId": "<string>",
"questionnaire": "<string>",
"authored": "2023-11-07T05:31:56Z",
"basedOn": [
"<string>"
],
"partOf": [
"<string>"
]
}
'import requests
url = "https://api.clinikapi.com/v1/intakes"
payload = {
"patientId": "<string>",
"items": [
{
"linkId": "<string>",
"definition": "<string>",
"text": "<string>",
"answer": [
{
"valueString": "<string>",
"valueBoolean": True,
"valueInteger": 123,
"valueDecimal": 123,
"valueDate": "<string>",
"valueDateTime": "<string>",
"valueTime": "<string>",
"valueCoding": {
"system": "<string>",
"code": "<string>",
"display": "<string>"
},
"valueQuantity": {
"value": 123,
"unit": "<string>"
},
"valueUri": "<string>"
}
],
"items": [
{
"linkId": "<string>",
"definition": "<string>",
"text": "<string>",
"answer": [{}]
}
]
}
],
"encounterId": "<string>",
"authorId": "<string>",
"sourceId": "<string>",
"questionnaire": "<string>",
"authored": "2023-11-07T05:31:56Z",
"basedOn": ["<string>"],
"partOf": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
patientId: '<string>',
items: [
{
linkId: '<string>',
definition: '<string>',
text: '<string>',
answer: [
{
valueString: '<string>',
valueBoolean: true,
valueInteger: 123,
valueDecimal: 123,
valueDate: '<string>',
valueDateTime: '<string>',
valueTime: '<string>',
valueCoding: {system: '<string>', code: '<string>', display: '<string>'},
valueQuantity: {value: 123, unit: '<string>'},
valueUri: '<string>'
}
],
items: [{linkId: '<string>', definition: '<string>', text: '<string>', answer: [{}]}]
}
],
encounterId: '<string>',
authorId: '<string>',
sourceId: '<string>',
questionnaire: '<string>',
authored: '2023-11-07T05:31:56Z',
basedOn: ['<string>'],
partOf: ['<string>']
})
};
fetch('https://api.clinikapi.com/v1/intakes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.clinikapi.com/v1/intakes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'patientId' => '<string>',
'items' => [
[
'linkId' => '<string>',
'definition' => '<string>',
'text' => '<string>',
'answer' => [
[
'valueString' => '<string>',
'valueBoolean' => true,
'valueInteger' => 123,
'valueDecimal' => 123,
'valueDate' => '<string>',
'valueDateTime' => '<string>',
'valueTime' => '<string>',
'valueCoding' => [
'system' => '<string>',
'code' => '<string>',
'display' => '<string>'
],
'valueQuantity' => [
'value' => 123,
'unit' => '<string>'
],
'valueUri' => '<string>'
]
],
'items' => [
[
'linkId' => '<string>',
'definition' => '<string>',
'text' => '<string>',
'answer' => [
[
]
]
]
]
]
],
'encounterId' => '<string>',
'authorId' => '<string>',
'sourceId' => '<string>',
'questionnaire' => '<string>',
'authored' => '2023-11-07T05:31:56Z',
'basedOn' => [
'<string>'
],
'partOf' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.clinikapi.com/v1/intakes"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"items\": [\n {\n \"linkId\": \"<string>\",\n \"definition\": \"<string>\",\n \"text\": \"<string>\",\n \"answer\": [\n {\n \"valueString\": \"<string>\",\n \"valueBoolean\": true,\n \"valueInteger\": 123,\n \"valueDecimal\": 123,\n \"valueDate\": \"<string>\",\n \"valueDateTime\": \"<string>\",\n \"valueTime\": \"<string>\",\n \"valueCoding\": {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n },\n \"valueQuantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"valueUri\": \"<string>\"\n }\n ],\n \"items\": [\n {\n \"linkId\": \"<string>\",\n \"definition\": \"<string>\",\n \"text\": \"<string>\",\n \"answer\": [\n {}\n ]\n }\n ]\n }\n ],\n \"encounterId\": \"<string>\",\n \"authorId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"questionnaire\": \"<string>\",\n \"authored\": \"2023-11-07T05:31:56Z\",\n \"basedOn\": [\n \"<string>\"\n ],\n \"partOf\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.clinikapi.com/v1/intakes")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"items\": [\n {\n \"linkId\": \"<string>\",\n \"definition\": \"<string>\",\n \"text\": \"<string>\",\n \"answer\": [\n {\n \"valueString\": \"<string>\",\n \"valueBoolean\": true,\n \"valueInteger\": 123,\n \"valueDecimal\": 123,\n \"valueDate\": \"<string>\",\n \"valueDateTime\": \"<string>\",\n \"valueTime\": \"<string>\",\n \"valueCoding\": {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n },\n \"valueQuantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"valueUri\": \"<string>\"\n }\n ],\n \"items\": [\n {\n \"linkId\": \"<string>\",\n \"definition\": \"<string>\",\n \"text\": \"<string>\",\n \"answer\": [\n {}\n ]\n }\n ]\n }\n ],\n \"encounterId\": \"<string>\",\n \"authorId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"questionnaire\": \"<string>\",\n \"authored\": \"2023-11-07T05:31:56Z\",\n \"basedOn\": [\n \"<string>\"\n ],\n \"partOf\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/intakes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"patientId\": \"<string>\",\n \"items\": [\n {\n \"linkId\": \"<string>\",\n \"definition\": \"<string>\",\n \"text\": \"<string>\",\n \"answer\": [\n {\n \"valueString\": \"<string>\",\n \"valueBoolean\": true,\n \"valueInteger\": 123,\n \"valueDecimal\": 123,\n \"valueDate\": \"<string>\",\n \"valueDateTime\": \"<string>\",\n \"valueTime\": \"<string>\",\n \"valueCoding\": {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n },\n \"valueQuantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"valueUri\": \"<string>\"\n }\n ],\n \"items\": [\n {\n \"linkId\": \"<string>\",\n \"definition\": \"<string>\",\n \"text\": \"<string>\",\n \"answer\": [\n {}\n ]\n }\n ]\n }\n ],\n \"encounterId\": \"<string>\",\n \"authorId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"questionnaire\": \"<string>\",\n \"authored\": \"2023-11-07T05:31:56Z\",\n \"basedOn\": [\n \"<string>\"\n ],\n \"partOf\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Your ClinikAPI secret key (clk_live_* or clk_test_*)
Body
application/json
Maximum array length:
200Show child attributes
Show child attributes
Who filled out the form (practitioner or device ID)
Who provided the answers (patient, related person, practitioner)
Reference to the Questionnaire definition (canonical URL or ID)
Available options:
in-progress, completed, amended, stopped When the answers were gathered (defaults to now)
CarePlan or ServiceRequest IDs this intake fulfills
Observation or Procedure IDs this intake is part of
Response
201
Intake submitted
⌘I