Skip to main content

​
clinik.immunizationEvaluations

Immunization Evaluations (FHIR ImmunizationEvaluation) assess whether an immunization event meets the protocol requirements for a target disease. Use these to track vaccine series compliance.

​
create

const { data, meta } = await clinik.immunizationEvaluations.create(request): Promise<ApiResponse<ImmunizationEvaluation>>
FieldTypeRequiredDescription
statusstringYescompleted
patientIdstringYesPatient ID
datestringNoEvaluation date
authorityIdstringNoAuthority Organization ID
targetDiseasestringYesDisease being evaluated against
immunizationEventIdstringYesImmunization ID
doseStatusstringYesvalid, not-valid
doseStatusReasonstring[]NoReasons for the dose status
descriptionstringNoDescription of the evaluation
seriesstringNoVaccine series name
doseNumbernumberNoDose number within series
seriesDosesnumberNoRecommended number of doses

​
Example

const { data } = await clinik.immunizationEvaluations.create({
  status: 'completed',
  patientId: 'pt_abc123',
  date: '2024-03-20',
  targetDisease: 'COVID-19',
  immunizationEventId: 'imm_vax456',
  doseStatus: 'valid',
  series: 'Primary Series',
  doseNumber: 2,
  seriesDoses: 2,
  description: 'Second dose of primary series meets protocol requirements',
});
Same pattern as other resources. Update supports status and description. Search supports patientId, status, immunizationEventId, targetDisease filters.