Generated Narrative: OperationDefinition cql-group-evaluate

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.

 <status value="active"/> <kind value="operation"/> <experimental value="false"/> <date value="2023-11-27T16:26:11+00:00"/> <publisher value="HL7 International / Clinical Decision Support"/> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/dss"/> </telecom> </contact> <description value="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."/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> <display value="World"/> </coding> </jurisdiction> <purpose value="This operation is defined to support evaluating the membership criteria of a group definition directly via an operation"/> <affectsState value="false"/> <code value="evaluate"/> <resource value="Group"/> <system value="false"/> <type value="true"/> <instance value="true"/> <parameter> <name value="url"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="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."/> <type value="canonical"/> </parameter> <parameter> <name value="group"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="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."/> <type value="Group"/> </parameter> <parameter> <name value="subject"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="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"/> <type value="string"/> <searchType value="reference"/> </parameter> <parameter> <name value="parameters"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="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)."/> <type value="Parameters"/> </parameter> <parameter> <name value="return"/> <use value="out"/> <min value="1"/> <max value="1"/> <documentation value="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."/> <type value="Group"/> </parameter> </OperationDefinition>