This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). 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.
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.
This resource is referenced by AdverseEvent, ChargeItem, ImmunizationEvaluation, ImmunizationRecommendation and Observation.
This resource implements the Event pattern.
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 | |
status | ?!Σ | 1..1 | code | completed | entered-in-error | not-done Immunization Status Codes (Required) |
statusReason | 0..1 | CodeableConcept | Reason for current status Immunization Status Reason Codes (Example) | |
vaccineCode | Σ | 1..1 | CodeableConcept | Vaccine product administered Vaccine Administered Value Set (Example) |
patient | Σ | 1..1 | Reference(Patient) | Who was immunized |
encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | |
occurrence[x] | Σ | 1..1 | Vaccine administration date | |
occurrenceDateTime | dateTime | |||
occurrenceString | string | |||
recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record | |
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in |
informationSource[x] | 0..1 | Indicates the source of a reported record Immunization Origin Codes (Example) | ||
informationSourceCodeableConcept | CodeableConcept | |||
informationSourceReference | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | |||
location | 0..1 | Reference(Location) | Where immunization occurred | |
manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | |
lotNumber | 0..1 | string | Vaccine lot number | |
expirationDate | 0..1 | date | Vaccine expiration date | |
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) | Individual or organization who was performing |
note | Σ | 0..* | Annotation | Additional immunization notes |
reason | 0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Why immunization occurred Immunization Reason Codes (Example) | |
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency |
subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Immunization Subpotent Reason (Example) | |
education | I | 0..* | BackboneElement | Educational material presented to patient + Rule: One of documentType or reference SHALL be present |
documentType | 0..1 | string | Educational material document identifier | |
reference | 0..1 | uri | Educational material reference pointer | |
publicationDate | 0..1 | dateTime | Educational material publication date | |
presentationDate | 0..1 | dateTime | Educational material presentation date | |
programEligibility | 0..* | CodeableConcept | Patient eligibility for a vaccination program 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 | |
detail | 0..1 | Reference(Observation) | 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 targetted Immunization Target Disease Codes (Example) | |
doseNumber | 1..1 | string | Dose number within series | |
seriesDoses | 0..1 | string | Recommended number of doses for immunity | |
Documentation for this format |
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> <status value="[code]"/><!-- 1..1 completed | entered-in-error | not-done --> <statusReason><!-- 0..1 CodeableConcept Reason for current status --></statusReason> <vaccineCode><!-- 1..1 CodeableConcept Vaccine product administered --></vaccineCode> <patient><!-- 1..1 Reference(Patient) Who was immunized --></patient> <encounter><!-- 0..1 Reference(Encounter) Encounter immunization was part of --></encounter> <occurrence[x]><!-- 1..1 dateTime|string Vaccine administration date --></occurrence[x]> <recorded value="[dateTime]"/><!-- 0..1 When the immunization was first captured in the subject's record --> <primarySource value="[boolean]"/><!-- 0..1 Indicates context the data was recorded in --> <informationSource[x]><!-- 0..1 CodeableConcept|Reference(Organization|Patient| Practitioner|PractitionerRole|RelatedPerson) Indicates the source of a reported record --></informationSource[x]> <location><!-- 0..1 Reference(Location) Where immunization occurred --></location> <manufacturer><!-- 0..1 Reference(Organization) Vaccine manufacturer --></manufacturer> <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> <performer> <!-- 0..* Who performed event --> <function><!-- 0..1 CodeableConcept What type of performance was done --></function> <actor><!-- 1..1 Reference(Organization|Practitioner|PractitionerRole) Individual or organization who was performing --></actor> </performer> <note><!-- 0..* Annotation Additional immunization notes --></note> <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> <!-- 0..* Educational material presented to patient --> <documentType value="[string]"/><!-- 0..1 Educational material document identifier --> <reference value="[uri]"/><!-- 0..1 Educational material reference pointer --> <publicationDate value="[dateTime]"/><!-- 0..1 Educational material publication date --> <presentationDate value="[dateTime]"/><!-- 0..1 Educational material presentation date --> </education> <programEligibility><!-- 0..* CodeableConcept Patient eligibility for a vaccination program --></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><!-- 0..1 Reference(Observation) Additional information on reaction --></detail> <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><!-- 0..* CodeableConcept Vaccine preventatable disease being targetted --></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 "status" : "<code>", // R! completed | entered-in-error | not-done "statusReason" : { CodeableConcept }, // Reason for current status "vaccineCode" : { CodeableConcept }, // R! Vaccine product administered "patient" : { Reference(Patient) }, // R! Who was immunized "encounter" : { Reference(Encounter) }, // Encounter immunization was part of // occurrence[x]: Vaccine administration date. One of these 2: "occurrenceDateTime" : "<dateTime>", "occurrenceString" : "<string>", "recorded" : "<dateTime>", // When the immunization was first captured in the subject's record "primarySource" : <boolean>, // Indicates context the data was recorded in // informationSource[x]: Indicates the source of a reported record. One of these 2: "informationSourceCodeableConcept" : { CodeableConcept }, "informationSourceReference" : { Reference(Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) }, "location" : { Reference(Location) }, // Where immunization occurred "manufacturer" : { Reference(Organization) }, // Vaccine manufacturer "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 "performer" : [{ // Who performed event "function" : { CodeableConcept }, // What type of performance was done "actor" : { Reference(Organization|Practitioner|PractitionerRole) } // 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 "education" : [{ // Educational material presented to patient "documentType" : "<string>", // Educational material document identifier "reference" : "<uri>", // Educational material reference pointer "publicationDate" : "<dateTime>", // Educational material publication date "presentationDate" : "<dateTime>" // Educational material presentation date }], "programEligibility" : [{ CodeableConcept }], // Patient eligibility for a vaccination program "fundingSource" : { CodeableConcept }, // Funding source for the vaccine "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 }], "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 targetted "doseNumber" : "<string>", // R! Dose number within series "seriesDoses" : "<string>" // Recommended number of doses for immunity }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:Immunization; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:Immunization.identifier [ Identifier ], ... ; # 0..* Business identifier fhir:Immunization.status [ code ]; # 1..1 completed | entered-in-error | not-done fhir:Immunization.statusReason [ CodeableConcept ]; # 0..1 Reason for current status fhir:Immunization.vaccineCode [ CodeableConcept ]; # 1..1 Vaccine product administered fhir:Immunization.patient [ Reference(Patient) ]; # 1..1 Who was immunized fhir:Immunization.encounter [ Reference(Encounter) ]; # 0..1 Encounter immunization was part of # Immunization.occurrence[x] : 1..1 Vaccine administration date. One of these 2 fhir:Immunization.occurrenceDateTime [ dateTime ] fhir:Immunization.occurrenceString [ string ] fhir:Immunization.recorded [ dateTime ]; # 0..1 When the immunization was first captured in the subject's record fhir:Immunization.primarySource [ boolean ]; # 0..1 Indicates context the data was recorded in # Immunization.informationSource[x] : 0..1 Indicates the source of a reported record. One of these 2 fhir:Immunization.informationSourceCodeableConcept [ CodeableConcept ] fhir:Immunization.informationSourceReference [ Reference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] fhir:Immunization.location [ Reference(Location) ]; # 0..1 Where immunization occurred fhir:Immunization.manufacturer [ Reference(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.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 done fhir:Immunization.performer.actor [ Reference(Organization|Practitioner|PractitionerRole) ]; # 1..1 Individual or organization who was performing ], ...; fhir:Immunization.note [ Annotation ], ... ; # 0..* Additional immunization notes 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 subpotent fhir:Immunization.education [ # 0..* Educational material presented to patient fhir:Immunization.education.documentType [ string ]; # 0..1 Educational material document identifier fhir:Immunization.education.reference [ uri ]; # 0..1 Educational material reference pointer fhir:Immunization.education.publicationDate [ dateTime ]; # 0..1 Educational material publication date fhir:Immunization.education.presentationDate [ dateTime ]; # 0..1 Educational material presentation date ], ...; fhir:Immunization.programEligibility [ CodeableConcept ], ... ; # 0..* Patient eligibility for a vaccination program 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 started fhir:Immunization.reaction.detail [ Reference(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 recommendations fhir:Immunization.protocolApplied.targetDisease [ CodeableConcept ], ... ; # 0..* Vaccine preventatable disease being targetted 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 R3
Immunization | |
Immunization.status |
|
Immunization.informationSource[x] |
|
Immunization.reason |
|
Immunization.protocolApplied.doseNumber |
|
Immunization.protocolApplied.seriesDoses |
|
Immunization.reportOrigin |
|
Immunization.reasonCode |
|
Immunization.reasonReference |
|
Immunization.protocolApplied.doseNumber[x] |
|
Immunization.protocolApplied.seriesDoses[x] |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
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 | |
status | ?!Σ | 1..1 | code | completed | entered-in-error | not-done Immunization Status Codes (Required) |
statusReason | 0..1 | CodeableConcept | Reason for current status Immunization Status Reason Codes (Example) | |
vaccineCode | Σ | 1..1 | CodeableConcept | Vaccine product administered Vaccine Administered Value Set (Example) |
patient | Σ | 1..1 | Reference(Patient) | Who was immunized |
encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | |
occurrence[x] | Σ | 1..1 | Vaccine administration date | |
occurrenceDateTime | dateTime | |||
occurrenceString | string | |||
recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record | |
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in |
informationSource[x] | 0..1 | Indicates the source of a reported record Immunization Origin Codes (Example) | ||
informationSourceCodeableConcept | CodeableConcept | |||
informationSourceReference | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | |||
location | 0..1 | Reference(Location) | Where immunization occurred | |
manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | |
lotNumber | 0..1 | string | Vaccine lot number | |
expirationDate | 0..1 | date | Vaccine expiration date | |
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) | Individual or organization who was performing |
note | Σ | 0..* | Annotation | Additional immunization notes |
reason | 0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Why immunization occurred Immunization Reason Codes (Example) | |
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency |
subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Immunization Subpotent Reason (Example) | |
education | I | 0..* | BackboneElement | Educational material presented to patient + Rule: One of documentType or reference SHALL be present |
documentType | 0..1 | string | Educational material document identifier | |
reference | 0..1 | uri | Educational material reference pointer | |
publicationDate | 0..1 | dateTime | Educational material publication date | |
presentationDate | 0..1 | dateTime | Educational material presentation date | |
programEligibility | 0..* | CodeableConcept | Patient eligibility for a vaccination program 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 | |
detail | 0..1 | Reference(Observation) | 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 targetted Immunization Target Disease Codes (Example) | |
doseNumber | 1..1 | string | Dose number within series | |
seriesDoses | 0..1 | string | Recommended number of doses for immunity | |
Documentation for this format |
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> <status value="[code]"/><!-- 1..1 completed | entered-in-error | not-done --> <statusReason><!-- 0..1 CodeableConcept Reason for current status --></statusReason> <vaccineCode><!-- 1..1 CodeableConcept Vaccine product administered --></vaccineCode> <patient><!-- 1..1 Reference(Patient) Who was immunized --></patient> <encounter><!-- 0..1 Reference(Encounter) Encounter immunization was part of --></encounter> <occurrence[x]><!-- 1..1 dateTime|string Vaccine administration date --></occurrence[x]> <recorded value="[dateTime]"/><!-- 0..1 When the immunization was first captured in the subject's record --> <primarySource value="[boolean]"/><!-- 0..1 Indicates context the data was recorded in --> <informationSource[x]><!-- 0..1 CodeableConcept|Reference(Organization|Patient| Practitioner|PractitionerRole|RelatedPerson) Indicates the source of a reported record --></informationSource[x]> <location><!-- 0..1 Reference(Location) Where immunization occurred --></location> <manufacturer><!-- 0..1 Reference(Organization) Vaccine manufacturer --></manufacturer> <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> <performer> <!-- 0..* Who performed event --> <function><!-- 0..1 CodeableConcept What type of performance was done --></function> <actor><!-- 1..1 Reference(Organization|Practitioner|PractitionerRole) Individual or organization who was performing --></actor> </performer> <note><!-- 0..* Annotation Additional immunization notes --></note> <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> <!-- 0..* Educational material presented to patient --> <documentType value="[string]"/><!-- 0..1 Educational material document identifier --> <reference value="[uri]"/><!-- 0..1 Educational material reference pointer --> <publicationDate value="[dateTime]"/><!-- 0..1 Educational material publication date --> <presentationDate value="[dateTime]"/><!-- 0..1 Educational material presentation date --> </education> <programEligibility><!-- 0..* CodeableConcept Patient eligibility for a vaccination program --></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><!-- 0..1 Reference(Observation) Additional information on reaction --></detail> <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><!-- 0..* CodeableConcept Vaccine preventatable disease being targetted --></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 "status" : "<code>", // R! completed | entered-in-error | not-done "statusReason" : { CodeableConcept }, // Reason for current status "vaccineCode" : { CodeableConcept }, // R! Vaccine product administered "patient" : { Reference(Patient) }, // R! Who was immunized "encounter" : { Reference(Encounter) }, // Encounter immunization was part of // occurrence[x]: Vaccine administration date. One of these 2: "occurrenceDateTime" : "<dateTime>", "occurrenceString" : "<string>", "recorded" : "<dateTime>", // When the immunization was first captured in the subject's record "primarySource" : <boolean>, // Indicates context the data was recorded in // informationSource[x]: Indicates the source of a reported record. One of these 2: "informationSourceCodeableConcept" : { CodeableConcept }, "informationSourceReference" : { Reference(Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) }, "location" : { Reference(Location) }, // Where immunization occurred "manufacturer" : { Reference(Organization) }, // Vaccine manufacturer "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 "performer" : [{ // Who performed event "function" : { CodeableConcept }, // What type of performance was done "actor" : { Reference(Organization|Practitioner|PractitionerRole) } // 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 "education" : [{ // Educational material presented to patient "documentType" : "<string>", // Educational material document identifier "reference" : "<uri>", // Educational material reference pointer "publicationDate" : "<dateTime>", // Educational material publication date "presentationDate" : "<dateTime>" // Educational material presentation date }], "programEligibility" : [{ CodeableConcept }], // Patient eligibility for a vaccination program "fundingSource" : { CodeableConcept }, // Funding source for the vaccine "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 }], "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 targetted "doseNumber" : "<string>", // R! Dose number within series "seriesDoses" : "<string>" // Recommended number of doses for immunity }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:Immunization; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:Immunization.identifier [ Identifier ], ... ; # 0..* Business identifier fhir:Immunization.status [ code ]; # 1..1 completed | entered-in-error | not-done fhir:Immunization.statusReason [ CodeableConcept ]; # 0..1 Reason for current status fhir:Immunization.vaccineCode [ CodeableConcept ]; # 1..1 Vaccine product administered fhir:Immunization.patient [ Reference(Patient) ]; # 1..1 Who was immunized fhir:Immunization.encounter [ Reference(Encounter) ]; # 0..1 Encounter immunization was part of # Immunization.occurrence[x] : 1..1 Vaccine administration date. One of these 2 fhir:Immunization.occurrenceDateTime [ dateTime ] fhir:Immunization.occurrenceString [ string ] fhir:Immunization.recorded [ dateTime ]; # 0..1 When the immunization was first captured in the subject's record fhir:Immunization.primarySource [ boolean ]; # 0..1 Indicates context the data was recorded in # Immunization.informationSource[x] : 0..1 Indicates the source of a reported record. One of these 2 fhir:Immunization.informationSourceCodeableConcept [ CodeableConcept ] fhir:Immunization.informationSourceReference [ Reference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] fhir:Immunization.location [ Reference(Location) ]; # 0..1 Where immunization occurred fhir:Immunization.manufacturer [ Reference(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.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 done fhir:Immunization.performer.actor [ Reference(Organization|Practitioner|PractitionerRole) ]; # 1..1 Individual or organization who was performing ], ...; fhir:Immunization.note [ Annotation ], ... ; # 0..* Additional immunization notes 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 subpotent fhir:Immunization.education [ # 0..* Educational material presented to patient fhir:Immunization.education.documentType [ string ]; # 0..1 Educational material document identifier fhir:Immunization.education.reference [ uri ]; # 0..1 Educational material reference pointer fhir:Immunization.education.publicationDate [ dateTime ]; # 0..1 Educational material publication date fhir:Immunization.education.presentationDate [ dateTime ]; # 0..1 Educational material presentation date ], ...; fhir:Immunization.programEligibility [ CodeableConcept ], ... ; # 0..* Patient eligibility for a vaccination program 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 started fhir:Immunization.reaction.detail [ Reference(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 recommendations fhir:Immunization.protocolApplied.targetDisease [ CodeableConcept ], ... ; # 0..* Vaccine preventatable disease being targetted 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 3
Immunization | |
Immunization.status |
|
Immunization.informationSource[x] |
|
Immunization.reason |
|
Immunization.protocolApplied.doseNumber |
|
Immunization.protocolApplied.seriesDoses |
|
Immunization.reportOrigin |
|
Immunization.reasonCode |
|
Immunization.reasonReference |
|
Immunization.protocolApplied.doseNumber[x] |
|
Immunization.protocolApplied.seriesDoses[x] |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
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 definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis a
Path | Definition | Type | Reference |
---|---|---|---|
Immunization.status | A set of codes indicating the current status of an Immunization. | Required | ImmunizationStatusCodes |
Immunization.statusReason | The reason why a vaccine was not administered. | Example | ImmunizationStatusReasonCodes |
Immunization.vaccineCode | The code for vaccine product administered. | Example | VaccineAdministeredValueSet |
Immunization.informationSource[x] | The source of the data for a record which is not from a primary source. | Example | ImmunizationOriginCodes |
Immunization.site | The site at which the vaccine was administered. | Example | CodesForImmunizationSiteOfAdministration |
Immunization.route | The route by which the vaccine was administered. | Example | ImmunizationRouteCodes |
Immunization.performer.function | The role a practitioner or organization plays in the immunization event. | Extensible | ImmunizationFunctionCodes |
Immunization.reason | The reason why a vaccine was administered. | Example | ImmunizationReasonCodes |
Immunization.subpotentReason | The reason why a dose is considered to be subpotent. | Example | ImmunizationSubpotentReason |
Immunization.programEligibility | The patient's eligibility for a vaccation program. | Example | ImmunizationProgramEligibility |
Immunization.fundingSource | The source of funding used to purchase the vaccine administered. | Example | ImmunizationFundingSource |
Immunization.protocolApplied.targetDisease | The vaccine preventable disease the dose is being administered for. | Example | ImmunizationTargetDiseaseCodes |
id | Level | Location | Description | Expression |
imm-1 | Rule | Immunization.education | One of documentType or reference SHALL be present | documentType.exists() or reference.exists() |
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) | 17 Resources |
identifier | token | Business identifier | Immunization.identifier | 30 Resources |
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 | Immunization.manufacturer (Organization) | |
patient | reference | The patient for the vaccination record | Immunization.patient (Patient) | 33 Resources |
performer | reference | The practitioner or organization who played a role in the vaccination | Immunization.performer.actor (Practitioner, Organization, PractitionerRole) | |
reaction | reference | Additional information on reaction | Immunization.reaction.detail (Observation) | |
reaction-date N | date | When reaction started | Immunization.reaction.date | |
reason-code D | token | Reason why the vaccine was administered | Immunization.reason.concept | |
reason-reference D | reference | Reference to a resource (by instance) | Immunization.reason.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 |