QI-Core Implementation Guide
7.0.0-ballot - STU7 Ballot United States of America flag

This page is part of the Quality Improvement Core Framework (v7.0.0-ballot: STU7 (v7.0.0) Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 6.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: QICore ImmunizationEvaluation

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunizationevaluation Version: 7.0.0-ballot
Active as of 2022-12-20 Computable Name: QICoreImmunizationEvaluation

Defines constraints and extensions on the ImmunizationEvaluation resource for the minimal set of data to query and retrieve a patient's Immunization Evaluation.

QI Elements:
  • identifier: (QI) Business identifier
  • status: (QI) completed | entered-in-error
  • patient: (QI) Who this evaluation is for
  • date: (QI) Date evaluation was performed
  • targetDisease: (QI) Evaluation target disease
  • immunizationEvent: (QI) Immunization being evaluated
  • doseStatus: (QI) Status of the dose relative to published recommendations
  • doseStatusReason: (QI) Reason for the dose status
Primary code path: targetDisease
(PCPath) This element is the primary code path for this resource CQL Retrieve


NOTE TO BALLOT REVIEWERS:
  • US Core 7.0, and thus QI-Core 7.0, has a new approach to USCDI requirements.
    • As noted in the US Core 7.0 Must Support section, US Core 7.0 no longer highlights mandatory (cardinality 1..* or 1..1) and Must Support elements with a (USCDI) indicator as such items must be supported for interoperability.
    • Those USCDI elements that are not mandatory or Must Support now include an indicator (ADDITIONAL USCDI) in US Core. QI-Core 7.0 does not reference USCDI elements; rather, users should access US Core 7.0 to understand its implementation of USCDI version 4.
  • We invite comments about the approach and suggestions for other options that would also avoid unnecessary noise or reading load to the QI-Core profile representation.
  • Further, QI-Core 7.0 does not discuss USCDI+Quality because at the time of ballot preparation, no published version of USCDI+Quality is available. We seek reviewer advice regarding how QI-Core might address future USCDI+Quality.

Usage

See the patterns page for implementation and usage patterns.

Examples

Example of immunization evaluation

Usage:

Formal Views of Profile Content

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

This structure is derived from ImmunizationEvaluation

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationEvaluation 0..* ImmunizationEvaluation Immunization evaluation information
... identifier 0..* Identifier (QI) Business identifier
... status 1..1 code (QI) completed | entered-in-error
... patient 1..1 Reference(QICore Patient) (QI) Who this evaluation is for
... authority 0..1 Reference(QICore Organization) Who is responsible for publishing the recommendations
... targetDisease 1..1 CodeableConcept (QI) Evaluation target disease
Binding: ImmunizationEvaluationTargetDiseaseCodes (preferred)
... immunizationEvent 1..1 Reference(QICore Immunization) (QI) Immunization being evaluated
... doseStatus 1..1 CodeableConcept (QI) Status of the dose relative to published recommendations
Binding: ImmunizationEvaluationDoseStatusCodes (preferred)
... doseStatusReason 0..* CodeableConcept (QI) Reason for the dose status
Binding: ImmunizationEvaluationDoseStatusCodes (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ImmunizationEvaluation.targetDiseasepreferredImmunizationEvaluationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-evaluation-target-disease
from the FHIR Standard
ImmunizationEvaluation.doseStatuspreferredImmunizationEvaluationDoseStatusCodes
http://hl7.org/fhir/ValueSet/immunization-evaluation-dose-status
from the FHIR Standard
ImmunizationEvaluation.doseStatusReasonpreferredImmunizationEvaluationDoseStatusCodes
http://hl7.org/fhir/ValueSet/immunization-evaluation-dose-status
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationEvaluation 0..* ImmunizationEvaluation Immunization evaluation information
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier (QI) Business identifier
... patient Σ 1..1 Reference(QICore Patient) (QI) Who this evaluation is for
... date 1..1 dateTime (QI) Date evaluation was performed
... authority 0..1 Reference(QICore Organization) Who is responsible for publishing the recommendations
... targetDisease Σ 1..1 CodeableConcept (QI) Evaluation target disease
Binding: ImmunizationEvaluationTargetDiseaseCodes (preferred)
... immunizationEvent Σ 1..1 Reference(QICore Immunization) (QI) Immunization being evaluated
... doseStatus Σ 1..1 CodeableConcept (QI) Status of the dose relative to published recommendations
Binding: ImmunizationEvaluationDoseStatusCodes (preferred)
... doseStatusReason 0..* CodeableConcept (QI) Reason for the dose status
Binding: ImmunizationEvaluationDoseStatusCodes (preferred)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImmunizationEvaluation.statusrequiredImmunizationEvaluationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-evaluation-status|4.0.1
from the FHIR Standard
ImmunizationEvaluation.targetDiseasepreferredImmunizationEvaluationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-evaluation-target-disease
from the FHIR Standard
ImmunizationEvaluation.doseStatuspreferredImmunizationEvaluationDoseStatusCodes
http://hl7.org/fhir/ValueSet/immunization-evaluation-dose-status
from the FHIR Standard
ImmunizationEvaluation.doseStatusReasonpreferredImmunizationEvaluationDoseStatusCodes
http://hl7.org/fhir/ValueSet/immunization-evaluation-dose-status
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationEvaluationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationEvaluationIf 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-4errorImmunizationEvaluationIf 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-5errorImmunizationEvaluationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationEvaluationA 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationEvaluation 0..* ImmunizationEvaluation Immunization evaluation information
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier (QI) Business identifier
... status ?!Σ 1..1 code (QI) completed | entered-in-error
Binding: ImmunizationEvaluationStatusCodes (required): The status of the evaluation being done.

... patient Σ 1..1 Reference(QICore Patient) (QI) Who this evaluation is for
... date 1..1 dateTime (QI) Date evaluation was performed
... authority 0..1 Reference(QICore Organization) Who is responsible for publishing the recommendations
... targetDisease Σ 1..1 CodeableConcept (QI) Evaluation target disease
Binding: ImmunizationEvaluationTargetDiseaseCodes (preferred)
... immunizationEvent Σ 1..1 Reference(QICore Immunization) (QI) Immunization being evaluated
... doseStatus Σ 1..1 CodeableConcept (QI) Status of the dose relative to published recommendations
Binding: ImmunizationEvaluationDoseStatusCodes (preferred)
... doseStatusReason 0..* CodeableConcept (QI) Reason for the dose status
Binding: ImmunizationEvaluationDoseStatusCodes (preferred)
... description 0..1 string Evaluation notes
... series 0..1 string Name of vaccine series
... doseNumber[x] 0..1 Dose number within series
.... doseNumberPositiveInt positiveInt
.... doseNumberString string
... seriesDoses[x] 0..1 Recommended number of doses for immunity
.... seriesDosesPositiveInt positiveInt
.... seriesDosesString string

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImmunizationEvaluation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ImmunizationEvaluation.statusrequiredImmunizationEvaluationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-evaluation-status|4.0.1
from the FHIR Standard
ImmunizationEvaluation.targetDiseasepreferredImmunizationEvaluationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-evaluation-target-disease
from the FHIR Standard
ImmunizationEvaluation.doseStatuspreferredImmunizationEvaluationDoseStatusCodes
http://hl7.org/fhir/ValueSet/immunization-evaluation-dose-status
from the FHIR Standard
ImmunizationEvaluation.doseStatusReasonpreferredImmunizationEvaluationDoseStatusCodes
http://hl7.org/fhir/ValueSet/immunization-evaluation-dose-status
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationEvaluationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationEvaluationIf 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-4errorImmunizationEvaluationIf 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-5errorImmunizationEvaluationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationEvaluationA 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()

Differential View

This structure is derived from ImmunizationEvaluation

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationEvaluation 0..* ImmunizationEvaluation Immunization evaluation information
... identifier 0..* Identifier (QI) Business identifier
... status 1..1 code (QI) completed | entered-in-error
... patient 1..1 Reference(QICore Patient) (QI) Who this evaluation is for
... authority 0..1 Reference(QICore Organization) Who is responsible for publishing the recommendations
... targetDisease 1..1 CodeableConcept (QI) Evaluation target disease
Binding: ImmunizationEvaluationTargetDiseaseCodes (preferred)
... immunizationEvent 1..1 Reference(QICore Immunization) (QI) Immunization being evaluated
... doseStatus 1..1 CodeableConcept (QI) Status of the dose relative to published recommendations
Binding: ImmunizationEvaluationDoseStatusCodes (preferred)
... doseStatusReason 0..* CodeableConcept (QI) Reason for the dose status
Binding: ImmunizationEvaluationDoseStatusCodes (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ImmunizationEvaluation.targetDiseasepreferredImmunizationEvaluationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-evaluation-target-disease
from the FHIR Standard
ImmunizationEvaluation.doseStatuspreferredImmunizationEvaluationDoseStatusCodes
http://hl7.org/fhir/ValueSet/immunization-evaluation-dose-status
from the FHIR Standard
ImmunizationEvaluation.doseStatusReasonpreferredImmunizationEvaluationDoseStatusCodes
http://hl7.org/fhir/ValueSet/immunization-evaluation-dose-status
from the FHIR Standard

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationEvaluation 0..* ImmunizationEvaluation Immunization evaluation information
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier (QI) Business identifier
... patient Σ 1..1 Reference(QICore Patient) (QI) Who this evaluation is for
... date 1..1 dateTime (QI) Date evaluation was performed
... authority 0..1 Reference(QICore Organization) Who is responsible for publishing the recommendations
... targetDisease Σ 1..1 CodeableConcept (QI) Evaluation target disease
Binding: ImmunizationEvaluationTargetDiseaseCodes (preferred)
... immunizationEvent Σ 1..1 Reference(QICore Immunization) (QI) Immunization being evaluated
... doseStatus Σ 1..1 CodeableConcept (QI) Status of the dose relative to published recommendations
Binding: ImmunizationEvaluationDoseStatusCodes (preferred)
... doseStatusReason 0..* CodeableConcept (QI) Reason for the dose status
Binding: ImmunizationEvaluationDoseStatusCodes (preferred)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImmunizationEvaluation.statusrequiredImmunizationEvaluationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-evaluation-status|4.0.1
from the FHIR Standard
ImmunizationEvaluation.targetDiseasepreferredImmunizationEvaluationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-evaluation-target-disease
from the FHIR Standard
ImmunizationEvaluation.doseStatuspreferredImmunizationEvaluationDoseStatusCodes
http://hl7.org/fhir/ValueSet/immunization-evaluation-dose-status
from the FHIR Standard
ImmunizationEvaluation.doseStatusReasonpreferredImmunizationEvaluationDoseStatusCodes
http://hl7.org/fhir/ValueSet/immunization-evaluation-dose-status
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationEvaluationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationEvaluationIf 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-4errorImmunizationEvaluationIf 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-5errorImmunizationEvaluationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationEvaluationA 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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationEvaluation 0..* ImmunizationEvaluation Immunization evaluation information
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier (QI) Business identifier
... status ?!Σ 1..1 code (QI) completed | entered-in-error
Binding: ImmunizationEvaluationStatusCodes (required): The status of the evaluation being done.

... patient Σ 1..1 Reference(QICore Patient) (QI) Who this evaluation is for
... date 1..1 dateTime (QI) Date evaluation was performed
... authority 0..1 Reference(QICore Organization) Who is responsible for publishing the recommendations
... targetDisease Σ 1..1 CodeableConcept (QI) Evaluation target disease
Binding: ImmunizationEvaluationTargetDiseaseCodes (preferred)
... immunizationEvent Σ 1..1 Reference(QICore Immunization) (QI) Immunization being evaluated
... doseStatus Σ 1..1 CodeableConcept (QI) Status of the dose relative to published recommendations
Binding: ImmunizationEvaluationDoseStatusCodes (preferred)
... doseStatusReason 0..* CodeableConcept (QI) Reason for the dose status
Binding: ImmunizationEvaluationDoseStatusCodes (preferred)
... description 0..1 string Evaluation notes
... series 0..1 string Name of vaccine series
... doseNumber[x] 0..1 Dose number within series
.... doseNumberPositiveInt positiveInt
.... doseNumberString string
... seriesDoses[x] 0..1 Recommended number of doses for immunity
.... seriesDosesPositiveInt positiveInt
.... seriesDosesString string

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImmunizationEvaluation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ImmunizationEvaluation.statusrequiredImmunizationEvaluationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-evaluation-status|4.0.1
from the FHIR Standard
ImmunizationEvaluation.targetDiseasepreferredImmunizationEvaluationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-evaluation-target-disease
from the FHIR Standard
ImmunizationEvaluation.doseStatuspreferredImmunizationEvaluationDoseStatusCodes
http://hl7.org/fhir/ValueSet/immunization-evaluation-dose-status
from the FHIR Standard
ImmunizationEvaluation.doseStatusReasonpreferredImmunizationEvaluationDoseStatusCodes
http://hl7.org/fhir/ValueSet/immunization-evaluation-dose-status
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationEvaluationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationEvaluationIf 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-4errorImmunizationEvaluationIf 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-5errorImmunizationEvaluationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationEvaluationA 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()

 

Other representations of profile: CSV, Excel, Schematron