Skip to main content
POST
/
v1
/
immunizations
Create immunization
curl --request POST \
  --url https://api.clinikapi.com/v1/immunizations \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "vaccineCode": "<string>",
  "patientId": "<string>",
  "encounterId": "<string>",
  "occurrenceDateTime": "<string>",
  "recorded": "<string>",
  "primarySource": true,
  "manufacturer": "<string>",
  "lotNumber": "<string>",
  "expirationDate": "<string>",
  "site": "<string>",
  "route": "<string>",
  "doseQuantity": {
    "value": 123,
    "unit": "<string>"
  },
  "performer": [
    {
      "actorId": "<string>",
      "function": "<string>"
    }
  ],
  "note": "<string>",
  "reasonCode": [
    "<string>"
  ],
  "statusReason": "<string>",
  "isSubpotent": true,
  "reaction": [
    {
      "date": "<string>",
      "reported": true
    }
  ],
  "protocolApplied": [
    {
      "series": "<string>",
      "doseNumber": 123,
      "seriesDoses": 123,
      "targetDisease": [
        "<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:
completed,
not-done
vaccineCode
required
Maximum string length: 500
patientId
string
required
Maximum string length: 128
encounterId
string
Maximum string length: 128
occurrenceDateTime
string
Maximum string length: 50
recorded
string
Maximum string length: 50
primarySource
boolean
manufacturer
string
Maximum string length: 500
lotNumber
string
Maximum string length: 100
expirationDate
string
Maximum string length: 50
site
string
Maximum string length: 200
route
string
Maximum string length: 200
doseQuantity
object
performer
object[]
Maximum array length: 10
note
string
Maximum string length: 5000
reasonCode
string[]
Maximum array length: 10
Maximum string length: 500
statusReason
string
Maximum string length: 500
isSubpotent
boolean
reaction
object[]
Maximum array length: 10
protocolApplied
object[]
Maximum array length: 10

Response

201

Immunization created