Skip to main content
POST
/
v1
/
assessments
Create assessment
curl --request POST \
  --url https://api.clinikapi.com/v1/assessments \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "patientId": "<string>",
  "summary": "<string>",
  "statusReason": "<string>",
  "encounterId": "<string>",
  "practitionerId": "<string>",
  "code": "<string>",
  "description": "<string>",
  "findings": [
    {
      "code": "<string>",
      "text": "<string>",
      "basis": "<string>"
    }
  ],
  "note": "<string>",
  "effectiveDateTime": "2023-11-07T05:31:56Z",
  "date": "2023-11-07T05:31:56Z",
  "previousAssessmentId": "<string>",
  "problemIds": [
    "<string>"
  ],
  "investigations": [
    {
      "name": "<string>",
      "itemIds": [
        "<string>"
      ]
    }
  ],
  "protocol": [
    "<string>"
  ],
  "prognosis": [
    {
      "code": "<string>",
      "text": "<string>"
    }
  ],
  "supportingInfoIds": [
    "<string>"
  ]
}
'

Authorizations

x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
status
enum<string>
required
Available options:
in-progress,
completed
patientId
string
required
summary
string
required
Maximum string length: 5000
statusReason
string

Reason for current status

Maximum string length: 500
encounterId
string
practitionerId
string
code
string

Kind of assessment (initial-assessment, follow-up, discharge)

Maximum string length: 200
description
string
Maximum string length: 2000
findings
object[]
Maximum array length: 50
note
string
Maximum string length: 2000
effectiveDateTime
string<date-time>
date
string<date-time>

When the assessment was documented (defaults to now)

previousAssessmentId
string

Reference to the previous assessment for this patient

problemIds
string[]

Condition or AllergyIntolerance IDs being assessed

investigations
object[]

Sets of investigations (labs, imaging, questionnaires)

Maximum array length: 20
protocol
string[]

Clinical protocol URIs followed

prognosis
object[]

Prognosis codes (good, poor, guarded)

Maximum array length: 10
supportingInfoIds
string[]

Supporting information references

Response

201

Assessment created