CQL Evaluation Service

Using CQL with FHIR
2.0.0-ballot - STU2Ballot International flag

This page is part of the Using CQL with FHIR Implementation Guide (v2.0.0-ballot: STU2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.0.0. For a full list of available versions, 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-ballot
Draft as of 2024-12-16				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

Generated Narrative: CapabilityStatement cql-evaluation-service

Implementation Guide Version: 2.0.0-ballot
FHIR Version: 4.0.1
Supported Formats: json, xml
Supported Patch Formats:
Published on: 2024-12-16 21:04:43+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

http://hl7.org/fhir/uv/cql/ImplementationGuide/hl7.fhir.uv.cql

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 Type	Profile	R	S	U	C	Searches	`_include`	`_revinclude`	Operations
Library	http://hl7.org/fhir/uv/cql/StructureDefinition/cql-library Additional supported profiles: CQL Model Info CQL Module ELM XML Library ELM JSON Library	y	y			date, 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

Conformance	Parameter	Type
SHALL	date	`date`
SHALL	name	`string`
SHALL	title	`string`
SHALL	identifier	`token`
SHALL	description	`string`
SHALL	status	`token`
SHALL	url	`uri`
SHALL	version	`token`
SHALL	composed-of	`reference`
SHALL	depends-on	`reference`

Operations

Use

IG © 2023+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.cql#2.0.0-ballot based on FHIR 4.0.1. Generated 2024-12-16
Links: Table of Contents | QA Report | Version History | | Propose a change

CapabilityStatement: CQL Evaluation Service