Using CQL With FHIR
2.1.0-cibuild - STU 2 International flag

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.1.0-cibuild 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

Resource Profile: CQL Evaluation Result

Official URL: http://hl7.org/fhir/uv/cql/StructureDefinition/cql-evaluationresult Version: 2.1.0-cibuild
Standards status: Trial-use Active as of 2025-12-04 Maturity Level: 1 Computable Name: CQLEvaluationResult
Other Identifiers: OID:2.16.840.1.113883.4.642.40.37.42.7

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

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... parameter SΣC 0..* BackboneElement Operation Parameter
Constraints: inv-1
.... Slices for extension Content/Rules for all slices
..... extension: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
...... Slices for extension Content/Rules for all slices
....... extension:dataAbsentReason S 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
........ 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
....... extension:isEmptyList S 0..1 boolean Empty list
URL: http://hl7.org/fhir/StructureDefinition/cqf-isEmptyList
....... extension:isEmptyTuple S 0..1 boolean Empty tuple
URL: http://hl7.org/fhir/StructureDefinition/cqf-isEmptyTuple
..... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Parameters.parameter.​value[x].extension:dataAbsentReason.​value[x] Base required DataAbsentReason 📦4.0.1 FHIR Std.
Parameters.parameter.​value[x].extension:dataAbsentReason.​value[x]:valueCode Base required DataAbsentReason 📦4.0.1 FHIR Std.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... parameter S 0..* BackboneElement Operation Parameter
.... Slices for extension Content/Rules for all slices
..... extension: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
...... extension: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
...... extension:isEmptyList S 0..1 boolean Empty list
URL: http://hl7.org/fhir/StructureDefinition/cqf-isEmptyList
...... extension:isEmptyTuple S 0..1 boolean Empty tuple
URL: http://hl7.org/fhir/StructureDefinition/cqf-isEmptyTuple

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... parameter SΣC 0..* BackboneElement Operation Parameter
Constraints: inv-1
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension: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
....... extension: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 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
........ 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
....... extension:isEmptyList S 0..1 boolean Empty list
URL: http://hl7.org/fhir/StructureDefinition/cqf-isEmptyList
....... extension:isEmptyTuple S 0..1 boolean Empty tuple
URL: http://hl7.org/fhir/StructureDefinition/cqf-isEmptyTuple
..... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Parameters.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Parameters.parameter.​value[x].extension:dataAbsentReason.​value[x] Base required DataAbsentReason 📦4.0.1 FHIR Std.
Parameters.parameter.​value[x].extension:dataAbsentReason.​value[x]:valueCode Base required DataAbsentReason 📦4.0.1 FHIR Std.

Constraints

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

Summary

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

Extensions

This structure refers to these extensions:

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... parameter SΣC 0..* BackboneElement Operation Parameter
Constraints: inv-1
.... Slices for extension Content/Rules for all slices
..... extension: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
...... Slices for extension Content/Rules for all slices
....... extension:dataAbsentReason S 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
........ 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
....... extension:isEmptyList S 0..1 boolean Empty list
URL: http://hl7.org/fhir/StructureDefinition/cqf-isEmptyList
....... extension:isEmptyTuple S 0..1 boolean Empty tuple
URL: http://hl7.org/fhir/StructureDefinition/cqf-isEmptyTuple
..... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Parameters.parameter.​value[x].extension:dataAbsentReason.​value[x] Base required DataAbsentReason 📦4.0.1 FHIR Std.
Parameters.parameter.​value[x].extension:dataAbsentReason.​value[x]:valueCode Base required DataAbsentReason 📦4.0.1 FHIR Std.

Constraints

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

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... parameter S 0..* BackboneElement Operation Parameter
.... Slices for extension Content/Rules for all slices
..... extension: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
...... extension: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
...... extension:isEmptyList S 0..1 boolean Empty list
URL: http://hl7.org/fhir/StructureDefinition/cqf-isEmptyList
...... extension:isEmptyTuple S 0..1 boolean Empty tuple
URL: http://hl7.org/fhir/StructureDefinition/cqf-isEmptyTuple

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... parameter SΣC 0..* BackboneElement Operation Parameter
Constraints: inv-1
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension: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
....... extension: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 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
........ 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
....... extension:isEmptyList S 0..1 boolean Empty list
URL: http://hl7.org/fhir/StructureDefinition/cqf-isEmptyList
....... extension:isEmptyTuple S 0..1 boolean Empty tuple
URL: http://hl7.org/fhir/StructureDefinition/cqf-isEmptyTuple
..... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Parameters.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Parameters.parameter.​value[x].extension:dataAbsentReason.​value[x] Base required DataAbsentReason 📦4.0.1 FHIR Std.
Parameters.parameter.​value[x].extension:dataAbsentReason.​value[x]:valueCode Base required DataAbsentReason 📦4.0.1 FHIR Std.

Constraints

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

Summary

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

Extensions

This structure refers to these extensions:

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron