Immunization Incubator Implementation Guide
0.1.0 - International flag

Immunization Incubator Implementation Guide, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/immunization-incubator/ and changes regularly. See the Directory of published versions

Resource: Immunization Recommendation

Official URL: http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation Version: 0.1.0
Standards status: Trial-use Draft as of 2021-01-02 Maturity Level: 1 Computable Name: ImmunizationRecommendation
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1232

A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.

Scope and Usage

The ImmunizationRecommendation resource is intended to cover the expression of a customized set of immunization recommendations and status for a specific individual with the ultimate goal of achieving long-lasting immunity in the individual. This can include recommending future doses to progress the individual along the path to immunity and/or indicating that vaccination is not needed (e.g., the individual has completed the recommended set of doses and has presumed immunity, a contraindication or other condition would render further doses inadvisable, an acquired immunity negates the need for additional doses, the patient has aged out of a series). Where the individual is not yet fully protected, recommendations may be used to initiate clinical activity such as the ordering and administration of a vaccine. These recommendations may be used for non-clinical purposes such as presentation of vaccination credentials, satisfaction of school enrollment requirements or public health purposes. While not explicitly expressed in the resource itself, the "intent" of an ImmunizationRecommendation resource is always considered to be "proposal".

An individual recommendation in the ImmunizationRecommendation resource will often relate to the recommendation of a specific dose of vaccine. The base ImmunizationRecommendation is silent on the time frame for the recommended administration date for a recommendation contained in the resource. That is, it is a system decision about how far in advance (1 day, 1 week, 6 weeks, 6 months, etc) of the recommendation administration date a recommendation is made. A recommendation may also be used to indicate that additional doses are not needed for some reason (such as the series is complete, the patient has aged out of the series, the patient is immune through some other mechanism or additional doses are contraindicated). This functionality may be important to convey to end users that they should not take action.

The display of immunization recommendations to end users is the responsibility of the system using the data contained in the ImmunizationRecommendation resource. Use case specific Implementation Guides can define specific display or usage expectations (if any) of systems using the recommendations contained in the resource.

Boundaries and Relationships

An ImmunizationRecommendation resource may reference the relevant Immunization and ImmunizationEvaluation resources that underly the recommendation. Additional resources may be referenced where they document other factors (such as underlying medical conditions, behaviors, etc) which impact the recommendation.

The recommendations contained within an ImmunizationRecommendation resource may be used to initiate a set of clinical activities leading to the administration and documentation of one or more doses of vaccine. Where a record of an order to administer a vaccine is required, the MedicationRequest resource is used. The value of MedicationRequest.intent is used to distinguish between a plan to vaccinate and an authorized order. MedicationRequest.basedOn may be used to link the order to the initiating ImmunizationRecommendation. The documentation of the administration of the vaccine should be accomplished through the use of the Immunization resource.

Note that the ImmunizationRecommendation resource allows the inclusion of multiple recommendations in a single instance of the resource. Where the output of the evaluation process results in only a single recommendation, the use of MedicationRequest where .intent is valued "proposal" is allowed as an alternative to the ImmunizationRecommendation resource if it simplifies the subsequent clinical workflow.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Resource Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* DomainResource Guidance or advice relating to an immunization

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ 0..* Identifier Business identifier
... patient Σ 1..1 Reference(Patient) Who this profile is for
... date Σ 1..1 dateTime Date recommendation(s) created
... recommendation ΣC 1..* BackboneElement Vaccine administration recommendations
Constraints: imr-1
.... vaccineCode ΣC 0..* CodeableConcept Vaccine or vaccine group recommendation applies to
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
.... targetDisease ΣC 0..* CodeableConcept Disease to be immunized against
Binding: ImmunizationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.
.... contraindicatedVaccineCode Σ 0..* CodeableConcept Vaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
.... forecastStatus ?!Σ 1..1 CodeableConcept Vaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.
.... forecastReason Σ 0..* CodeableConcept Vaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.
.... dateCriterion 0..* BackboneElement Dates governing proposed immunization
..... code 1..1 CodeableConcept Type of date
Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).
..... value 1..1 dateTime Recommended date
.... description 0..1 markdown Protocol details
.... series 0..1 string Name of vaccination series
.... doseNumber Σ 0..1 CodeableConcept Recommended dose number within series
Binding Description: (example): A code expressing the vaccine dose number - several coding schemes exist or will be defined for each jurisdiction.
.... seriesDoses 0..1 CodeableConcept Recommended number of doses for immunity
Binding Description: (example): A code expressing the doses recommended or expected - several coding schemes exist or will be defined for each jurisdiction.
.... supportingImmunization 0..* Reference(Immunization | Immunization Evaluation) Past immunizations supporting recommendation
.... supportingPatientInformation 0..* Reference(Resource) Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ImmunizationRecommendation.​recommendation.vaccineCode Base example Vaccine Administered Value Set 📦6.0.0-ballot3 FHIR Std.
ImmunizationRecommendation.​recommendation.targetDisease Base example Immunization Target Disease Codes 📦6.0.0-ballot3 FHIR Std.
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode Base example Vaccine Administered Value Set 📦6.0.0-ballot3 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization Recommendation Status Codes 📦6.0.0-ballot3 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastReason Base example Immunization Recommendation Reason Codes 📦6.0.0-ballot3 FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion.​code Base example Immunization Recommendation Date Criterion Codes 📦6.0.0-ballot3 FHIR Std.
ImmunizationRecommendation.​recommendation.doseNumber Base example Not State Unknown
ImmunizationRecommendation.​recommendation.seriesDoses Base example Not State Unknown

Constraints

Id Grade Path(s) Description Expression
imr-1 error ImmunizationRecommendation.recommendation One of vaccineCode or targetDisease SHALL be present vaccineCode.exists() or targetDisease.exists()
<ImmunizationRecommendation xmlns="http://hl7.org/fhir"> doco
 <id value="[id]"/><!-- 0..1 * Logical id of this artifact  -->
 <meta><!-- I 0..1 * Metadata about the resource  --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 * A set of rules under which this content was created  -->
 <language value="[code]"/><!-- I 0..1 * Language of the resource content  -->
 <text><!-- I 0..1 * Text summary of the resource, for human interpretation  --></text>
 <contained><!-- 0..* * Contained, inline Resources  --></contained>
 <extension><!-- See Extensions  Additional content defined by implementations  --></extension>
 <modifierExtension><!-- I 0..* * Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- 0..* * Business identifier  --></identifier>
 <patient><!-- 1..1 * Who this profile is for  --></patient>
 <date value="[dateTime]"/><!-- 1..1 * Date recommendation(s) created  -->
 <authority><!-- 0..1 * Who is responsible for schedule  --></authority>
 <recommendation> I 1..* *  <!-- I 1..* Vaccine administration recommendations -->
  <id value="[id]"/><!-- 0..1 * Unique id for inter-element referencing   -->
  <extension><!-- See Extensions  Additional content defined by implementations   --></extension>
  <modifierExtension><!-- I 0..* * Extensions that cannot be ignored even if unrecognized   --></modifierExtension>
  <vaccineCode><!-- 0..* * Vaccine  or vaccine group recommendation applies to   --></vaccineCode>
  <targetDisease><!-- 0..* * Disease to be immunized against   --></targetDisease>
  <contraindicatedVaccineCode><!-- 0..* * Vaccine which is contraindicated to fulfill the recommendation   --></contraindicatedVaccineCode>
  <forecastStatus><!-- 1..1 * Vaccine recommendation status   --></forecastStatus>
  <forecastReason><!-- 0..* * Vaccine administration status reason   --></forecastReason>
  <dateCriterion> I 0..* *  <!-- I 0..* Dates governing proposed immunization -->
   <id value="[id]"/><!-- 0..1 * Unique id for inter-element referencing    -->
   <extension><!-- See Extensions  Additional content defined by implementations    --></extension>
   <modifierExtension><!-- I 0..* * Extensions that cannot be ignored even if unrecognized    --></modifierExtension>
   <code><!-- 1..1 * Type of date    --></code>
   <value value="[dateTime]"/><!-- 1..1 * Recommended date    -->
  </dateCriterion>
  <description value="[markdown]"/><!-- 0..1 * Protocol details   -->
  <series value="[string]"/><!-- 0..1 * Name of vaccination series   -->
  <doseNumber><!-- 0..1 * Recommended dose number within series   --></doseNumber>
  <seriesDoses><!-- 0..1 * Recommended number of doses for immunity   --></seriesDoses>
  <supportingImmunization><!-- 0..* * Past immunizations supporting recommendation   --></supportingImmunization>
  <supportingPatientInformation><!-- 0..* * Patient observations supporting recommendation   --></supportingPatientInformation>
 </recommendation>
</ImmunizationRecommendation>

{doco
  "resourceType" : "ImmunizationRecommendation",
  "id" : "<id>", // 0..1 Logical id of this artifact
  "meta" : { Meta }, // I 0..1 Metadata about the resource
  "implicitRules" : "<uri>", // I 0..1 A set of rules under which this content was created
  "language" : "<code>", // I 0..1 Language of the resource content
  "text" : { Narrative }, // I 0..1 Text summary of the resource, for human interpretation
  "contained" : [{ Resource }], // 0..* Contained, inline Resources
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
  "identifier" : [{ Identifier }], // 0..* Business identifier
  "patient" : { Reference(Patient) }, // 1..1 Who this profile is for
  "date" : "<dateTime>", // 1..1 Date recommendation(s) created
  "authority" : { Reference(Organization) }, // 0..1 Who is responsible for schedule
  "recommendation" : [{ BackboneElement }] // I 1..* Vaccine administration recommendations
    "id" : "<id>", // 0..1 Unique id for inter-element referencing
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
    "vaccineCode" : [{ CodeableConcept }], // 0..* Vaccine  or vaccine group recommendation applies to
    "targetDisease" : [{ CodeableConcept }], // 0..* Disease to be immunized against
    "contraindicatedVaccineCode" : [{ CodeableConcept }], // 0..* Vaccine which is contraindicated to fulfill the recommendation
    "forecastStatus" : { CodeableConcept }, // 1..1 Vaccine recommendation status
    "forecastReason" : [{ CodeableConcept }], // 0..* Vaccine administration status reason
    "dateCriterion" : [{ BackboneElement }], // I 0..* Dates governing proposed immunization
      "id" : "<id>", // 0..1 Unique id for inter-element referencing
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
      "code" : { CodeableConcept }, // 1..1 Type of date
      "value" : "<dateTime>" // 1..1 Recommended date
    }
    "description" : "<markdown>", // 0..1 Protocol details
    "series" : "<string>", // 0..1 Name of vaccination series
    "doseNumber" : { CodeableConcept }, // 0..1 Recommended dose number within series
    "seriesDoses" : { CodeableConcept }, // 0..1 Recommended number of doses for immunity
    "supportingImmunization" : [{ Reference(Immunization|ImmunizationEvaluation) }], // 0..* Past immunizations supporting recommendation
    "supportingPatientInformation" : [{ Reference(Resource) }] // 0..* Patient observations supporting recommendation
  }
}

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ImmunizationRecommendation;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  fhir:id [ id ] ; # 0..1 Logical id of this artifact
  fhir:meta [ Meta ] ; # 0..1 I Metadata about the resource
  fhir:implicitRules [ uri ] ; # 0..1 I A set of rules under which this content was created
  fhir:language [ code ] ; # 0..1 I Language of the resource content
  fhir:text [ Narrative ] ; # 0..1 I Text summary of the resource, for human interpretation
  fhir:contained  ( [ Resource ] ... ) ; # 0..* Contained, inline Resources
  fhir:extension  ( [ Extension ] ... ) ; # 0..* I Additional content defined by implementations
  fhir:modifierExtension  ( [ Extension ] ... ) ; # 0..* I Extensions that cannot be ignored
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business identifier
  fhir:patient [ Reference(Patient) ] ; # 1..1 Who this profile is for
  fhir:date [ dateTime ] ; # 1..1 Date recommendation(s) created
  fhir:authority [ Reference(Organization) ] ; # 0..1 Who is responsible for schedule
  fhir:recommendation  ( [ BackboneElement ] ... ) ; # 1..* I Vaccine administration recommendations
]

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* DomainResource Guidance or advice relating to an immunization

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ 0..* Identifier Business identifier
... patient Σ 1..1 Reference(Patient) Who this profile is for
... date Σ 1..1 dateTime Date recommendation(s) created
... recommendation ΣC 1..* BackboneElement Vaccine administration recommendations
Constraints: imr-1
.... vaccineCode ΣC 0..* CodeableConcept Vaccine or vaccine group recommendation applies to
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
.... targetDisease ΣC 0..* CodeableConcept Disease to be immunized against
Binding: ImmunizationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.
.... contraindicatedVaccineCode Σ 0..* CodeableConcept Vaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
.... forecastStatus ?!Σ 1..1 CodeableConcept Vaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.
.... forecastReason Σ 0..* CodeableConcept Vaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.
.... dateCriterion 0..* BackboneElement Dates governing proposed immunization
..... code 1..1 CodeableConcept Type of date
Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).
..... value 1..1 dateTime Recommended date
.... description 0..1 markdown Protocol details
.... series 0..1 string Name of vaccination series
.... doseNumber Σ 0..1 CodeableConcept Recommended dose number within series
Binding Description: (example): A code expressing the vaccine dose number - several coding schemes exist or will be defined for each jurisdiction.
.... seriesDoses 0..1 CodeableConcept Recommended number of doses for immunity
Binding Description: (example): A code expressing the doses recommended or expected - several coding schemes exist or will be defined for each jurisdiction.
.... supportingImmunization 0..* Reference(Immunization | Immunization Evaluation) Past immunizations supporting recommendation
.... supportingPatientInformation 0..* Reference(Resource) Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ImmunizationRecommendation.​recommendation.vaccineCode Base example Vaccine Administered Value Set 📦6.0.0-ballot3 FHIR Std.
ImmunizationRecommendation.​recommendation.targetDisease Base example Immunization Target Disease Codes 📦6.0.0-ballot3 FHIR Std.
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode Base example Vaccine Administered Value Set 📦6.0.0-ballot3 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization Recommendation Status Codes 📦6.0.0-ballot3 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastReason Base example Immunization Recommendation Reason Codes 📦6.0.0-ballot3 FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion.​code Base example Immunization Recommendation Date Criterion Codes 📦6.0.0-ballot3 FHIR Std.
ImmunizationRecommendation.​recommendation.doseNumber Base example Not State Unknown
ImmunizationRecommendation.​recommendation.seriesDoses Base example Not State Unknown

Constraints

Id Grade Path(s) Description Expression
imr-1 error ImmunizationRecommendation.recommendation One of vaccineCode or targetDisease SHALL be present vaccineCode.exists() or targetDisease.exists()

 

Other representations of resource: CSV, Excel

Notes:

Name Type Description Expression
date date

Date recommendation(s) created

ImmunizationRecommendation.date
identifier token

Business identifier

ImmunizationRecommendation.identifier
information reference

Patient observations supporting recommendation

ImmunizationRecommendation.recommendation.supportingPatientInformation
patient reference

Who this profile is for

ImmunizationRecommendation.patient
status token

Vaccine recommendation status

ImmunizationRecommendation.recommendation.forecastStatus
support reference

Past immunizations supporting recommendation

ImmunizationRecommendation.recommendation.supportingImmunization
target-disease token

Disease to be immunized against

ImmunizationRecommendation.recommendation.targetDisease
vaccine-type token

Vaccine or vaccine group recommendation applies to

ImmunizationRecommendation.recommendation.vaccineCode