CQL FHIR Query Pattern Coverage - Using CQL With FHIR v3.0.0-ballot

Using CQL With FHIR
3.0.0-ballot - STU 3 Ballot International flag

Using CQL With FHIR - Downloaded Version null See the Directory of published versions

Extension: CQL FHIR Query Pattern Coverage - Detailed Descriptions

Page standards status: Trial-use

Maturity Level: 1

Definitions for the cql-fhirQueryPatternCoverage extension

Key Elements Table
Differential Table
Snapshot Table

Guidance on how to interpret the contents of this table can be foundhere

0. Extension
Definition	Describes the extent to which the FHIR query patterns given for a data requirement (i.e. the cqf-fhirQueryPattern extensions present on the data requirement) cover the criteria of that data requirement. Because the query patterns for a data requirement are considered as a set (i.e. the union of the results of the query patterns represents the data for the data requirement), coverage is a characteristic of the data requirement as a whole, rather than of any individual query pattern. Optional Extension Element - found in all resources.
Short	How completely do the query patterns cover the data requirement?Optional Extensions Element
Comments	This extension does not change the expectation that the query patterns for a data requirement are sound, meaning that the union of their results includes all the data described by the data requirement. Criteria that cannot be expressed as search parameters are omitted from the query patterns, rather than approximated with criteria that could exclude required data, and the resulting loss of precision is communicated with this extension. Consuming systems apply the criteria of the data requirement to the results of the query patterns unless the coverage is `total`.
Control	0..1* This element is affected by the following invariants: ele-1
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.extension
Definition	An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	ExtensionAdditional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..0*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing	This element introduces a set of slices on `Extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
4. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`http://hl7.org/fhir/uv/cql/StructureDefinition/cql-fhirQueryPatternCoverage`
6. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	10..1
Binding	The codes SHALL be taken from For codes, see Query Pattern Coverage Value Set (required to `http://hl7.org/fhir/uv/cql/ValueSet/query-pattern-coverage`)
Type	code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Extension
Definition	Describes the extent to which the FHIR query patterns given for a data requirement (i.e. the cqf-fhirQueryPattern extensions present on the data requirement) cover the criteria of that data requirement. Because the query patterns for a data requirement are considered as a set (i.e. the union of the results of the query patterns represents the data for the data requirement), coverage is a characteristic of the data requirement as a whole, rather than of any individual query pattern.
Short	How completely do the query patterns cover the data requirement?
Comments	This extension does not change the expectation that the query patterns for a data requirement are sound, meaning that the union of their results includes all the data described by the data requirement. Criteria that cannot be expressed as search parameters are omitted from the query patterns, rather than approximated with criteria that could exclude required data, and the resulting loss of precision is communicated with this extension. Consuming systems apply the criteria of the data requirement to the results of the query patterns unless the coverage is `total`.
Control	0..1
2. Extension.extension
Control	0..0
4. Extension.url
Type	uri
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Fixed Value	`http://hl7.org/fhir/uv/cql/StructureDefinition/cql-fhirQueryPatternCoverage`
6. Extension.value[x]
Control	1..?
Binding	The codes SHALL be taken from Query Pattern Coverage Value Set (required to `http://hl7.org/fhir/uv/cql/ValueSet/query-pattern-coverage`)
Type	code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value	This primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be foundhere

0. Extension
Definition	Describes the extent to which the FHIR query patterns given for a data requirement (i.e. the cqf-fhirQueryPattern extensions present on the data requirement) cover the criteria of that data requirement. Because the query patterns for a data requirement are considered as a set (i.e. the union of the results of the query patterns represents the data for the data requirement), coverage is a characteristic of the data requirement as a whole, rather than of any individual query pattern.
Short	How completely do the query patterns cover the data requirement?
Comments	This extension does not change the expectation that the query patterns for a data requirement are sound, meaning that the union of their results includes all the data described by the data requirement. Criteria that cannot be expressed as search parameters are omitted from the query patterns, rather than approximated with criteria that could exclude required data, and the resulting loss of precision is communicated with this extension. Consuming systems apply the criteria of the data requirement to the results of the query patterns unless the coverage is `total`.
Control	0..1 This element is affected by the following invariants: ele-1
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
2. Extension.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
4. Extension.extension
Definition	An Extension
Short	Extension
Control	0..0
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing	This element introduces a set of slices on `Extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`http://hl7.org/fhir/uv/cql/StructureDefinition/cql-fhirQueryPatternCoverage`
8. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	1..1
Binding	The codes SHALL be taken from Query Pattern Coverage Value Set (required to `http://hl7.org/fhir/uv/cql/ValueSet/query-pattern-coverage`)
Type	code
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)

IG © 2023+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.cql#3.0.0-ballot based on FHIR 4.0.1. Generated 2026-08-14
Links: Table of Contents | QA Report | Version History | | Propose a change