This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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

4.14 Resource ImmunizationRecommendation - Content

A patient's point-of-time immunization status and recommendation with optional supporting justification.

4.14.1 Scope and Usage

The ImmunizationRecommendation resource is intended to cover communication of a specified patient's immunization recommendation and status across all healthcare disciplines in all care settings and all regions.

Additionally, the ImmunizationRecommendation resource is expected to cover key concepts related to the querying of a patient's immunization recommendation and status. This resource - through consultation with the PHER work group - is believed to meet key use cases and information requirements as defined in the existing HL7 v3 POIZ domain and Immunization Domain Analysis Model.

4.14.2 Boundaries and Relationships

This resource references the following resources:

One of the considerations for this resource is if it is better for this resource to be a profile of the CarePlan resource or if it is more appropriate for this to be a separate resource due to the number of immunization profile-specific data elements. Please consider this when submitting your ballot comments.

4.14.3 Resource Content

ImmunizationRecommendation (Resource)A unique identifier assigned to this particular recommendation recordidentifier : Identifier 0..*The patient who is the subject of the profilesubject : Resource(Patient) 1..1RecommendationThe date the immunization recommendation was createddate : dateTime 1..1Vaccine that pertains to the recommendationvaccineType : CodeableConcept 1..1 <<The type of vaccine administeredVaccineType>>This indicates the next recommended dose number (e.g. dose 2 is the next recommended dose)doseNumber : integer 0..1Vaccine administration statusforecastStatus : CodeableConcept 1..1 <<The patient's status with respect to a vaccination protocolImmunizationRecommendationStatus>>Immunization event history that supports the status and recommendationsupportingImmunization : Resource(Immunization) 0..*Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance informationsupportingPatientInformation : Resource(Observation|AdverseReaction| AllergyIntolerance) 0..*DateCriterionDate classification of recommendation - e.g. earliest date to give, latest date to give, etccode : CodeableConcept 1..1 <<Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.)ImmunizationRecommendationDateCriterion>>Date recommendationvalue : dateTime 1..1ProtocolIndicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocoldoseSequence : integer 0..1Contains the description about the protocol under which the vaccine was administereddescription : string 0..1Indicates the authority who published the protocol? E.g. ACIPauthority : Resource(Organization) 0..1One possible path to achieve presumed immunity against a disease - within the context of an authorityseries : string 0..1Vaccine date recommendations - e.g. earliest date to administer, latest date to administer, etcdateCriterion0..*Contains information about the protocol under which the vaccine was administeredprotocol0..1Vaccine administration recommendationsrecommendation1..*

This resource is referenced by [Procedure]

<ImmunizationRecommendation xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: extension, modifierExtension, language, text, and contained -->
 <identifier><!-- 0..* Identifier Business identifier --></identifier>
 <subject><!-- 1..1 Resource(Patient) Who this profile is for --></subject>
 <recommendation>  <!-- 1..* Vaccine administration recommendations -->
  <date value="[dateTime]"/><!-- 1..1 Date recommendation created -->
  <vaccineType><!-- 1..1 CodeableConcept Vaccine recommendation applies to --></vaccineType>
  <doseNumber value="[integer]"/><!-- 0..1 Recommended dose number -->
  <forecastStatus><!-- 1..1 CodeableConcept Vaccine administration status --></forecastStatus>
  <dateCriterion>  <!-- 0..* Dates governing proposed immunization -->
   <code><!-- 1..1 CodeableConcept Type of date --></code>
   <value value="[dateTime]"/><!-- 1..1 Recommended date -->
  </dateCriterion>
  <protocol>  <!-- 0..1 Protocol used by recommendation -->
   <doseSequence value="[integer]"/><!-- 0..1 Number of dose within sequence -->
   <description value="[string]"/><!-- 0..1 Protocol details -->
   <authority><!-- 0..1 Resource(Organization) Who is responsible for protocol --></authority>
   <series value="[string]"/><!-- 0..1 Name of vaccination series -->
  </protocol>
  <supportingImmunization><!-- 0..* Resource(Immunization) 
      Past immunizations supporting recommendation --></supportingImmunization>
  <supportingPatientInformation><!-- 0..* Resource(Observation|AdverseReaction|
    AllergyIntolerance) Patient observations supporting recommendation --></supportingPatientInformation>
 </recommendation>
</ImmunizationRecommendation>

Alternate definitions: Schema/Schematron, Resource Profile

4.14.3.1 Terminology Bindings

PathDefinitionTypeReference
ImmunizationRecommendation.recommendation.vaccineType The type of vaccine administeredExamplehttp://hl7.org/fhir/v3/vs/VaccineType
ImmunizationRecommendation.recommendation.forecastStatus The patient's status with respect to a vaccination protocolExamplehttp://hl7.org/fhir/vs/immunization-recommendation-status
ImmunizationRecommendation.recommendation.dateCriterion.code Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.)Examplehttp://hl7.org/fhir/vs/immunization-recommendation-date-criterion

4.14.4 Search Parameters

Search parameters for this resource. The standard parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPaths
_idtokenThe logical resource id associated with the resource (must be supported by all servers)
_languagetokenThe language of the resource
datedateDate recommendation createdImmunizationRecommendation.recommendation.date
dose-numbernumberRecommended dose numberImmunizationRecommendation.recommendation.doseNumber
dose-sequencetokenNumber of dose within sequenceImmunizationRecommendation.recommendation.protocol.doseSequence
identifiertokenBusiness identifierImmunizationRecommendation.identifier
informationreferencePatient observations supporting recommendationImmunizationRecommendation.recommendation.supportingPatientInformation
(AllergyIntolerance, Observation, AdverseReaction)
statustokenVaccine administration statusImmunizationRecommendation.recommendation.forecastStatus
subjectreferenceWho this profile is forImmunizationRecommendation.subject
(Patient)
supportreferencePast immunizations supporting recommendationImmunizationRecommendation.recommendation.supportingImmunization
(Immunization)
vaccine-typetokenVaccine recommendation applies toImmunizationRecommendation.recommendation.vaccineType
comments powered by Disqus