Skip to main content
POST
/
v1
/
observations
Create observation
curl --request POST \
  --url https://api.clinikapi.com/v1/observations \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "code": "<string>",
  "patientId": "<string>",
  "encounterId": "<string>",
  "performerId": "<string>",
  "effectiveDateTime": "2023-11-07T05:31:56Z",
  "issued": "2023-11-07T05:31:56Z",
  "valueQuantity": {
    "value": 123,
    "unit": "<string>",
    "system": "<string>",
    "code": "<string>"
  },
  "valueString": "<string>",
  "valueCodeableConcept": {
    "system": "<string>",
    "code": "<string>",
    "display": "<string>"
  },
  "component": [
    {
      "code": "<string>",
      "valueQuantity": {
        "value": 123,
        "unit": "<string>"
      },
      "valueString": "<string>"
    }
  ],
  "category": "<string>",
  "interpretation": "<string>",
  "referenceRange": {
    "low": {
      "value": 123,
      "unit": "<string>"
    },
    "high": {
      "value": 123,
      "unit": "<string>"
    },
    "text": "<string>"
  },
  "bodySite": "<string>",
  "method": "<string>",
  "specimenId": "<string>",
  "deviceId": "<string>",
  "note": "<string>"
}
'
{
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "requestId": "<string>",
  "issues": [
    {
      "severity": "<string>",
      "code": "<string>",
      "diagnostics": "<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:
registered,
preliminary,
final,
amended,
corrected,
cancelled
code
required
patientId
string
required
encounterId
string
performerId
string
effectiveDateTime
string<date-time>
issued
string<date-time>

When this version was made available

valueQuantity
object
valueString
string
Maximum string length: 2000
valueCodeableConcept
object
component
object[]
Maximum array length: 20
category
string

vital-signs, laboratory, social-history, exam

interpretation
string

H (high), L (low), N (normal), A (abnormal), HH, LL

Maximum string length: 10
referenceRange
object
bodySite
string
Maximum string length: 200
method
string
Maximum string length: 200
specimenId
string

Specimen reference

deviceId
string

Device reference

note
string
Maximum string length: 2000

Response

Observation created