QI-Core Implementation Guide
6.0.0 - STU6 United States of America flag

This page is part of the Quality Improvement Core Framework (v6.0.0: STU6 (v6.0.0)) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: QICore ImmunizationRecommendation

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunizationrecommendation Version: 6.0.0
Active as of 2018-08-22 Computable Name: QICoreImmunizationRecommendation

Profile of ImmunizationRecommendation for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

Usage

See the patterns page for implementation and usage patterns.

Examples

Example of immunizationrecommendation using a vaccine code

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from ImmunizationRecommendation

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... patient 1..1Reference(QICore Patient)(QI-Core) Who this profile is for
... authority 0..1Reference(QICore Organization)Who is responsible for protocol
... recommendation 1..*BackboneElement(QI-Core) Vaccine administration recommendations
.... vaccineCode 0..*CodeableConcept(QI-Core) Vaccine or vaccine group recommendation applies to
Binding: CVX Vaccines Administered Vaccine Set . (extensible): CVX Vaccines Administered Vaccine Set

.... doseNumber[x] 0..1positiveInt, string(QI-Core) Recommended dose number within series
.... supportingImmunization 0..*Reference(QICore Immunization | QICore ImmunizationEvaluation)Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(QICore Simple Observation | QICore AllergyIntolerance)Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ImmunizationRecommendation.recommendation.vaccineCodeextensibleCVX Vaccines Administered Vaccine Set .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... patient Σ1..1Reference(QICore Patient)(QI-Core) Who this profile is for
... authority 0..1Reference(QICore Organization)Who is responsible for protocol
... recommendation ΣC1..*BackboneElement(QI-Core) Vaccine administration recommendations
imr-1: One of vaccineCode or targetDisease SHALL be present
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... vaccineCode Σ0..*CodeableConcept(QI-Core) Vaccine or vaccine group recommendation applies to
Binding: CVX Vaccines Administered Vaccine Set . (extensible): CVX Vaccines Administered Vaccine Set


.... forecastStatus ?!Σ1..1CodeableConceptVaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.

.... doseNumber[x] Σ0..1(QI-Core) Recommended dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... supportingImmunization 0..*Reference(QICore Immunization | QICore ImmunizationEvaluation)Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(QICore Simple Observation | QICore AllergyIntolerance)Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImmunizationRecommendation.recommendation.vaccineCodeextensibleCVX Vaccines Administered Vaccine Set .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6
ImmunizationRecommendation.recommendation.forecastStatusexampleImmunizationRecommendationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-status
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationRecommendationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationRecommendationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationRecommendationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
imr-1errorImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... patient Σ1..1Reference(QICore Patient)(QI-Core) Who this profile is for
... date Σ1..1dateTimeDate recommendation(s) created
... authority 0..1Reference(QICore Organization)Who is responsible for protocol
... recommendation ΣC1..*BackboneElement(QI-Core) Vaccine administration recommendations
imr-1: One of vaccineCode or targetDisease SHALL be present
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... vaccineCode Σ0..*CodeableConcept(QI-Core) Vaccine or vaccine group recommendation applies to
Binding: CVX Vaccines Administered Vaccine Set . (extensible): CVX Vaccines Administered Vaccine Set


.... targetDisease Σ0..1CodeableConceptDisease to be immunized against
Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.

.... contraindicatedVaccineCode Σ0..*CodeableConceptVaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.


.... forecastStatus ?!Σ1..1CodeableConceptVaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.

.... forecastReason Σ0..*CodeableConceptVaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.


.... dateCriterion 0..*BackboneElementDates governing proposed immunization
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1CodeableConceptType of date
Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).

..... value 1..1dateTimeRecommended date
.... description 0..1stringProtocol details
.... series 0..1stringName of vaccination series
.... doseNumber[x] Σ0..1(QI-Core) Recommended dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring
.... supportingImmunization 0..*Reference(QICore Immunization | QICore ImmunizationEvaluation)Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(QICore Simple Observation | QICore AllergyIntolerance)Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImmunizationRecommendation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ImmunizationRecommendation.recommendation.vaccineCodeextensibleCVX Vaccines Administered Vaccine Set .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6
ImmunizationRecommendation.recommendation.targetDiseaseexampleImmunizationRecommendationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-target-disease
from the FHIR Standard
ImmunizationRecommendation.recommendation.contraindicatedVaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastStatusexampleImmunizationRecommendationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-status
from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastReasonexampleImmunizationRecommendationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-reason
from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion.codeexampleImmunizationRecommendationDateCriterionCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationRecommendationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationRecommendationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationRecommendationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
imr-1errorImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()

Differential View

This structure is derived from ImmunizationRecommendation

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... patient 1..1Reference(QICore Patient)(QI-Core) Who this profile is for
... authority 0..1Reference(QICore Organization)Who is responsible for protocol
... recommendation 1..*BackboneElement(QI-Core) Vaccine administration recommendations
.... vaccineCode 0..*CodeableConcept(QI-Core) Vaccine or vaccine group recommendation applies to
Binding: CVX Vaccines Administered Vaccine Set . (extensible): CVX Vaccines Administered Vaccine Set

.... doseNumber[x] 0..1positiveInt, string(QI-Core) Recommended dose number within series
.... supportingImmunization 0..*Reference(QICore Immunization | QICore ImmunizationEvaluation)Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(QICore Simple Observation | QICore AllergyIntolerance)Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ImmunizationRecommendation.recommendation.vaccineCodeextensibleCVX Vaccines Administered Vaccine Set .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... patient Σ1..1Reference(QICore Patient)(QI-Core) Who this profile is for
... authority 0..1Reference(QICore Organization)Who is responsible for protocol
... recommendation ΣC1..*BackboneElement(QI-Core) Vaccine administration recommendations
imr-1: One of vaccineCode or targetDisease SHALL be present
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... vaccineCode Σ0..*CodeableConcept(QI-Core) Vaccine or vaccine group recommendation applies to
Binding: CVX Vaccines Administered Vaccine Set . (extensible): CVX Vaccines Administered Vaccine Set


.... forecastStatus ?!Σ1..1CodeableConceptVaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.

.... doseNumber[x] Σ0..1(QI-Core) Recommended dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... supportingImmunization 0..*Reference(QICore Immunization | QICore ImmunizationEvaluation)Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(QICore Simple Observation | QICore AllergyIntolerance)Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImmunizationRecommendation.recommendation.vaccineCodeextensibleCVX Vaccines Administered Vaccine Set .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6
ImmunizationRecommendation.recommendation.forecastStatusexampleImmunizationRecommendationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-status
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationRecommendationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationRecommendationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationRecommendationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
imr-1errorImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... patient Σ1..1Reference(QICore Patient)(QI-Core) Who this profile is for
... date Σ1..1dateTimeDate recommendation(s) created
... authority 0..1Reference(QICore Organization)Who is responsible for protocol
... recommendation ΣC1..*BackboneElement(QI-Core) Vaccine administration recommendations
imr-1: One of vaccineCode or targetDisease SHALL be present
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... vaccineCode Σ0..*CodeableConcept(QI-Core) Vaccine or vaccine group recommendation applies to
Binding: CVX Vaccines Administered Vaccine Set . (extensible): CVX Vaccines Administered Vaccine Set


.... targetDisease Σ0..1CodeableConceptDisease to be immunized against
Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.

.... contraindicatedVaccineCode Σ0..*CodeableConceptVaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.


.... forecastStatus ?!Σ1..1CodeableConceptVaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.

.... forecastReason Σ0..*CodeableConceptVaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.


.... dateCriterion 0..*BackboneElementDates governing proposed immunization
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1CodeableConceptType of date
Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).

..... value 1..1dateTimeRecommended date
.... description 0..1stringProtocol details
.... series 0..1stringName of vaccination series
.... doseNumber[x] Σ0..1(QI-Core) Recommended dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring
.... supportingImmunization 0..*Reference(QICore Immunization | QICore ImmunizationEvaluation)Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(QICore Simple Observation | QICore AllergyIntolerance)Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImmunizationRecommendation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ImmunizationRecommendation.recommendation.vaccineCodeextensibleCVX Vaccines Administered Vaccine Set .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6
ImmunizationRecommendation.recommendation.targetDiseaseexampleImmunizationRecommendationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-target-disease
from the FHIR Standard
ImmunizationRecommendation.recommendation.contraindicatedVaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastStatusexampleImmunizationRecommendationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-status
from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastReasonexampleImmunizationRecommendationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-reason
from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion.codeexampleImmunizationRecommendationDateCriterionCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationRecommendationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationRecommendationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationRecommendationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
imr-1errorImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()

 

Other representations of profile: CSV, Excel, Schematron