Skip to main content

​
clinik.immunizationRecommendations

Immunization Recommendations (FHIR ImmunizationRecommendation) provide patient-specific vaccine recommendations based on immunization history and clinical guidelines.

​
create

const { data, meta } = await clinik.immunizationRecommendations.create(request): Promise<ApiResponse<ImmunizationRecommendation>>
FieldTypeRequiredDescription
patientIdstringYesPatient ID
datestringYesWhen recommendations were created
authorityIdstringNoOrganization ID for the authority
recommendationArrayYesRecommendation entries
recommendation[].vaccineCodestring[]NoVaccine codes
recommendation[].targetDiseasestringNoTarget disease
recommendation[].forecastStatusstringYesForecast status (e.g. due, overdue, immune, contraindicated)
recommendation[].forecastReasonstring[]NoForecast reasons
recommendation[].descriptionstringNoDescription
recommendation[].seriesstringNoSeries name
recommendation[].doseNumbernumberNoRecommended dose number
recommendation[].seriesDosesnumberNoTotal doses in series
recommendation[].dateCriterionArrayNoDate criteria
recommendation[].dateCriterion[].codestringYesCriterion code (e.g. “Earliest Date”, “Recommended Date”)
recommendation[].dateCriterion[].valuestringYesCriterion date value

​
Example

const { data } = await clinik.immunizationRecommendations.create({
  patientId: 'pt_child456',
  date: '2024-06-15T10:00:00Z',
  authorityId: 'org_cdc',
  recommendation: [
    {
      vaccineCode: ['MMR'],
      targetDisease: 'Measles',
      forecastStatus: 'due',
      series: 'Primary Series',
      doseNumber: 2,
      seriesDoses: 2,
      dateCriterion: [
        { code: 'Earliest Date', value: '2024-07-01' },
        { code: 'Recommended Date', value: '2024-08-15' },
        { code: 'Latest Date', value: '2024-12-31' },
      ],
    },
    {
      vaccineCode: ['Tdap'],
      targetDisease: 'Tetanus',
      forecastStatus: 'overdue',
      description: 'Booster dose overdue by 6 months',
      doseNumber: 1,
      seriesDoses: 1,
    },
  ],
});
Immunization recommendations support read, delete, and search — but are not commonly updated. Search supports patientId, vaccineCode, targetDisease, dateFrom, dateTo filters.