Skip to main content

ImmunizationRecommendation

PropertyValue
Publisher
NameImmunizationRecommendation
URLhttp://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
ImmunizationRecommendation0..*ImmunizationRecommendationA patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.
ImmunizationRecommendation.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
ImmunizationRecommendation.meta0..1MetaThe 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.
ImmunizationRecommendation.implicitRules0..1uriA 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.
ImmunizationRecommendation.language0..1codeThe base language in which the resource is written.
ImmunizationRecommendation.text0..1NarrativeA 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.
ImmunizationRecommendation.contained0..*ResourceThese 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.
ImmunizationRecommendation.extension0..*ExtensionMay 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.
ImmunizationRecommendation.modifierExtension0..*ExtensionMay 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).
ImmunizationRecommendation.identifier0..*IdentifierA unique identifier assigned to this particular recommendation record.
ImmunizationRecommendation.patient1..1ReferenceThe patient the recommendation(s) are for.
ImmunizationRecommendation.date1..1dateTimeThe date the immunization recommendation(s) were created.
ImmunizationRecommendation.authority0..1ReferenceIndicates the authority who published the protocol (e.g. ACIP).
ImmunizationRecommendation.recommendation1..*BackboneElementVaccine administration recommendations.
ImmunizationRecommendation.recommendation.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ImmunizationRecommendation.recommendation.extension0..*ExtensionMay 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.
ImmunizationRecommendation.recommendation.modifierExtension0..*ExtensionMay 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).
ImmunizationRecommendation.recommendation.vaccineCode0..*CodeableConceptVaccine(s) or vaccine group that pertain to the recommendation.
ImmunizationRecommendation.recommendation.targetDisease0..1CodeableConceptThe targeted disease for the recommendation.
ImmunizationRecommendation.recommendation.contraindicatedVaccineCode0..*CodeableConceptVaccine(s) which should not be used to fulfill the recommendation.
ImmunizationRecommendation.recommendation.forecastStatus1..1CodeableConceptIndicates the patient status with respect to the path to immunity for the target disease.
ImmunizationRecommendation.recommendation.forecastReason0..*CodeableConceptThe reason for the assigned forecast status.
ImmunizationRecommendation.recommendation.dateCriterion0..*BackboneElementVaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.
ImmunizationRecommendation.recommendation.dateCriterion.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ImmunizationRecommendation.recommendation.dateCriterion.extension0..*ExtensionMay 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.
ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension0..*ExtensionMay 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).
ImmunizationRecommendation.recommendation.dateCriterion.code1..1CodeableConceptDate classification of recommendation. For example, earliest date to give, latest date to give, etc.
ImmunizationRecommendation.recommendation.dateCriterion.value1..1dateTimeThe date whose meaning is specified by dateCriterion.code.
ImmunizationRecommendation.recommendation.description0..1stringContains the description about the protocol under which the vaccine was administered.
ImmunizationRecommendation.recommendation.series0..1stringOne possible path to achieve presumed immunity against a disease - within the context of an authority.
ImmunizationRecommendation.recommendation.doseNumber[x]0..1positiveIntNominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose).
ImmunizationRecommendation.recommendation.seriesDoses[x]0..1positiveIntThe recommended number of doses to achieve immunity.
ImmunizationRecommendation.recommendation.supportingImmunization0..*ReferenceImmunization event history and/or evaluation that supports the status and recommendation.
ImmunizationRecommendation.recommendation.supportingPatientInformation0..*ReferencePatient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
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
_iguhealth-version-seqnumberThe version sequence of the resourceResource.meta.extension.where(url='https://iguhealth.app/version-sequence').value
_iguhealth-authorreferenceThe author of the resourceResource.meta.extension.where(url='https://iguhealth.app/author').value