Skip to main content
POST
/
v1
/
immunization-evaluations
Create immunization evaluation
curl --request POST \
  --url https://api.clinikapi.com/v1/immunization-evaluations \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "patientId": "<string>",
  "targetDisease": "<string>",
  "immunizationEventId": "<string>",
  "doseStatus": "<string>",
  "date": "<string>",
  "authorityId": "<string>",
  "doseStatusReason": [
    "<string>"
  ],
  "description": "<string>",
  "series": "<string>",
  "doseNumber": 123,
  "seriesDoses": 123
}
'

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:
completed
​
patientId
string
required
Maximum string length: 128
​
targetDisease
string
required
Maximum string length: 500
​
immunizationEventId
string
required
Maximum string length: 128
​
doseStatus
string
required
Maximum string length: 200
​
date
string
Maximum string length: 50
​
authorityId
string
Maximum string length: 128
​
doseStatusReason
string[]
Maximum array length: 10
Maximum string length: 500
​
description
string
Maximum string length: 2000
​
series
string
Maximum string length: 200
​
doseNumber
integer
​
seriesDoses
integer

Response

201

Immunization evaluation created