QI-Core Implementation Guide
5.0.0-ballot - STU Ballot
US
This page is part of the Quality Improvement Core Framework (v5.0.0-ballot: STU 5 Ballot) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 7.0.1. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunizationevaluation | Version: 5.0.0-ballot | |||
| Active as of 2022-08-04 | 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.
| Example of immunization evaluation |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ImmunizationEvaluation
This structure is derived from ImmunizationEvaluation
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | ImmunizationEvaluation | Immunization evaluation information | |
![]() ![]() | S | 0..* | Identifier | Business identifier |
![]() ![]() | S | 1..1 | code | completed | entered-in-error |
![]() ![]() | S | 1..1 | Reference(QICorePatient) | Who this evaluation is for |
![]() ![]() | S | 1..1 | dateTime | Date evaluation was performed |
![]() ![]() | 0..1 | Reference(QICoreOrganization) | Who is responsible for publishing the recommendations | |
![]() ![]() | S | 1..1 | CodeableConcept | Evaluation target disease Binding: ImmunizationEvaluationTargetDiseaseCodes (preferred) |
![]() ![]() | S | 1..1 | Reference(QICore Immunization) | Immunization being evaluated |
![]() ![]() | S | 1..1 | CodeableConcept | Status of the dose relative to published recommendations Binding: ImmunizationEvaluationDoseStatusCodes (preferred) |
![]() ![]() | S | 0..* | CodeableConcept | Reason for the dose status Binding: ImmunizationEvaluationDoseStatusCodes (preferred) |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() | 0..* | ImmunizationEvaluation | Immunization evaluation information | |||||
![]() ![]() | Σ | 0..1 | string | Logical id of this artifact | ||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() | S | 0..* | Identifier | Business identifier | ||||
![]() ![]() | ?!SΣ | 1..1 | code | completed | entered-in-error Binding: ImmunizationEvaluationStatusCodes (required): The status of the evaluation being done. | ||||
![]() ![]() | SΣ | 1..1 | Reference(QICorePatient) | Who this evaluation is for | ||||
![]() ![]() | S | 1..1 | dateTime | Date evaluation was performed | ||||
![]() ![]() | 0..1 | Reference(QICoreOrganization) | Who is responsible for publishing the recommendations | |||||
![]() ![]() | SΣ | 1..1 | CodeableConcept | Evaluation target disease Binding: ImmunizationEvaluationTargetDiseaseCodes (preferred) | ||||
![]() ![]() | SΣ | 1..1 | Reference(QICore Immunization) | Immunization being evaluated | ||||
![]() ![]() | SΣ | 1..1 | CodeableConcept | Status of the dose relative to published recommendations Binding: ImmunizationEvaluationDoseStatusCodes (preferred) | ||||
![]() ![]() | S | 0..* | CodeableConcept | Reason for the dose status Binding: ImmunizationEvaluationDoseStatusCodes (preferred) | ||||
![]() ![]() | 0..1 | string | Evaluation notes | |||||
![]() ![]() | 0..1 | string | Name of vaccine series | |||||
![]() ![]() | 0..1 | Dose number within series | ||||||
![]() ![]() ![]() | positiveInt | |||||||
![]() ![]() ![]() | string | |||||||
![]() ![]() | 0..1 | Recommended number of doses for immunity | ||||||
![]() ![]() ![]() | positiveInt | |||||||
![]() ![]() ![]() | string | |||||||
Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | ImmunizationEvaluation | Immunization evaluation information | |
![]() ![]() | 0..* | Identifier | Business identifier | |
![]() ![]() | ?!Σ | 1..1 | code | completed | entered-in-error Binding: ImmunizationEvaluationStatusCodes (required): The status of the evaluation being done. |
![]() ![]() | Σ | 1..1 | Reference(QICorePatient) | Who this evaluation is for |
![]() ![]() | 1..1 | dateTime | Date evaluation was performed | |
![]() ![]() | Σ | 1..1 | CodeableConcept | Evaluation target disease Binding: ImmunizationEvaluationTargetDiseaseCodes (preferred) |
![]() ![]() | Σ | 1..1 | Reference(QICore Immunization) | Immunization being evaluated |
![]() ![]() | Σ | 1..1 | CodeableConcept | Status of the dose relative to published recommendations Binding: ImmunizationEvaluationDoseStatusCodes (preferred) |
![]() ![]() | 0..* | CodeableConcept | Reason for the dose status Binding: ImmunizationEvaluationDoseStatusCodes (preferred) | |
Documentation for this format | ||||
This structure is derived from ImmunizationEvaluation
Differential View
This structure is derived from ImmunizationEvaluation
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | ImmunizationEvaluation | Immunization evaluation information | |
![]() ![]() | S | 0..* | Identifier | Business identifier |
![]() ![]() | S | 1..1 | code | completed | entered-in-error |
![]() ![]() | S | 1..1 | Reference(QICorePatient) | Who this evaluation is for |
![]() ![]() | S | 1..1 | dateTime | Date evaluation was performed |
![]() ![]() | 0..1 | Reference(QICoreOrganization) | Who is responsible for publishing the recommendations | |
![]() ![]() | S | 1..1 | CodeableConcept | Evaluation target disease Binding: ImmunizationEvaluationTargetDiseaseCodes (preferred) |
![]() ![]() | S | 1..1 | Reference(QICore Immunization) | Immunization being evaluated |
![]() ![]() | S | 1..1 | CodeableConcept | Status of the dose relative to published recommendations Binding: ImmunizationEvaluationDoseStatusCodes (preferred) |
![]() ![]() | S | 0..* | CodeableConcept | Reason for the dose status Binding: ImmunizationEvaluationDoseStatusCodes (preferred) |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() | 0..* | ImmunizationEvaluation | Immunization evaluation information | |||||
![]() ![]() | Σ | 0..1 | string | Logical id of this artifact | ||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() | S | 0..* | Identifier | Business identifier | ||||
![]() ![]() | ?!SΣ | 1..1 | code | completed | entered-in-error Binding: ImmunizationEvaluationStatusCodes (required): The status of the evaluation being done. | ||||
![]() ![]() | SΣ | 1..1 | Reference(QICorePatient) | Who this evaluation is for | ||||
![]() ![]() | S | 1..1 | dateTime | Date evaluation was performed | ||||
![]() ![]() | 0..1 | Reference(QICoreOrganization) | Who is responsible for publishing the recommendations | |||||
![]() ![]() | SΣ | 1..1 | CodeableConcept | Evaluation target disease Binding: ImmunizationEvaluationTargetDiseaseCodes (preferred) | ||||
![]() ![]() | SΣ | 1..1 | Reference(QICore Immunization) | Immunization being evaluated | ||||
![]() ![]() | SΣ | 1..1 | CodeableConcept | Status of the dose relative to published recommendations Binding: ImmunizationEvaluationDoseStatusCodes (preferred) | ||||
![]() ![]() | S | 0..* | CodeableConcept | Reason for the dose status Binding: ImmunizationEvaluationDoseStatusCodes (preferred) | ||||
![]() ![]() | 0..1 | string | Evaluation notes | |||||
![]() ![]() | 0..1 | string | Name of vaccine series | |||||
![]() ![]() | 0..1 | Dose number within series | ||||||
![]() ![]() ![]() | positiveInt | |||||||
![]() ![]() ![]() | string | |||||||
![]() ![]() | 0..1 | Recommended number of doses for immunity | ||||||
![]() ![]() ![]() | positiveInt | |||||||
![]() ![]() ![]() | string | |||||||
Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| ImmunizationEvaluation.language | preferred | CommonLanguages Max Binding: AllLanguages |
| ImmunizationEvaluation.status | required | ImmunizationEvaluationStatusCodes |
| ImmunizationEvaluation.targetDisease | preferred | ImmunizationEvaluationTargetDiseaseCodes |
| ImmunizationEvaluation.doseStatus | preferred | ImmunizationEvaluationDoseStatusCodes |
| ImmunizationEvaluation.doseStatusReason | preferred | ImmunizationEvaluationDoseStatusCodes |
| 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()) |