Release
4B
5
Ballot
Medications
This
page
is
part
of
the
FHIR
Specification
(v4.3.0:
R4B
(v5.0.0-ballot:
R5
Ballot
-
STU
see
ballot
notes
).
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 | Security Category : Patient | Compartments : Patient , Practitioner |
Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.
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. While the terms "immunization" and "vaccination" are not clinically identical, for the purposes of the FHIR resources, the terms are used synonymously.
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
Public
Health
work
group
-
is
believed
to
meet
key
use
cases
and
information
requirements
as
defined
in
the
existing
HL7
v2
immunization
implementation
guide,
HL7
v3
POIZ
domain
and
Immunization
Domain
Analysis
Model.
Administration of vaccines is intended to be handled using the Immunization 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 MedicationAdministration resource to capture vaccinations for workflow or other reasons, they SHOULD also expose an equivalent Immunization instance.
While the Immunization and MedicationAdministration resources are distinct, they are both able to capture specific details of the administered product. The Immunization resource uses Immunization.vaccineCode to indicate the nature of the vaccine administered to the patient. The Immunization.administeredProduct may additionally be used to identify the specific product used (either as a coded value or as a reference to a Medication resource). The Immunization resource also contains data about the administered vaccine including the manufacturer, lot number and expiration date. However, the data elements contained within Immunization are expected to only be used when Immunization.administeredProduct does not reference a Medication resource which contains the same information about the product.
Similarly, MedicationAdministrative.medication references a Medication resource which is used to identify the administered product. Medication.marketingAuthorizationHolder, Medication.batch.lotNumber and Medication.batch.expirationDate are all analogous to the Immunization resource elements and are similarly used to capture details of the administered product.
Immunization.reaction 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.
Some workflows may require documenting that specific educational materials were presented to the patient (or other responsible party) at the time of or before the immunization event. Conveyance of this information should be accomplished using the Communication resource. This resource can be linked to an Immunization resource and indicate the timing and nature of the educational material provided. The Communication resource may be a standalone resource or may be contained within the Immunization resource as appropriate. Feedback on this approach is welcome.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
Immunization
|
TU | DomainResource |
Immunization
event
information
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
identifier
|
0..* | Identifier |
Business
identifier
|
|
basedOn
| Σ | 0..* | Reference ( CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation ) |
Authority
that
the
immunization
event
is
based
on
|
status
|
?! Σ | 1..1 | code |
completed
|
entered-in-error
|
not-done
Immunization Status Codes ( Required ) |
|
statusReason
|
0..1 | CodeableConcept |
Reason
Immunization Status Reason Codes ( Example ) |
|
|
vaccineCode
|
Σ | 1..1 | CodeableConcept |
Vaccine
Vaccine Administered Value Set ( Example ) |
|
administeredProduct
| 0..1 | CodeableReference ( Medication ) |
Product
that
was
administered
| |
|
|
|
|
|
|
|
lotNumber
|
0..1 |
|
|
|
|
expirationDate
|
|
|
date |
Vaccine
|
|
patient
|
Σ | 1..1 |
|
Who
was
immunized
|
|
encounter
|
0..1 |
|
Encounter
immunization
was
part
of
|
|
|
supportingInformation
|
|
|
|
|
occurrence[x]
|
Σ |
|
|
|
occurrenceDateTime
|
|
|
|
|
occurrenceString
|
|
|
|
|
|
primarySource
|
Σ | 0..1 |
|
|
|
informationSource
|
0..1 |
|
Immunization Origin Codes ( Example ) |
|
|
location
|
0..1 |
|
|
|
|
site
|
0..1 | CodeableConcept |
Body
site
vaccine
was
administered
Codes for Immunization Site of Administration ( Example ) |
|
|
route
|
0..1 | CodeableConcept |
How
vaccine
entered
body
Immunization Route Codes ( Example ) |
|
|
doseQuantity
|
0..1 | SimpleQuantity |
Amount
of
vaccine
administered
|
|
performer
|
Σ | 0..* | BackboneElement |
Who
performed
event
|
|
function
|
Σ | 0..1 | CodeableConcept |
What
type
of
performance
was
done
Immunization Function Codes ( Extensible ) |
|
actor
|
Σ | 1..1 | Reference ( Practitioner | PractitionerRole | Organization | Patient | RelatedPerson ) |
Individual
or
organization
who
was
performing
|
|
note
|
Σ | 0..* | Annotation |
Additional
immunization
notes
|
|
reason
|
0..* |
|
Why
immunization
occurred
Immunization Reason Codes ( Example ) |
|
|
isSubpotent
|
?! Σ | 0..1 | boolean |
Dose
potency
|
|
subpotentReason
|
0..* | CodeableConcept |
Reason
for
being
subpotent
Immunization Subpotent Reason ( Example ) |
|
|
programEligibility
|
0..* | BackboneElement |
Patient
eligibility
for
a
specific
vaccination
program
|
|
|
program
|
|
|
Vaccine Funding Programs |
|
|
|
|
CodeableConcept |
Immunization Program Eligibility ( Example ) |
|
|
fundingSource
|
0..1 | CodeableConcept |
Funding
source
for
the
vaccine
Immunization Funding Source ( Example ) |
|
|
reaction
|
0..* | BackboneElement |
Details
of
a
reaction
that
follows
immunization
|
|
|
date
|
0..1 | dateTime |
When
reaction
started
|
|
|
|
0..1 |
|
Additional
information
on
reaction
|
|
|
reported
|
0..1 | boolean |
Indicates
self-reported
reaction
|
|
protocolApplied
|
0..* | BackboneElement |
Protocol
followed
by
the
provider
|
|
series
|
0..1 | string |
Name
of
vaccine
series
|
|
|
authority
|
0..1 | Reference ( Organization ) |
Who
is
responsible
for
publishing
the
recommendations
|
|
|
targetDisease
|
0..* | CodeableConcept |
Vaccine
preventatable
disease
being
Immunization Target Disease Codes ( Example ) |
|
|
doseNumber
|
1..1 |
|
Dose
number
within
series
|
|
|
seriesDoses
|
0..1 | string |
Recommended
number
of
doses
for
immunity
|
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
UML Diagram ( Legend )
XML Template
<Immunization xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Business identifier --></identifier> <basedOn><!-- 0..* Reference(CarePlan|ImmunizationRecommendation| MedicationRequest|ServiceRequest) Authority that the immunization event is based on --></basedOn> <status value="[code]"/><!-- 1..1 completed | entered-in-error | not-done -->
<</statusReason> <</vaccineCode><statusReason><!-- 0..1 CodeableConcept Reason for current status --></statusReason> <vaccineCode><!-- 1..1 CodeableConcept Vaccine administered --></vaccineCode> <administeredProduct><!-- 0..1 CodeableReference(Medication) Product that was administered --></administeredProduct> <manufacturer><!-- 0..1 CodeableReference(Organization) Vaccine manufacturer --></manufacturer> <lotNumber value="[string]"/><!-- 0..1 Vaccine lot number --> <expirationDate value="[date]"/><!-- 0..1 Vaccine expiration date --> <patient><!-- 1..1 Reference(Patient) Who was immunized --></patient> <encounter><!-- 0..1 Reference(Encounter) Encounter immunization was part of --></encounter> <supportingInformation><!-- 0..* Reference(Any) Additional information in support of the immunization --></supportingInformation> <occurrence[x]><!-- 1..1 dateTime|string Vaccine administration date --></occurrence[x]>< < <</reportOrigin><primarySource value="[boolean]"/><!-- 0..1 Indicates context the data was captured in --> <informationSource><!-- 0..1 CodeableReference(Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) Indicates the source of a reported record --></informationSource> <location><!-- 0..1 Reference(Location) Where immunization occurred --></location><</manufacturer> < <<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> <performer> <!-- 0..* Who performed event --> <function><!-- 0..1 CodeableConcept What type of performance was done --></function><</actor><actor><!-- 1..1 Reference(Organization|Patient|Practitioner|PractitionerRole| RelatedPerson) Individual or organization who was performing --></actor> </performer> <note><!-- 0..* Annotation Additional immunization notes --></note><</reasonCode> <</reasonReference><reason><!-- 0..* CodeableReference(Condition|DiagnosticReport|Observation) Why immunization occurred --></reason> <isSubpotent value="[boolean]"/><!-- 0..1 Dose potency --> <subpotentReason><!-- 0..* CodeableConcept Reason for being subpotent --></subpotentReason>< < < < < </education> <</programEligibility><programEligibility> <!-- 0..* Patient eligibility for a specific vaccination program --> <program><!-- 1..1 CodeableConcept The program that eligibility is declared for --></program> <programStatus><!-- 1..1 CodeableConcept The patient's eligibility status for the program --></programStatus> </programEligibility> <fundingSource><!-- 0..1 CodeableConcept Funding source for the vaccine --></fundingSource> <reaction> <!-- 0..* Details of a reaction that follows immunization --> <date value="[dateTime]"/><!-- 0..1 When reaction started --><</detail><manifestation><!-- 0..1 CodeableReference(Observation) Additional information on reaction --></manifestation> <reported value="[boolean]"/><!-- 0..1 Indicates self-reported reaction --> </reaction> <protocolApplied> <!-- 0..* Protocol followed by the provider --> <series value="[string]"/><!-- 0..1 Name of vaccine series --> <authority><!-- 0..1 Reference(Organization) Who is responsible for publishing the recommendations --></authority><</targetDisease> <</doseNumber[x]> <</seriesDoses[x]><targetDisease><!-- 0..* CodeableConcept Vaccine preventatable disease being targeted --></targetDisease> <doseNumber value="[string]"/><!-- 1..1 Dose number within series --> <seriesDoses value="[string]"/><!-- 0..1 Recommended number of doses for immunity --> </protocolApplied> </Immunization>
JSON Template
{
"resourceType" : "Immunization",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business identifier
"basedOn" : [{ Reference(CarePlan|ImmunizationRecommendation|
MedicationRequest|ServiceRequest) }], // Authority that the immunization event is based on
"status" : "<code>", // R! completed | entered-in-error | not-done
"
"
"statusReason" : { CodeableConcept }, // Reason for current status
"vaccineCode" : { CodeableConcept }, // R! Vaccine administered
"administeredProduct" : { CodeableReference(Medication) }, // Product that was administered
"manufacturer" : { CodeableReference(Organization) }, // Vaccine manufacturer
"lotNumber" : "<string>", // Vaccine lot number
"expirationDate" : "<date>", // Vaccine expiration date
"patient" : { Reference(Patient) }, // R! Who was immunized
"encounter" : { Reference(Encounter) }, // Encounter immunization was part of
"supportingInformation" : [{ Reference(Any) }], // Additional information in support of the immunization
// occurrence[x]: Vaccine administration date. One of these 2:
"occurrenceDateTime" : "<dateTime>",
"occurrenceString" : "<string>",
"
"
"
"primarySource" : <boolean>, // Indicates context the data was captured in
"informationSource" : { CodeableReference(Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson) }, // Indicates the source of a reported record
"location" : { Reference(Location) }, // Where immunization occurred
"
"
"
"site" : { CodeableConcept }, // Body site vaccine was administered
"route" : { CodeableConcept }, // How vaccine entered body
"doseQuantity" : { Quantity(SimpleQuantity) }, // Amount of vaccine administered
"performer" : [{ // Who performed event
"function" : { CodeableConcept }, // What type of performance was done
"
"actor" : { Reference(Organization|Patient|Practitioner|PractitionerRole|
RelatedPerson) } // R! Individual or organization who was performing
}],
"note" : [{ Annotation }], // Additional immunization notes
"
"
"reason" : [{ CodeableReference(Condition|DiagnosticReport|Observation) }], // Why immunization occurred
"isSubpotent" : <boolean>, // Dose potency
"subpotentReason" : [{ CodeableConcept }], // Reason for being subpotent
"
"
"
"
"
"programEligibility" : [{ // Patient eligibility for a specific vaccination program
"program" : { CodeableConcept }, // R! The program that eligibility is declared for
"programStatus" : { CodeableConcept } // R! The patient's eligibility status for the program
}],
"
"fundingSource" : { CodeableConcept }, // Funding source for the vaccine
"reaction" : [{ // Details of a reaction that follows immunization
"date" : "<dateTime>", // When reaction started
"
"manifestation" : { CodeableReference(Observation) }, // Additional information on reaction
"reported" : <boolean> // Indicates self-reported reaction
}],
"protocolApplied" : [{ // Protocol followed by the provider
"series" : "<string>", // Name of vaccine series
"authority" : { Reference(Organization) }, // Who is responsible for publishing the recommendations
"
">",
">",
">"
">"
"targetDisease" : [{ CodeableConcept }], // Vaccine preventatable disease being targeted
"doseNumber" : "<string>", // R! Dose number within series
"seriesDoses" : "<string>" // Recommended number of doses for immunity
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .fhir: fhir:fhir:Immunization.statusReason [ CodeableConcept ]; # 0..1 Reason for current status fhir:Immunization.vaccineCode [ CodeableConcept ]; # 1..1 Vaccine administered fhir:Immunization.administeredProduct [ CodeableReference(Medication) ]; # 0..1 Product that was administered fhir:Immunization.manufacturer [ CodeableReference(Organization) ]; # 0..1 Vaccine manufacturer fhir:Immunization.lotNumber [ string ]; # 0..1 Vaccine lot number fhir:Immunization.expirationDate [ date ]; # 0..1 Vaccine expiration date fhir:Immunization.patient [ Reference(Patient) ]; # 1..1 Who was immunized fhir:Immunization.encounter [ Reference(Encounter) ]; # 0..1 Encounter immunization was part of fhir:Immunization.supportingInformation [ Reference(Any) ], ... ; # 0..* Additional information in support of the immunization # Immunization.occurrence[x] : 1..1 Vaccine administration date. One of these 2 fhir:Immunization.occurrenceDateTime [ dateTime ] fhir:Immunization.occurrenceString [ string ]fhir: fhir: fhir:fhir:Immunization.primarySource [ boolean ]; # 0..1 Indicates context the data was captured in fhir:Immunization.informationSource [ CodeableReference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Indicates the source of a reported record fhir:Immunization.location [ Reference(Location) ]; # 0..1 Where immunization occurredfhir: fhir: fhir:fhir:Immunization.site [ CodeableConcept ]; # 0..1 Body site vaccine was administered fhir:Immunization.route [ CodeableConcept ]; # 0..1 How vaccine entered body fhir:Immunization.doseQuantity [ Quantity(SimpleQuantity) ]; # 0..1 Amount of vaccine administered fhir:Immunization.performer [ # 0..* Who performed event fhir:Immunization.performer.function [ CodeableConcept ]; # 0..1 What type of performance was donefhir:fhir:Immunization.performer.actor [ Reference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 1..1 Individual or organization who was performing ], ...; fhir:Immunization.note [ Annotation ], ... ; # 0..* Additional immunization notesfhir: fhir:fhir:Immunization.reason [ CodeableReference(Condition|DiagnosticReport|Observation) ], ... ; # 0..* Why immunization occurred fhir:Immunization.isSubpotent [ boolean ]; # 0..1 Dose potency fhir:Immunization.subpotentReason [ CodeableConcept ], ... ; # 0..* Reason for being subpotentfhir: fhir: fhir: fhir: fhir:fhir:Immunization.programEligibility [ # 0..* Patient eligibility for a specific vaccination program fhir:Immunization.programEligibility.program [ CodeableConcept ]; # 1..1 The program that eligibility is declared for fhir:Immunization.programEligibility.programStatus [ CodeableConcept ]; # 1..1 The patient's eligibility status for the program ], ...;fhir:fhir:Immunization.fundingSource [ CodeableConcept ]; # 0..1 Funding source for the vaccine fhir:Immunization.reaction [ # 0..* Details of a reaction that follows immunization fhir:Immunization.reaction.date [ dateTime ]; # 0..1 When reaction startedfhir:fhir:Immunization.reaction.manifestation [ CodeableReference(Observation) ]; # 0..1 Additional information on reaction fhir:Immunization.reaction.reported [ boolean ]; # 0..1 Indicates self-reported reaction ], ...; fhir:Immunization.protocolApplied [ # 0..* Protocol followed by the provider fhir:Immunization.protocolApplied.series [ string ]; # 0..1 Name of vaccine series fhir:Immunization.protocolApplied.authority [ Reference(Organization) ]; # 0..1 Who is responsible for publishing the recommendationsfhir: # . One of these 2 fhir: ] fhir: ] # . One of these 2 fhir: ] fhir: ]fhir:Immunization.protocolApplied.targetDisease [ CodeableConcept ], ... ; # 0..* Vaccine preventatable disease being targeted fhir:Immunization.protocolApplied.doseNumber [ string ]; # 1..1 Dose number within series fhir:Immunization.protocolApplied.seriesDoses [ string ]; # 0..1 Recommended number of doses for immunity ], ...; ]
Changes since R4
| Immunization | |
| Immunization.basedOn |
|
| Immunization.administeredProduct |
|
| Immunization.manufacturer |
|
| Immunization.supportingInformation |
|
| Immunization.informationSource |
|
| Immunization.performer.actor |
|
| Immunization.reason |
|
| Immunization.programEligibility |
|
| Immunization.programEligibility.program |
|
| Immunization.programEligibility.programStatus |
|
| Immunization.reaction.manifestation |
|
| Immunization.protocolApplied.doseNumber |
|
| Immunization.protocolApplied.seriesDoses |
|
| Immunization.recorded |
|
| Immunization.reportOrigin |
|
| Immunization.reasonCode |
|
| Immunization.reasonReference |
|
| Immunization.education |
|
| Immunization.reaction.detail |
|
| Immunization.protocolApplied.doseNumber[x] |
|
| Immunization.protocolApplied.seriesDoses[x] |
|
See the Full Difference for further information
This analysis is available as XML or JSON .
Conversions
between
R3
and
R4
See
R3
<-->
R4
Conversion
Maps
(status
=
3
tests
that
all
execute
ok.
All
tests
pass
round-trip
testing
and
3
r3
resources
are
invalid
(0
errors).
)
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
Immunization
|
TU | DomainResource |
Immunization
event
information
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
identifier
|
0..* | Identifier |
Business
identifier
|
|
|
basedOn
| Σ | 0..* | Reference ( CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation ) |
Authority
that
the
immunization
event
is
based
on
|
|
status
|
?! Σ | 1..1 | code |
completed
|
entered-in-error
|
not-done
Immunization Status Codes ( Required ) |
|
statusReason
|
0..1 | CodeableConcept |
Reason
Immunization Status Reason Codes ( Example ) |
|
|
vaccineCode
|
Σ | 1..1 | CodeableConcept |
Vaccine
Vaccine Administered Value Set ( Example ) |
|
administeredProduct
| 0..1 | CodeableReference ( Medication ) |
Product
that
was
administered
| |
|
|
|
|
|
|
|
lotNumber
|
0..1 |
|
|
|
|
expirationDate
|
|
|
date |
Vaccine
|
|
patient
|
Σ | 1..1 |
|
Who
was
immunized
|
|
encounter
|
0..1 |
|
Encounter
immunization
was
part
of
|
|
|
supportingInformation
|
|
|
|
|
|
occurrence[x]
|
Σ |
|
|
|
|
occurrenceDateTime
|
|
|
|
|
|
occurrenceString
|
|
|
|
|
|
primarySource
|
Σ | 0..1 |
|
|
|
informationSource
|
0..1 |
|
Immunization Origin Codes ( Example ) |
|
|
location
|
0..1 |
|
|
|
|
site
|
0..1 | CodeableConcept |
Body
site
vaccine
was
administered
Codes for Immunization Site of Administration ( Example ) |
|
|
route
|
0..1 | CodeableConcept |
How
vaccine
entered
body
Immunization Route Codes ( Example ) |
|
|
doseQuantity
|
0..1 | SimpleQuantity |
Amount
of
vaccine
administered
|
|
|
performer
|
Σ | 0..* | BackboneElement |
Who
performed
event
|
|
function
|
Σ | 0..1 | CodeableConcept |
What
type
of
performance
was
done
Immunization Function Codes ( Extensible ) |
|
actor
|
Σ | 1..1 | Reference ( Practitioner | PractitionerRole | Organization | Patient | RelatedPerson ) |
Individual
or
organization
who
was
performing
|
|
note
|
Σ | 0..* | Annotation |
Additional
immunization
notes
|
|
reason
|
0..* |
|
Why
immunization
occurred
Immunization Reason Codes ( Example ) |
|
|
isSubpotent
|
?! Σ | 0..1 | boolean |
Dose
potency
|
|
subpotentReason
|
0..* | CodeableConcept |
Reason
for
being
subpotent
Immunization Subpotent Reason ( Example ) |
|
|
programEligibility
|
0..* | BackboneElement |
Patient
eligibility
for
a
specific
vaccination
program
|
|
|
program
|
|
|
Vaccine Funding Programs |
|
|
|
|
CodeableConcept |
Immunization Program Eligibility ( Example ) |
|
|
fundingSource
|
0..1 | CodeableConcept |
Funding
source
for
the
vaccine
Immunization Funding Source ( Example ) |
|
|
reaction
|
0..* | BackboneElement |
Details
of
a
reaction
that
follows
immunization
|
|
|
date
|
0..1 | dateTime |
When
reaction
started
|
|
|
|
0..1 |
|
Additional
information
on
reaction
|
|
|
reported
|
0..1 | boolean |
Indicates
self-reported
reaction
|
|
|
protocolApplied
|
0..* | BackboneElement |
Protocol
followed
by
the
provider
|
|
|
series
|
0..1 | string |
Name
of
vaccine
series
|
|
|
authority
|
0..1 | Reference ( Organization ) |
Who
is
responsible
for
publishing
the
recommendations
|
|
|
targetDisease
|
0..* | CodeableConcept |
Vaccine
preventatable
disease
being
Immunization Target Disease Codes ( Example ) |
|
|
doseNumber
|
1..1 |
|
Dose
number
within
series
|
|
|
seriesDoses
|
0..1 | string |
Recommended
number
of
doses
for
immunity
|
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
XML Template
<Immunization xmlns="http://hl7.org/fhir"><</statusReason> <</vaccineCode><statusReason><!-- 0..1 CodeableConcept Reason for current status --></statusReason> <vaccineCode><!-- 1..1 CodeableConcept Vaccine administered --></vaccineCode> <administeredProduct><!-- 0..1 CodeableReference(Medication) Product that was administered --></administeredProduct> <manufacturer><!-- 0..1 CodeableReference(Organization) Vaccine manufacturer --></manufacturer> <lotNumber value="[string]"/><!-- 0..1 Vaccine lot number --> <expirationDate value="[date]"/><!-- 0..1 Vaccine expiration date --> <patient><!-- 1..1 Reference(Patient) Who was immunized --></patient> <encounter><!-- 0..1 Reference(Encounter) Encounter immunization was part of --></encounter> <supportingInformation><!-- 0..* Reference(Any) Additional information in support of the immunization --></supportingInformation> <occurrence[x]><!-- 1..1 dateTime|string Vaccine administration date --></occurrence[x]>< < <</reportOrigin><primarySource value="[boolean]"/><!-- 0..1 Indicates context the data was captured in --> <informationSource><!-- 0..1 CodeableReference(Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) Indicates the source of a reported record --></informationSource> <location><!-- 0..1 Reference(Location) Where immunization occurred --></location><</manufacturer> < <<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> <performer> <!-- 0..* Who performed event --> <function><!-- 0..1 CodeableConcept What type of performance was done --></function><</actor><actor><!-- 1..1 Reference(Organization|Patient|Practitioner|PractitionerRole| RelatedPerson) Individual or organization who was performing --></actor> </performer> <note><!-- 0..* Annotation Additional immunization notes --></note><</reasonCode> <</reasonReference><reason><!-- 0..* CodeableReference(Condition|DiagnosticReport|Observation) Why immunization occurred --></reason> <isSubpotent value="[boolean]"/><!-- 0..1 Dose potency --> <subpotentReason><!-- 0..* CodeableConcept Reason for being subpotent --></subpotentReason>< < < < < </education> <</programEligibility><programEligibility> <!-- 0..* Patient eligibility for a specific vaccination program --> <program><!-- 1..1 CodeableConcept The program that eligibility is declared for --></program> <programStatus><!-- 1..1 CodeableConcept The patient's eligibility status for the program --></programStatus> </programEligibility> <fundingSource><!-- 0..1 CodeableConcept Funding source for the vaccine --></fundingSource> <reaction> <!-- 0..* Details of a reaction that follows immunization --> <date value="[dateTime]"/><!-- 0..1 When reaction started --><</detail><manifestation><!-- 0..1 CodeableReference(Observation) Additional information on reaction --></manifestation> <reported value="[boolean]"/><!-- 0..1 Indicates self-reported reaction --> </reaction> <protocolApplied> <!-- 0..* Protocol followed by the provider --> <series value="[string]"/><!-- 0..1 Name of vaccine series --> <authority><!-- 0..1 Reference(Organization) Who is responsible for publishing the recommendations --></authority><</targetDisease> <</doseNumber[x]> <</seriesDoses[x]><targetDisease><!-- 0..* CodeableConcept Vaccine preventatable disease being targeted --></targetDisease> <doseNumber value="[string]"/><!-- 1..1 Dose number within series --> <seriesDoses value="[string]"/><!-- 0..1 Recommended number of doses for immunity --> </protocolApplied> </Immunization>
JSON Template
{
"resourceType" : "Immunization",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business identifier
"basedOn" : [{ Reference(CarePlan|ImmunizationRecommendation|
MedicationRequest|ServiceRequest) }], // Authority that the immunization event is based on
"status" : "<code>", // R! completed | entered-in-error | not-done
"
"
"statusReason" : { CodeableConcept }, // Reason for current status
"vaccineCode" : { CodeableConcept }, // R! Vaccine administered
"administeredProduct" : { CodeableReference(Medication) }, // Product that was administered
"manufacturer" : { CodeableReference(Organization) }, // Vaccine manufacturer
"lotNumber" : "<string>", // Vaccine lot number
"expirationDate" : "<date>", // Vaccine expiration date
"patient" : { Reference(Patient) }, // R! Who was immunized
"encounter" : { Reference(Encounter) }, // Encounter immunization was part of
"supportingInformation" : [{ Reference(Any) }], // Additional information in support of the immunization
// occurrence[x]: Vaccine administration date. One of these 2:
"occurrenceDateTime" : "<dateTime>",
"occurrenceString" : "<string>",
"
"
"
"primarySource" : <boolean>, // Indicates context the data was captured in
"informationSource" : { CodeableReference(Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson) }, // Indicates the source of a reported record
"location" : { Reference(Location) }, // Where immunization occurred
"
"
"
"site" : { CodeableConcept }, // Body site vaccine was administered
"route" : { CodeableConcept }, // How vaccine entered body
"doseQuantity" : { Quantity(SimpleQuantity) }, // Amount of vaccine administered
"performer" : [{ // Who performed event
"function" : { CodeableConcept }, // What type of performance was done
"
"actor" : { Reference(Organization|Patient|Practitioner|PractitionerRole|
RelatedPerson) } // R! Individual or organization who was performing
}],
"note" : [{ Annotation }], // Additional immunization notes
"
"
"reason" : [{ CodeableReference(Condition|DiagnosticReport|Observation) }], // Why immunization occurred
"isSubpotent" : <boolean>, // Dose potency
"subpotentReason" : [{ CodeableConcept }], // Reason for being subpotent
"
"
"
"
"
"programEligibility" : [{ // Patient eligibility for a specific vaccination program
"program" : { CodeableConcept }, // R! The program that eligibility is declared for
"programStatus" : { CodeableConcept } // R! The patient's eligibility status for the program
}],
"
"fundingSource" : { CodeableConcept }, // Funding source for the vaccine
"reaction" : [{ // Details of a reaction that follows immunization
"date" : "<dateTime>", // When reaction started
"
"manifestation" : { CodeableReference(Observation) }, // Additional information on reaction
"reported" : <boolean> // Indicates self-reported reaction
}],
"protocolApplied" : [{ // Protocol followed by the provider
"series" : "<string>", // Name of vaccine series
"authority" : { Reference(Organization) }, // Who is responsible for publishing the recommendations
"
">",
">",
">"
">"
"targetDisease" : [{ CodeableConcept }], // Vaccine preventatable disease being targeted
"doseNumber" : "<string>", // R! Dose number within series
"seriesDoses" : "<string>" // Recommended number of doses for immunity
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .fhir: fhir:fhir:Immunization.statusReason [ CodeableConcept ]; # 0..1 Reason for current status fhir:Immunization.vaccineCode [ CodeableConcept ]; # 1..1 Vaccine administered fhir:Immunization.administeredProduct [ CodeableReference(Medication) ]; # 0..1 Product that was administered fhir:Immunization.manufacturer [ CodeableReference(Organization) ]; # 0..1 Vaccine manufacturer fhir:Immunization.lotNumber [ string ]; # 0..1 Vaccine lot number fhir:Immunization.expirationDate [ date ]; # 0..1 Vaccine expiration date fhir:Immunization.patient [ Reference(Patient) ]; # 1..1 Who was immunized fhir:Immunization.encounter [ Reference(Encounter) ]; # 0..1 Encounter immunization was part of fhir:Immunization.supportingInformation [ Reference(Any) ], ... ; # 0..* Additional information in support of the immunization # Immunization.occurrence[x] : 1..1 Vaccine administration date. One of these 2 fhir:Immunization.occurrenceDateTime [ dateTime ] fhir:Immunization.occurrenceString [ string ]fhir: fhir: fhir:fhir:Immunization.primarySource [ boolean ]; # 0..1 Indicates context the data was captured in fhir:Immunization.informationSource [ CodeableReference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Indicates the source of a reported record fhir:Immunization.location [ Reference(Location) ]; # 0..1 Where immunization occurredfhir: fhir: fhir:fhir:Immunization.site [ CodeableConcept ]; # 0..1 Body site vaccine was administered fhir:Immunization.route [ CodeableConcept ]; # 0..1 How vaccine entered body fhir:Immunization.doseQuantity [ Quantity(SimpleQuantity) ]; # 0..1 Amount of vaccine administered fhir:Immunization.performer [ # 0..* Who performed event fhir:Immunization.performer.function [ CodeableConcept ]; # 0..1 What type of performance was donefhir:fhir:Immunization.performer.actor [ Reference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 1..1 Individual or organization who was performing ], ...; fhir:Immunization.note [ Annotation ], ... ; # 0..* Additional immunization notesfhir: fhir:fhir:Immunization.reason [ CodeableReference(Condition|DiagnosticReport|Observation) ], ... ; # 0..* Why immunization occurred fhir:Immunization.isSubpotent [ boolean ]; # 0..1 Dose potency fhir:Immunization.subpotentReason [ CodeableConcept ], ... ; # 0..* Reason for being subpotentfhir: fhir: fhir: fhir: fhir:fhir:Immunization.programEligibility [ # 0..* Patient eligibility for a specific vaccination program fhir:Immunization.programEligibility.program [ CodeableConcept ]; # 1..1 The program that eligibility is declared for fhir:Immunization.programEligibility.programStatus [ CodeableConcept ]; # 1..1 The patient's eligibility status for the program ], ...;fhir:fhir:Immunization.fundingSource [ CodeableConcept ]; # 0..1 Funding source for the vaccine fhir:Immunization.reaction [ # 0..* Details of a reaction that follows immunization fhir:Immunization.reaction.date [ dateTime ]; # 0..1 When reaction startedfhir:fhir:Immunization.reaction.manifestation [ CodeableReference(Observation) ]; # 0..1 Additional information on reaction fhir:Immunization.reaction.reported [ boolean ]; # 0..1 Indicates self-reported reaction ], ...; fhir:Immunization.protocolApplied [ # 0..* Protocol followed by the provider fhir:Immunization.protocolApplied.series [ string ]; # 0..1 Name of vaccine series fhir:Immunization.protocolApplied.authority [ Reference(Organization) ]; # 0..1 Who is responsible for publishing the recommendationsfhir: # . One of these 2 fhir: ] fhir: ] # . One of these 2 fhir: ] fhir: ]fhir:Immunization.protocolApplied.targetDisease [ CodeableConcept ], ... ; # 0..* Vaccine preventatable disease being targeted fhir:Immunization.protocolApplied.doseNumber [ string ]; # 1..1 Dose number within series fhir:Immunization.protocolApplied.seriesDoses [ string ]; # 0..1 Recommended number of doses for immunity ], ...; ]
Changes since Release 4
| Immunization | |
| Immunization.basedOn |
|
| Immunization.administeredProduct |
|
| Immunization.manufacturer |
|
| Immunization.supportingInformation |
|
| Immunization.informationSource |
|
| Immunization.performer.actor |
|
| Immunization.reason |
|
| Immunization.programEligibility |
|
| Immunization.programEligibility.program |
|
| Immunization.programEligibility.programStatus |
|
| Immunization.reaction.manifestation |
|
| Immunization.protocolApplied.doseNumber |
|
| Immunization.protocolApplied.seriesDoses |
|
| Immunization.recorded |
|
| Immunization.reportOrigin |
|
| Immunization.reasonCode |
|
| Immunization.reasonReference |
|
| Immunization.education |
|
| Immunization.reaction.detail |
|
| Immunization.protocolApplied.doseNumber[x] |
|
| Immunization.protocolApplied.seriesDoses[x] |
|
See the Full Difference for further information
This analysis is available as XML or JSON .
Conversions
between
R3
and
R4
See
R3
<-->
R4
Conversion
Maps
(status
=
3
tests
that
all
execute
ok.
All
tests
pass
round-trip
testing
and
3
r3
resources
are
invalid
(0
errors).
)
See
the
Profiles
&
Extensions
and
the
alternate
Additional
definitions:
Master
Definition
XML
+
JSON
,
XML
Schema
/
Schematron
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
the
extensions
,
the
spreadsheet
version
&
the
dependency
analysis
| Path | Definition | Type | Reference |
|---|---|---|---|
| Immunization.status |
The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support describing the current status of the administered dose of vaccine. |
Required | ImmunizationStatusCodes |
| Immunization.statusReason |
The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support describing the reason why a dose of vaccine was not administered. This value set is provided as a suggestive example. |
Example | ImmunizationStatusReasonCodes |
| Immunization.vaccineCode |
This identifies the vaccine substance administered - CVX codes. |
Example | VaccineAdministeredValueSet |
|
|
The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support describing the source of the data when the report of the immunization event is not based on information from the person, entity or organization who administered the vaccine. This value set is provided as a suggestive example. |
Example | ImmunizationOriginCodes |
| Immunization.site |
The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support describing the body site where the vaccination occurred. This value set is provided as a suggestive example. |
Example | CodesForImmunizationSiteOfAdministration |
| Immunization.route |
The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support describing the administrative routes used during vaccination. This value set is provided as a suggestive example. |
Example | ImmunizationRouteCodes |
| Immunization.performer.function |
The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support describing the function a practitioner or organization may play in the immunization event. This value set is provided as a suggestive example. |
Extensible | ImmunizationFunctionCodes |
|
|
The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support describing the reason why a dose of vaccine was administered. This value set is provided as a suggestive example. |
Example | ImmunizationReasonCodes |
| Immunization.subpotentReason |
The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support describing the reason why a dose is considered to be subpotent. This value set is provided as a suggestive example. |
Example | ImmunizationSubpotentReason |
| Immunization.programEligibility.program |
The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support describing programs that a patient may be eligible for to cover vaccine administration costs. This value set is provided as a suggestive example. |
Example |
|
| Immunization.programEligibility.programStatus |
The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support describing the patient's eligibility for a vaccination program. This value set is provided as a suggestive example. |
Example |
|
| Immunization.fundingSource |
The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support describing the source of the vaccine administered. This value set is provided as a suggestive example. |
Example |
|
| Immunization.protocolApplied.targetDisease |
The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support describing the disease that the dose is being administered against. This value set is provided as a suggestive example and includes SNOMED CT concepts from the 64572001 (Disease) hierarchy. |
|
|
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
| date | date | Vaccination (non)-Administration Date | (Immunization.occurrence as dateTime) | |
| identifier | token | Business identifier | Immunization.identifier | |
| location | reference | The service delivery location or facility in which the vaccine was / was to be administered |
Immunization.location
( Location ) |
|
| lot-number N | string | Vaccine Lot Number | Immunization.lotNumber | |
| manufacturer | reference | Vaccine Manufacturer |
|
|
| patient | reference | The patient for the vaccination record |
Immunization.patient
( Patient ) |
|
| performer | reference |
The
|
Immunization.performer.actor
( Practitioner , Organization , Patient , PractitionerRole , RelatedPerson ) |
|
| reaction | reference | Additional information on reaction |
|
|
| reaction-date N | date | When reaction started | Immunization.reaction.date | |
| reason-code D | token | Reason why the vaccine was administered |
|
|
| reason-reference D | reference |
|
|
|
| series N | string | The series being followed by the provider | Immunization.protocolApplied.series | |
| status N | token | Immunization event status | Immunization.status | |
| status-reason | token | Reason why the vaccine was not administered | Immunization.statusReason | |
| target-disease | token | The target disease the dose is being administered against | Immunization.protocolApplied.targetDisease | |
| vaccine-code | token | Vaccine Product Administered | Immunization.vaccineCode |
FHIR
®©
HL7.org
2011+.
FHIR
Release
4B
(v4.3.0)
hl7.fhir.r4b.core#4.3.0
R5
Ballot
hl7.fhir.core#5.0.0-ballot
generated
on
Sat,
May
28,
Sep
10,
2022
12:55+1000.
05:04+1000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Glossary
|
QA
Page
|
Compare
to
R4
R4B
|
Compare
to
R5
Draft
|
|
Propose
a
change