Using CQL With FHIR
2.0.0 - STU 2 International flag

Using CQL With FHIR, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cql-ig/ and changes regularly. See the Directory of published versions

CapabilityStatement: CQL Evaluation Service

Official URL: http://hl7.org/fhir/uv/cql/CapabilityStatement/cql-evaluation-service Version: 2.0.0
Standards status: Trial-use Maturity Level: 4 Computable Name: CQLEvaluationService
Other Identifiers: OID:2.16.840.1.113883.4.642.40.37.13.2

Capability statement for a service supporting CQL evaluation use cases

Raw OpenAPI-Swagger Definition file | Download

CQL Evaluation Service

  • Implementation Guide Version: 2.0.0
  • FHIR Version: 4.0.1
  • Supported Formats: json, xml
  • Supported Patch Formats:
  • Published on: 2025-07-08 13:34:17+0000
  • Published by: HL7 International / Clinical Decision Support

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: server

RESTful CQL Evaluation Service

Security
Enable CORS: yes
Security services supported: Certificates
Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
Libraryhttp://hl7.org/fhir/uv/cql/StructureDefinition/cql-library
Additional supported profiles:
  CQL Model Info
  CQL Module
  ELM XML Library
  ELM JSON Library		yydate, name, title, identifier, description, status, url, version, composed-of, depends-on

Resource Conformance: SHALL Library

Base System Profile
CQL Library
Profile Conformance
SHALL
Reference Policy

Supported Profiles

CQL Model Info
CQL Module
ELM XML Library
ELM JSON Library

Interaction summary
  • SHALL support
    read

    Read allows clients to get the logical definitions of the available libraries

    search-type

    Search allows clients to find libraries on the server

Search Parameters
ConformanceParameterTypeDocumentation
SHALLdatedate
SHALLnamestring
SHALLtitlestring
SHALLidentifiertoken
SHALLdescriptionstring
SHALLstatustoken
SHALLurluri
SHALLversiontoken
SHALLcomposed-ofreference
SHALLdepends-onreference
 

Operations

Use