Using CQL With FHIR
2.1.0-cibuild - 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.1.0-cibuild 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

OperationDefinition: CQL Group Evaluate

Official URL: http://hl7.org/fhir/uv/cql/OperationDefinition/cql-group-evaluate Version: 2.1.0-cibuild
Standards status: Trial-use Maturity Level: 1 Computable Name: CQLGroupEvaluate
Other Identifiers: OID:2.16.840.1.113883.4.642.40.37.33.3

Evaluates the membership criteria of a group definition returns the results as an actual Group resource. The Group is expected to use the characteristicsExpression extension to define membership criteria.

Language: en

URL: [base]/Group/$evaluate

URL: [base]/Group/[id]/$evaluate

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INurl0..1canonical

The canonical url (with optional version) of the group to be evaluated. This parameter is only used when the operation is invoked at the type level, and is exclusive with the group parameter.

INgroup0..1Group

The group to be evaluated, provided as an input. This parameter is only used when the operation is invoked at the type level, and is exclusive with the url parameter.

INsubject0..1string
(reference)

Subject for which the group will be evaluated. This corresponds to the context in which the group 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

INparameters0..1Parameters

Any input parameters to the evaluation. Parameters defined in this input will be bound by name to the evaluation context. If the membership criteria is a CQL expression, these parameters will be available to the expression. If the membership criteria is a CQL identifier, these parameters will be bound by name to the parameters defined in the CQL library (or included libraries, recursively). 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. If parameter names are qualified, the parameter will be bound only to parameters in the library with the qualifier name, and the qualifier name must be the name of a library included by the library being evaluated (or an included library, recursively).

OUTreturn1..1Group

The results of the group evaluation, returned as an actual Group resource with members as determined by the evaluation of the membership criteria against the data present in the server.