Using CQL with FHIR
2.0.0-ballot - STU2Ballot
Using CQL with FHIR
2.0.0-ballot - STU2Ballot
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
| Page standards status: Trial-use | Maturity Level: 3 |
{
"resourceType" : "OperationDefinition",
"id" : "cql-cql",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition cql-cql</b></p><a name=\"cql-cql\"> </a><a name=\"hccql-cql\"> </a><a name=\"cql-cql-en-US\"> </a><p>URL: [base]/$cql</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>subject</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td><div><p>Subject for which the expression will be evaluated. This corresponds to the context in which the expression will be evaluated and is represented as a relative FHIR id (e.g. Patient/123), which establishes both the context and context value for the evaluation</p>\n</div></td></tr><tr><td>IN</td><td>expression</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Expression to be evaluated. Note that this is an expression of CQL, not the text of a library with definition statements.</p>\n</div></td></tr><tr><td>IN</td><td>parameters</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/parameters.html\">Parameters</a></td><td/><td><div><p>Any input parameters for the expression. Parameters defined in this input will be made available by name to the CQL expression. Parameter types are mapped to CQL as specified in the Using CQL section of this implementation guide. If a parameter appears more than once in the input Parameters resource, it is represented with a List in the input CQL. If a parameter has parts, it is represented as a Tuple in the input CQL.</p>\n</div></td></tr><tr><td>IN</td><td>library</td><td/><td>0..*</td><td></td><td/><td><div><p>A library to be included. The library is resolved by url and made available by name within the expression to be evaluated.</p>\n</div></td></tr><tr><td>IN</td><td>library.url</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>The canonical url (with optional version) of the library to be included</p>\n</div></td></tr><tr><td>IN</td><td>library.name</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The name of the library to be used to reference the library within the CQL expression. If no name is provided, the name of the library will be used</p>\n</div></td></tr><tr><td>IN</td><td>useServerData</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>Whether to use data from the server performing the evaluation. If this parameter is true (the default), then the operation will use data first from any bundles provided as parameters (through the data and prefetch parameters), second data from the server performing the operation, and third, data from the dataEndpoint parameter (if provided). If this parameter is false, the operation will use data first from the bundles provided in the data or prefetch parameters, and second from the dataEndpoint parameter (if provided).</p>\n</div></td></tr><tr><td>IN</td><td>data</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>Data to be made available to the library evaluation. This parameter is exclusive with the prefetchData parameter (i.e. either provide all data as a single bundle, or provide data using multiple bundles with prefetch descriptions).</p>\n</div></td></tr><tr><td>IN</td><td>prefetchData</td><td/><td>0..*</td><td></td><td/><td><div><p>Data to be made available to the library evaluation, organized as prefetch response bundles. Each prefetchData parameter specifies either the name of the prefetchKey it is satisfying, a DataRequirement describing the prefetch, or both.</p>\n</div></td></tr><tr><td>IN</td><td>prefetchData.key</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The key of the prefetch item. When using this operation as part of a CDS Hooks implementation, this SHALL be the name of a prefetch item in a CDS Hooks discovery response. Prefetch data SHALL be made available to retrieve statements in the CQL and SHOULD NOT be provided as the value of any CQL parameters in the library being evaluated to avoid confusion between context parameters and retrieve data.</p>\n</div></td></tr><tr><td>IN</td><td>prefetchData.descriptor</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/metadatatypes.html#DataRequirement\">DataRequirement</a></td><td/><td><div><p>A DataRequirement describing the content of the prefetch item.</p>\n</div></td></tr><tr><td>IN</td><td>prefetchData.data</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>The prefetch data as a Bundle. If this part is missing, it indicates there is no data associated with this prefetch item.</p>\n</div></td></tr><tr><td>IN</td><td>dataEndpoint</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/endpoint.html\">Endpoint</a></td><td/><td><div><p>An endpoint to use to access data referenced by retrieve operations in the library. If provided, this endpoint is used after the data or prefetchData bundles, and the server, if the useServerData parameter is true.</p>\n</div></td></tr><tr><td>IN</td><td>contentEndpoint</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/endpoint.html\">Endpoint</a></td><td/><td><div><p>An endpoint to use to access content (i.e. libraries) referenced by the library. If no content endpoint is supplied, the evaluation will attempt to retrieve content from the server on which the operation is being performed.</p>\n</div></td></tr><tr><td>IN</td><td>terminologyEndpoint</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/endpoint.html\">Endpoint</a></td><td/><td><div><p>An endpoint to use to access terminology (i.e. valuesets, codesystems, and membership testing) referenced by the library. If no terminology endpoint is supplied, the evaluation will attempt to use the server on which the operation is being performed as the terminology server.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..*</td><td><a href=\"http://hl7.org/fhir/R4/resource.html\">Resource</a></td><td/><td><div><p>The result of evaluating the given expression, returned as a FHIR Type following the mapping from <a href=\"conformance.html#fhir-type-mapping\">CQL to FHIR</a> types. If the result is a list, the parameter will be repeated for each element in the list, with the special case that an empty list is represented with a parameter with a cqf-cqlType extension indicating the type of the result (e.g. List<Integer>) and the cqf-isEmptyList extension</p>\n<p>Because the cardinality of the return parameter is 1..*, the result of the $cql evaluate will always be a Parameters resource.</p>\n</div></td></tr></table></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"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/OperationDefinition/cql-cql",
"version" : "2.0.0-ballot",
"name" : "CQLCQL",
"title" : "CQL CQL",
"status" : "active",
"kind" : "operation",
"experimental" : false,
"date" : "2023-11-27T16:26:11+00:00",
"publisher" : "HL7 International / Clinical Decision Support",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/dss"
}
]
}
],
"description" : "The $cql operation evaluates a CQL expression and returns the result. The operation has a single return parameter that can be of any type to accommodate the possible result types of a CQL expression.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"purpose" : "This operation is defined to support evaluating CQL expressions directly via an operation",
"affectsState" : false,
"code" : "cql",
"system" : true,
"type" : false,
"instance" : false,
"parameter" : [
{
"name" : "subject",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Subject for which the expression will be evaluated. This corresponds to the context in which the expression will be evaluated and is represented as a relative FHIR id (e.g. Patient/123), which establishes both the context and context value for the evaluation",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "expression",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Expression to be evaluated. Note that this is an expression of CQL, not the text of a library with definition statements.",
"type" : "string"
},
{
"name" : "parameters",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Any input parameters for the expression. Parameters defined in this input will be made available by name to the CQL expression. Parameter types are mapped to CQL as specified in the Using CQL section of this implementation guide. If a parameter appears more than once in the input Parameters resource, it is represented with a List in the input CQL. If a parameter has parts, it is represented as a Tuple in the input CQL.",
"type" : "Parameters"
},
{
"name" : "library",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "A library to be included. The library is resolved by url and made available by name within the expression to be evaluated.",
"part" : [
{
"name" : "url",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The canonical url (with optional version) of the library to be included",
"type" : "canonical"
},
{
"name" : "name",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The name of the library to be used to reference the library within the CQL expression. If no name is provided, the name of the library will be used",
"type" : "string"
}
]
},
{
"name" : "useServerData",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Whether to use data from the server performing the evaluation. If this parameter is true (the default), then the operation will use data first from any bundles provided as parameters (through the data and prefetch parameters), second data from the server performing the operation, and third, data from the dataEndpoint parameter (if provided). If this parameter is false, the operation will use data first from the bundles provided in the data or prefetch parameters, and second from the dataEndpoint parameter (if provided).",
"type" : "boolean"
},
{
"name" : "data",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Data to be made available to the library evaluation. This parameter is exclusive with the prefetchData parameter (i.e. either provide all data as a single bundle, or provide data using multiple bundles with prefetch descriptions).",
"type" : "Bundle"
},
{
"name" : "prefetchData",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Data to be made available to the library evaluation, organized as prefetch response bundles. Each prefetchData parameter specifies either the name of the prefetchKey it is satisfying, a DataRequirement describing the prefetch, or both.",
"part" : [
{
"name" : "key",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The key of the prefetch item. When using this operation as part of a CDS Hooks implementation, this SHALL be the name of a prefetch item in a CDS Hooks discovery response. Prefetch data SHALL be made available to retrieve statements in the CQL and SHOULD NOT be provided as the value of any CQL parameters in the library being evaluated to avoid confusion between context parameters and retrieve data.",
"type" : "string"
},
{
"name" : "descriptor",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A DataRequirement describing the content of the prefetch item.",
"type" : "DataRequirement"
},
{
"name" : "data",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The prefetch data as a Bundle. If this part is missing, it indicates there is no data associated with this prefetch item.",
"type" : "Bundle"
}
]
},
{
"name" : "dataEndpoint",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "An endpoint to use to access data referenced by retrieve operations in the library. If provided, this endpoint is used after the data or prefetchData bundles, and the server, if the useServerData parameter is true.",
"type" : "Endpoint"
},
{
"name" : "contentEndpoint",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "An endpoint to use to access content (i.e. libraries) referenced by the library. If no content endpoint is supplied, the evaluation will attempt to retrieve content from the server on which the operation is being performed.",
"type" : "Endpoint"
},
{
"name" : "terminologyEndpoint",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "An endpoint to use to access terminology (i.e. valuesets, codesystems, and membership testing) referenced by the library. If no terminology endpoint is supplied, the evaluation will attempt to use the server on which the operation is being performed as the terminology server.",
"type" : "Endpoint"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "*",
"documentation" : "The result of evaluating the given expression, returned as a FHIR Type following the mapping from [CQL to FHIR](conformance.html#fhir-type-mapping) types. If the result is a list, the parameter will be repeated for each element in the list, with the special case that an empty list is represented with a parameter with a cqf-cqlType extension indicating the type of the result (e.g. List<Integer>) and the cqf-isEmptyList extension\n\nBecause the cardinality of the return parameter is 1..*, the result of the $cql evaluate will always be a Parameters resource.",
"type" : "Resource"
}
]
}
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