This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
(v4.0.1:
R4
-
Mixed
Normative
and
STU
3).
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
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
R4
R3
R2
Public
Health
and
Emergency
Response
Work
Group
|
Maturity Level : 3 | Trial Use | Security Category : Patient | Compartments : Patient , Practitioner |
Detailed Descriptions for the elements in the Immunization resource.
| Immunization | |||||||||
| Element Id | Immunization | ||||||||
| Definition |
Describes
the
event
of
a
patient
being
administered
a
|
||||||||
|
|
|
||||||||
|
|
|
||||||||
| Immunization.identifier | |||||||||
| Element Id | Immunization.identifier | ||||||||
| Definition |
A unique identifier assigned to this immunization record. |
||||||||
| Note |
This
is
a
business
|
||||||||
|
|
0..* | ||||||||
| Type | Identifier | ||||||||
| Immunization.status | |||||||||
| Element Id | Immunization.status | ||||||||
| Definition |
Indicates
the
current
status
of
the
|
||||||||
|
|
1..1 | ||||||||
| Terminology Binding | Immunization Status Codes ( Required ) | ||||||||
| Type | code | ||||||||
| Is Modifier | true (Reason: This element is labeled as a modifier because it is a status element that contains statuses entered-in-error and not-done which means that the resource should not be treated as valid) | ||||||||
| Summary | true | ||||||||
| Comments |
Will
generally
be
set
to
show
that
the
immunization
has
been
|
||||||||
|
|
|||||||||
| Element Id | Immunization.statusReason | ||||||||
| Definition |
Indicates
|
||||||||
|
|
|
||||||||
|
|
|
||||||||
|
|
|
||||||||
| Comments |
This
|
||||||||
| Immunization.vaccineCode | |||||||||
| Element Id | Immunization.vaccineCode | ||||||||
| Definition |
Vaccine that was administered or was to be administered. |
||||||||
|
|
1..1 | ||||||||
| Terminology Binding | Vaccine Administered Value Set ( Example ) | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | true | ||||||||
| Immunization.patient | |||||||||
| Element Id | Immunization.patient | ||||||||
| Definition |
The patient who either received or did not receive the immunization. |
||||||||
|
|
1..1 | ||||||||
| Type | Reference ( Patient ) | ||||||||
| Summary | true | ||||||||
| Immunization.encounter | |||||||||
| Element Id | Immunization.encounter | ||||||||
| Definition |
The visit or admission or other contact between patient and health care provider the immunization was performed as part of. |
||||||||
|
|
0..1 | ||||||||
| Type | Reference ( Encounter ) | ||||||||
|
|
|||||||||
| Element Id | Immunization.occurrence[x] | ||||||||
| Definition |
Date vaccine administered or was to be administered. |
||||||||
|
|
|
||||||||
| Type | dateTime | string | ||||||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
| Summary | true | ||||||||
| 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.
|
||||||||
| Immunization.recorded | |||||||||
| Element Id | Immunization.recorded | ||||||||
| Definition | The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | dateTime | ||||||||
| Summary | false | ||||||||
| Immunization.primarySource | |||||||||
| Element Id | 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. |
||||||||
|
|
|
||||||||
| Type | boolean | ||||||||
| Summary | true | ||||||||
| Comments |
Reflects the “reliability” of the content. |
||||||||
| Immunization.reportOrigin | |||||||||
| Element Id | 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. |
||||||||
|
|
0..1 | ||||||||
| Terminology Binding | Immunization Origin Codes ( Example ) | ||||||||
| Type | CodeableConcept | ||||||||
| Comments |
Should
not
be
populated
if
primarySource
=
True,
|
||||||||
| Immunization.location | |||||||||
| Element Id | Immunization.location | ||||||||
| Definition |
The service delivery location where the vaccine administration occurred. |
||||||||
|
|
0..1 | ||||||||
| Type | Reference ( Location ) | ||||||||
| Immunization.manufacturer | |||||||||
| Element Id | Immunization.manufacturer | ||||||||
| Definition |
Name of vaccine manufacturer. |
||||||||
|
|
0..1 | ||||||||
| Type | Reference ( Organization ) | ||||||||
| Immunization.lotNumber | |||||||||
| Element Id | Immunization.lotNumber | ||||||||
| Definition |
Lot number of the vaccine product. |
||||||||
|
|
0..1 | ||||||||
| Type | string | ||||||||
| Immunization.expirationDate | |||||||||
| Element Id | Immunization.expirationDate | ||||||||
| Definition |
Date vaccine batch expires. |
||||||||
|
|
0..1 | ||||||||
| Type | date | ||||||||
| Immunization.site | |||||||||
| Element Id | Immunization.site | ||||||||
| Definition |
Body site where vaccine was administered. |
||||||||
|
|
0..1 | ||||||||
| Terminology Binding | Codes for Immunization Site of Administration ( Example ) | ||||||||
| Type | CodeableConcept | ||||||||
| Immunization.route | |||||||||
| Element Id | Immunization.route | ||||||||
| Definition |
The path by which the vaccine product is taken into the body. |
||||||||
|
|
0..1 | ||||||||
| Terminology Binding | Immunization Route Codes ( Example ) | ||||||||
| Type | CodeableConcept | ||||||||
| Immunization.doseQuantity | |||||||||
| Element Id | Immunization.doseQuantity | ||||||||
| Definition |
The quantity of vaccine product that was administered. |
||||||||
|
|
0..1 | ||||||||
| Type | SimpleQuantity | ||||||||
|
|
|||||||||
| Element Id | Immunization.performer | ||||||||
| Definition |
Indicates
who
|
||||||||
|
|
0..* | ||||||||
| Summary | true | ||||||||
|
|
|||||||||
| Element Id | Immunization.performer.function | ||||||||
| Definition |
Describes the type of performance (e.g. ordering provider, administering provider, etc.). |
||||||||
|
|
0..1 | ||||||||
| Terminology Binding |
Immunization
|
||||||||
| Type | CodeableConcept | ||||||||
| Summary | true | ||||||||
|
|
|||||||||
| Element Id | Immunization.performer.actor | ||||||||
| Definition |
The
|
||||||||
|
|
1..1 | ||||||||
| Type | Reference ( Practitioner | PractitionerRole | Organization ) | ||||||||
| Summary | true | ||||||||
| Comments | When the individual practitioner who performed the action is known, it is best to send. | ||||||||
| Immunization.note | |||||||||
| Element Id | Immunization.note | ||||||||
| Definition |
Extra information about the immunization that is not conveyed by the other attributes. |
||||||||
|
|
0..* | ||||||||
| Type | Annotation | ||||||||
| Summary | true | ||||||||
|
|
|||||||||
| Element Id | Immunization.reasonCode | ||||||||
| Definition |
Reasons
why
|
||||||||
|
|
| ||||||||
| Terminology Binding | Immunization Reason Codes ( Example ) | ||||||||
| Type | CodeableConcept | ||||||||
|
|
|||||||||
| Element Id | Immunization.reasonReference | ||||||||
| Definition |
|
||||||||
|
|
0..* | ||||||||
|
|
|
||||||||
| Immunization.isSubpotent | |||||||||
| Element Id | Immunization.isSubpotent | ||||||||
| Definition | Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type |
| ||||||||
| Is Modifier | true (Reason: This element is labeled as a modifier because an immunization event with a subpotent vaccine doesn't protect the patient the same way as a potent dose.) | ||||||||
| Meaning if Missing | By default, a dose should be considered to be potent. | ||||||||
| Summary | true | ||||||||
| Comments | Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event. |
||||||||
|
|
|||||||||
| Element Id | Immunization.subpotentReason | ||||||||
| Definition |
Reason
why
a
|
||||||||
|
|
0..* | ||||||||
| Terminology Binding |
Immunization
|
||||||||
| Type | CodeableConcept | ||||||||
|
|
|||||||||
| Element Id | Immunization.education | ||||||||
| Definition |
|
||||||||
|
|
0..* | ||||||||
|
|
|
||||||||
|
|
|||||||||
| Element Id | Immunization.education.documentType | ||||||||
| Definition |
|
||||||||
|
|
0..1 | ||||||||
| Type |
|
||||||||
|
|
|||||||||
| Element Id | Immunization.education.reference | ||||||||
| Definition |
|
||||||||
|
|
0..1 | ||||||||
| Type |
|
||||||||
|
|
|||||||||
| Element Id | Immunization.education.publicationDate | ||||||||
| Definition |
|
||||||||
|
|
0..1 | ||||||||
| Type |
|
||||||||
|
|
|||||||||
| Element Id | Immunization.education.presentationDate | ||||||||
| Definition |
|
||||||||
|
|
| ||||||||
| Type | dateTime | ||||||||
|
|
|||||||||
| Element Id | Immunization.programEligibility | ||||||||
| Definition |
|
||||||||
|
|
| ||||||||
| Terminology Binding | Immunization Program Eligibility ( Example ) | ||||||||
| Type |
|
||||||||
|
|
|||||||||
| Element Id | Immunization.fundingSource | ||||||||
| Definition |
|
||||||||
|
|
0..1 | ||||||||
| Terminology Binding | Immunization Funding Source ( Example ) | ||||||||
| Type |
|
||||||||
|
|
|||||||||
| Element Id | Immunization.reaction | ||||||||
| Definition |
| ||||||||
| Cardinality | 0..* | ||||||||
| Comments |
A
reaction
may
be
an
indication
of
an
allergy
or
intolerance
and,
if
this
is
determined
to
be
the
| ||||||||
| Immunization.reaction.date | |||||||||
| Element Id | Immunization.reaction.date | ||||||||
| Definition |
Date
of
reaction
to
the
|
||||||||
|
| 0..1 | ||||||||
| Type | dateTime | ||||||||
| Immunization.reaction.detail | |||||||||
| Element Id | Immunization.reaction.detail | ||||||||
| Definition | Details of the reaction. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type |
Reference
(
|
||||||||
|
| |||||||||
| Element Id | Immunization.reaction.reported | ||||||||
| Definition | Self-reported indicator. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | boolean | ||||||||
| Immunization.protocolApplied | |||||||||
| Element Id | Immunization.protocolApplied | ||||||||
| Definition | The protocol (set of recommendations) being followed by the provider who administered the dose. | ||||||||
| Cardinality | 0..* | ||||||||
| Immunization.protocolApplied.series | |||||||||
| Element Id | Immunization.protocolApplied.series | ||||||||
| Definition |
One possible path to achieve presumed immunity against a disease - within the context of an authority. |
||||||||
|
|
0..1 | ||||||||
| Type | string | ||||||||
|
|
|||||||||
| Element Id | Immunization.protocolApplied.authority | ||||||||
| Definition |
|
||||||||
|
|
0..1 | ||||||||
| Type |
|
||||||||
|
|
|||||||||
| Element Id | Immunization.protocolApplied.targetDisease | ||||||||
| Definition |
The
|
||||||||
|
|
|
||||||||
| Terminology Binding |
|
||||||||
| Type | CodeableConcept | ||||||||
|
|
|||||||||
| Element Id | Immunization.protocolApplied.doseNumber[x] | ||||||||
| Definition |
|
||||||||
|
|
1..1 | ||||||||
|
|
|
||||||||
|
|
|
||||||||
| Comments |
|
||||||||
|
|
|||||||||
| Element Id | Immunization.protocolApplied.seriesDoses[x] | ||||||||
| Definition |
|
||||||||
|
|
0..1 | ||||||||
|
|
|
||||||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
| Comments |
The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose). |
||||||||