Connectathon 11 Snapshot

This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

4.11.8 Resource DecisionSupportRule - Operations

This resource has 1 operation associated with it:

$evaluateEvaluate

For more information about operations, including how they are invoked, see Operations.

4.11.8.1 Evaluate

The evaluate operation requests clinical decision support guidance based on a specific decision support module

Formal Definition (as a OperationDefinition).

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

In Parameters:
NameCardinalityTypeBindingProfileDocumentation
requestId0..1code

An optional client-provided identifier to track the request

evaluateAtDateTime0..1datetime

An optional date and time specifying that the evaluation should be performed as thought it was the given date and time. The most direct implication of this is that references to "Now" within the evaluation logic of the module should result in this value. In addition, wherever possible, the data accessed by the module should appear as though it was accessed at this time. The evaluateAtDateTime value may be any time in the past or future, enabling both retrospective and prospective scenarios. If no value is provided, the date and time of the request is assumed

inputParameters0..1Parameters

The input parameters for a request, if any. These parameters are defined by the module that is the target of the evaluation, and supply the input information to the module.

setting0..1CodeableConcept

The current setting of the request (inpatient, outpatient, etc)

settingContext0..1CodeableConcept

Additional detail about the setting of the request, if any

Out Parameters:
NameCardinalityTypeBindingProfileDocumentation
return1..1GuidanceResponse

The result of the request as a GuidanceResponse resource. Output parameters, if any, will be contained in the parameters element of the response

Note: as this the only out parameter, it is a resource, and it has the name 'return', the result of this operation is returned directly as a resource