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: QICoreImmunizationEvaluation

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunizationevaluation Version: 4.1.1
Draft as of 2019-07-28 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.

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..*ImmunizationEvaluationImmunization evaluation information
... identifier S0..*IdentifierBusiness identifier
... status S1..1codecompleted | entered-in-error
... patient S1..1Reference(QICorePatient)Who this evaluation is for
... authority 0..1Reference(QICoreOrganization)Who is responsible for publishing the recommendations
... targetDisease S1..1CodeableConceptEvaluation target disease
... immunizationEvent S1..1Reference(QICoreImmunization)Immunization being evaluated
... doseStatus S1..1CodeableConceptStatus of the dose relative to published recommendations
... doseStatusReason S0..*CodeableConceptReason for the dose status

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationEvaluation 0..*ImmunizationEvaluationImmunization evaluation information
... 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 S0..*IdentifierBusiness identifier
... status ?!SΣ1..1codecompleted | entered-in-error
Binding: ImmunizationEvaluationStatusCodes (required): The status of the evaluation being done.

... 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): The vaccine preventable disease the dose is being evaluated against.

... immunizationEvent SΣ1..1Reference(QICoreImmunization)Immunization being evaluated
... doseStatus SΣ1..1CodeableConceptStatus of the dose relative to published recommendations
Binding: ImmunizationEvaluationDoseStatusCodes (example): The status of the administered dose relative to the published recommendations for the target disease.

... doseStatusReason S0..*CodeableConceptReason for the dose status
Binding: ImmunizationEvaluationDoseStatusReasonCodes (example): The reason the dose status was assigned.


... 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationEvaluation 0..*ImmunizationEvaluationImmunization evaluation information
... identifier 0..*IdentifierBusiness identifier
... status ?!Σ1..1codecompleted | entered-in-error
Binding: ImmunizationEvaluationStatusCodes (required): The status of the evaluation being done.

... patient Σ1..1Reference(QICorePatient)Who this evaluation is for
... targetDisease Σ1..1CodeableConceptEvaluation target disease
Binding: ImmunizationEvaluationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being evaluated against.

... immunizationEvent Σ1..1Reference(QICoreImmunization)Immunization being evaluated
... doseStatus Σ1..1CodeableConceptStatus of the dose relative to published recommendations
Binding: ImmunizationEvaluationDoseStatusCodes (example): The status of the administered dose relative to the published recommendations for the target disease.

... doseStatusReason 0..*CodeableConceptReason for the dose status
Binding: ImmunizationEvaluationDoseStatusReasonCodes (example): The reason the dose status was assigned.



doco Documentation for this format

Differential View

This structure is derived from ImmunizationEvaluation

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationEvaluation 0..*ImmunizationEvaluationImmunization evaluation information
... identifier S0..*IdentifierBusiness identifier
... status S1..1codecompleted | entered-in-error
... patient S1..1Reference(QICorePatient)Who this evaluation is for
... authority 0..1Reference(QICoreOrganization)Who is responsible for publishing the recommendations
... targetDisease S1..1CodeableConceptEvaluation target disease
... immunizationEvent S1..1Reference(QICoreImmunization)Immunization being evaluated
... doseStatus S1..1CodeableConceptStatus of the dose relative to published recommendations
... doseStatusReason S0..*CodeableConceptReason for the dose status

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationEvaluation 0..*ImmunizationEvaluationImmunization evaluation information
... 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 S0..*IdentifierBusiness identifier
... status ?!SΣ1..1codecompleted | entered-in-error
Binding: ImmunizationEvaluationStatusCodes (required): The status of the evaluation being done.

... 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): The vaccine preventable disease the dose is being evaluated against.

... immunizationEvent SΣ1..1Reference(QICoreImmunization)Immunization being evaluated
... doseStatus SΣ1..1CodeableConceptStatus of the dose relative to published recommendations
Binding: ImmunizationEvaluationDoseStatusCodes (example): The status of the administered dose relative to the published recommendations for the target disease.

... doseStatusReason S0..*CodeableConceptReason for the dose status
Binding: ImmunizationEvaluationDoseStatusReasonCodes (example): The reason the dose status was assigned.


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

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

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

Constraints

IdGradePathDetailsRequirements
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-1errorImmunizationEvaluation.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationEvaluation.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationEvaluation.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationEvaluation.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationEvaluation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorImmunizationEvaluation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorImmunizationEvaluation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorImmunizationEvaluation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorImmunizationEvaluation.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationEvaluation.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationEvaluation.patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationEvaluation.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationEvaluation.authorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationEvaluation.targetDiseaseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationEvaluation.immunizationEventAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationEvaluation.doseStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationEvaluation.doseStatusReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationEvaluation.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationEvaluation.seriesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationEvaluation.doseNumber[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunizationEvaluation.seriesDoses[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())