Skip to main content

ImmunizationRecommendation

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

Properties

NameRequiredTypeDescription
identifierIdentifier[]

Business identifier

Details

A unique identifier assigned to this particular recommendation record.

patientReference<Patient>

Who this profile is for

Details

The patient the recommendation(s) are for.

datedateTime

Date recommendation(s) created

Details

The date the immunization recommendation(s) were created.

authorityReference<Organization>

Who is responsible for protocol

Details

Indicates the authority who published the protocol (e.g. ACIP).

recommendationImmunizationRecommendationRecommendation[]

Vaccine administration recommendations

Details

Vaccine administration recommendations.

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

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.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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.

vaccineCodeCodeableConcept[]

Vaccine or vaccine group recommendation applies to

Details

Vaccine(s) or vaccine group that pertain to the recommendation.

targetDiseaseCodeableConcept

Disease to be immunized against

Details

The targeted disease for the recommendation.

contraindicatedVaccineCodeCodeableConcept[]

Vaccine which is contraindicated to fulfill the recommendation

Details

Vaccine(s) which should not be used to fulfill the recommendation.

forecastStatusCodeableConcept

Vaccine recommendation status

Details

Indicates the patient status with respect to the path to immunity for the target disease.

forecastReasonCodeableConcept[]

Vaccine administration status reason

Details

The reason for the assigned forecast status.

dateCriterionImmunizationRecommendationRecommendationDateCriterion[]

Dates governing proposed immunization

Details

Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

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.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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.

codeCodeableConcept

Type of date

Details

Date classification of recommendation. For example, earliest date to give, latest date to give, etc.

valuedateTime

Recommended date

Details

The date whose meaning is specified by dateCriterion.code.

descriptionstring

Protocol details

Details

Contains the description about the protocol under which the vaccine was administered.

seriesstring

Name of vaccination series

Details

One possible path to achieve presumed immunity against a disease - within the context of an authority.

doseNumber[x]positiveInt, string

Recommended dose number within series

Details

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

seriesDoses[x]positiveInt, string

Recommended number of doses for immunity

Details

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

supportingImmunizationReference<Immunization | ImmunizationEvaluation>[]

Past immunizations supporting recommendation

Details

Immunization event history and/or evaluation that supports the status and recommendation.

supportingPatientInformationReference<Resource>[]

Patient observations supporting recommendation

Details

Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.

Search Parameters

NameTypeDescriptionExpression
datedateDate recommendation(s) createdImmunizationRecommendation.date
identifiertokenBusiness identifierImmunizationRecommendation.identifier
informationreferencePatient observations supporting recommendationImmunizationRecommendation.recommendation.supportingPatientInformation
patientreferenceWho this profile is forImmunizationRecommendation.patient
statustokenVaccine recommendation statusImmunizationRecommendation.recommendation.forecastStatus
supportreferencePast immunizations supporting recommendationImmunizationRecommendation.recommendation.supportingImmunization
target-diseasetokenDisease to be immunized againstImmunizationRecommendation.recommendation.targetDisease
vaccine-typetokenVaccine or vaccine group recommendation applies toImmunizationRecommendation.recommendation.vaccineCode

Inherited Properties

NameRequiredTypeDescription
idstring

Logical id of this artifact

Details

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

metaMeta

Metadata about the resource

Details

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesuri

A set of rules under which this content was created

Details

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

languagecode

Language of the resource content

Details

The base language in which the resource is written.

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

textNarrative

Text summary of the resource, for human interpretation

Details

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

containedResource[]

Contained, inline Resources

Details

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

extensionExtension[]

Additional content defined by implementations

Details

May be used to represent additional information that is not part of the basic definition of the resource. 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.

modifierExtensionExtension[]

Extensions that cannot be ignored

Details

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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.