Skip to main content
POST
/
v1
/
immunization-recommendations
Create immunization recommendation
curl --request POST \
  --url https://api.clinikapi.com/v1/immunization-recommendations \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "patientId": "<string>",
  "date": "<string>",
  "recommendation": [
    {
      "forecastStatus": "<string>",
      "vaccineCode": [
        "<string>"
      ],
      "targetDisease": "<string>",
      "forecastReason": [
        "<string>"
      ],
      "description": "<string>",
      "series": "<string>",
      "doseNumber": 123,
      "seriesDoses": 123,
      "dateCriterion": [
        {
          "code": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "authorityId": "<string>"
}
'

Authorizations

x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
patientId
string
required
Maximum string length: 128
date
string
required
Maximum string length: 50
recommendation
object[]
required
Required array length: 1 - 20 elements
authorityId
string
Maximum string length: 128

Response

201

Immunization recommendation created