Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

11.9 Resource ImmunizationRecommendation - Content

Public Health and Emergency Response icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Patient Compartments: Patient

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

The ImmunizationRecommendation resource is intended to cover communication of a specified patient's immunization recommendations and status across all healthcare disciplines in all care settings and all regions. The set of customized (for the patient) recommendations is based on the comparison of the patient's immunization history with a set of published recommendations (protocols).

Additionally, the ImmunizationRecommendation resource is expected to cover key concepts related to the querying of a patient's immunization recommendations and status. 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 v3 icon POIZ domain and Immunization Domain Analysis Model.

This resource references the following resources:

  • Patient
  • Organization
  • Immunization
  • ImmunizationEvaluation

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation TUDomainResourceGuidance or advice relating to an immunization

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierBusiness identifier

... patient Σ1..1Reference(Patient)Who this profile is for
... date Σ1..1dateTimeDate recommendation(s) created
... recommendation ΣC1..*BackboneElementVaccine administration recommendations
+ Rule: One of vaccineCode or targetDisease SHALL be present

.... vaccineCode ΣC0..*CodeableConceptVaccine or vaccine group recommendation applies to
Binding: Vaccine Administered Value Set (Example)

.... targetDisease ΣC0..*CodeableConceptDisease to be immunized against
Binding: Immunization Target Disease Codes (Example)

.... contraindicatedVaccineCode Σ0..*CodeableConceptVaccine which is contraindicated to fulfill the recommendation
Binding: Vaccine Administered Value Set (Example)

.... forecastStatus ?!Σ1..1CodeableConceptVaccine recommendation status
Binding: Immunization Recommendation Status Codes (Example)
.... forecastReason Σ0..*CodeableConceptVaccine administration status reason
Binding: Immunization Recommendation Reason Codes (Example)

.... dateCriterion 0..*BackboneElementDates governing proposed immunization

..... code 1..1CodeableConceptType of date
Binding: Immunization Recommendation Date Criterion Codes (Example)
..... value 1..1dateTimeRecommended date
.... description 0..1markdownProtocol details
.... series 0..1stringName of vaccination series
.... doseNumber Σ0..1stringRecommended dose number within series
.... seriesDoses 0..1stringRecommended number of doses for immunity
.... supportingImmunization 0..*Reference(Immunization | ImmunizationEvaluation)Past immunizations supporting recommendation

.... supportingPatientInformation 0..*Reference(Any)Patient observations supporting recommendation


doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

ImmunizationRecommendation (DomainResource)A unique identifier assigned to this particular recommendation recordidentifier : Identifier [0..*]The patient the recommendation(s) are forpatient : Reference [1..1] « Patient »The date the immunization recommendation(s) were createddate : dateTime [1..1]Indicates the authority who published the protocol (e.g. ACIP)authority : Reference [0..1] « Organization »RecommendationVaccine(s) or vaccine group that pertain to the recommendationvaccineCode : CodeableConcept [0..*] « null (Strength=Example)VaccineAdministeredValueSet?? » « This element has or is affected by some invariantsC »The targeted disease for the recommendationtargetDisease : CodeableConcept [0..*] « null (Strength=Example) ImmunizationTargetDiseaseCodes?? » « This element has or is affected by some invariantsC »Vaccine(s) which should not be used to fulfill the recommendationcontraindicatedVaccineCode : CodeableConcept [0..*] « null (Strength=Example) VaccineAdministeredValueSet?? »Indicates the patient status with respect to the path to immunity for the target disease (this element modifies the meaning of other elements)forecastStatus : CodeableConcept [1..1] « null (Strength=Example) ImmunizationRecommendationSta...?? »The reason for the assigned forecast statusforecastReason : CodeableConcept [0..*] « null (Strength=Example) ImmunizationRecommendationRea...?? »Contains the description about the protocol under which the vaccine was administereddescription : markdown [0..1]One possible path to achieve presumed immunity against a disease - within the context of an authorityseries : string [0..1]Nominal position of the recommended dose in a series as determined by the evaluation and forecasting process (e.g. dose 2 is the next recommended dose)doseNumber : string [0..1]The recommended number of doses to achieve immunity as determined by the evaluation and forecasting processseriesDoses : string [0..1]Immunization event history and/or evaluation that supports the status and recommendationsupportingImmunization : Reference [0..*] « Immunization| ImmunizationEvaluation »Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance informationsupportingPatientInformation : Reference [0..*] « Any »DateCriterionDate classification of recommendation. For example, earliest date to give, latest date to give, etccode : CodeableConcept [1..1] « null (Strength=Example)ImmunizationRecommendationDat...?? »The date whose meaning is specified by dateCriterion.codevalue : dateTime [1..1]Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etcdateCriterion[0..*]Vaccine administration recommendationsrecommendation[1..*]

XML Template

<ImmunizationRecommendation xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business identifier --></identifier>
 <patient><!-- 1..1 Reference(Patient) Who this profile is for --></patient>
 <date value="[dateTime]"/><!-- 1..1 Date recommendation(s) created -->
 <authority><!-- 0..1 Reference(Organization) Who is responsible for protocol --></authority>
 <recommendation>  <!-- 1..* Vaccine administration recommendations -->
  <vaccineCode><!-- I 0..* CodeableConcept Vaccine  or vaccine group recommendation applies to --></vaccineCode>
  <targetDisease><!-- I 0..* CodeableConcept Disease to be immunized against --></targetDisease>
  <contraindicatedVaccineCode><!-- 0..* CodeableConcept Vaccine which is contraindicated to fulfill the recommendation --></contraindicatedVaccineCode>
  <forecastStatus><!-- 1..1 CodeableConcept Vaccine recommendation status --></forecastStatus>
  <forecastReason><!-- 0..* CodeableConcept Vaccine administration status reason --></forecastReason>
  <dateCriterion>  <!-- 0..* Dates governing proposed immunization -->
   <code><!-- 1..1 CodeableConcept 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 value="[string]"/><!-- 0..1 Recommended dose number within series -->
  <seriesDoses value="[string]"/><!-- 0..1 Recommended number of doses for immunity -->
  <supportingImmunization><!-- 0..* Reference(Immunization|ImmunizationEvaluation) Past immunizations supporting recommendation --></supportingImmunization>
  <supportingPatientInformation><!-- 0..* Reference(Any) Patient observations supporting recommendation --></supportingPatientInformation>
 </recommendation>
</ImmunizationRecommendation>

JSON Template

{doco
  "resourceType" : "ImmunizationRecommendation",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifier
  "patient" : { Reference(Patient) }, // R!  Who this profile is for
  "date" : "<dateTime>", // R!  Date recommendation(s) created
  "authority" : { Reference(Organization) }, // Who is responsible for protocol
  "recommendation" : [{ // R!  Vaccine administration recommendations
    "vaccineCode" : [{ CodeableConcept }], // I Vaccine  or vaccine group recommendation applies to
    "targetDisease" : [{ CodeableConcept }], // I Disease to be immunized against
    "contraindicatedVaccineCode" : [{ CodeableConcept }], // Vaccine which is contraindicated to fulfill the recommendation
    "forecastStatus" : { CodeableConcept }, // R!  Vaccine recommendation status
    "forecastReason" : [{ CodeableConcept }], // Vaccine administration status reason
    "dateCriterion" : [{ // Dates governing proposed immunization
      "code" : { CodeableConcept }, // R!  Type of date
      "value" : "<dateTime>" // R!  Recommended date
    }],
    "description" : "<markdown>", // Protocol details
    "series" : "<string>", // Name of vaccination series
    "doseNumber" : "<string>", // Recommended dose number within series
    "seriesDoses" : "<string>", // Recommended number of doses for immunity
    "supportingImmunization" : [{ Reference(Immunization|ImmunizationEvaluation) }], // Past immunizations supporting recommendation
    "supportingPatientInformation" : [{ Reference(Any) }] // Patient observations supporting recommendation
  }]
}

Turtle Template

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


[ a fhir:ImmunizationRecommendation;
  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: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 protocol
  fhir:recommendation ( [ # 1..* Vaccine administration recommendations
    fhir:vaccineCode  ( [ CodeableConcept ] ... ) ; # 0..* I Vaccine  or vaccine group recommendation applies to
    fhir:targetDisease  ( [ CodeableConcept ] ... ) ; # 0..* I Disease to be immunized against
    fhir:contraindicatedVaccineCode  ( [ CodeableConcept ] ... ) ; # 0..* Vaccine which is contraindicated to fulfill the recommendation
    fhir:forecastStatus [ CodeableConcept ] ; # 1..1 Vaccine recommendation status
    fhir:forecastReason  ( [ CodeableConcept ] ... ) ; # 0..* Vaccine administration status reason
    fhir:dateCriterion ( [ # 0..* Dates governing proposed immunization
      fhir:code [ CodeableConcept ] ; # 1..1 Type of date
      fhir:value [ dateTime ] ; # 1..1 Recommended date
    ] ... ) ;
    fhir:description [ markdown ] ; # 0..1 Protocol details
    fhir:series [ string ] ; # 0..1 Name of vaccination series
    fhir:doseNumber [ string ] ; # 0..1 Recommended dose number within series
    fhir:seriesDoses [ string ] ; # 0..1 Recommended number of doses for immunity
    fhir:supportingImmunization  ( [ Reference(Immunization|ImmunizationEvaluation) ] ... ) ; # 0..* Past immunizations supporting recommendation
    fhir:supportingPatientInformation  ( [ Reference(Any) ] ... ) ; # 0..* Patient observations supporting recommendation
  ] ... ) ;
]

Changes from both R4 and R4B

ImmunizationRecommendation
ImmunizationRecommendation.recommendation.targetDisease
  • Max Cardinality changed from 1 to *
ImmunizationRecommendation.recommendation.description
  • Type changed from string to markdown
ImmunizationRecommendation.recommendation.doseNumber
  • Renamed from doseNumber[x] to doseNumber
  • Remove Type positiveInt
ImmunizationRecommendation.recommendation.seriesDoses
  • Renamed from seriesDoses[x] to seriesDoses
  • Remove Type positiveInt

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

See R4 <--> R5 Conversion Maps (status = See Conversions Summary.)

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation TUDomainResourceGuidance or advice relating to an immunization

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierBusiness identifier

... patient Σ1..1Reference(Patient)Who this profile is for
... date Σ1..1dateTimeDate recommendation(s) created
... recommendation ΣC1..*BackboneElementVaccine administration recommendations
+ Rule: One of vaccineCode or targetDisease SHALL be present

.... vaccineCode ΣC0..*CodeableConceptVaccine or vaccine group recommendation applies to
Binding: Vaccine Administered Value Set (Example)

.... targetDisease ΣC0..*CodeableConceptDisease to be immunized against
Binding: Immunization Target Disease Codes (Example)

.... contraindicatedVaccineCode Σ0..*CodeableConceptVaccine which is contraindicated to fulfill the recommendation
Binding: Vaccine Administered Value Set (Example)

.... forecastStatus ?!Σ1..1CodeableConceptVaccine recommendation status
Binding: Immunization Recommendation Status Codes (Example)
.... forecastReason Σ0..*CodeableConceptVaccine administration status reason
Binding: Immunization Recommendation Reason Codes (Example)

.... dateCriterion 0..*BackboneElementDates governing proposed immunization

..... code 1..1CodeableConceptType of date
Binding: Immunization Recommendation Date Criterion Codes (Example)
..... value 1..1dateTimeRecommended date
.... description 0..1markdownProtocol details
.... series 0..1stringName of vaccination series
.... doseNumber Σ0..1stringRecommended dose number within series
.... seriesDoses 0..1stringRecommended number of doses for immunity
.... supportingImmunization 0..*Reference(Immunization | ImmunizationEvaluation)Past immunizations supporting recommendation

.... supportingPatientInformation 0..*Reference(Any)Patient observations supporting recommendation


doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

ImmunizationRecommendation (DomainResource)A unique identifier assigned to this particular recommendation recordidentifier : Identifier [0..*]The patient the recommendation(s) are forpatient : Reference [1..1] « Patient »The date the immunization recommendation(s) were createddate : dateTime [1..1]Indicates the authority who published the protocol (e.g. ACIP)authority : Reference [0..1] « Organization »RecommendationVaccine(s) or vaccine group that pertain to the recommendationvaccineCode : CodeableConcept [0..*] « null (Strength=Example)VaccineAdministeredValueSet?? » « This element has or is affected by some invariantsC »The targeted disease for the recommendationtargetDisease : CodeableConcept [0..*] « null (Strength=Example) ImmunizationTargetDiseaseCodes?? » « This element has or is affected by some invariantsC »Vaccine(s) which should not be used to fulfill the recommendationcontraindicatedVaccineCode : CodeableConcept [0..*] « null (Strength=Example) VaccineAdministeredValueSet?? »Indicates the patient status with respect to the path to immunity for the target disease (this element modifies the meaning of other elements)forecastStatus : CodeableConcept [1..1] « null (Strength=Example) ImmunizationRecommendationSta...?? »The reason for the assigned forecast statusforecastReason : CodeableConcept [0..*] « null (Strength=Example) ImmunizationRecommendationRea...?? »Contains the description about the protocol under which the vaccine was administereddescription : markdown [0..1]One possible path to achieve presumed immunity against a disease - within the context of an authorityseries : string [0..1]Nominal position of the recommended dose in a series as determined by the evaluation and forecasting process (e.g. dose 2 is the next recommended dose)doseNumber : string [0..1]The recommended number of doses to achieve immunity as determined by the evaluation and forecasting processseriesDoses : string [0..1]Immunization event history and/or evaluation that supports the status and recommendationsupportingImmunization : Reference [0..*] « Immunization| ImmunizationEvaluation »Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance informationsupportingPatientInformation : Reference [0..*] « Any »DateCriterionDate classification of recommendation. For example, earliest date to give, latest date to give, etccode : CodeableConcept [1..1] « null (Strength=Example)ImmunizationRecommendationDat...?? »The date whose meaning is specified by dateCriterion.codevalue : dateTime [1..1]Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etcdateCriterion[0..*]Vaccine administration recommendationsrecommendation[1..*]

XML Template

<ImmunizationRecommendation xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business identifier --></identifier>
 <patient><!-- 1..1 Reference(Patient) Who this profile is for --></patient>
 <date value="[dateTime]"/><!-- 1..1 Date recommendation(s) created -->
 <authority><!-- 0..1 Reference(Organization) Who is responsible for protocol --></authority>
 <recommendation>  <!-- 1..* Vaccine administration recommendations -->
  <vaccineCode><!-- I 0..* CodeableConcept Vaccine  or vaccine group recommendation applies to --></vaccineCode>
  <targetDisease><!-- I 0..* CodeableConcept Disease to be immunized against --></targetDisease>
  <contraindicatedVaccineCode><!-- 0..* CodeableConcept Vaccine which is contraindicated to fulfill the recommendation --></contraindicatedVaccineCode>
  <forecastStatus><!-- 1..1 CodeableConcept Vaccine recommendation status --></forecastStatus>
  <forecastReason><!-- 0..* CodeableConcept Vaccine administration status reason --></forecastReason>
  <dateCriterion>  <!-- 0..* Dates governing proposed immunization -->
   <code><!-- 1..1 CodeableConcept 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 value="[string]"/><!-- 0..1 Recommended dose number within series -->
  <seriesDoses value="[string]"/><!-- 0..1 Recommended number of doses for immunity -->
  <supportingImmunization><!-- 0..* Reference(Immunization|ImmunizationEvaluation) Past immunizations supporting recommendation --></supportingImmunization>
  <supportingPatientInformation><!-- 0..* Reference(Any) Patient observations supporting recommendation --></supportingPatientInformation>
 </recommendation>
</ImmunizationRecommendation>

JSON Template

{doco
  "resourceType" : "ImmunizationRecommendation",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifier
  "patient" : { Reference(Patient) }, // R!  Who this profile is for
  "date" : "<dateTime>", // R!  Date recommendation(s) created
  "authority" : { Reference(Organization) }, // Who is responsible for protocol
  "recommendation" : [{ // R!  Vaccine administration recommendations
    "vaccineCode" : [{ CodeableConcept }], // I Vaccine  or vaccine group recommendation applies to
    "targetDisease" : [{ CodeableConcept }], // I Disease to be immunized against
    "contraindicatedVaccineCode" : [{ CodeableConcept }], // Vaccine which is contraindicated to fulfill the recommendation
    "forecastStatus" : { CodeableConcept }, // R!  Vaccine recommendation status
    "forecastReason" : [{ CodeableConcept }], // Vaccine administration status reason
    "dateCriterion" : [{ // Dates governing proposed immunization
      "code" : { CodeableConcept }, // R!  Type of date
      "value" : "<dateTime>" // R!  Recommended date
    }],
    "description" : "<markdown>", // Protocol details
    "series" : "<string>", // Name of vaccination series
    "doseNumber" : "<string>", // Recommended dose number within series
    "seriesDoses" : "<string>", // Recommended number of doses for immunity
    "supportingImmunization" : [{ Reference(Immunization|ImmunizationEvaluation) }], // Past immunizations supporting recommendation
    "supportingPatientInformation" : [{ Reference(Any) }] // Patient observations supporting recommendation
  }]
}

Turtle Template

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


[ a fhir:ImmunizationRecommendation;
  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: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 protocol
  fhir:recommendation ( [ # 1..* Vaccine administration recommendations
    fhir:vaccineCode  ( [ CodeableConcept ] ... ) ; # 0..* I Vaccine  or vaccine group recommendation applies to
    fhir:targetDisease  ( [ CodeableConcept ] ... ) ; # 0..* I Disease to be immunized against
    fhir:contraindicatedVaccineCode  ( [ CodeableConcept ] ... ) ; # 0..* Vaccine which is contraindicated to fulfill the recommendation
    fhir:forecastStatus [ CodeableConcept ] ; # 1..1 Vaccine recommendation status
    fhir:forecastReason  ( [ CodeableConcept ] ... ) ; # 0..* Vaccine administration status reason
    fhir:dateCriterion ( [ # 0..* Dates governing proposed immunization
      fhir:code [ CodeableConcept ] ; # 1..1 Type of date
      fhir:value [ dateTime ] ; # 1..1 Recommended date
    ] ... ) ;
    fhir:description [ markdown ] ; # 0..1 Protocol details
    fhir:series [ string ] ; # 0..1 Name of vaccination series
    fhir:doseNumber [ string ] ; # 0..1 Recommended dose number within series
    fhir:seriesDoses [ string ] ; # 0..1 Recommended number of doses for immunity
    fhir:supportingImmunization  ( [ Reference(Immunization|ImmunizationEvaluation) ] ... ) ; # 0..* Past immunizations supporting recommendation
    fhir:supportingPatientInformation  ( [ Reference(Any) ] ... ) ; # 0..* Patient observations supporting recommendation
  ] ... ) ;
]

Changes from both R4 and R4B

ImmunizationRecommendation
ImmunizationRecommendation.recommendation.targetDisease
  • Max Cardinality changed from 1 to *
ImmunizationRecommendation.recommendation.description
  • Type changed from string to markdown
ImmunizationRecommendation.recommendation.doseNumber
  • Renamed from doseNumber[x] to doseNumber
  • Remove Type positiveInt
ImmunizationRecommendation.recommendation.seriesDoses
  • Renamed from seriesDoses[x] to seriesDoses
  • Remove Type positiveInt

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

See R4 <--> R5 Conversion Maps (status = See Conversions Summary.)

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

PathValueSetTypeDocumentation
ImmunizationRecommendation.recommendation.vaccineCode VaccineAdministeredValueSet Example

This identifies the vaccine substance administered - CVX codes.

ImmunizationRecommendation.recommendation.targetDisease ImmunizationTargetDiseaseCodes Example

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.

ImmunizationRecommendation.recommendation.contraindicatedVaccineCode VaccineAdministeredValueSet Example

This identifies the vaccine substance administered - CVX codes.

ImmunizationRecommendation.recommendation.forecastStatus ImmunizationRecommendationStatusCodes Example

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 status of the patient towards perceived immunity against a vaccine preventable disease. This value set is provided as a suggestive example.

ImmunizationRecommendation.recommendation.forecastReason ImmunizationRecommendationReasonCodes Example

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 reasons why a given recommendation status is assigned. This value set is provided as a suggestive example and includes SNOMED CT concepts.

ImmunizationRecommendation.recommendation.dateCriterion.code ImmunizationRecommendationDateCriterionCodes Example

The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support the definition of dates relevant to recommendations for future doses of vaccines. This value set is provided as a suggestive example.

UniqueKeyLevelLocationDescriptionExpression
img imr-1Rule ImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be presentvaccineCode.exists() or targetDisease.exists()

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
datedateDate recommendation(s) createdImmunizationRecommendation.date27 Resources
identifiertokenBusiness identifierImmunizationRecommendation.identifier65 Resources
informationreferencePatient observations supporting recommendationImmunizationRecommendation.recommendation.supportingPatientInformation
(Any)
patientreferenceWho this profile is forImmunizationRecommendation.patient
(Patient)
66 Resources
statustokenVaccine recommendation statusImmunizationRecommendation.recommendation.forecastStatus
supportreferencePast immunizations supporting recommendationImmunizationRecommendation.recommendation.supportingImmunization
(Immunization, ImmunizationEvaluation)
target-diseasetokenDisease to be immunized againstImmunizationRecommendation.recommendation.targetDisease
vaccine-typetokenVaccine or vaccine group recommendation applies toImmunizationRecommendation.recommendation.vaccineCode