Using CQL with FHIR
2.0.0-ballot - STU2Ballot 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-ballot 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: Library Evaluation Service Capability Statement Example

Official URL: http://hl7.org/fhir/uv/cql/CapabilityStatement/cql-evaluation-service-example Version: 2.0.0-ballot
Draft as of 2016-09-16 Computable Name: LibraryEvaluationServiceCapabilityStatementExample
Other Identifiers: OID:2.16.840.1.113883.4.642.40.37.13.1

Basic conformance statement for a Library Evaluation Service. A server can support more functionality than defined here, but this is the minimum amount

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement cql-evaluation-service-example

Library Evaluation Service Capability Statement Example

  • Implementation Guide Version: 2.0.0-ballot
  • FHIR Version: 4.0.1
  • Supported Formats: json, xml
  • Supported Patch Formats:
  • Published on: 2016-09-16
  • 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.

This CapabilityStatement instantiates the CapabilityStatement http://hl7.org/fhir/knowledge-repository (Knowledge Repository Service Conformance Statement)

FHIR RESTful Capabilities

Mode: server

RESTful Library 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/StructureDefinition/Libraryyydescription, identifier, status, title, topic, version, url

Resource Conformance: supported Library

Base System Profile
Library
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    read

    Read allows clients to get the logical definitions of the libraries

    search-type

    Search allows clients to find libraries on the server

Search Parameters
ConformanceParameterTypeDocumentation
SHALLdescriptionstring
SHALLidentifiertoken
SHALLstatustoken
SHALLtitlestring
SHALLtopictoken
SHALLversiontoken
SHALLurluri
 

Operations

Use