# Immunization

Canonical page: https://docs.ovok.com/api/fhir/r4/immunization

Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/Immunization/[id]` |
| Vread | `GET` | `/fhir/R4/Immunization/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/Immunization/[id]` |
| Patch | `PATCH` | `/fhir/R4/Immunization/[id]` |
| Delete | `DELETE` | `/fhir/R4/Immunization/[id]` |
| Create | `POST` | `/fhir/R4/Immunization` |
| Search | `GET` | `/fhir/R4/Immunization` |
| History | `GET` | `/fhir/R4/Immunization/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Business identifier |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | completed \| entered-in-error \| not-done |
| <span id="element-status-reason"></span>`statusReason` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Reason not done |
| <span id="element-vaccine-code"></span>`vaccineCode` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `1..1` | Vaccine product administered |
| <span id="element-patient"></span>`patient` | [Reference](/fhir-elements/complex/reference) | `1..1` | Who was immunized |
| <span id="element-encounter"></span>`encounter` | [Reference](/fhir-elements/complex/reference) | `0..1` | Encounter immunization was part of |
| <span id="element-occurrence-x"></span>`occurrence[x]` | [dateTime](/fhir-elements/primitive/date-time), [string](/fhir-elements/primitive/string) | `1..1` | Vaccine administration date |
| <span id="element-recorded"></span>`recorded` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | When the immunization was first captured in the subject's record |
| <span id="element-primary-source"></span>`primarySource` | [boolean](/fhir-elements/primitive/boolean) | `0..1` | Indicates context the data was recorded in |
| <span id="element-report-origin"></span>`reportOrigin` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Indicates the source of a secondarily reported record |
| <span id="element-location"></span>`location` | [Reference](/fhir-elements/complex/reference) | `0..1` | Where immunization occurred |
| <span id="element-manufacturer"></span>`manufacturer` | [Reference](/fhir-elements/complex/reference) | `0..1` | Vaccine manufacturer |
| <span id="element-lot-number"></span>`lotNumber` | [string](/fhir-elements/primitive/string) | `0..1` | Vaccine lot number |
| <span id="element-expiration-date"></span>`expirationDate` | [date](/fhir-elements/primitive/date) | `0..1` | Vaccine expiration date |
| <span id="element-site"></span>`site` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Body site vaccine  was administered |
| <span id="element-route"></span>`route` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | How vaccine entered body |
| <span id="element-dose-quantity"></span>`doseQuantity` | [Quantity](/fhir-elements/complex/quantity) | `0..1` | Amount of vaccine administered |
| <span id="element-performer"></span>`performer` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Who performed event |
| <span id="element-note"></span>`note` | [Annotation](/fhir-elements/complex/annotation) | `0..*` | Additional immunization notes |
| <span id="element-reason-code"></span>`reasonCode` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Why immunization occurred |
| <span id="element-reason-reference"></span>`reasonReference` | [Reference](/fhir-elements/complex/reference) | `0..*` | Why immunization occurred |
| <span id="element-is-subpotent"></span>`isSubpotent` | [boolean](/fhir-elements/primitive/boolean) | `0..1` | Dose potency |
| <span id="element-subpotent-reason"></span>`subpotentReason` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Reason for being subpotent |
| <span id="element-education"></span>`education` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Educational material presented to patient |
| <span id="element-program-eligibility"></span>`programEligibility` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Patient eligibility for a vaccination program |
| <span id="element-funding-source"></span>`fundingSource` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Funding source for the vaccine |
| <span id="element-reaction"></span>`reaction` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Details of a reaction that follows immunization |
| <span id="element-protocol-applied"></span>`protocolApplied` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Protocol followed by the provider |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `date` | date | Multiple Resources: AllergyIntolerance: Date first version of the resource instance was recorded ; CarePlan: Time period plan covers ; CareTeam: Time period team covers ; ClinicalImpression: When the assessment was documented ; Composition: Composition editing time ; Consent: When this Consent was created or indexed ; DiagnosticReport: The clinically relevant time of the report ; Encounter: A date within the period the Encounter lasted ; EpisodeOfCare: The provided date search value falls within the episode of care's period ; FamilyMemberHistory: When history was recorded or last updated ; Flag: Time period when flag is active ; Immunization: Vaccination  (non)-Administration Date ; List: When the list was prepared ; Observation: Obtained date/time. If the obtained element is a period, a date that falls in the period ; Procedure: When the procedure was performed ; RiskAssessment: When was assessment made? ; SupplyRequest: When the request was made  |
| `identifier` | token | Multiple Resources: AllergyIntolerance: External ids for this item ; CarePlan: External Ids for this plan ; CareTeam: External Ids for this team ; Composition: Version-independent identifier for the Composition ; Condition: A unique identifier of the condition record ; Consent: Identifier for this record (external references) ; DetectedIssue: Unique id for the detected issue ; DeviceRequest: Business identifier for request/order ; DiagnosticReport: An identifier for the report ; DocumentManifest: Unique Identifier for the set of documents ; DocumentReference: Master Version Specific Identifier ; Encounter: Identifier(s) by which this encounter is known ; EpisodeOfCare: Business Identifier(s) relevant for this EpisodeOfCare ; FamilyMemberHistory: A search by a record identifier ; Goal: External Ids for this goal ; ImagingStudy: Identifiers for the Study, such as DICOM Study Instance UID and Accession number ; Immunization: Business identifier ; List: Business identifier ; MedicationAdministration: Return administrations with this external identifier ; MedicationDispense: Returns dispenses with this external identifier ; MedicationRequest: Return prescriptions with this external identifier ; MedicationStatement: Return statements with this external identifier ; NutritionOrder: Return nutrition orders with this external identifier ; Observation: The unique id for a particular observation ; Procedure: A unique identifier for a procedure ; RiskAssessment: Unique identifier for the assessment ; ServiceRequest: Identifiers assigned to this order ; SupplyDelivery: External identifier ; SupplyRequest: Business Identifier for SupplyRequest ; VisionPrescription: Return prescriptions with this external identifier  |
| `location` | reference | The service delivery location or facility in which the vaccine was / was to be administered |
| `lot-number` | string | Vaccine Lot Number |
| `manufacturer` | reference | Vaccine Manufacturer |
| `patient` | reference | Multiple Resources: AllergyIntolerance: Who the sensitivity is for ; CarePlan: Who the care plan is for ; CareTeam: Who care team is for ; ClinicalImpression: Patient or group assessed ; Composition: Who and/or what the composition is about ; Condition: Who has the condition? ; Consent: Who the consent applies to ; DetectedIssue: Associated patient ; DeviceRequest: Individual the service is ordered for ; DeviceUseStatement: Search by subject - a patient ; DiagnosticReport: The subject of the report if a patient ; DocumentManifest: The subject of the set of documents ; DocumentReference: Who/what is the subject of the document ; Encounter: The patient or group present at the encounter ; EpisodeOfCare: The patient who is the focus of this episode of care ; FamilyMemberHistory: The identity of a subject to list family member history items for ; Flag: The identity of a subject to list flags for ; Goal: Who this goal is intended for ; ImagingStudy: Who the study is about ; Immunization: The patient for the vaccination record ; List: If all resources have the same subject ; MedicationAdministration: The identity of a patient to list administrations  for ; MedicationDispense: The identity of a patient to list dispenses  for ; MedicationRequest: Returns prescriptions for a specific patient ; MedicationStatement: Returns statements for a specific patient. ; NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement ; Observation: The subject that the observation is about (if patient) ; Procedure: Search by subject - a patient ; RiskAssessment: Who/what does assessment apply to? ; ServiceRequest: Search by subject - a patient ; SupplyDelivery: Patient for whom the item is supplied ; VisionPrescription: The identity of a patient to list dispenses for  |
| `performer` | reference | The practitioner or organization who played a role in the vaccination |
| `reaction` | reference | Additional information on reaction |
| `reaction-date` | date | When reaction started |
| `reason-code` | token | Reason why the vaccine was administered |
| `reason-reference` | reference | Why immunization occurred |
| `series` | string | The series being followed by the provider |
| `status` | token | Immunization event status |
| `status-reason` | token | Reason why the vaccine was not administered |
| `target-disease` | token | The target disease the dose is being administered against |
| `vaccine-code` | token | Vaccine Product Administered |

## Reference [#reference]

Official FHIR R4 spec: [Immunization](https://hl7.org/fhir/R4/immunization.html).  
Maturity: Trial Use 3 (FMM 3).
