Implementation Guide for Astacus project
0.0.1 - ci-build France flag

Implementation Guide for Astacus project - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

OperationDefinition: Astacus Aggregator CQL

Official URL: https://aphp.fr/fhir/fr/astacus/OperationDefinition/astacus-aggregator-cql Version: 0.0.1
Draft as of 2023-04-07 Computable Name: AstacusAggregatorCQL

Evaluates a CQL expression and returns the results as a Parameters resource.

This operation is defined to support evaluating CQL expressions directly via an operation

URL: [base]/$agg-cql

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INexpression1..1string

Expression to be evaluated. Note that this is an expression of CQL, not the text of a library with definition statements.

INparameters0..1Parameters

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.

INlibrary0..*

A library to be included. The library is resolved by url and made available by name within the expression to be evaluated.

INlibrary.url1..1canonical

The canonical url (with optional version) of the library to be included

INlibrary.name0..1string

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

OUTreturn1..1Resource

A Bundle conforming to AstacusAggregatorBundle.

OUTissues0..1OperationOutcome

A list of hints and warnings about problems encountered while extracting the resource(s). If there was nothing to extract, a 'success' OperationOutcome is returned with a warning and/or information messages. In situations where the input is invalid or the operation otherwise fails to complete successfully, a normal 'erroneous' OperationOutcome would be returned (as happens with all operations) indicating what the issue was.