11.9 Resource ImmunizationRecommendation - Content

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation	TU		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
authority		0..1	Reference ( Organization )	Who is responsible for protocol
recommendation	Σ I C	1..*	BackboneElement	Vaccine administration recommendations + Rule: One of vaccineCode or targetDisease SHALL be present
vaccineCode	Σ	0..*	CodeableConcept	Vaccine or vaccine group recommendation applies to Vaccine Administered Value Set ( Example )
targetDisease	Σ	0..1 0..*	CodeableConcept	Disease to be immunized against Immunization Recommendation Target Disease Codes ( Example )
contraindicatedVaccineCode	Σ	0..*	CodeableConcept	Vaccine which is contraindicated to fulfill the recommendation Vaccine Administered Value Set ( Example )
forecastStatus	?! Σ	1..1	CodeableConcept	Vaccine recommendation status Immunization Recommendation Status Codes ( Example )
forecastReason	Σ	0..*	CodeableConcept	Vaccine administration status reason Immunization Recommendation Reason Codes ( Example )
dateCriterion		0..*	BackboneElement	Dates governing proposed immunization
code		1..1	CodeableConcept	Type of date Immunization Recommendation Date Criterion Codes ( Example )
value		1..1	dateTime	Recommended date
description		0..1	string	Protocol details
series		0..1	string	Name of vaccination series
doseNumber[x] doseNumber	Σ	0..1	string	Recommended dose number within series
doseNumberPositiveInt seriesDoses		positiveInt 0..1	doseNumberString string	Recommended number of doses for immunity seriesDosesPositiveInt positiveInt seriesDosesString string
supportingImmunization		0..*	Reference ( Immunization | ImmunizationEvaluation )	Past immunizations supporting recommendation
supportingPatientInformation		0..*	Reference ( Any )	Patient observations supporting recommendation
Documentation for this format

See the Extensions for this resource

<ImmunizationRecommendation 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>
 <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><!-- 0..* CodeableConcept Vaccine  or vaccine group recommendation applies to --></vaccineCode>
  <</targetDisease>

  <targetDisease><!-- 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="[string]"/><!-- 0..1 Protocol details -->
  <series value="[string]"/><!-- 0..1 Name of vaccination series -->
  <</doseNumber[x]>
  <</seriesDoses[x]>

  <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>

{
  "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 }], // Vaccine  or vaccine group recommendation applies to
    "

    "targetDisease" : [{ CodeableConcept }], // 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" : "<string>", // 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
  }]
}

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


[ 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:ImmunizationRecommendation.identifier [ Identifier ], ... ; # 0..* Business identifier
  fhir:ImmunizationRecommendation.patient [ Reference(Patient) ]; # 1..1 Who this profile is for
  fhir:ImmunizationRecommendation.date [ dateTime ]; # 1..1 Date recommendation(s) created
  fhir:ImmunizationRecommendation.authority [ Reference(Organization) ]; # 0..1 Who is responsible for protocol
  fhir:ImmunizationRecommendation.recommendation [ # 1..* Vaccine administration recommendations
    fhir:ImmunizationRecommendation.recommendation.vaccineCode [ CodeableConcept ], ... ; # 0..* Vaccine  or vaccine group recommendation applies to
    fhir:

    fhir:ImmunizationRecommendation.recommendation.targetDisease [ CodeableConcept ], ... ; # 0..* Disease to be immunized against

    fhir:ImmunizationRecommendation.recommendation.contraindicatedVaccineCode [ CodeableConcept ], ... ; # 0..* Vaccine which is contraindicated to fulfill the recommendation
    fhir:ImmunizationRecommendation.recommendation.forecastStatus [ CodeableConcept ]; # 1..1 Vaccine recommendation status
    fhir:ImmunizationRecommendation.recommendation.forecastReason [ CodeableConcept ], ... ; # 0..* Vaccine administration status reason
    fhir:ImmunizationRecommendation.recommendation.dateCriterion [ # 0..* Dates governing proposed immunization
      fhir:ImmunizationRecommendation.recommendation.dateCriterion.code [ CodeableConcept ]; # 1..1 Type of date
      fhir:ImmunizationRecommendation.recommendation.dateCriterion.value [ dateTime ]; # 1..1 Recommended date
    ], ...;
    fhir:ImmunizationRecommendation.recommendation.description [ string ]; # 0..1 Protocol details
    fhir:ImmunizationRecommendation.recommendation.series [ string ]; # 0..1 Name of vaccination series
    # . One of these 2
      fhir: ]
      fhir: ]
    # . One of these 2
      fhir: ]
      fhir: ]

    fhir:ImmunizationRecommendation.recommendation.doseNumber [ string ]; # 0..1 Recommended dose number within series
    fhir:ImmunizationRecommendation.recommendation.seriesDoses [ string ]; # 0..1 Recommended number of doses for immunity

    fhir:ImmunizationRecommendation.recommendation.supportingImmunization [ Reference(Immunization|ImmunizationEvaluation) ], ... ; # 0..* Past immunizations supporting recommendation
    fhir:ImmunizationRecommendation.recommendation.supportingPatientInformation [ Reference(Any) ], ... ; # 0..* Patient observations supporting recommendation
  ], ...;
]

See the Full Difference for further information

This analysis is available as XML or JSON .

Conversions between R3 and R4 See R3 <--> R4 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and all r3 resources are valid.)

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation	TU		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
authority		0..1	Reference ( Organization )	Who is responsible for protocol
recommendation	Σ I C	1..*	BackboneElement	Vaccine administration recommendations + Rule: One of vaccineCode or targetDisease SHALL be present
vaccineCode	Σ	0..*	CodeableConcept	Vaccine or vaccine group recommendation applies to Vaccine Administered Value Set ( Example )
targetDisease	Σ	0..1 0..*	CodeableConcept	Disease to be immunized against Immunization Recommendation Target Disease Codes ( Example )
contraindicatedVaccineCode	Σ	0..*	CodeableConcept	Vaccine which is contraindicated to fulfill the recommendation Vaccine Administered Value Set ( Example )
forecastStatus	?! Σ	1..1	CodeableConcept	Vaccine recommendation status Immunization Recommendation Status Codes ( Example )
forecastReason	Σ	0..*	CodeableConcept	Vaccine administration status reason Immunization Recommendation Reason Codes ( Example )
dateCriterion		0..*	BackboneElement	Dates governing proposed immunization
code		1..1	CodeableConcept	Type of date Immunization Recommendation Date Criterion Codes ( Example )
value		1..1	dateTime	Recommended date
description		0..1	string	Protocol details
series		0..1	string	Name of vaccination series
doseNumber[x] doseNumber	Σ	0..1	string	Recommended dose number within series
doseNumberPositiveInt seriesDoses		positiveInt 0..1	doseNumberString string	Recommended number of doses for immunity seriesDosesPositiveInt positiveInt seriesDosesString string
supportingImmunization		0..*	Reference ( Immunization | ImmunizationEvaluation )	Past immunizations supporting recommendation
supportingPatientInformation		0..*	Reference ( Any )	Patient observations supporting recommendation
Documentation for this format

See the Extensions for this resource

<ImmunizationRecommendation 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>
 <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><!-- 0..* CodeableConcept Vaccine  or vaccine group recommendation applies to --></vaccineCode>
  <</targetDisease>

  <targetDisease><!-- 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="[string]"/><!-- 0..1 Protocol details -->
  <series value="[string]"/><!-- 0..1 Name of vaccination series -->
  <</doseNumber[x]>
  <</seriesDoses[x]>

  <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>

{
  "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 }], // Vaccine  or vaccine group recommendation applies to
    "

    "targetDisease" : [{ CodeableConcept }], // 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" : "<string>", // 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
  }]
}

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


[ 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:ImmunizationRecommendation.identifier [ Identifier ], ... ; # 0..* Business identifier
  fhir:ImmunizationRecommendation.patient [ Reference(Patient) ]; # 1..1 Who this profile is for
  fhir:ImmunizationRecommendation.date [ dateTime ]; # 1..1 Date recommendation(s) created
  fhir:ImmunizationRecommendation.authority [ Reference(Organization) ]; # 0..1 Who is responsible for protocol
  fhir:ImmunizationRecommendation.recommendation [ # 1..* Vaccine administration recommendations
    fhir:ImmunizationRecommendation.recommendation.vaccineCode [ CodeableConcept ], ... ; # 0..* Vaccine  or vaccine group recommendation applies to
    fhir:

    fhir:ImmunizationRecommendation.recommendation.targetDisease [ CodeableConcept ], ... ; # 0..* Disease to be immunized against

    fhir:ImmunizationRecommendation.recommendation.contraindicatedVaccineCode [ CodeableConcept ], ... ; # 0..* Vaccine which is contraindicated to fulfill the recommendation
    fhir:ImmunizationRecommendation.recommendation.forecastStatus [ CodeableConcept ]; # 1..1 Vaccine recommendation status
    fhir:ImmunizationRecommendation.recommendation.forecastReason [ CodeableConcept ], ... ; # 0..* Vaccine administration status reason
    fhir:ImmunizationRecommendation.recommendation.dateCriterion [ # 0..* Dates governing proposed immunization
      fhir:ImmunizationRecommendation.recommendation.dateCriterion.code [ CodeableConcept ]; # 1..1 Type of date
      fhir:ImmunizationRecommendation.recommendation.dateCriterion.value [ dateTime ]; # 1..1 Recommended date
    ], ...;
    fhir:ImmunizationRecommendation.recommendation.description [ string ]; # 0..1 Protocol details
    fhir:ImmunizationRecommendation.recommendation.series [ string ]; # 0..1 Name of vaccination series
    # . One of these 2
      fhir: ]
      fhir: ]
    # . One of these 2
      fhir: ]
      fhir: ]

    fhir:ImmunizationRecommendation.recommendation.doseNumber [ string ]; # 0..1 Recommended dose number within series
    fhir:ImmunizationRecommendation.recommendation.seriesDoses [ string ]; # 0..1 Recommended number of doses for immunity

    fhir:ImmunizationRecommendation.recommendation.supportingImmunization [ Reference(Immunization|ImmunizationEvaluation) ], ... ; # 0..* Past immunizations supporting recommendation
    fhir:ImmunizationRecommendation.recommendation.supportingPatientInformation [ Reference(Any) ], ... ; # 0..* Patient observations supporting recommendation
  ], ...;
]

See the Full Difference for further information

This analysis is available as XML or JSON .

Conversions between R3 and R4 See R3 <--> R4 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and all r3 resources are valid.)