11.15 Resource ImmunizationRecommendation - Content

<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><!-- 0..1 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]><!-- 0..1 positiveInt|string Recommended dose number within series --></doseNumber[x]>
  <seriesDoses[x]><!-- 0..1 positiveInt|string Recommended number of doses for immunity --></seriesDoses[x]>
  <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[x]: Recommended dose number within series. One of these 2:
    "doseNumberPositiveInt" : "<positiveInt>",
    "doseNumberString" : "<string>",
    // seriesDoses[x]: Recommended number of doses for immunity. One of these 2:
    "seriesDosesPositiveInt" : "<positiveInt>",
    "seriesDosesString" : "<string>",
    "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:ImmunizationRecommendation.recommendation.targetDisease [ CodeableConcept ]; # 0..1 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
    # ImmunizationRecommendation.recommendation.doseNumber[x] : 0..1 Recommended dose number within series. One of these 2
      fhir:ImmunizationRecommendation.recommendation.doseNumberPositiveInt [ positiveInt ]
      fhir:ImmunizationRecommendation.recommendation.doseNumberString [ string ]
    # ImmunizationRecommendation.recommendation.seriesDoses[x] : 0..1 Recommended number of doses for immunity. One of these 2
      fhir:ImmunizationRecommendation.recommendation.seriesDosesPositiveInt [ positiveInt ]
      fhir:ImmunizationRecommendation.recommendation.seriesDosesString [ string ]
    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.

See R2 <--> R3 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and all r3 resources are valid.). Note: these have note yet been updated to be R3 to R4

<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><!-- 0..1 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]><!-- 0..1 positiveInt|string Recommended dose number within series --></doseNumber[x]>
  <seriesDoses[x]><!-- 0..1 positiveInt|string Recommended number of doses for immunity --></seriesDoses[x]>
  <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[x]: Recommended dose number within series. One of these 2:
    "doseNumberPositiveInt" : "<positiveInt>",
    "doseNumberString" : "<string>",
    // seriesDoses[x]: Recommended number of doses for immunity. One of these 2:
    "seriesDosesPositiveInt" : "<positiveInt>",
    "seriesDosesString" : "<string>",
    "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:ImmunizationRecommendation.recommendation.targetDisease [ CodeableConcept ]; # 0..1 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
    # ImmunizationRecommendation.recommendation.doseNumber[x] : 0..1 Recommended dose number within series. One of these 2
      fhir:ImmunizationRecommendation.recommendation.doseNumberPositiveInt [ positiveInt ]
      fhir:ImmunizationRecommendation.recommendation.doseNumberString [ string ]
    # ImmunizationRecommendation.recommendation.seriesDoses[x] : 0..1 Recommended number of doses for immunity. One of these 2
      fhir:ImmunizationRecommendation.recommendation.seriesDosesPositiveInt [ positiveInt ]
      fhir:ImmunizationRecommendation.recommendation.seriesDosesString [ string ]
    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.

See R2 <--> R3 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and all r3 resources are valid.). Note: these have note yet been updated to be R3 to R4