Release 5 Preview #2
MedicationsThis page is part of the FHIR Specification (v4.4.0: R5 Preview #2). 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
| Public Health and Emergency Response Work Group | Maturity Level: 1 | Trial Use | Security 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 POIZ domain and Immunization Domain Analysis Model.
This resource references the following resources:
This resource is referenced by CarePlan, DiagnosticReport, MedicationRequest and Observation.
This resource implements the Request pattern.
Structure
UML Diagram (Legend)
XML Template
<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..* 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 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
{
"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
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since R3
| ImmunizationRecommendation | |
| ImmunizationRecommendation.recommendation.targetDisease |
|
| ImmunizationRecommendation.recommendation.doseNumber |
|
| ImmunizationRecommendation.recommendation.seriesDoses |
|
| ImmunizationRecommendation.recommendation.doseNumber[x] |
|
| ImmunizationRecommendation.recommendation.seriesDoses[x] |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R3 <--> R4 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and all r3 resources are valid.)
Structure
XML Template
<ImmunizationRecommendation xmlns="http://hl7.org/fhir">
JSON Template
{
"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
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since Release 3
| ImmunizationRecommendation | |
| ImmunizationRecommendation.recommendation.targetDisease |
|
| ImmunizationRecommendation.recommendation.doseNumber |
|
| ImmunizationRecommendation.recommendation.seriesDoses |
|
| ImmunizationRecommendation.recommendation.doseNumber[x] |
|
| ImmunizationRecommendation.recommendation.seriesDoses[x] |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R3 <--> R4 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and all r3 resources are valid.)
See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis a
| Path | Definition | Type | Reference |
|---|---|---|---|
| ImmunizationRecommendation.recommendation.vaccineCode ImmunizationRecommendation.recommendation.contraindicatedVaccineCode | The type of vaccine administered. | Example | VaccineAdministeredValueSet |
| ImmunizationRecommendation.recommendation.targetDisease | The disease that the recommended vaccination targets. | Example | ImmunizationRecommendationTargetDiseaseCodes |
| ImmunizationRecommendation.recommendation.forecastStatus | The patient's status with respect to a vaccination protocol. | Example | ImmunizationRecommendationStatusCodes |
| ImmunizationRecommendation.recommendation.forecastReason | The reason for the patient's status with respect to a vaccination protocol. | Example | ImmunizationRecommendationReasonCodes |
| 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.). | Example | ImmunizationRecommendationDateCriterionCodes |
| id | Level | Location | Description | Expression |
| imr-1 | Rule | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present | vaccineCode.exists() or targetDisease.exists() |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
| date N | date | Date recommendation(s) created | ImmunizationRecommendation.date | |
| identifier | token | Business identifier | ImmunizationRecommendation.identifier | |
| information | reference | Patient observations supporting recommendation | ImmunizationRecommendation.recommendation.supportingPatientInformation (Any) | |
| patient | reference | Who this profile is for | ImmunizationRecommendation.patient (Patient) | |
| status | token | Vaccine recommendation status | ImmunizationRecommendation.recommendation.forecastStatus | |
| support | reference | Past immunizations supporting recommendation | ImmunizationRecommendation.recommendation.supportingImmunization (Immunization, ImmunizationEvaluation) | |
| target-disease | token | Disease to be immunized against | ImmunizationRecommendation.recommendation.targetDisease | |
| vaccine-type | token | Vaccine or vaccine group recommendation applies to | ImmunizationRecommendation.recommendation.vaccineCode |
FHIR ®© HL7.org 2011+. FHIR CI Build hl7.fhir.core#4.4.0 generated on Sun, May 3, 2020 08:47+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change