Path | Short | Definition | Comments |
---|---|---|---|
Guidance or advice relating to an immunization | A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification. | ||
identifier | Business identifier | A unique identifier assigned to this particular recommendation record. | |
patient | Who this profile is for | The patient the recommendation(s) are for. | |
date | Date recommendation(s) created | The date the immunization recommendation(s) were created. | |
authority | Who is responsible for protocol | Indicates the authority who published the protocol (e.g. ACIP). | |
recommendation | Vaccine administration recommendations | Vaccine administration recommendations. | |
recommendation.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
recommendation.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
recommendation.modifierExtension | Extensions that cannot be ignored even if unrecognized | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
recommendation.vaccineCode | Vaccine or vaccine group recommendation applies to | Vaccine(s) or vaccine group that pertain to the recommendation. | |
recommendation.targetDisease | Disease to be immunized against | The targeted disease for the recommendation. | |
recommendation.contraindicatedVaccineCode | Vaccine which is contraindicated to fulfill the recommendation | Vaccine(s) which should not be used to fulfill the recommendation. | |
recommendation.forecastStatus | Vaccine recommendation status | Indicates the patient status with respect to the path to immunity for the target disease. | |
recommendation.forecastReason | Vaccine administration status reason | The reason for the assigned forecast status. | |
recommendation.dateCriterion | Dates governing proposed immunization | Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc. | |
recommendation.dateCriterion.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
recommendation.dateCriterion.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
recommendation.dateCriterion.modifierExtension | Extensions that cannot be ignored even if unrecognized | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
recommendation.dateCriterion.code | Type of date | Date classification of recommendation. For example, earliest date to give, latest date to give, etc. | |
recommendation.dateCriterion.value | Recommended date | The date whose meaning is specified by dateCriterion.code. | |
recommendation.description | Protocol details | Contains the description about the protocol under which the vaccine was administered. | |
recommendation.series | Name of vaccination series | One possible path to achieve presumed immunity against a disease - within the context of an authority. | |
recommendation.doseNumber[x] | Recommended dose number within series | Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose). | The use of an integer is prefered if known. A string should only be used in cases where an interger is not available (such as when documenting a recurring booster dose). |
recommendation.seriesDoses[x] | Recommended number of doses for immunity | The recommended number of doses to achieve immunity. | The use of an integer is prefered if known. A string should only be used in cases where an interger is not available (such as when documenting a recurring booster dose). |
recommendation.supportingImmunization | Past immunizations supporting recommendation | Immunization event history and/or evaluation that supports the status and recommendation. | |
recommendation.supportingPatientInformation | Patient observations supporting recommendation | Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information. |
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.
date | Date recommendation(s) created | ImmunizationRecommendation.date |
identifier | Business identifier | ImmunizationRecommendation.identifier |
information | Patient observations supporting recommendation | ImmunizationRecommendation.recommendation.supportingPatientInformation |
patient | Who this profile is for | ImmunizationRecommendation.patient |
status | Vaccine recommendation status | ImmunizationRecommendation.recommendation.forecastStatus |
support | Past immunizations supporting recommendation | ImmunizationRecommendation.recommendation.supportingImmunization |
target-disease | Disease to be immunized against | ImmunizationRecommendation.recommendation.targetDisease |
vaccine-type | Vaccine or vaccine group recommendation applies to | ImmunizationRecommendation.recommendation.vaccineCode |