This page is part of the Quality Improvement Core Framework (v6.0.0-ballot: STU6 (v6.0.0) Ballot 1) based on FHIR R4. The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: 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.

Usage:

• Refer to this Resource Profile: QICore ImmunizationRecommendation
• Examples for this Resource Profile: ImmunizationEvaluation/example

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

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(QICore Patient)	Who this evaluation is for
date	S	1..1	dateTime	Date evaluation was performed
authority		0..1	Reference(QICore Organization)	Who is responsible for publishing the recommendations
targetDisease	S	1..1	CodeableConcept	Evaluation target disease Binding: ImmunizationEvaluationTargetDiseaseCodes (preferred)
immunizationEvent	S	1..1	Reference(QICore Immunization)	Immunization being evaluated
doseStatus	S	1..1	CodeableConcept	Status of the dose relative to published recommendations Binding: ImmunizationEvaluationDoseStatusCodes (preferred)
doseStatusReason	S	0..*	CodeableConcept	Reason for the dose status Binding: ImmunizationEvaluationDoseStatusCodes (preferred)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
ImmunizationEvaluation.targetDisease	preferred	ImmunizationEvaluationTargetDiseaseCodes
ImmunizationEvaluation.doseStatus	preferred	ImmunizationEvaluationDoseStatusCodes
ImmunizationEvaluation.doseStatusReason	preferred	ImmunizationEvaluationDoseStatusCodes

Name	Flags	Card.	Type	Description & Constraints
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	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(QICore Patient)	Who this evaluation is for
date	S	1..1	dateTime	Date evaluation was performed
authority		0..1	Reference(QICore Organization)	Who is responsible for publishing the recommendations
targetDisease	SΣ	1..1	CodeableConcept	Evaluation target disease Binding: ImmunizationEvaluationTargetDiseaseCodes (preferred)
immunizationEvent	SΣ	1..1	Reference(QICore Immunization)	Immunization being evaluated
doseStatus	SΣ	1..1	CodeableConcept	Status of the dose relative to published recommendations Binding: ImmunizationEvaluationDoseStatusCodes (preferred)
doseStatusReason	S	0..*	CodeableConcept	Reason for the dose status Binding: ImmunizationEvaluationDoseStatusCodes (preferred)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
ImmunizationEvaluation.status	required	ImmunizationEvaluationStatusCodes
ImmunizationEvaluation.targetDisease	preferred	ImmunizationEvaluationTargetDiseaseCodes
ImmunizationEvaluation.doseStatus	preferred	ImmunizationEvaluationDoseStatusCodes
ImmunizationEvaluation.doseStatusReason	preferred	ImmunizationEvaluationDoseStatusCodes

Constraints

Id	Grade	Path(s)	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	**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()

Name	Flags	Card.	Type	Description & Constraints
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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(QICore Patient)	Who this evaluation is for
date	S	1..1	dateTime	Date evaluation was performed
authority		0..1	Reference(QICore Organization)	Who is responsible for publishing the recommendations
targetDisease	SΣ	1..1	CodeableConcept	Evaluation target disease Binding: ImmunizationEvaluationTargetDiseaseCodes (preferred)
immunizationEvent	SΣ	1..1	Reference(QICore Immunization)	Immunization being evaluated
doseStatus	SΣ	1..1	CodeableConcept	Status of the dose relative to published recommendations Binding: ImmunizationEvaluationDoseStatusCodes (preferred)
doseStatusReason	S	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
ImmunizationEvaluation.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
ImmunizationEvaluation.status	required	ImmunizationEvaluationStatusCodes
ImmunizationEvaluation.targetDisease	preferred	ImmunizationEvaluationTargetDiseaseCodes
ImmunizationEvaluation.doseStatus	preferred	ImmunizationEvaluationDoseStatusCodes
ImmunizationEvaluation.doseStatusReason	preferred	ImmunizationEvaluationDoseStatusCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Summary

Mandatory: 4 elements
Must-Support: 8 elements

Structures

This structure refers to these other structures:

• QICore Patient (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient)
• QICore Organization (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization)
• QICore Immunization (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(QICore Patient)	Who this evaluation is for
date	S	1..1	dateTime	Date evaluation was performed
authority		0..1	Reference(QICore Organization)	Who is responsible for publishing the recommendations
targetDisease	S	1..1	CodeableConcept	Evaluation target disease Binding: ImmunizationEvaluationTargetDiseaseCodes (preferred)
immunizationEvent	S	1..1	Reference(QICore Immunization)	Immunization being evaluated
doseStatus	S	1..1	CodeableConcept	Status of the dose relative to published recommendations Binding: ImmunizationEvaluationDoseStatusCodes (preferred)
doseStatusReason	S	0..*	CodeableConcept	Reason for the dose status Binding: ImmunizationEvaluationDoseStatusCodes (preferred)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
ImmunizationEvaluation.targetDisease	preferred	ImmunizationEvaluationTargetDiseaseCodes
ImmunizationEvaluation.doseStatus	preferred	ImmunizationEvaluationDoseStatusCodes
ImmunizationEvaluation.doseStatusReason	preferred	ImmunizationEvaluationDoseStatusCodes

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
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	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(QICore Patient)	Who this evaluation is for
date	S	1..1	dateTime	Date evaluation was performed
authority		0..1	Reference(QICore Organization)	Who is responsible for publishing the recommendations
targetDisease	SΣ	1..1	CodeableConcept	Evaluation target disease Binding: ImmunizationEvaluationTargetDiseaseCodes (preferred)
immunizationEvent	SΣ	1..1	Reference(QICore Immunization)	Immunization being evaluated
doseStatus	SΣ	1..1	CodeableConcept	Status of the dose relative to published recommendations Binding: ImmunizationEvaluationDoseStatusCodes (preferred)
doseStatusReason	S	0..*	CodeableConcept	Reason for the dose status Binding: ImmunizationEvaluationDoseStatusCodes (preferred)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
ImmunizationEvaluation.status	required	ImmunizationEvaluationStatusCodes
ImmunizationEvaluation.targetDisease	preferred	ImmunizationEvaluationTargetDiseaseCodes
ImmunizationEvaluation.doseStatus	preferred	ImmunizationEvaluationDoseStatusCodes
ImmunizationEvaluation.doseStatusReason	preferred	ImmunizationEvaluationDoseStatusCodes

Constraints

Id	Grade	Path(s)	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	**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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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(QICore Patient)	Who this evaluation is for
date	S	1..1	dateTime	Date evaluation was performed
authority		0..1	Reference(QICore Organization)	Who is responsible for publishing the recommendations
targetDisease	SΣ	1..1	CodeableConcept	Evaluation target disease Binding: ImmunizationEvaluationTargetDiseaseCodes (preferred)
immunizationEvent	SΣ	1..1	Reference(QICore Immunization)	Immunization being evaluated
doseStatus	SΣ	1..1	CodeableConcept	Status of the dose relative to published recommendations Binding: ImmunizationEvaluationDoseStatusCodes (preferred)
doseStatusReason	S	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
ImmunizationEvaluation.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
ImmunizationEvaluation.status	required	ImmunizationEvaluationStatusCodes
ImmunizationEvaluation.targetDisease	preferred	ImmunizationEvaluationTargetDiseaseCodes
ImmunizationEvaluation.doseStatus	preferred	ImmunizationEvaluationDoseStatusCodes
ImmunizationEvaluation.doseStatusReason	preferred	ImmunizationEvaluationDoseStatusCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Summary

Mandatory: 4 elements
Must-Support: 8 elements

Structures

This structure refers to these other structures:

• QICore Patient (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient)
• QICore Organization (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization)
• QICore Immunization (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunization)

Other representations of profile: CSV, Excel, Schematron