This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Public Health and Emergency Response Work Group | Maturity Level: 3 | Trial Use | Compartments: Patient, Practitioner |
Detailed Descriptions for the elements in the Immunization resource.
Immunization | |
Definition | Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed. |
Control | 1..1 |
Invariants | Defined on this element imm-1: If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present (expression : (notGiven = true).not() or (reaction.empty() and explanation.reason.empty()), xpath: not(f:notGiven/@value=true() and (count(f:reaction) > 0 or exists(f:explanation/f:reason)))) imm-2: If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent. (expression : (notGiven = true) or explanation.reasonNotGiven.empty(), xpath: not(f:notGiven/@value=false() and exists(f:explanation/f:reasonNotGiven))) |
Immunization.identifier | |
Definition | A unique identifier assigned to this immunization record. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Immunization.status | |
Definition | Indicates the current status of the vaccination event. |
Control | 1..1 |
Terminology Binding | Immunization Status Codes (Required) |
Type | code |
Is Modifier | true |
Summary | true |
Comments | Will generally be set to show that the immunization has been completed. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Immunization.notGiven | |
Definition | Indicates if the vaccination was or was not given. |
Control | 1..1 |
Type | boolean |
Is Modifier | true |
Summary | true |
Comments | This element is labeled as a modifier because it indicates that an immunization didn't happen. |
Immunization.vaccineCode | |
Definition | Vaccine that was administered or was to be administered. |
Control | 1..1 |
Terminology Binding | Vaccine Administered Value Set (Example) |
Type | CodeableConcept |
Immunization.patient | |
Definition | The patient who either received or did not receive the immunization. |
Control | 1..1 |
Type | Reference(Patient) |
Immunization.encounter | |
Definition | The visit or admission or other contact between patient and health care provider the immunization was performed as part of. |
Control | 0..1 |
Type | Reference(Encounter) |
Immunization.date | |
Definition | Date vaccine administered or was to be administered. |
Control | 0..1 |
Type | dateTime |
Comments | When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. |
Immunization.primarySource | |
Definition | An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded. |
Control | 1..1 |
Type | boolean |
Comments | Reflects the “reliability” of the content. |
Immunization.reportOrigin | |
Definition | The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine. |
Control | 0..1 |
Terminology Binding | Immunization Origin Codes (Example) |
Type | CodeableConcept |
Comments | Should not be populated if primarySource = True, will not be required even if primarySource = False. |
Immunization.location | |
Definition | The service delivery location where the vaccine administration occurred. |
Control | 0..1 |
Type | Reference(Location) |
Immunization.manufacturer | |
Definition | Name of vaccine manufacturer. |
Control | 0..1 |
Type | Reference(Organization) |
Immunization.lotNumber | |
Definition | Lot number of the vaccine product. |
Control | 0..1 |
Type | string |
Immunization.expirationDate | |
Definition | Date vaccine batch expires. |
Control | 0..1 |
Type | date |
Immunization.site | |
Definition | Body site where vaccine was administered. |
Control | 0..1 |
Terminology Binding | Codes for Immunization Site of Administration (Example) |
Type | CodeableConcept |
Immunization.route | |
Definition | The path by which the vaccine product is taken into the body. |
Control | 0..1 |
Terminology Binding | Immunization Route Codes (Example) |
Type | CodeableConcept |
Immunization.doseQuantity | |
Definition | The quantity of vaccine product that was administered. |
Control | 0..1 |
Type | SimpleQuantity |
Immunization.practitioner | |
Definition | Indicates who or what performed the event. |
Control | 0..* |
Summary | true |
Immunization.practitioner.role | |
Definition | Describes the type of performance (e.g. ordering provider, administering provider, etc.). |
Control | 0..1 |
Terminology Binding | Immunization Role Codes (Extensible) |
Type | CodeableConcept |
Summary | true |
Immunization.practitioner.actor | |
Definition | The device, practitioner, etc. who performed the action. |
Control | 1..1 |
Type | Reference(Practitioner) |
Summary | true |
Immunization.note | |
Definition | Extra information about the immunization that is not conveyed by the other attributes. |
Control | 0..* |
Type | Annotation |
Summary | true |
Immunization.explanation | |
Definition | Reasons why a vaccine was or was not administered. |
Control | 0..1 |
Immunization.explanation.reason | |
Definition | Reasons why a vaccine was administered. |
Control | 0..* |
Terminology Binding | Immunization Reason Codes (Example) |
Type | CodeableConcept |
Immunization.explanation.reasonNotGiven | |
Definition | Reason why a vaccine was not administered. |
Control | 0..* |
Terminology Binding | Immunization Reasons for Not Immunizing Codes (Example) |
Type | CodeableConcept |
Immunization.reaction | |
Definition | Categorical data indicating that an adverse event is associated in time to an immunization. |
Control | 0..* |
Comments | A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements. |
Immunization.reaction.date | |
Definition | Date of reaction to the immunization. |
Control | 0..1 |
Type | dateTime |
Immunization.reaction.detail | |
Definition | Details of the reaction. |
Control | 0..1 |
Type | Reference(Observation) |
Immunization.reaction.reported | |
Definition | Self-reported indicator. |
Control | 0..1 |
Type | boolean |
Immunization.vaccinationProtocol | |
Definition | Contains information about the protocol(s) under which the vaccine was administered. |
Control | 0..* |
Immunization.vaccinationProtocol.doseSequence | |
Definition | Nominal position in a series. |
Control | 0..1 |
Type | positiveInt |
Immunization.vaccinationProtocol.description | |
Definition | Contains the description about the protocol under which the vaccine was administered. |
Control | 0..1 |
Type | string |
Immunization.vaccinationProtocol.authority | |
Definition | Indicates the authority who published the protocol. E.g. ACIP. |
Control | 0..1 |
Type | Reference(Organization) |
Immunization.vaccinationProtocol.series | |
Definition | One possible path to achieve presumed immunity against a disease - within the context of an authority. |
Control | 0..1 |
Type | string |
Immunization.vaccinationProtocol.seriesDoses | |
Definition | The recommended number of doses to achieve immunity. |
Control | 0..1 |
Type | positiveInt |
Immunization.vaccinationProtocol.targetDisease | |
Definition | The targeted disease. |
Control | 1..* |
Terminology Binding | Vaccination Protocol Dose Target Codes (Example) |
Type | CodeableConcept |
Immunization.vaccinationProtocol.doseStatus | |
Definition | Indicates if the immunization event should "count" against the protocol. |
Control | 1..1 |
Terminology Binding | Vaccination Protocol Dose Status codes (Example) |
Type | CodeableConcept |
Comments | May need to differentiate between status declarations by a provider vs. a CDS engine. |
Immunization.vaccinationProtocol.doseStatusReason | |
Definition | Provides an explanation as to why an immunization event should or should not count against the protocol. |
Control | 0..1 |
Terminology Binding | Vaccination Protocol Dose Status Reason codes (Example) |
Type | CodeableConcept |