Resource type: immunizationrecommendation

Description

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

Elements

PathShortDefinitionComments
Guidance or advice relating to an immunizationA patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.
identifierBusiness identifierA unique identifier assigned to this particular recommendation record.
patientWho this profile is forThe patient the recommendation(s) are for.
dateDate recommendation(s) createdThe date the immunization recommendation(s) were created.
authorityWho is responsible for protocolIndicates the authority who published the protocol (e.g. ACIP).
recommendationVaccine administration recommendationsVaccine administration recommendations.
recommendation.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
recommendation.extensionAdditional content defined by implementationsMay 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.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay 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.vaccineCodeVaccine or vaccine group recommendation applies toVaccine(s) or vaccine group that pertain to the recommendation.
recommendation.targetDiseaseDisease to be immunized againstThe targeted disease for the recommendation.
recommendation.contraindicatedVaccineCodeVaccine which is contraindicated to fulfill the recommendationVaccine(s) which should not be used to fulfill the recommendation.
recommendation.forecastStatusVaccine recommendation statusIndicates the patient status with respect to the path to immunity for the target disease.
recommendation.forecastReasonVaccine administration status reasonThe reason for the assigned forecast status.
recommendation.dateCriterionDates governing proposed immunizationVaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.
recommendation.dateCriterion.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
recommendation.dateCriterion.extensionAdditional content defined by implementationsMay 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.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay 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.codeType of dateDate classification of recommendation. For example, earliest date to give, latest date to give, etc.
recommendation.dateCriterion.valueRecommended dateThe date whose meaning is specified by dateCriterion.code.
recommendation.descriptionProtocol detailsContains the description about the protocol under which the vaccine was administered.
recommendation.seriesName of vaccination seriesOne possible path to achieve presumed immunity against a disease - within the context of an authority.
recommendation.doseNumber[x]Recommended dose number within seriesNominal 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 immunityThe 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.supportingImmunizationPast immunizations supporting recommendationImmunization event history and/or evaluation that supports the status and recommendation.
recommendation.supportingPatientInformationPatient observations supporting recommendationPatient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.

Scope and Usage

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.

Boundaries and Relationships

This resource references the following resources:

Search Parameters

dateDate recommendation(s) createdImmunizationRecommendation.date
identifierBusiness identifierImmunizationRecommendation.identifier
informationPatient observations supporting recommendationImmunizationRecommendation.recommendation.supportingPatientInformation
patientWho this profile is forImmunizationRecommendation.patient
statusVaccine recommendation statusImmunizationRecommendation.recommendation.forecastStatus
supportPast immunizations supporting recommendationImmunizationRecommendation.recommendation.supportingImmunization
target-diseaseDisease to be immunized againstImmunizationRecommendation.recommendation.targetDisease
vaccine-typeVaccine or vaccine group recommendation applies toImmunizationRecommendation.recommendation.vaccineCode

Extension Definitions

These are extension definitions for this resource defined by the spec