QI-Core Implementation Guide: STU Ballot (v3.3.0 for FHIR 4.0.0)

Quality Improvement Core Framework (v3.3.0: STU 4 Ballot 1). The current version is 3.2.0 based on FHIR R4. See the Directory of published versions

D.4.1 StructureDefinition-qicore-immunizationrec

Introduction:

See the patterns page for implementation and usage patterns.

Examples:

Example of immunizationrecommendation using a vaccine code

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunizationrec

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

This profile builds on ImmunizationRecommendation.

This profile was published on Wed Aug 22 00:00:00 EDT 2018 as a draft by Health Level Seven, Inc. - CQI WG.

Description of Profiles, Differentials, and Snapshots.

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation I0..*Guidance 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... 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 Σ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 Σ0..*CodeableConceptVaccine or vaccine group recommendation applies to
Binding: US Core Vaccine Administered Value Set (CVX) (extensible)
.... targetDisease Σ0..1CodeableConceptDisease to be immunized against
Binding: ImmunizationRecommendationTargetDiseaseCodes (example)
.... contraindicatedVaccineCode Σ0..*CodeableConceptVaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example)
.... forecastStatus ?!Σ1..1CodeableConceptVaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example)
.... forecastReason Σ0..*CodeableConceptVaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example)
.... dateCriterion I0..*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)
..... value 1..1dateTimeRecommended date
.... description 0..1stringProtocol details
.... series 0..1stringName of vaccination series
.... doseNumber[x] Σ0..1Recommended dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring
.... supportingImmunization 0..*Reference(QICoreImmunization)Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(QICoreObservation | QICoreAllergyIntolerance)Patient observations supporting recommendation

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation I0..*Guidance 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... 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 Σ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 Σ0..*CodeableConceptVaccine or vaccine group recommendation applies to
Binding: US Core Vaccine Administered Value Set (CVX) (extensible)
.... targetDisease Σ0..1CodeableConceptDisease to be immunized against
Binding: ImmunizationRecommendationTargetDiseaseCodes (example)
.... contraindicatedVaccineCode Σ0..*CodeableConceptVaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example)
.... forecastStatus ?!Σ1..1CodeableConceptVaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example)
.... forecastReason Σ0..*CodeableConceptVaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example)
.... dateCriterion I0..*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)
..... value 1..1dateTimeRecommended date
.... description 0..1stringProtocol details
.... series 0..1stringName of vaccination series
.... doseNumber[x] Σ0..1Recommended dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring
.... supportingImmunization 0..*Reference(QICoreImmunization)Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(QICoreObservation | QICoreAllergyIntolerance)Patient observations supporting recommendation

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

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

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2ImmunizationRecommendationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4ImmunizationRecommendationIf 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-3ImmunizationRecommendationIf 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-6ImmunizationRecommendationA resource should have narrative for robust management
: text.div.exists()
dom-5ImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
ele-1ImmunizationRecommendation.recommendationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
imr-1ImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()
ele-1ImmunizationRecommendation.recommendation.dateCriterionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())