Using CQL With FHIR
3.0.0-ballot - STU 3 Ballot

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

## Home

Official URL: http://hl7.org/fhir/uv/cql/ImplementationGuide/hl7.fhir.uv.cql | Version: 3.0.0-ballot | Highlight text changes?
IG Standards status: Trial-use | Maturity Level: 4 | Computable Name: CQL
Other Identifiers: OID:2.16.840.1.113883.4.642.40.37

### Summary

Clinical Quality Language (CQL) is a clinically-focused query language that can be used to express logic in a broad range of healthcare use cases, including clinical decision and cognitive support, public health and quality reporting, computable clinical guidelines, research trial eligibility, and many others. Several implementation guides have been published that include conformance criteria related to the use of CQL in these contexts. This implementation guide is the result of extracting common aspects of that support to a universal realm, broadly applicable implementation guide that supports the use of CQL with Fast Healthcare Interoperability Resources (FHIR). Future versions of those implementation guides should consider referencing the conformance and guidance established here.

Much of the content in this implementation guide has been balloted, published, reviewed, implemented, and refined over many years as part of Quality Measure Implementation Guide (STU4 and prior), FHIR Clinical Guidelines (STU1), Quality Improvement Profile (QI-Core) (STU6 and prior), and the Canonical Resource Management Infrastructure IG (STU1).

Some of the conformance language and requirements described in this implementation guide, particularly around the use of terminology, may be applicable more broadly. We propose the inclusion of appropriate conformance requirements and guidance in a future version of the CQL specification.

### Scope of Use

The intent of this implementation guide is to support the use of CQL with FHIR in general. It is a universal realm specification and is intended to be broadly applicable to any use case that involves libraries or expressions of CQL evaluating against FHIR resources, including:

- Library profiles to support packaging of CQL (and compiled CQL, or Expression Logical Model (ELM)) as FHIR Library resources
- Evaluation support profiles to facilitate the representation of structured information about a logic library, as well as the result of evaluating a logic library
- CQL Evaluation Service capability statement
- Model Information (ModelInfo)-related profiles to facilitate configuration of ModelInfo for FHIR implementation guides
- Universally applicable CQL Artifacts for use with FHIR, including FHIR-ModelInfo, FHIRHelpers, and FHIRCommon

### How to read this Guide

#### Target Audiences

This implementation guide is targeted at two main audiences:

1. Authors: Persons involved in the development of CQL-based FHIR Knowledge Artifacts that are authoring CQL, either directly or with tooling assistance
2. Integrators: Persons involved in the development of systems that support authoring, publishing, distributing, and implementing CQL-based FHIR Knowledge Artifacts

This Guide is divided into several pages which are listed at the top of each page in the menu bar:

- Home: Summary and background information on Using CQL with FHIR.
- Authoring:
  - Using CQL: Conformance requirements for using Clinical Quality Language as part of authoring FHIR Knowledge Artifacts.
  - Patterns: Patterns and guidance for using Clinical Quality Language as part of authoring FHIR Knowledge Artifacts.
- Integrating:
  - Conformance: Conformance requirements for integrating Clinical Quality Language as part of systems that support authoring, publishing, distribution, and implementing FHIR Knowledge Artifacts.
  - Using ELM: Conformance requirements for the use of Expression Logical Model (ELM) artifacts.
  - Using ModelInfo: Conformance requirements for the use of Model Info.
- CQL Artifacts:
  - FHIR ModelInfo: Description of the contents of the base FHIR ModelInfo
  - FHIRHelpers: Conversion functions used to simplify access to FHIR data types
  - FHIRCommon: Library of common functions and declarations for use in FHIR artifacts
- FHIR Artifacts:
  - Profiles: List of profiles defined for use by knowledge artifacts.
  - Extensions: List of extensions defined and used by knowledge artifacts.
  - Operations: List of operations and operation pattern profiles.
  - Capabilities: Definitions of services and operations in support of authoring, publishing, and distributing canonical resources and knowledge artifacts.
  - Terminology: List of CodeSystems and ValueSets.
  - Artifacts Summary: List of the FHIR artifacts defined as part of this implementation guide.
- Downloads: Links to downloadable artifacts for implementations.
- Changes: Changes made in each version of the Using CQL with FHIR Implementation Guide.

### Acknowledgements

This Implementation Guide was made possible by the thoughtful contributions of the following people and organizations:

- Brian Kaney, Vermonster - Editor
- Bryant Austin, Smile Digital Health - Contributor
- Clinical Quality Information (CQI) Work Group
- Michael Holck, ICF - Contributor
- Ewout Kramer, Firely - Contributor
- Carl Leitner - Contributor
- Rob McClure, Md Partners - Contributor
- Evan Muchasak, NCQA - Contributor
- Rob Reynolds, Smile Digital Health - Contributor
- Brenin Rhodes, Smile Digital Health - Contributor
- Bryn Rhodes, Smile Digital Health - Editor
- Derek Ritz - Contributor
- Chris Schuler, Smile Digital Health - Contributor
- Jennifer Seeman, ICF - Contributor
- Adam Stevenson, Smile Digital Health - Contributor

In addition, the editors would like to thank the many reviewers that provided detailed and insightful comments as part of balloting and preparation of this content, including Chris Moesel, Lloyd McKenzie, Jonathan Percival, Yan Heras, Paul Denning, Juliet Rubini, Angela Flanagan, Isaac Vetter, and many others.

### References

Health Level Seven. Clinical Quality Framework - HL7 Clinical Decision Support Work Group Confluence Page. [Online]. Available from: https://confluence.hl7.org/display/CQIWC/Clinical Quality Framework [Accessed 11 October 2019].

Health Level Seven. Clinical Quality Language. [Online]. Available from: http://cql.hl7.org [Accessed October 2023].

Health Level Seven. FHIR Clinical Guidelines. [Online]. Available from: http://hl7.org/fhir/uv/cpg [Accessed October 2023].

Health Level Seven. Canonical Resource Management Infrastructure. [Online]. Available from: http://hl7.org/fhir/uv/crmi [Accessed May 2024].

Health Level Seven. Quality Measure Implementation Guide. [Online]. Available from: http://hl7.org/fhir/us/cqfmeasures [Accessed October 2023].

Health Level Seven. HL7 Cross-Paradigm Specification: Representing Negatives. [Online]. Available from: https://www.hl7.org/implement/standards/product_brief.cfm?product_id=592 [Accessed March 2024].

Health Level Seven. FHIR Quality Profile. [Online]. Available from: http://hl7.org/fhir/us/qicore [Accessed March 2024].

Health Level Seven. US Core. [Online]. Available from: http://hl7.org/fhir/us/core [Accessed March 2024].

### Dependencies

IG | Package | FHIR
--- | --- | ---
Using CQL With FHIR | hl7.fhir.uv.cql#3.0.0-ballot | R4
HL7 Terminology (THO) | hl7.terminology.r4#7.3.0 | R4
FHIR Extensions Pack | hl7.fhir.uv.extensions.r4#5.3.0 | R4
FHIR Tooling Extensions IG | hl7.fhir.uv.tools.r4#1.1.2 | R4

### Cross Version Analysis

This is an R4 IG. None of the features it uses are changed in R4B, so it can be used as is with R4B systems. Packages for both R4 (hl7.fhir.uv.cql.r4) and R4B (hl7.fhir.uv.cql.r4b) are available.

### Global Profiles

There are no Global profiles defined

### Intellectual Property Statements

This publication includes IP covered under the following statements.

- This material contains content from LOINC. LOINC is copyright © 1995-2020, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc.
  Show Usage
  - LOINC: CQLExample, ELMExample, Example, ParameterExample and Parameters/cql-typemappingexampleresult
- This material derives from the HL7 Terminology (THO). THO is copyright ©1989+ Health Level Seven International and is made available under the CC0 designation. For more licensing information see: https://terminology.hl7.org/license.html
  Show Usage
  - LibraryType: ANCCohort, CQLExample... Show 12 more, CQLModelInfo, ELMExample, EXMLogicModuleDefinition, Example, FHIR, FHIRCommon, FHIRCommonTests, FHIRHelpers, FHIRHelpersTests, ParameterExample, TypeMappingExample and USCoreExample
  - Observation Category Codes: Observation/negation-example and Parameters/cql-typemappingexampleresult
  - Observation Reference Range Meaning Codes: Parameters/cql-typemappingexampleresult
  - UsageContextType: Dangersigns and Specifichealthconcerns
  - contactRole2: Parameters/cql-typemappingexampleresult
  - identifierType: Parameters/cql-typemappingexampleresult
  - MaritalStatus: Parameters/cql-typemappingexampleresult