Skip to main content
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>"
  ]
}
'

Authorizations

​
x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
​
patientId
string
required
​
items
object[]
required
Maximum array length: 200
​
encounterId
string
​
authorId
string

Who filled out the form (practitioner or device ID)

​
sourceId
string

Who provided the answers (patient, related person, practitioner)

​
questionnaire
string

Reference to the Questionnaire definition (canonical URL or ID)

​
status
enum<string>
Available options:
in-progress,
completed,
amended,
stopped
​
authored
string<date-time>

When the answers were gathered (defaults to now)

​
basedOn
string[]

CarePlan or ServiceRequest IDs this intake fulfills

​
partOf
string[]

Observation or Procedure IDs this intake is part of

Response

201

Intake submitted