FHIR Immunization Resource

Record of a vaccination event, including the vaccine administered and the date. This page documents the Immunization resource as served by the mock.health synthetic FHIR R4 sandbox — 5 search parameters, US Core 6.1 profiling, and the elements accepted on write.

Endpoints

• GET https://api.mock.health/fhir/Immunization — search
• GET https://api.mock.health/fhir/Immunization/{id} — read by logical id
• POST https://api.mock.health/fhir/Immunization — create (Pro)
• PUT https://api.mock.health/fhir/Immunization/{id} — update (Pro)

Search parameters

• patient (reference) — required — Patient who received the immunization
• date (date) — Vaccination date
• identifier (token) — External identifier
• status (token) — completed | not-done | entered-in-error
• vaccine-code (token) — Vaccine product code (CVX)

US Core profiles

• us-core-immunization

Write elements

Fields accepted when creating or updating a Immunization. Required elements are base FHIR cardinality; the rest are US Core must-support.

• status (code) — required — completed | entered-in-error | not-done
• vaccineCode (CodeableConcept) — required — Vaccine product code (CVX)
• patient (Reference(Patient)) — required — Patient who received the vaccination
• occurrenceDateTime (dateTime) — required — Date/time of vaccination
• primarySource (boolean) — US Core MS — whether data is from the source who administered

Specification

Base definition: HL7 FHIR R4 Immunization. Category: Immunizations.

API reference · Quickstart · USCDI compliance · SMART on FHIR