FHIR Immunization Resource (R5)

Immunization describes a vaccination event: which vaccine (vaccineCode), when (occurrence[x]), to whom, and whether it was actually given or not. Element table, search parameters, example JSON and FHIRPath for FHIR R5.

• FHIR Immunization Resource (R5) — part of the free FHIR Toolbox library.
• Runs entirely in your browser: your FHIR data is never uploaded to a server.

Overview

Immunization describes a vaccination event: which vaccine (vaccineCode), when (occurrence[x]), to whom, and whether it was actually given or not. Use ImmunizationRecommendation for what is due, and ImmunizationEvaluation for the assessment of a dose.

Elements

Example JSON (R5)

{
  "resourceType": "Immunization",
  "id": "example",
  "status": "completed",
  "vaccineCode": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/sid/cvx",
        "code": "140",
        "display": "Influenza, seasonal, injectable, preservative free"
      }
    ]
  },
  "patient": {
    "reference": "Patient/example"
  },
  "occurrenceDateTime": "2024-10-01",
  "primarySource": true,
  "lotNumber": "AAJN11K"
}

FHIRPath

• Immunization.vaccineCode.coding.code — CVX code
• Immunization.occurrence.ofType(dateTime) — When the dose was given
• Immunization.status — completed | entered-in-error | not-done

Common validation errors

• Omitting occurrence[x] (occurrenceDateTime or occurrenceString). It is required.
• Using status not-done without statusReason.
• Putting the CVX code in the wrong system. CVX uses http://hl7.org/fhir/sid/cvx.

FHIR Toolbox is a free, privacy-first collection of HL7 FHIR utilities by Omindra Labs. Every tool performs zero-server processing — your health data never leaves your device.