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-immunizationevaluation

Introduction:

See the patterns page for implementation and usage patterns.

Examples:

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

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

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

This profile builds on ImmunizationEvaluation.

This profile was published on Sun Jul 28 00:00:00 EDT 2019 as a draft by Health Level Seven, Inc. - CQI WG.

Description of Profiles, Differentials, and Snapshots.

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationEvaluation 0..*
... identifier S0..*Identifier
... status S1..1code
... patient S1..1Reference(QICorePatient)
... date S1..1dateTime
... authority 0..1Reference(QICoreOrganization)
... targetDisease S1..1CodeableConcept
... immunizationEvent S1..1Reference(QICoreImmunization)
... doseStatus S1..1CodeableConcept
... doseStatusReason S0..*CodeableConcept

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationEvaluation I0..*Immunization evaluation information
... 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 S0..*IdentifierBusiness identifier
... status ?!SΣ1..1codecompleted | entered-in-error
Binding: ImmunizationEvaluationStatusCodes (required)
... patient SΣ1..1Reference(QICorePatient)Who this evaluation is for
... date S1..1dateTimeDate evaluation was performed
... authority 0..1Reference(QICoreOrganization)Who is responsible for publishing the recommendations
... targetDisease SΣ1..1CodeableConceptEvaluation target disease
Binding: ImmunizationEvaluationTargetDiseaseCodes (example)
... immunizationEvent SΣ1..1Reference(QICoreImmunization)Immunization being evaluated
... doseStatus SΣ1..1CodeableConceptStatus of the dose relative to published recommendations
Binding: ImmunizationEvaluationDoseStatusCodes (example)
... doseStatusReason S0..*CodeableConceptReason for the dose status
Binding: ImmunizationEvaluationDoseStatusReasonCodes (example)
... description 0..1stringEvaluation notes
... series 0..1stringName of vaccine series
... doseNumber[x] 0..1Dose number within series
.... doseNumberPositiveIntpositiveInt
.... doseNumberStringstring
... seriesDoses[x] 0..1Recommended number of doses for immunity
.... seriesDosesPositiveIntpositiveInt
.... seriesDosesStringstring

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationEvaluation 0..*
... identifier S0..*Identifier
... status S1..1code
... patient S1..1Reference(QICorePatient)
... date S1..1dateTime
... authority 0..1Reference(QICoreOrganization)
... targetDisease S1..1CodeableConcept
... immunizationEvent S1..1Reference(QICoreImmunization)
... doseStatus S1..1CodeableConcept
... doseStatusReason S0..*CodeableConcept

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationEvaluation I0..*Immunization evaluation information
... 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 S0..*IdentifierBusiness identifier
... status ?!SΣ1..1codecompleted | entered-in-error
Binding: ImmunizationEvaluationStatusCodes (required)
... patient SΣ1..1Reference(QICorePatient)Who this evaluation is for
... date S1..1dateTimeDate evaluation was performed
... authority 0..1Reference(QICoreOrganization)Who is responsible for publishing the recommendations
... targetDisease SΣ1..1CodeableConceptEvaluation target disease
Binding: ImmunizationEvaluationTargetDiseaseCodes (example)
... immunizationEvent SΣ1..1Reference(QICoreImmunization)Immunization being evaluated
... doseStatus SΣ1..1CodeableConceptStatus of the dose relative to published recommendations
Binding: ImmunizationEvaluationDoseStatusCodes (example)
... doseStatusReason S0..*CodeableConceptReason for the dose status
Binding: ImmunizationEvaluationDoseStatusReasonCodes (example)
... description 0..1stringEvaluation notes
... series 0..1stringName of vaccine series
... doseNumber[x] 0..1Dose number within series
.... doseNumberPositiveIntpositiveInt
.... doseNumberStringstring
... seriesDoses[x] 0..1Recommended number of doses for immunity
.... seriesDosesPositiveIntpositiveInt
.... seriesDosesStringstring

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
ImmunizationEvaluation.languagepreferredCommonLanguages
Max Binding: AllLanguages
ImmunizationEvaluation.statusrequiredImmunizationEvaluationStatusCodes
ImmunizationEvaluation.targetDiseaseexampleImmunizationEvaluationTargetDiseaseCodes
ImmunizationEvaluation.doseStatusexampleImmunizationEvaluationDoseStatusCodes
ImmunizationEvaluation.doseStatusReasonexampleImmunizationEvaluationDoseStatusReasonCodes

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2ImmunizationEvaluationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4ImmunizationEvaluationIf 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-3ImmunizationEvaluationIf 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-6ImmunizationEvaluationA resource should have narrative for robust management
: text.div.exists()
dom-5ImmunizationEvaluationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()