FHIR Release 3 (STU)

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 GroupMaturity Level: 3 Trial UseCompartments: 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.

Control1..1
InvariantsDefined 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.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Immunization.status
Definition

Indicates the current status of the vaccination event.

Control1..1
Terminology BindingImmunization Status Codes (Required)
Typecode
Is Modifiertrue
Summarytrue
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.

Control1..1
Typeboolean
Is Modifiertrue
Summarytrue
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.

Control1..1
Terminology BindingVaccine Administered Value Set (Example)
TypeCodeableConcept
Immunization.patient
Definition

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

Control1..1
TypeReference(Patient)
Immunization.encounter
Definition

The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

Control0..1
TypeReference(Encounter)
Immunization.date
Definition

Date vaccine administered or was to be administered.

Control0..1
TypedateTime
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.

Control1..1
Typeboolean
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.

Control0..1
Terminology BindingImmunization Origin Codes (Example)
TypeCodeableConcept
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.

Control0..1
TypeReference(Location)
Immunization.manufacturer
Definition

Name of vaccine manufacturer.

Control0..1
TypeReference(Organization)
Immunization.lotNumber
Definition

Lot number of the vaccine product.

Control0..1
Typestring
Immunization.expirationDate
Definition

Date vaccine batch expires.

Control0..1
Typedate
Immunization.site
Definition

Body site where vaccine was administered.

Control0..1
Terminology BindingCodes for Immunization Site of Administration (Example)
TypeCodeableConcept
Immunization.route
Definition

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

Control0..1
Terminology BindingImmunization Route Codes (Example)
TypeCodeableConcept
Immunization.doseQuantity
Definition

The quantity of vaccine product that was administered.

Control0..1
TypeSimpleQuantity
Immunization.practitioner
Definition

Indicates who or what performed the event.

Control0..*
Summarytrue
Immunization.practitioner.role
Definition

Describes the type of performance (e.g. ordering provider, administering provider, etc.).

Control0..1
Terminology BindingImmunization Role Codes (Extensible)
TypeCodeableConcept
Summarytrue
Immunization.practitioner.actor
Definition

The device, practitioner, etc. who performed the action.

Control1..1
TypeReference(Practitioner)
Summarytrue
Immunization.note
Definition

Extra information about the immunization that is not conveyed by the other attributes.

Control0..*
TypeAnnotation
Summarytrue
Immunization.explanation
Definition

Reasons why a vaccine was or was not administered.

Control0..1
Immunization.explanation.reason
Definition

Reasons why a vaccine was administered.

Control0..*
Terminology BindingImmunization Reason Codes (Example)
TypeCodeableConcept
Immunization.explanation.reasonNotGiven
Definition

Reason why a vaccine was not administered.

Control0..*
Terminology BindingImmunization Reasons for Not Immunizing Codes (Example)
TypeCodeableConcept
Immunization.reaction
Definition

Categorical data indicating that an adverse event is associated in time to an immunization.

Control0..*
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.

Control0..1
TypedateTime
Immunization.reaction.detail
Definition

Details of the reaction.

Control0..1
TypeReference(Observation)
Immunization.reaction.reported
Definition

Self-reported indicator.

Control0..1
Typeboolean
Immunization.vaccinationProtocol
Definition

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

Control0..*
Immunization.vaccinationProtocol.doseSequence
Definition

Nominal position in a series.

Control0..1
TypepositiveInt
Immunization.vaccinationProtocol.description
Definition

Contains the description about the protocol under which the vaccine was administered.

Control0..1
Typestring
Immunization.vaccinationProtocol.authority
Definition

Indicates the authority who published the protocol. E.g. ACIP.

Control0..1
TypeReference(Organization)
Immunization.vaccinationProtocol.series
Definition

One possible path to achieve presumed immunity against a disease - within the context of an authority.

Control0..1
Typestring
Immunization.vaccinationProtocol.seriesDoses
Definition

The recommended number of doses to achieve immunity.

Control0..1
TypepositiveInt
Immunization.vaccinationProtocol.targetDisease
Definition

The targeted disease.

Control1..*
Terminology BindingVaccination Protocol Dose Target Codes (Example)
TypeCodeableConcept
Immunization.vaccinationProtocol.doseStatus
Definition

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

Control1..1
Terminology BindingVaccination Protocol Dose Status codes (Example)
TypeCodeableConcept
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.

Control0..1
Terminology BindingVaccination Protocol Dose Status Reason codes (Example)
TypeCodeableConcept