QI-Core Implementation Guide
4.1.1 - STU 4.1.1 US

This page is part of the Quality Improvement Core Framework (v4.1.1: STU 4) based on FHIR 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: QICoreImmunizationRecommendation

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunizationrec Version: 4.1.1
Draft 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 S1..1Reference(QICorePatient)Who this profile is for
... authority 0..1Reference(QICoreOrganization)Who is responsible for protocol
... recommendation S1..*BackboneElementVaccine administration recommendations
.... vaccineCode S0..*CodeableConceptVaccine or vaccine group recommendation applies to
Binding: US Core Vaccine Administered Value Set (CVX) (extensible): This identifies the CVX code system

.... doseNumber[x] S0..1positiveInt, stringRecommended dose number within series
.... supportingImmunization 0..*Reference(QICoreImmunization | QICoreImmunizationEvaluation)Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(QICoreObservation | QICoreAllergyIntolerance)Patient observations supporting recommendation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... id Σ0..1stringLogical 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 SΣ1..1Reference(QICorePatient)Who this profile is for
... date Σ1..1dateTimeDate recommendation(s) created
... authority 0..1Reference(QICoreOrganization)Who is responsible for protocol
... recommendation SΣI1..*BackboneElementVaccine administration recommendations
.... 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 SΣ0..*CodeableConceptVaccine or vaccine group recommendation applies to
Binding: US Core Vaccine Administered Value Set (CVX) (extensible): This identifies the CVX code system


.... 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] SΣ0..1Recommended dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring
.... supportingImmunization 0..*Reference(QICoreImmunization | QICoreImmunizationEvaluation)Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(QICoreObservation | QICoreAllergyIntolerance)Patient observations supporting recommendation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... patient Σ1..1Reference(QICorePatient)Who this profile is for
... recommendation ΣI1..*BackboneElementVaccine administration recommendations
.... vaccineCode Σ0..*CodeableConceptVaccine or vaccine group recommendation applies to
Binding: US Core Vaccine Administered Value Set (CVX) (extensible): This identifies the CVX code system


.... doseNumber[x] Σ0..1Recommended dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring

doco Documentation for this format

Differential View

This structure is derived from ImmunizationRecommendation

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... patient S1..1Reference(QICorePatient)Who this profile is for
... authority 0..1Reference(QICoreOrganization)Who is responsible for protocol
... recommendation S1..*BackboneElementVaccine administration recommendations
.... vaccineCode S0..*CodeableConceptVaccine or vaccine group recommendation applies to
Binding: US Core Vaccine Administered Value Set (CVX) (extensible): This identifies the CVX code system

.... doseNumber[x] S0..1positiveInt, stringRecommended dose number within series
.... supportingImmunization 0..*Reference(QICoreImmunization | QICoreImmunizationEvaluation)Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(QICoreObservation | QICoreAllergyIntolerance)Patient observations supporting recommendation

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... id Σ0..1stringLogical 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 SΣ1..1Reference(QICorePatient)Who this profile is for
... date Σ1..1dateTimeDate recommendation(s) created
... authority 0..1Reference(QICoreOrganization)Who is responsible for protocol
... recommendation SΣI1..*BackboneElementVaccine administration recommendations
.... 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 SΣ0..*CodeableConceptVaccine or vaccine group recommendation applies to
Binding: US Core Vaccine Administered Value Set (CVX) (extensible): This identifies the CVX code system


.... 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] SΣ0..1Recommended dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring
.... supportingImmunization 0..*Reference(QICoreImmunization | QICoreImmunizationEvaluation)Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(QICoreObservation | QICoreAllergyIntolerance)Patient observations supporting recommendation

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
ImmunizationRecommendation.languagepreferredCommonLanguages
Max Binding: AllLanguages
ImmunizationRecommendation.recommendation.vaccineCodeextensibleUSCoreVaccineAdministeredValueSetCvx
ImmunizationRecommendation.recommendation.targetDiseaseexampleImmunizationRecommendationTargetDiseaseCodes
ImmunizationRecommendation.recommendation.contraindicatedVaccineCodeexampleVaccineAdministeredValueSet
ImmunizationRecommendation.recommendation.forecastStatusexampleImmunizationRecommendationStatusCodes
ImmunizationRecommendation.recommendation.forecastReasonexampleImmunizationRecommendationReasonCodes
ImmunizationRecommendation.recommendation.dateCriterion.codeexampleImmunizationRecommendationDateCriterionCodes

Constraints

IdGradePathDetailsRequirements
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-1errorImmunizationRecommendation.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationRecommendation.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationRecommendation.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationRecommendation.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationRecommendation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorImmunizationRecommendation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorImmunizationRecommendation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorImmunizationRecommendation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorImmunizationRecommendation.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationRecommendation.patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationRecommendation.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationRecommendation.authorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationRecommendation.recommendationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
imr-1errorImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()
ele-1errorImmunizationRecommendation.recommendation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorImmunizationRecommendation.recommendation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorImmunizationRecommendation.recommendation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorImmunizationRecommendation.recommendation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorImmunizationRecommendation.recommendation.vaccineCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationRecommendation.recommendation.targetDiseaseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationRecommendation.recommendation.contraindicatedVaccineCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationRecommendation.recommendation.forecastStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationRecommendation.recommendation.forecastReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationRecommendation.recommendation.dateCriterionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationRecommendation.recommendation.dateCriterion.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorImmunizationRecommendation.recommendation.dateCriterion.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorImmunizationRecommendation.recommendation.dateCriterion.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorImmunizationRecommendation.recommendation.dateCriterion.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorImmunizationRecommendation.recommendation.dateCriterion.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationRecommendation.recommendation.dateCriterion.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationRecommendation.recommendation.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationRecommendation.recommendation.seriesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationRecommendation.recommendation.doseNumber[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationRecommendation.recommendation.seriesDoses[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationRecommendation.recommendation.supportingImmunizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationRecommendation.recommendation.supportingPatientInformationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())