url | canonical | 0..1 | The canonical url (with optional version) of the library to be evaluated. This parameter is only used when the operation is invoked at the type level, and is exclusive with the library parameter. |
library | Library | 0..1 | The library 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. |
subject | string | 0..1 | Subject for which the library will be evaluated. This corresponds to the context in which the library 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 |
expression | string | 0..* | The identifier (optionally qualified) of the expression(s) to be evaluated, regardless of whether the declaration is private. If no expression names are provided, the operation evaluates all public expression definitions in the library (or all expressions if includePrivate is true). If an expression name is unqualified, it refers to the name of an expression defined in the library being evaluated. If the expression name is qualified, the name refers to an the identifier of an expression defined 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). Note that this may result in expression results being included multiple times, as expressions in included libraries may be invoked multiple times from the library being evaluated. |
includePrivate | boolean | 0..1 | Indicates whether to include private expression declarations in the result. Note that if expressions are named, this parameter is ignored. If this parameter is not provided, the default behavior is that only public expression declarations will be included. |
parameters | Parameters | 0..1 | Any input parameters for the library. Parameters defined in this input will be bound by name to 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). |
useServerData | boolean | 0..1 | 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). |
data | Bundle | 0..1 | 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). |
prefetchData | any | 0..* | 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. |
dataEndpoint | Endpoint | 0..1 | 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. |
contentEndpoint | Endpoint | 0..1 | 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. |
terminologyEndpoint | Endpoint | 0..1 | 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. |