XIG: CapabilityStatement/cql-evaluation-service

FHIR IG Statistics: CapabilityStatement/cql-evaluation-service

Package	hl7.fhir.uv.cql
Type	CapabilityStatement
Id	cql-evaluation-service
FHIR Version	R4
Source	http://hl7.org/fhir/uv/cql/https://build.fhir.org/ig/HL7/cql-ig/CapabilityStatement-cql-evaluation-service.html
URL	http://hl7.org/fhir/uv/cql/CapabilityStatement/cql-evaluation-service
Version	2.0.0
Status	active
Date	2025-07-08T13:34:17+00:00
Name	CQLEvaluationService
Title	CQL Evaluation Service
Realm	uv
Authority	hl7
Description	Capability statement for a service supporting CQL evaluation use cases
Kind	requirements

Resources that use this resource

No resources found

Resources that this resource uses

ImplementationGuide
hl7.fhir.uv.cql	Using CQL With FHIR

OperationDefinition
cql-cql	CQL CQL
cql-library-evaluate	CQL Library Evaluate

StructureDefinition
cql-library	CQL Library
cql-modelinfo	CQL Model Info
cql-module	CQL Module
elm-json-library	ELM JSON Library
elm-xml-library	ELM XML Library

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement cql-evaluation-service

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

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

Source

{
  "resourceType": "CapabilityStatement",
  "id": "cql-evaluation-service",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 4
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "cds"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use"
    }
  ],
  "url": "http://hl7.org/fhir/uv/cql/CapabilityStatement/cql-evaluation-service",
  "version": "2.0.0",
  "name": "CQLEvaluationService",
  "title": "CQL Evaluation Service",
  "status": "active",
  "experimental": false,
  "date": "2025-07-08T13:34:17+00:00",
  "publisher": "HL7 International / Clinical Decision Support",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/dss"
        }
      ]
    }
  ],
  "description": "Capability statement for a service supporting CQL evaluation use cases",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "json",
    "xml"
  ],
  "implementationGuide": [
    "http://hl7.org/fhir/uv/cql/ImplementationGuide/hl7.fhir.uv.cql"
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "RESTful CQL Evaluation Service",
      "security": {
        "cors": true,
        "service": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
                "code": "Certificates"
              }
            ]
          }
        ]
      },
      "resource": [
        {
          "type": "Library",
          "profile": "http://hl7.org/fhir/uv/cql/StructureDefinition/cql-library",
          "supportedProfile": [
            "http://hl7.org/fhir/uv/cql/StructureDefinition/cql-modelinfo",
            "http://hl7.org/fhir/uv/cql/StructureDefinition/cql-module",
            "http://hl7.org/fhir/uv/cql/StructureDefinition/elm-xml-library",
            "http://hl7.org/fhir/uv/cql/StructureDefinition/elm-json-library"
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Read allows clients to get the logical definitions of the available libraries"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Search allows clients to find libraries on the server"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "date",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-date",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-name",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "title",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-title",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-identifier",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "description",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-description",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-status",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "url",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-url",
              "type": "uri"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "version",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-version",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "composed-of",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-composed-of",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "depends-on",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-composed-of",
              "type": "reference"
            }
          ]
        }
      ],
      "operation": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "name": "cql",
          "definition": "http://hl7.org/fhir/uv/cql/OperationDefinition/cql-cql"
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "name": "evaluate",
          "definition": "http://hl7.org/fhir/uv/cql/OperationDefinition/cql-library-evaluate"
        }
      ]
    }
  ]
}