Using CQL With FHIR
3.0.0-ballot - STU 3 Ballot

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

## Extension: CQL FHIR Query Pattern Coverage

Official URL: http://hl7.org/fhir/uv/cql/StructureDefinition/cql-fhirQueryPatternCoverage | Version: 3.0.0-ballot | Highlight text changes?
Standards status: Trial-use | Maturity Level: 1 | Computable Name: CQLFHIRQueryPatternCoverage
Other Identifiers: OID:2.16.840.1.113883.4.642.40.37.42.18

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. A coverage of `total` indicates that no further filtering of the results is required; any other value indicates that the consumer must apply the criteria of the data requirement to the results of the query patterns.

Context of Use

This extension may be used on the following element(s)

- Element ID: `DataRequirement`

Usage info

Usages:

- Use this Extension: CQL Module
- Examples for this Extension: EXMLogicModuleDefinition

You can also check for usages in the FHIR IG Statistics

### Formal Views of Extension Content

Description Differentials, Snapshots, and other representations.

- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..1 | Extension | How completely do the query patterns cover the data requirement?
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "http://hl7.org/fhir/uv/cql/StructureDefinition/cql-fhirQueryPatternCoverage"
value[x] |  | 1..1 | code | Value of extension Binding: Query Pattern Coverage Value Set (required)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Extension.value[x] | Base | required | Query Pattern Coverage Value Set | 📦3.0.0-ballot | This IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..1 | Extension | How completely do the query patterns cover the data requirement?
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/uv/cql/StructureDefinition/cql-fhirQueryPatternCoverage"
value[x] |  | 1..1 | code | Value of extension Binding: Query Pattern Coverage Value Set (required)
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Extension.value[x] | Base | required | Query Pattern Coverage Value Set | 📦3.0.0-ballot | This IG

#### 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()`

Summary

Simple Extension with the type code: 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. A coverage of `total` indicates that no further filtering of the results is required; any other value indicates that the consumer must apply the criteria of the data requirement to the results of the query patterns.

Maturity: 1

Differential ViewDifferential View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..1 | Extension | How completely do the query patterns cover the data requirement?
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "http://hl7.org/fhir/uv/cql/StructureDefinition/cql-fhirQueryPatternCoverage"
value[x] |  | 1..1 | code | Value of extension Binding: Query Pattern Coverage Value Set (required)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Extension.value[x] | Base | required | Query Pattern Coverage Value Set | 📦3.0.0-ballot | This IG

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..1 | Extension | How completely do the query patterns cover the data requirement?
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/uv/cql/StructureDefinition/cql-fhirQueryPatternCoverage"
value[x] |  | 1..1 | code | Value of extension Binding: Query Pattern Coverage Value Set (required)
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Extension.value[x] | Base | required | Query Pattern Coverage Value Set | 📦3.0.0-ballot | This IG

#### 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()`

Summary

Simple Extension with the type code: 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. A coverage of `total` indicates that no further filtering of the results is required; any other value indicates that the consumer must apply the criteria of the data requirement to the results of the query patterns.

Maturity: 1

Other representations of profile: CSV, Excel, Schematron