Using CQL With FHIR
3.0.0-ballot - STU 3 Ballot

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

## Artifacts Summary

Page standards status: Trial-use | Highlight text changes?

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

### Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

CQL Evaluation Service | Capability statement for a service supporting CQL evaluation use cases

### Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

CQL CQL | The $cql operation evaluates a CQL expression and returns the result. The operation has a single return parameter that can be of any type to accommodate the possible result types of a CQL expression.
CQL Group Evaluate | Evaluates the membership criteria of a group definition returns the results as an actual Group resource. The Group is expected to use the characteristicsExpression extension to define membership criteria.
CQL Library Evaluate | Evaluates the contents of a library and returns the results as a Parameters resource. Results are returned as described in the FHIR Type Mapping section of the conformance page of this implementation guide. Unless specific expressions are named, the operation will provide the results for all public top-level expression declarations in the library. Use the includePrivate parameter to indicate that private expressions should be included as well.
CQL Resolve Namespace | Resolves the given namespace name to a namespace uri. For libraries published in FHIR NPM packages, the namespace name corresponds to the FHIR NPM packageId (and the `packageId` element of the ImplementationGuide resource), and the uri corresponds to the base canonical for the FHIR NPM package. For example, the namespace name for the Using CQL With FHIR implementation guide (this IG) is `hl7.fhir.uv.cql`, and the namespace uri is `http://hl7.org/fhir/uv/cql`. A package feed is one way to populate this mapping of namespace names to namespace URIs, but it is not the only way. A repository could potentially provide other ways to create this mapping.

### Knowledge Artifacts: Libraries

These define logic, asset collections and other libraries as part of content in this implementation guide.

FHIR Common | This library defines terminologies and functions commonly used in FHIR-based CQL artifacts.
FHIR Common Tests | This library defines tests for the FHIRCommon library
FHIR Helpers | This library defines functions to convert between FHIR data types and CQL system-defined types, as well as functions to support FHIRPath implementation. For more information, the FHIRHelpers wiki page: https://github.com/cqframework/clinical_quality_language/wiki/FHIRHelpers
FHIR HelpersTests | This library defines test cases for FHIRHelpers functionality
FHIR Model Definition | ​Model definition for the FHIR R4 (v4.0.1) Model. For a detailed description of the contents of this model information, refer to the FHIR ModelInfo page in the Using CQL With FHIR implementation guide.

### Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

CQL Capability Statement | The CQL Capability Statement Profile enables capability statements to express supported CQL versions.
CQL Group Definition | The CQL Group Definition profile defines conformance expectations for the use of a FHIR Group resource as a cohort definition using Clinical Quality Language (CQL) to define membership criteria. This profile is intended to be consistent with and able to be used as a cohort definition in other similar efforts including clinical trial eligibility in the Evidence-based Medicine on FHIR space, as well as the Bulk Cohort API cohort definition profile.
CQL Group Result | The CQL Group Result profile defines conformance expectations for the result of evaluating a FHIR Group Definition. This profile is intended to be consistent with and able to be used as an actual group definition in other contexts such as the various evaluate operations defined in clinical reasoning.
CQL ImplementationGuide | Supports the description of model info configuration information as part of an implementation guide
CQL Library | The CQL Library profile defines conformance expectations for the use of a FHIR Library resource as a wrapper for a Clinical Quality Language (CQL) library
CQL Model Info | The CQL Model Information profile supports the FHIR representation and distribution of CQL ModelInfo such as the FHIR Model Info Library
CQL Model Info Settings | CQL ModelInfo settings expressed using FHIR Parameters
CQL Module | The CQL Module profile describes the elements used to provide a structured representation of the declarations and data requirements of a logic library or operation
CQL Options | A parameters profile that defines supported CQL-to-ELM translator options used to translate CQL. Complete documentation of these options can be found in the Usage topic of the CQL-to-ELM translator overview.
CQL Parameters | The CQL Parameters profile supports exchanging CQL parameters and evaluation results for FHIR operations, including $cql and the various $evaluate operations defined throughout FHIR Clinical Reasoning. The profile supports unambiguously identifying the type of CQL values that have been mapped to FHIR, as well as communicating empty lists, empty tuples, and null parameters or results using the data-absent-reason extension.
CQL StructureDefinition | Supports configuration of model info information for a StructureDefinition
ELM JSON Library | The ELM Library supports distributing a Clinical Quality Language (CQL) library compiled to Expression Logical Model (ELM) in JSON format
ELM XML Library | The ELM CQL Library supports distributing a Clinical Quality Language (CQL) library compiled to Expression Logical Model (ELM) in XML format

### Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

CQL Evaluated Resource | A resource referenced during the evaluation of the logic used to determine membership of the entity.
CQL FHIR Query Pattern Coverage | 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.
CQL Namespace | The CQL namespace of the CQL library. For Library resources packaged in FHIR NPM Packages, this SHALL be the packageId of the package.
CQL Namespace URI | The CQL namespace URI of the CQL library. For Library resources packaged in FHIR NPM Packages, this SHALL be the base canonical of the package.
CQL Selectivity | Describes the selectivity of a set of data requirements with respect to a particular expression.
Time HasOffset | Indicates whether the datetime value being represented included a timezone offset. False indicates that the value being exchanged does not have a timezone offset, but the FHIR representation requires it.

### Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

CQL Context Declaration Value Set | Codes for specification-defined CQL context declarations. Models define what contexts are available beyond the ones defined here. See the Context discussion in the CQL specification for complete details.
Context Type | The set of known context types usable for CQL libraries in FHIR
Query Pattern Coverage Value Set | The extent to which the FHIR query patterns given for a data requirement cover the criteria of that data requirement
Selectivity Coverage Value Set | The coverage level of a description of the selectivity of an expression
Selectivity Form Value Set | The form of the selectivity description of an expression, either conjunctive or disjunctive.
Selectivity Inclusivity Value Set | The inclusivity of the selectivity description of an expression, either inclusion or an exclusion.

### Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

CQL Context Declaration Codes | Codes for specification-defined CQL context declarations. Models define what contexts are available beyond the ones defined here. See the Context discussion in the CQL specification for complete details.
Query Pattern Coverage Code System | Codes representing the extent to which the FHIR query patterns given for a data requirement cover the criteria of that data requirement, total, partial, or non. Note that in all cases, the union of the results of the query patterns is expected to be sound, meaning that it includes all the data described by the data requirement; the coverage indicates only whether additional data may also be returned (i.e. whether the consumer must still apply the criteria of the data requirement to the results).
Selectivity Coverage Code System | Codes representing the coverage level of the description of the selectivity of an expression, total, partial, or non.
Selectivity Form Code System | Codes representing the form of the description of the selectivity of an expression, either conjunctive or disjunctive.
Selectivity Inclusivity Code System | Codes representing the inclusivity of the selectivity of an expression, inclusion, exclusion, or indeterminate.

### Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

ANC Cohort | Example cohort definition for antenatal care
CQL Example | Example CQL Library illustrating the CQL Profile (a Library with only text/cql content)
CQL IG Example Code System | This code system contains example content used to support examples in the Using CQL IG
CQL ImplementationGuide Example | This implementation guide demonstrates the use of modelinfo settings
Danger signs | Before each contact, the health worker should check whether the woman has any of the danger signs listed here – if yes, she should refer to the hospital urgently; if no, she should continue to the normal contact
ELM Example | Example ELM library demonstrating the ELM XML and ELM JSON profiles (a CQL library with only ELM)
Example | Example CQL Library used to demonstrate common patterns used in CQL with FHIR-based models
Example ANC Cohort | Example illustrating the result of evaluating the ANC Cohort Definition Group
Example ANC Cohort Definition | Example ANC Cohort Definition Group
Example CQL Operations Parameters | Example Parameters resource demonstrating the use of the CQLOptions profile to specify CQL translator options. This resource would typically be a contained resource in an implementation guide, artifact collection, or library.
Example Danger Signs - Central cyanosis Codes | Codes representing possible values for the Danger Signs - Central cyanosis element
Example Danger Signs - No danger signs Codes | Codes representing possible values for the Danger Signs - No danger signs element
Example Danger signs Codes | Codes representing possible values for the Danger signs element
Example Danger signs Codes Grouper | Group Valueset with codes representing possible values for the Danger signs Codes Grouper element
Example Evaluation Result Parameters | Example Parameters resource demonstrating the use of data-absent-reason extension to indicate a null evaluation result.
Example Logic Library - Module Definition | This library is used as an example module definition in the Using FHIR with CQL Implementation Guide
Example Negation Observation | Example Observation resource illustrating negation and the use of the `codeOptions` extension.
Example Patient | Example Patient resource used as part of the observation negation example.
Example Pregnancy Observation | Example Observation resource used as a pregnancy confirmation observation for the cohort examples.
Example Specific health concern(s) Codes | Codes representing possible values for the Specific health concern(s) element
Example Type Mapping Evaluation Result Parameters | Example Parameters resource showing the result of evaluating the TypeMappingExample library, demonstrating all possible CQL-to-FHIR type mappings.
Library Evaluation Service Capability Statement Example | Basic conformance statement for a Library Evaluation Service. A server can support more functionality than defined here, but this is the minimum amount
Parameter Example | Example CQL library with a parameter defined, used to illustrate calling the $cql and Library/$evaluate operations with libraries that have parameters
Specific health concern(s) | If the woman came to the facility with a specific health concern, select the health concern(s) from the list
Type Mapping Example | Example CQL library providing a complete set of expressions that cover all possible CQL and FHIR Type Mapping, for both input and output. See the Type Mapping Evaluation Result example for an illustration of the type mapping in a Parameters resource.
USCore Example Model Definition | Example Model definition for USCore (v3.1.0) Model. This is an experimental resource only used as an example in this implementation guide. Official model information files for the latest versions of USCore are being balloted and published as part of USCore (version 8.0.0+). Prior versions of model information files for US Core are being published in the Common CQL Assets for FHIR (US-based) implementation guide.

### Other

These are resources that are used within this implementation guide that do not fit into one of the other categories.

FHIR ModelInfo Settings | Settings used to construct the FHIR ModelInfo version 4.0.1