US Quality Core Implementation Guide
0.1.0 - cibuild United States of America flag

US Quality Core Implementation Guide, published by ASTP. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/FHIR/us-quality-core/ and changes regularly. See the Directory of published versions

Resource Profile: US Quality Core ImmunizationEvaluation

Official URL: http://fhir.org/guides/astp/us-quality-core/StructureDefinition/us-quality-core-immunizationevaluation Version: 0.1.0
Active as of 2022-12-20 Computable Name: USQualityCoreImmunizationEvaluation

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

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 Business identifier
... patient Σ 1..1 Reference(US Quality Core Patient) Who this evaluation is for
... date 1..1 dateTime Date evaluation was performed
... authority 0..1 Reference(US Quality Core Organization) Who is responsible for publishing the recommendations
... targetDisease Σ 1..1 CodeableConcept Evaluation target disease
Binding: ImmunizationEvaluationTargetDiseaseCodes (preferred)
... immunizationEvent Σ 1..1 Reference(US Quality Core Immunization) Immunization being evaluated
... doseStatus Σ 1..1 CodeableConcept Status of the dose relative to published recommendations
Binding: ImmunizationEvaluationDoseStatusCodes (preferred)
... doseStatusReason 0..* CodeableConcept Reason for the dose status
Binding: ImmunizationEvaluationDoseStatusCodes (preferred)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImmunizationEvaluation.​status Base required Immunization Evaluation Status Codes 📍4.0.1 FHIR Std.
ImmunizationEvaluation.​targetDisease Base preferred Immunization Evaluation Target Disease Codes 📦4.0.1 FHIR Std.
ImmunizationEvaluation.​doseStatus Base preferred Immunization Evaluation Dose Status codes 📦4.0.1 FHIR Std.
ImmunizationEvaluation.​doseStatusReason Base preferred Immunization Evaluation Dose Status codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from ImmunizationEvaluation

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

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ImmunizationEvaluation.​targetDisease Base preferred Immunization Evaluation Target Disease Codes 📦4.0.1 FHIR Std.
ImmunizationEvaluation.​doseStatus Base preferred Immunization Evaluation Dose Status codes 📦4.0.1 FHIR Std.
ImmunizationEvaluation.​doseStatusReason Base preferred Immunization Evaluation Dose Status codes 📦4.0.1 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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 Business identifier
... status ?!Σ 1..1 code completed | entered-in-error
Binding: ImmunizationEvaluationStatusCodes (required): The status of the evaluation being done.
... patient Σ 1..1 Reference(US Quality Core Patient) Who this evaluation is for
... date 1..1 dateTime Date evaluation was performed
... authority 0..1 Reference(US Quality Core Organization) Who is responsible for publishing the recommendations
... targetDisease Σ 1..1 CodeableConcept Evaluation target disease
Binding: ImmunizationEvaluationTargetDiseaseCodes (preferred)
... immunizationEvent Σ 1..1 Reference(US Quality Core Immunization) Immunization being evaluated
... doseStatus Σ 1..1 CodeableConcept Status of the dose relative to published recommendations
Binding: ImmunizationEvaluationDoseStatusCodes (preferred)
... doseStatusReason 0..* CodeableConcept 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

Path Status Usage ValueSet Version Source
ImmunizationEvaluation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ImmunizationEvaluation.​status Base required Immunization Evaluation Status Codes 📍4.0.1 FHIR Std.
ImmunizationEvaluation.​targetDisease Base preferred Immunization Evaluation Target Disease Codes 📦4.0.1 FHIR Std.
ImmunizationEvaluation.​doseStatus Base preferred Immunization Evaluation Dose Status codes 📦4.0.1 FHIR Std.
ImmunizationEvaluation.​doseStatusReason Base preferred Immunization Evaluation Dose Status codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 Business identifier
... patient Σ 1..1 Reference(US Quality Core Patient) Who this evaluation is for
... date 1..1 dateTime Date evaluation was performed
... authority 0..1 Reference(US Quality Core Organization) Who is responsible for publishing the recommendations
... targetDisease Σ 1..1 CodeableConcept Evaluation target disease
Binding: ImmunizationEvaluationTargetDiseaseCodes (preferred)
... immunizationEvent Σ 1..1 Reference(US Quality Core Immunization) Immunization being evaluated
... doseStatus Σ 1..1 CodeableConcept Status of the dose relative to published recommendations
Binding: ImmunizationEvaluationDoseStatusCodes (preferred)
... doseStatusReason 0..* CodeableConcept Reason for the dose status
Binding: ImmunizationEvaluationDoseStatusCodes (preferred)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImmunizationEvaluation.​status Base required Immunization Evaluation Status Codes 📍4.0.1 FHIR Std.
ImmunizationEvaluation.​targetDisease Base preferred Immunization Evaluation Target Disease Codes 📦4.0.1 FHIR Std.
ImmunizationEvaluation.​doseStatus Base preferred Immunization Evaluation Dose Status codes 📦4.0.1 FHIR Std.
ImmunizationEvaluation.​doseStatusReason Base preferred Immunization Evaluation Dose Status codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from ImmunizationEvaluation

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

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ImmunizationEvaluation.​targetDisease Base preferred Immunization Evaluation Target Disease Codes 📦4.0.1 FHIR Std.
ImmunizationEvaluation.​doseStatus Base preferred Immunization Evaluation Dose Status codes 📦4.0.1 FHIR Std.
ImmunizationEvaluation.​doseStatusReason Base preferred Immunization Evaluation Dose Status codes 📦4.0.1 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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 Business identifier
... status ?!Σ 1..1 code completed | entered-in-error
Binding: ImmunizationEvaluationStatusCodes (required): The status of the evaluation being done.
... patient Σ 1..1 Reference(US Quality Core Patient) Who this evaluation is for
... date 1..1 dateTime Date evaluation was performed
... authority 0..1 Reference(US Quality Core Organization) Who is responsible for publishing the recommendations
... targetDisease Σ 1..1 CodeableConcept Evaluation target disease
Binding: ImmunizationEvaluationTargetDiseaseCodes (preferred)
... immunizationEvent Σ 1..1 Reference(US Quality Core Immunization) Immunization being evaluated
... doseStatus Σ 1..1 CodeableConcept Status of the dose relative to published recommendations
Binding: ImmunizationEvaluationDoseStatusCodes (preferred)
... doseStatusReason 0..* CodeableConcept 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

Path Status Usage ValueSet Version Source
ImmunizationEvaluation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ImmunizationEvaluation.​status Base required Immunization Evaluation Status Codes 📍4.0.1 FHIR Std.
ImmunizationEvaluation.​targetDisease Base preferred Immunization Evaluation Target Disease Codes 📦4.0.1 FHIR Std.
ImmunizationEvaluation.​doseStatus Base preferred Immunization Evaluation Dose Status codes 📦4.0.1 FHIR Std.
ImmunizationEvaluation.​doseStatusReason Base preferred Immunization Evaluation Dose Status codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron