Using CQL with FHIR, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cql-ig/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON

Resource Profile: CQL Evaluation Result

The CQL Evaluation Result profile supports using the dataAbsentReason extension to indicate null evaluation results from operations.

Usage:

• Examples for this Resource Profile: Parameters/cql-evaluationresult-example and Parameters/cql-typemappingexampleresult

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 Parameters

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	Parameters	Operation Request or Response
parameter	S	0..*	BackboneElement	Operation Parameter
Slices for extension				Content/Rules for all slices
cqlType	S	0..1	string	What CQL type URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlType
name	S	1..1	string	Name from the definition
value[x]	S	0..1	base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta	If parameter is a data type
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
valueCode		1..1	code	Value of extension Fixed Value: unknown
isEmptyList	S	0..1	boolean	Empty list URL: http://hl7.org/fhir/StructureDefinition/cqf-isEmptyList
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	Parameters	Operation Request or Response
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
parameter	SΣC	0..*	BackboneElement	Operation Parameter ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
Slices for extension				Content/Rules for all slices
cqlType	S	0..1	string	What CQL type URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlType ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	SΣ	1..1	string	Name from the definition ele-1: All FHIR elements must have a @value or children
value[x]	SΣC	0..1		If parameter is a data type ele-1: All FHIR elements must have a @value or children
value[x]All Types				Content/Rules for all Types
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
Slices for value[x]		1..1	code	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children
value[x]:valueCode		1..1	code	Value of extension Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children Fixed Value: unknown
isEmptyList	S	0..1	boolean	Empty list URL: http://hl7.org/fhir/StructureDefinition/cqf-isEmptyList ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Parameters.parameter.value[x].extension:dataAbsentReason.value[x]	required	DataAbsentReason http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Parameters.parameter.value[x].extension:dataAbsentReason.value[x]:valueCode	required	Fixed Value: unknown http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard

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()
inv-1	error	Parameters.parameter	A parameter must have one and only one of (value, resource, part) : (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	Parameters	Operation Request or Response
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
parameter	SΣC	0..*	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
cqlType	S	0..1	string	What CQL type URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlType
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	SΣ	1..1	string	Name from the definition
value[x]	SΣC	0..1		If parameter is a data type
value[x]All Types				Content/Rules for all Types
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
Slices for value[x]		1..1	code	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required)
value[x]:valueCode		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: unknown
isEmptyList	S	0..1	boolean	Empty list URL: http://hl7.org/fhir/StructureDefinition/cqf-isEmptyList
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Parameters.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Parameters.parameter.value[x].extension:dataAbsentReason.value[x]	required	DataAbsentReason http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Parameters.parameter.value[x].extension:dataAbsentReason.value[x]:valueCode	required	Fixed Value: unknown http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard

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()
inv-1	error	Parameters.parameter	A parameter must have one and only one of (value, resource, part) : (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

This structure is derived from Parameters

Summary

Mandatory: 0 element(1 nested mandatory element)
Must-Support: 6 elements
Fixed: 1 element

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/cqf-cqlType
• http://hl7.org/fhir/StructureDefinition/data-absent-reason
• http://hl7.org/fhir/StructureDefinition/cqf-isEmptyList

Maturity: 1

Differential View

This structure is derived from Parameters

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	Parameters	Operation Request or Response
parameter	S	0..*	BackboneElement	Operation Parameter
Slices for extension				Content/Rules for all slices
cqlType	S	0..1	string	What CQL type URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlType
name	S	1..1	string	Name from the definition
value[x]	S	0..1	base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta	If parameter is a data type
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
valueCode		1..1	code	Value of extension Fixed Value: unknown
isEmptyList	S	0..1	boolean	Empty list URL: http://hl7.org/fhir/StructureDefinition/cqf-isEmptyList
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	Parameters	Operation Request or Response
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
parameter	SΣC	0..*	BackboneElement	Operation Parameter ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
Slices for extension				Content/Rules for all slices
cqlType	S	0..1	string	What CQL type URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlType ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	SΣ	1..1	string	Name from the definition ele-1: All FHIR elements must have a @value or children
value[x]	SΣC	0..1		If parameter is a data type ele-1: All FHIR elements must have a @value or children
value[x]All Types				Content/Rules for all Types
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
Slices for value[x]		1..1	code	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children
value[x]:valueCode		1..1	code	Value of extension Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children Fixed Value: unknown
isEmptyList	S	0..1	boolean	Empty list URL: http://hl7.org/fhir/StructureDefinition/cqf-isEmptyList ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Parameters.parameter.value[x].extension:dataAbsentReason.value[x]	required	DataAbsentReason http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Parameters.parameter.value[x].extension:dataAbsentReason.value[x]:valueCode	required	Fixed Value: unknown http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard

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()
inv-1	error	Parameters.parameter	A parameter must have one and only one of (value, resource, part) : (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	Parameters	Operation Request or Response
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
parameter	SΣC	0..*	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
cqlType	S	0..1	string	What CQL type URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlType
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	SΣ	1..1	string	Name from the definition
value[x]	SΣC	0..1		If parameter is a data type
value[x]All Types				Content/Rules for all Types
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
Slices for value[x]		1..1	code	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required)
value[x]:valueCode		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: unknown
isEmptyList	S	0..1	boolean	Empty list URL: http://hl7.org/fhir/StructureDefinition/cqf-isEmptyList
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Parameters.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Parameters.parameter.value[x].extension:dataAbsentReason.value[x]	required	DataAbsentReason http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Parameters.parameter.value[x].extension:dataAbsentReason.value[x]:valueCode	required	Fixed Value: unknown http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard

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()
inv-1	error	Parameters.parameter	A parameter must have one and only one of (value, resource, part) : (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

This structure is derived from Parameters

Summary

Mandatory: 0 element(1 nested mandatory element)
Must-Support: 6 elements
Fixed: 1 element

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/cqf-cqlType
• http://hl7.org/fhir/StructureDefinition/data-absent-reason
• http://hl7.org/fhir/StructureDefinition/cqf-isEmptyList

Maturity: 1

Other representations of profile: CSV, Excel, Schematron