DSTU2 STU 3 Ballot
This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . For a full list of available versions, see the Directory of published versions . Page versions: . Page versions: R5 R4B R4 R3 R2

4.18.6 11.6.6 Resource Immunization - Detailed Descriptions Resource Immunization - Detailed Descriptions Detailed Descriptions for the elements in the Immunization resource.

Detailed Descriptions for the elements in the Immunization resource.

© HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:43+1100. Links: Search | Version History | Table of Contents | Compare to DSTU1
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. 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 Defined on this element
imm-1 : If immunization was not administred (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present (xpath: not(f:wasNotGiven/@value=true() and (count(f:reaction) > 0 or exists(f:explanation/f:reason)))) : If immunization was not administered (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present ( expression : (wasNotGiven = true).not() or (reaction.empty() and explanation.reason.empty()), xpath: not(f:wasNotGiven/@value=true() and (count(f:reaction) > 0 or exists(f:explanation/f:reason))))
imm-2 : If immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent. (xpath: not(f:wasNotGiven/@value=false() and exists(f:explanation/f:reasonNotGiven))) : If immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent. ( expression : (wasNotGiven = true) or explanation.reasonNotGiven.empty(), xpath: not(f:wasNotGiven/@value=false() and exists(f:explanation/f:reasonNotGiven)))
Immunization.identifier
Definition

A unique identifier assigned to this immunization record. A unique identifier assigned to this immunization record.

Note This is a business identifer, not a resource identifier (see 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. Indicates the current status of the vaccination event.

Control 1..1
Binding MedicationAdministrationStatus: A set of codes indicating the current status of an Immunization ( MedicationAdministrationStatus: A set of codes indicating the current status of an Immunization ( Required )
Type code
Is Modifier Is Modifier true
Summary true
Comments

Will generally be set to show that the immunization has been completed. Will generally be set to show that the immunization has been completed.

Immunization.date
Definition

Date vaccine administered or was to be administered. 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. 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.vaccineCode
Definition

Vaccine that was administered or was to be administered. Vaccine that was administered or was to be administered.

Control 1..1
Binding Vaccine Administered Value Set: The code for vaccine product administered ( Vaccine Administered Value Set: The code for vaccine product administered ( Example )
Type CodeableConcept
Immunization.patient
Definition

The patient who either received or did not receive the immunization. The patient who either received or did not receive the immunization.

Control 1..1
Type Reference ( Patient )
Immunization.wasNotGiven
Definition

Indicates if the vaccination was or was not given. Indicates if the vaccination was or was not given.

Control 1..1
Type boolean
Is Modifier Is Modifier true
Summary true
Immunization.reported
Definition

True if this administration was reported rather than directly administered. True if this administration was reported rather than directly administered.

Control 1..1
Type boolean
Comments

May need source of reported info (e.g. parent), but leave out for now. May need source of reported info (e.g. parent), but leave out for now.

Immunization.performer
Definition

Clinician who administered the vaccine. Clinician who administered the vaccine.

Control 0..1
Type Reference ( Practitioner )
Immunization.requester
Definition

Clinician who ordered the vaccination. Clinician who ordered the vaccination.

Control 0..1
Type Reference ( Practitioner )
Comments

Other participants - delegate to Provenance resource. Other participants - delegate to Provenance resource.

Immunization.encounter
Definition

The visit or admission or other contact between patient and health care provider the immunization was performed as part of. 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.manufacturer
Definition

Name of vaccine manufacturer. Name of vaccine manufacturer.

Control 0..1
Type Reference ( Organization )
Immunization.location
Definition

The service delivery location where the vaccine administration occurred. The service delivery location where the vaccine administration occurred.

Control 0..1
Type Reference ( Location )
Immunization.lotNumber
Definition

Lot number of the vaccine product. Lot number of the vaccine product.

Control 0..1
Type string
Immunization.expirationDate
Definition

Date vaccine batch expires. Date vaccine batch expires.

Control 0..1
Type date
Immunization.site
Definition

Body site where vaccine was administered. Body site where vaccine was administered.

Control 0..1
Binding Codes for Immunization Site of Administration: The site at which the vaccine was administered ( Codes for Immunization Site of Administration: The site at which the vaccine was administered ( Example )
Type CodeableConcept
Immunization.route
Definition

The path by which the vaccine product is taken into the body. The path by which the vaccine product is taken into the body.

Control 0..1
Binding Immunization Route Codes: The route by which the vaccine was administered ( Immunization Route Codes: The route by which the vaccine was administered ( Example )
Type CodeableConcept
Immunization.doseQuantity
Definition

The quantity of vaccine product that was administered. The quantity of vaccine product that was administered.

Control 0..1
Type SimpleQuantity
Immunization.note
Definition

Extra information about the immunization that is not conveyed by the other attributes. 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. Reasons why a vaccine was or was not administered.

Control 0..1
Immunization.explanation.reason
Definition

Reasons why a vaccine was administered. Reasons why a vaccine was administered.

Control 0..*
Binding Immunization Reason Codes: The reason why a vaccine was administered ( Immunization Reason Codes: The reason why a vaccine was administered ( Example )
Type CodeableConcept
Immunization.explanation.reasonNotGiven
Definition

Reason why a vaccine was not administered. Reason why a vaccine was not administered.

Control 0..*
Binding Immunization Reasons for Not Immunizing Codes: The reason why a vaccine was not administered ( Immunization Reasons for Not Immunizing Codes: The reason why a vaccine was not administered ( Example )
Type CodeableConcept
Immunization.reaction
Definition

Categorical data indicating that an adverse event is associated in time to an immunization. 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 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. resource instance as most systems will not query against past Immunization.reaction elements.

Immunization.reaction.date
Definition

Date of reaction to the immunization. Date of reaction to the immunization.

Control 0..1
Type dateTime
Immunization.reaction.detail
Definition

Details of the reaction. Details of the reaction.

Control 0..1
Type Reference ( Observation )
Immunization.reaction.reported
Definition

Self-reported indicator. Self-reported indicator.

Control 0..1
Type boolean
Immunization.vaccinationProtocol
Definition

Contains information about the protocol(s) under which the vaccine was administered. Contains information about the protocol(s) under which the vaccine was administered.

Control 0..*
Immunization.vaccinationProtocol.doseSequence
Definition

Nominal position in a series. Nominal position in a series.

Control 1..1 0..1
Type positiveInt
Immunization.vaccinationProtocol.description
Definition

Contains the description about the protocol under which the vaccine was administered. 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. 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. 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. The recommended number of doses to achieve immunity.

Control 0..1
Type positiveInt
Immunization.vaccinationProtocol.targetDisease
Definition

The targeted disease. The targeted disease.

Control 1..*
Binding Vaccination Protocol Dose Target Codes: The disease target of the vaccination protocol ( Vaccination Protocol Dose Target Codes: The disease target of the vaccination protocol ( Example )
Type CodeableConcept
Immunization.vaccinationProtocol.doseStatus
Definition

Indicates if the immunization event should "count" against the protocol. Indicates if the immunization event should "count" against the protocol.

Control 1..1
Binding Vaccination Protocol Dose Status codes: The status of the vaccination protocol (i.e. should this count) ( Vaccination Protocol Dose Status codes: The status of the vaccination protocol (i.e. should this count) ( Example )
Type CodeableConcept
Comments

May need to differentiate between status declarations by a provider vs. a CDS engine. 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. Provides an explanation as to why an immunization event should or should not count against the protocol.

Control 0..1
Binding Vaccination Protocol Dose Status Reason codes: The reason for the determining if a vaccination should count or why vaccination should not count. ( Vaccination Protocol Dose Status Reason codes: The reason for the determining if a vaccination should count or why vaccination should not count. ( Example )
Type CodeableConcept