Medications
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
|
|
|
Compartments
|
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.
The Immunization resource is intended to cover the recording of current and historical administration of vaccines to patients across all healthcare disciplines in all care settings and all regions. This includes immunization of both humans and animals, but does not include the administration of non-vaccine agents, even those that may have or claim to have immunological effects.
Additionally, the Immunization resource is expected to cover key concepts related to the creation, revision and querying of a patient's immunization history. This resource - through consultation with the PHER work group - is believed to meet key use cases and information requirements as defined in the existing
HL7 v2
immunization
implementation
guide,
HL7
v3
immunization implementation guide,
HL7 v3
POIZ
domain
and
Immunization
Domain
Analysis
Model.
POIZ domain and Immunization Domain Analysis Model.
This resource references the following resources:
Administration of vaccines is intended to be handled using the
Immunization
resource.
resource.
MedicationAdministration
is
intended
for
tracking
the
administration
of
non-vaccine
medications.
Some
systems
treat
immunizations
in
the
same
way
as
any
other
medication
administration.
Such
systems
SHOULD
use
an
immunization
resource
to
represent
these.
If
systems
need
to
use
a
is intended for tracking the administration of non-vaccine medications. Some systems treat immunizations in the same way as any other medication administration. Such systems SHOULD use an immunization resource to represent these. If systems need to use a
MedicationAdministration
resource
to
capture
vaccinations
for
workflow
or
other
reasons,
they
SHOULD
also
expose
an
equivalent
resource to capture vaccinations for workflow or other reasons, they SHOULD also expose an equivalent
Immunization
instance.
AllergyIntolerance
and
Immunization.reaction
instance.
AllergyIntolerance and Immunization.reaction
Immunization.reaction
may
be
an
indication
of
an
allergy
or
intolerance.
If
this
is
deemed
to
be
the
case,
a
separate
may be an indication of an allergy or intolerance. If this is deemed to be the case, a separate
AllergyIntolerance
resource
instance
should
be
created
to
indicate
it,
as
most
systems
will
not
query
against
past
Immunization.reaction.
This
resource
is
referenced
by
resource instance should be created to indicate it, as most systems will not query against past Immunization.reaction.
This resource is referenced by immunizationrecommendation
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
Immunization
|
I | DomainResource |
|
|
identifier
|
0..* | Identifier |
|
|
status
|
?! Σ | 1..1 | code |
MedicationAdministrationStatus |
|
date
|
0..1 | dateTime |
|
|
|
vaccineCode
|
1..1 | CodeableConcept |
|
|
patient
|
1..1 | Reference ( Patient ) |
|
|
|
wasNotGiven
|
?! Σ | 1..1 | boolean |
|
|
reported
|
1..1 | boolean |
|
|
|
performer
|
0..1 | Reference ( Practitioner ) |
|
|
|
requester
|
0..1 | Reference ( Practitioner ) |
|
|
|
encounter
|
0..1 | Reference ( Encounter ) |
|
|
|
manufacturer
|
0..1 | Reference ( Organization ) |
|
|
|
location
|
0..1 | Reference ( Location ) |
|
|
|
lotNumber
|
0..1 | string |
|
|
|
expirationDate
|
0..1 | date |
|
|
|
site
|
0..1 | CodeableConcept |
|
|
|
route
|
0..1 | CodeableConcept |
|
|
|
doseQuantity
|
0..1 | SimpleQuantity |
|
|
|
note
|
Σ | 0..* | Annotation |
|
explanation
|
0..1 | BackboneElement |
|
|
reason
|
0..* | CodeableConcept |
|
|
reasonNotGiven
|
0..* | CodeableConcept |
|
|
|
reaction
|
0..* | BackboneElement |
|
|
|
date
|
0..1 | dateTime |
|
|
|
detail
|
0..1 | Reference ( Observation ) |
|
|
|
reported
|
0..1 | boolean |
|
|
|
vaccinationProtocol
|
0..* | BackboneElement |
|
|
doseSequence
|
|
positiveInt |
|
|
|
description
|
0..1 | string |
|
|
|
authority
|
0..1 | Reference ( Organization ) |
|
|
|
series
|
0..1 | string |
|
|
|
seriesDoses
|
0..1 | positiveInt |
|
|
|
targetDisease
|
1..* | CodeableConcept |
|
|
|
doseStatus
|
1..1 | CodeableConcept |
|
|
|
doseStatusReason
|
0..1 | CodeableConcept |
|
|
|
Documentation for this format
|
||||
UML
Diagram
UML Diagram
(
Legend
)
XML
Template
XML Template
<
<Immunization xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</identifier> < < <</vaccineCode> <</patient> < < <</performer> <</requester> <</encounter> <</manufacturer> <</location> < < <</site> <</route> <</doseQuantity> <</note> < <</reason> <</reasonNotGiven><identifier><!-- 0..* Identifier Business identifier --></identifier> <status value="[code]"/><!-- 1..1 in-progress | on-hold | completed | entered-in-error | stopped --> <date value="[dateTime]"/><!-- 0..1 Vaccination administration date --> <vaccineCode><!-- 1..1 CodeableConcept Vaccine product administered --></vaccineCode> <patient><!-- 1..1 Reference(Patient) Who was immunized --></patient> <wasNotGiven value="[boolean]"/><!-- 1..1 Flag for whether immunization was given --> <reported value="[boolean]"/><!-- 1..1 Indicates a self-reported record --> <performer><!-- 0..1 Reference(Practitioner) Who administered vaccine --></performer> <requester><!-- 0..1 Reference(Practitioner) Who ordered vaccination --></requester> <encounter><!-- 0..1 Reference(Encounter) Encounter administered as part of --></encounter> <manufacturer><!-- 0..1 Reference(Organization) Vaccine manufacturer --></manufacturer> <location><!-- 0..1 Reference(Location) Where vaccination occurred --></location> <lotNumber value="[string]"/><!-- 0..1 Vaccine lot number --> <expirationDate value="[date]"/><!-- 0..1 Vaccine expiration date --> <site><!-- 0..1 CodeableConcept Body site vaccine was administered --></site> <route><!-- 0..1 CodeableConcept How vaccine entered body --></route> <doseQuantity><!-- 0..1 Quantity(SimpleQuantity) Amount of vaccine administered --></doseQuantity> <note><!-- 0..* Annotation Vaccination notes --></note> <explanation> <!-- 0..1 Administration/non-administration reasons --> <reason><!-- 0..* CodeableConcept Why immunization occurred --></reason> <reasonNotGiven><!-- 0..* CodeableConcept Why immunization did not occur --></reasonNotGiven> </explanation>< < <</detail> <<reaction> <!-- 0..* Details of a reaction that follows immunization --> <date value="[dateTime]"/><!-- 0..1 When reaction started --> <detail><!-- 0..1 Reference(Observation) Additional information on reaction --></detail> <reported value="[boolean]"/><!-- 0..1 Indicates self-reported reaction --> </reaction>< < < <</authority> < < <</targetDisease> <</doseStatus> <</doseStatusReason><vaccinationProtocol> <!-- 0..* What protocol was followed --> <doseSequence value="[positiveInt]"/><!-- 0..1 Dose number within series --> <description value="[string]"/><!-- 0..1 Details of vaccine protocol --> <authority><!-- 0..1 Reference(Organization) Who is responsible for protocol --></authority> <series value="[string]"/><!-- 0..1 Name of vaccine series --> <seriesDoses value="[positiveInt]"/><!-- 0..1 Recommended number of doses for immunity --> <targetDisease><!-- 1..* CodeableConcept Disease immunized against --></targetDisease> <doseStatus><!-- 1..1 CodeableConcept Indicates if dose counts towards immunity --></doseStatus> <doseStatusReason><!-- 0..1 CodeableConcept Why dose does (not) count --></doseStatusReason> </vaccinationProtocol> </Immunization>
JSON
Template
JSON Template
{
"resourceType" : "",
{
"resourceType" : "Immunization",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"identifier" : [{ Identifier }], // Business identifier
"status" : "<code>", // R! in-progress | on-hold | completed | entered-in-error | stopped
"date" : "<dateTime>", // Vaccination administration date
"vaccineCode" : { CodeableConcept }, // R! Vaccine product administered
"patient" : { Reference(Patient) }, // R! Who was immunized
"wasNotGiven" : <boolean>, // R! Flag for whether immunization was given
"reported" : <boolean>, // R! Indicates a self-reported record
"performer" : { Reference(Practitioner) }, // Who administered vaccine
"requester" : { Reference(Practitioner) }, // Who ordered vaccination
"encounter" : { Reference(Encounter) }, // Encounter administered as part of
"manufacturer" : { Reference(Organization) }, // Vaccine manufacturer
"location" : { Reference(Location) }, // Where vaccination occurred
"lotNumber" : "<string>", // Vaccine lot number
"expirationDate" : "<date>", // Vaccine expiration date
"site" : { CodeableConcept }, // Body site vaccine was administered
"route" : { CodeableConcept }, // How vaccine entered body
"doseQuantity" : { Quantity(SimpleQuantity) }, // Amount of vaccine administered
"note" : [{ Annotation }], // Vaccination notes
"explanation" : { // Administration/non-administration reasons
"reason" : [{ CodeableConcept }], // Why immunization occurred
"reasonNotGiven" : [{ CodeableConcept }] // Why immunization did not occur
},
"
"
"
"
"reaction" : [{ // Details of a reaction that follows immunization
"date" : "<dateTime>", // When reaction started
"detail" : { Reference(Observation) }, // Additional information on reaction
"reported" : <boolean> // Indicates self-reported reaction
}],
"
"
"
"
"
"
"
"
"
"vaccinationProtocol" : [{ // What protocol was followed
"doseSequence" : "<positiveInt>", // Dose number within series
"description" : "<string>", // Details of vaccine protocol
"authority" : { Reference(Organization) }, // Who is responsible for protocol
"series" : "<string>", // Name of vaccine series
"seriesDoses" : "<positiveInt>", // Recommended number of doses for immunity
"targetDisease" : [{ CodeableConcept }], // R! Disease immunized against
"doseStatus" : { CodeableConcept }, // R! Indicates if dose counts towards immunity
"doseStatusReason" : { CodeableConcept } // Why dose does (not) count
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since DSTU2
| Immunization | |
| Immunization.vaccinationProtocol.doseSequence | Min Cardinality changed from 1 to 0 |
See the Full Difference for further information
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
Immunization
|
I | DomainResource |
|
|
|
identifier
|
0..* | Identifier |
|
|
|
status
|
?! Σ | 1..1 | code |
MedicationAdministrationStatus |
|
date
|
0..1 | dateTime |
|
|
|
vaccineCode
|
1..1 | CodeableConcept |
|
|
|
patient
|
1..1 | Reference ( Patient ) |
|
|
|
wasNotGiven
|
?! Σ | 1..1 | boolean |
|
|
reported
|
1..1 | boolean |
|
|
|
performer
|
0..1 | Reference ( Practitioner ) |
|
|
|
requester
|
0..1 | Reference ( Practitioner ) |
|
|
|
encounter
|
0..1 | Reference ( Encounter ) |
|
|
|
manufacturer
|
0..1 | Reference ( Organization ) |
|
|
|
location
|
0..1 | Reference ( Location ) |
|
|
|
lotNumber
|
0..1 | string |
|
|
|
expirationDate
|
0..1 | date |
|
|
|
site
|
0..1 | CodeableConcept |
|
|
|
route
|
0..1 | CodeableConcept |
|
|
|
doseQuantity
|
0..1 | SimpleQuantity |
|
|
|
note
|
Σ | 0..* | Annotation |
|
|
explanation
|
0..1 | BackboneElement |
|
|
|
reason
|
0..* | CodeableConcept |
|
|
|
reasonNotGiven
|
0..* | CodeableConcept |
|
|
|
reaction
|
0..* | BackboneElement |
|
|
|
date
|
0..1 | dateTime |
|
|
|
detail
|
0..1 | Reference ( Observation ) |
|
|
|
reported
|
0..1 | boolean |
|
|
|
vaccinationProtocol
|
0..* | BackboneElement |
|
|
|
doseSequence
|
|
positiveInt |
|
|
|
description
|
0..1 | string |
|
|
|
authority
|
0..1 | Reference ( Organization ) |
|
|
|
series
|
0..1 | string |
|
|
|
seriesDoses
|
0..1 | positiveInt |
|
|
|
targetDisease
|
1..* | CodeableConcept |
|
|
|
doseStatus
|
1..1 | CodeableConcept |
|
|
|
doseStatusReason
|
0..1 | CodeableConcept |
|
|
|
Documentation for this format
|
||||
XML
Template
XML Template
<
<Immunization xmlns="http://hl7.org/fhir"><</identifier> < < <</vaccineCode> <</patient> < < <</performer> <</requester> <</encounter> <</manufacturer> <</location> < < <</site> <</route> <</doseQuantity> <</note> < <</reason> <</reasonNotGiven><identifier><!-- 0..* Identifier Business identifier --></identifier> <status value="[code]"/><!-- 1..1 in-progress | on-hold | completed | entered-in-error | stopped --> <date value="[dateTime]"/><!-- 0..1 Vaccination administration date --> <vaccineCode><!-- 1..1 CodeableConcept Vaccine product administered --></vaccineCode> <patient><!-- 1..1 Reference(Patient) Who was immunized --></patient> <wasNotGiven value="[boolean]"/><!-- 1..1 Flag for whether immunization was given --> <reported value="[boolean]"/><!-- 1..1 Indicates a self-reported record --> <performer><!-- 0..1 Reference(Practitioner) Who administered vaccine --></performer> <requester><!-- 0..1 Reference(Practitioner) Who ordered vaccination --></requester> <encounter><!-- 0..1 Reference(Encounter) Encounter administered as part of --></encounter> <manufacturer><!-- 0..1 Reference(Organization) Vaccine manufacturer --></manufacturer> <location><!-- 0..1 Reference(Location) Where vaccination occurred --></location> <lotNumber value="[string]"/><!-- 0..1 Vaccine lot number --> <expirationDate value="[date]"/><!-- 0..1 Vaccine expiration date --> <site><!-- 0..1 CodeableConcept Body site vaccine was administered --></site> <route><!-- 0..1 CodeableConcept How vaccine entered body --></route> <doseQuantity><!-- 0..1 Quantity(SimpleQuantity) Amount of vaccine administered --></doseQuantity> <note><!-- 0..* Annotation Vaccination notes --></note> <explanation> <!-- 0..1 Administration/non-administration reasons --> <reason><!-- 0..* CodeableConcept Why immunization occurred --></reason> <reasonNotGiven><!-- 0..* CodeableConcept Why immunization did not occur --></reasonNotGiven> </explanation>< < <</detail> <<reaction> <!-- 0..* Details of a reaction that follows immunization --> <date value="[dateTime]"/><!-- 0..1 When reaction started --> <detail><!-- 0..1 Reference(Observation) Additional information on reaction --></detail> <reported value="[boolean]"/><!-- 0..1 Indicates self-reported reaction --> </reaction>< < < <</authority> < < <</targetDisease> <</doseStatus> <</doseStatusReason><vaccinationProtocol> <!-- 0..* What protocol was followed --> <doseSequence value="[positiveInt]"/><!-- 0..1 Dose number within series --> <description value="[string]"/><!-- 0..1 Details of vaccine protocol --> <authority><!-- 0..1 Reference(Organization) Who is responsible for protocol --></authority> <series value="[string]"/><!-- 0..1 Name of vaccine series --> <seriesDoses value="[positiveInt]"/><!-- 0..1 Recommended number of doses for immunity --> <targetDisease><!-- 1..* CodeableConcept Disease immunized against --></targetDisease> <doseStatus><!-- 1..1 CodeableConcept Indicates if dose counts towards immunity --></doseStatus> <doseStatusReason><!-- 0..1 CodeableConcept Why dose does (not) count --></doseStatusReason> </vaccinationProtocol> </Immunization>
JSON
Template
JSON Template
{
"resourceType" : "",
{
"resourceType" : "Immunization",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"identifier" : [{ Identifier }], // Business identifier
"status" : "<code>", // R! in-progress | on-hold | completed | entered-in-error | stopped
"date" : "<dateTime>", // Vaccination administration date
"vaccineCode" : { CodeableConcept }, // R! Vaccine product administered
"patient" : { Reference(Patient) }, // R! Who was immunized
"wasNotGiven" : <boolean>, // R! Flag for whether immunization was given
"reported" : <boolean>, // R! Indicates a self-reported record
"performer" : { Reference(Practitioner) }, // Who administered vaccine
"requester" : { Reference(Practitioner) }, // Who ordered vaccination
"encounter" : { Reference(Encounter) }, // Encounter administered as part of
"manufacturer" : { Reference(Organization) }, // Vaccine manufacturer
"location" : { Reference(Location) }, // Where vaccination occurred
"lotNumber" : "<string>", // Vaccine lot number
"expirationDate" : "<date>", // Vaccine expiration date
"site" : { CodeableConcept }, // Body site vaccine was administered
"route" : { CodeableConcept }, // How vaccine entered body
"doseQuantity" : { Quantity(SimpleQuantity) }, // Amount of vaccine administered
"note" : [{ Annotation }], // Vaccination notes
"explanation" : { // Administration/non-administration reasons
"reason" : [{ CodeableConcept }], // Why immunization occurred
"reasonNotGiven" : [{ CodeableConcept }] // Why immunization did not occur
},
"
"
"
"
"reaction" : [{ // Details of a reaction that follows immunization
"date" : "<dateTime>", // When reaction started
"detail" : { Reference(Observation) }, // Additional information on reaction
"reported" : <boolean> // Indicates self-reported reaction
}],
"
"
"
"
"
"
"
"
"
"vaccinationProtocol" : [{ // What protocol was followed
"doseSequence" : "<positiveInt>", // Dose number within series
"description" : "<string>", // Details of vaccine protocol
"authority" : { Reference(Organization) }, // Who is responsible for protocol
"series" : "<string>", // Name of vaccine series
"seriesDoses" : "<positiveInt>", // Recommended number of doses for immunity
"targetDisease" : [{ CodeableConcept }], // R! Disease immunized against
"doseStatus" : { CodeableConcept }, // R! Indicates if dose counts towards immunity
"doseStatusReason" : { CodeableConcept } // Why dose does (not) count
}]
}
Alternate
definitions:
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since DSTU2
| Immunization | |
| Immunization.vaccinationProtocol.doseSequence | Min Cardinality changed from 1 to 0 |
See the Full Difference for further information
Alternate definitions: Master Definition (
XML
,
JSON
),
XML
Schema
/
Schematron
,
Resource
Profile
(
XML
,
(for ) +
JSON
Schema
,
ShEx
(for
Turtle
),
Questionnaire
)
| Path | Definition | Type | Reference |
|---|---|---|---|
| Immunization.status |
|
Required | MedicationAdministrationStatus |
| Immunization.vaccineCode |
|
Example |
|
| Immunization.site |
|
Example |
|
| Immunization.route |
|
Example |
|
| Immunization.explanation.reason |
|
Example |
|
| Immunization.explanation.reasonNotGiven |
|
Example |
|
| Immunization.vaccinationProtocol.targetDisease |
|
Example |
|
| Immunization.vaccinationProtocol.doseStatus |
|
Example |
|
| Immunization.vaccinationProtocol.doseStatusReason |
|
Example |
|
:
(wasNotGiven = true).not() or (reaction.empty() and explanation.reason.empty())
)
:
(wasNotGiven = true) or explanation.reasonNotGiven.empty()
)
Search parameters for this resource. The
common parameters
also apply. See
Searching
for
more
information
about
searching
in
REST,
messaging,
and
services.
for more information about searching in REST, messaging, and services.
| Name | Type | Description | Paths |
| date | date |
|
Immunization.date |
| dose-sequence | number |
|
Immunization.vaccinationProtocol.doseSequence |
| identifier | token |
|
Immunization.identifier |
| location | reference |
|
Immunization.location
( Location ) |
| lot-number | string |
|
Immunization.lotNumber |
| manufacturer | reference |
|
Immunization.manufacturer
( Organization ) |
| notgiven | token |
|
Immunization.wasNotGiven |
| patient | reference |
|
Immunization.patient
( Patient ) |
| performer | reference |
|
Immunization.performer
( Practitioner ) |
| reaction | reference |
|
Immunization.reaction.detail
( Observation ) |
| reaction-date | date |
|
Immunization.reaction.date |
| reason | token |
|
Immunization.explanation.reason |
| reason-not-given | token |
|
Immunization.explanation.reasonNotGiven |
| requester | reference |
|
Immunization.requester
( Practitioner ) |
| status | token |
|
Immunization.status |
| vaccine-code | token |
|
Immunization.vaccineCode |
© HL7.org 2011+. FHIR STU3 Ballot (v1.6.0-9663) generated on Thu, Aug 11, 2016 17:06+1000.
QA Page
Links:
Search
|
|
Version History
|
Table of Contents
|
Compare to DSTU2
|
|
Propose
a
change
try
{
var
currentTabIndex
=
sessionStorage.getItem('fhir-resource-tab-index');
}
catch(exception){
}
if
(!currentTabIndex)
currentTabIndex
=
'0';
$(
'#tabs'
).tabs({
active:
currentTabIndex,
activate:
function(
event,
ui
)
{
var
active
=
$('.selector').tabs('option',
'active');
currentTabIndex
=
ui.newTab.index();
document.activeElement.blur();
try
{
sessionStorage.setItem('fhir-resource-tab-index',
currentTabIndex);
}
catch(exception){
}
}
});
|
Propose a change