Using CQL with FHIR
1.0.0-ballot - Ballot International flag

This page is part of the Using CQL with FHIR Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

Artifacts Summary

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

Evaluates a CQL expression and returns the results as a Parameters resource.

CQL Library Evaluate

Evaluates the contents of a library and returns the results as a Parameters resource.

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 Evaluation Result

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

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 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 StructureDefinition

Supports configuration of model info information for a StructureDefinition

ELM Library

The ELM Library supports distributing a Clinical Quality Language (CQL) library compiled to Expression Logical Model (ELM) in either JSON or XML format

Structures: Extension Definitions

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

CQL Access Level

Surfaces the CQL access level of the parameter definition on which it appears.

CQL Type

Surfaces the CQL type of the parameter definition on which it appears.

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

Cohort definition for antenatal care

ANCM Activity Codes

Set of codes representing all activities used in the ANC Mini implementation guide

ANCM Concept Codes

Set of codes representing all concepts used in the implementation guide

CQL ImplementationGuide Example

This implementation guide demonstrates the use of modelinfo settings

Danger Signs - Central cyanosis Codes

Codes representing possible values for the Danger Signs - Central cyanosis element

Danger Signs - No danger signs Codes

Codes representing possible values for the Danger Signs - No danger signs element

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

Danger signs Codes

Codes representing possible values for the Danger signs element

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 ModelInfo Settings Parameters

Example Parameters resource demonstrating the use of ModelInfo configuration parameters. This resource would typically be a contained resource in an implementation guide or artifact collection.

Example Negation Observation

Example Observation resource illustrating negation and the use of the notDoneValueSet extension.

Example Patient

Example Patient resource used as part of the observation negation example.

FHIR Common

This library defines terminologies and functions commonly used in FHIR-based CQL artifacts.

FHIR Common (Compiled CQL Example)

This library defines terminologies and functions commonly used in FHIR-based CQL artifacts.

FHIR Common (Source CQL Example)

This library defines terminologies and functions commonly used in FHIR-based CQL artifacts.

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

Specific health concern(s)

If the woman came to the facility with a specific health concern, select the health concern(s) from the list

Specific health concern(s) Codes

Codes representing possible values for the Specific health concern(s) element

USCore Model Definition

Model definition for USCore (v3.1.0) Model