QI-Core Implementation Guide
4.1.0 - release

Publication Build: This will be filled in by the publication tooling

## Resource Profile: QICoreImmunizationEvaluation

Defining URL: | http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunizationevaluation
Version: | 4.1.0
Name: | QICoreImmunizationEvaluation
Status: | Draft as of 7/28/19
Definition: | Defines constraints and extensions on the ImmunizationEvaluation resource for the minimal set of data to query and retrieve a patient's Immunization Evaluation.
Publisher: | http://www.hl7.org/Special/committees/cqi/index.cfm
Source Resource: | XML / JSON / Turtle

The official URL for this profile is:

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

Usage

See the patterns page for implementation and usage patterns.

### Examples

Example of immunization evaluation

### Formal Views of Profile Content

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

- Text Summary
- Differential Table
- Snapshot Table
- Snapshot Table (Must Support)
- All

This structure is derived from ImmunizationEvaluation

Summary

Mandatory: 4 elements
Must-Support: 8 elements

Structures

This structure refers to these other structures:

- QICorePatient (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient)
- QICoreOrganization (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization)
- QICoreImmunization (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunization)

This structure is derived from ImmunizationEvaluation

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ImmunizationEvaluation |  | 0..* | ImmunizationEvaluation | Immunization evaluation information
identifier | S | 0..* | Identifier | Business identifier
status | S | 1..1 | code | completed | entered-in-error
patient | S | 1..1 | Reference(QICorePatient) | Who this evaluation is for
date | S | 1..1 | dateTime | Date evaluation was performed
authority |  | 0..1 | Reference(QICoreOrganization) | Who is responsible for publishing the recommendations
targetDisease | S | 1..1 | CodeableConcept | Evaluation target disease
immunizationEvent | S | 1..1 | Reference(QICoreImmunization) | Immunization being evaluated
doseStatus | S | 1..1 | CodeableConcept | Status of the dose relative to published recommendations
doseStatusReason | S | 0..* | CodeableConcept | Reason for the dose status
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ImmunizationEvaluation |  | 0..* | ImmunizationEvaluation | Immunization evaluation information
id | Σ | 0..1 | string | 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
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language.
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 | S | 0..* | Identifier | Business identifier
status | ?!S Σ | 1..1 | code | completed | entered-in-error Binding: ImmunizationEvaluationStatusCodes (required): The status of the evaluation being done.
patient | S Σ | 1..1 | Reference(QICorePatient) | Who this evaluation is for
date | S | 1..1 | dateTime | Date evaluation was performed
authority |  | 0..1 | Reference(QICoreOrganization) | Who is responsible for publishing the recommendations
targetDisease | S Σ | 1..1 | CodeableConcept | Evaluation target disease Binding: ImmunizationEvaluationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being evaluated against.
immunizationEvent | S Σ | 1..1 | Reference(QICoreImmunization) | Immunization being evaluated
doseStatus | S Σ | 1..1 | CodeableConcept | Status 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 | S | 0..* | CodeableConcept | Reason for the dose status Binding: ImmunizationEvaluationDoseStatusReasonCodes (example): The reason the dose status was assigned.
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 |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ImmunizationEvaluation |  | 0..* | ImmunizationEvaluation | Immunization evaluation information
identifier |  | 0..* | Identifier | Business identifier
status | ?!Σ | 1..1 | code | completed | entered-in-error Binding: ImmunizationEvaluationStatusCodes (required): The status of the evaluation being done.
patient | Σ | 1..1 | Reference(QICorePatient) | Who this evaluation is for
date |  | 1..1 | dateTime | Date evaluation was performed
targetDisease | Σ | 1..1 | CodeableConcept | Evaluation target disease Binding: ImmunizationEvaluationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being evaluated against.
immunizationEvent | Σ | 1..1 | Reference(QICoreImmunization) | Immunization being evaluated
doseStatus | Σ | 1..1 | CodeableConcept | Status 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..* | CodeableConcept | Reason for the dose status Binding: ImmunizationEvaluationDoseStatusReasonCodes (example): The reason the dose status was assigned.
Documentation for this format

This structure is derived from ImmunizationEvaluation

Summary

Mandatory: 4 elements
Must-Support: 8 elements

Structures

This structure refers to these other structures:

- QICorePatient (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient)
- QICoreOrganization (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization)
- QICoreImmunization (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunization)

Differential View

This structure is derived from ImmunizationEvaluation

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ImmunizationEvaluation |  | 0..* | ImmunizationEvaluation | Immunization evaluation information
identifier | S | 0..* | Identifier | Business identifier
status | S | 1..1 | code | completed | entered-in-error
patient | S | 1..1 | Reference(QICorePatient) | Who this evaluation is for
date | S | 1..1 | dateTime | Date evaluation was performed
authority |  | 0..1 | Reference(QICoreOrganization) | Who is responsible for publishing the recommendations
targetDisease | S | 1..1 | CodeableConcept | Evaluation target disease
immunizationEvent | S | 1..1 | Reference(QICoreImmunization) | Immunization being evaluated
doseStatus | S | 1..1 | CodeableConcept | Status of the dose relative to published recommendations
doseStatusReason | S | 0..* | CodeableConcept | Reason for the dose status
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ImmunizationEvaluation |  | 0..* | ImmunizationEvaluation | Immunization evaluation information
id | Σ | 0..1 | string | 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
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language.
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 | S | 0..* | Identifier | Business identifier
status | ?!S Σ | 1..1 | code | completed | entered-in-error Binding: ImmunizationEvaluationStatusCodes (required): The status of the evaluation being done.
patient | S Σ | 1..1 | Reference(QICorePatient) | Who this evaluation is for
date | S | 1..1 | dateTime | Date evaluation was performed
authority |  | 0..1 | Reference(QICoreOrganization) | Who is responsible for publishing the recommendations
targetDisease | S Σ | 1..1 | CodeableConcept | Evaluation target disease Binding: ImmunizationEvaluationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being evaluated against.
immunizationEvent | S Σ | 1..1 | Reference(QICoreImmunization) | Immunization being evaluated
doseStatus | S Σ | 1..1 | CodeableConcept | Status 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 | S | 0..* | CodeableConcept | Reason for the dose status Binding: ImmunizationEvaluationDoseStatusReasonCodes (example): The reason the dose status was assigned.
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 |
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

#### Terminology Bindings

Path | Conformance | ValueSet
ImmunizationEvaluation.language | preferred | CommonLanguages Max Binding: AllLanguages
ImmunizationEvaluation.status | required | ImmunizationEvaluationStatusCodes
ImmunizationEvaluation.targetDisease | example | ImmunizationEvaluationTargetDiseaseCodes
ImmunizationEvaluation.doseStatus | example | ImmunizationEvaluationDoseStatusCodes
ImmunizationEvaluation.doseStatusReason | example | ImmunizationEvaluationDoseStatusReasonCodes

#### Constraints

Id | Grade | Path | Details | Requirements
dom-2 | error | ImmunizationEvaluation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | ImmunizationEvaluation | If 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-4 | error | ImmunizationEvaluation | If 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-5 | error | ImmunizationEvaluation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | Best Practice | ImmunizationEvaluation | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | ImmunizationEvaluation.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | ImmunizationEvaluation.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | ImmunizationEvaluation.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | ImmunizationEvaluation.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | ImmunizationEvaluation.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | ImmunizationEvaluation.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | ImmunizationEvaluation.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | ImmunizationEvaluation.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | ImmunizationEvaluation.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | ImmunizationEvaluation.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | ImmunizationEvaluation.patient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | ImmunizationEvaluation.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | ImmunizationEvaluation.authority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | ImmunizationEvaluation.targetDisease | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | ImmunizationEvaluation.immunizationEvent | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | ImmunizationEvaluation.doseStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | ImmunizationEvaluation.doseStatusReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | ImmunizationEvaluation.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | ImmunizationEvaluation.series | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | ImmunizationEvaluation.doseNumber[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | ImmunizationEvaluation.seriesDoses[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |