$evaluate

Evaluate

draftFHIR R3 package : Core3.0.2operation17 inputs1 output

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

Metadata

hl7.org/fhir
Canonical URL
http://hl7.org/fhir/OperationDefinition/ServiceDefinition-evaluate
Code
$evaluate
Kind
operation
Affects State
No
Publisher
HL7 (FHIR Project)

Invocation Context

Can be invoked at:
Instance Level
Target Resources:
ServiceDefinition

Input Parameters (17)

NameTypeCard.Description
requestIdid0..1An optional client-provided identifier to track the request.
evaluateAtDateTimedateTime0..1An optional date and time specifying that the evaluation should be performed as though 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.
inputParametersParameters0..1The input parameters for a request, if any. These parameters are defined by the module that is the target of the evaluation, and typically supply patient-independent information to the module.
inputDataAny0..*The input data for the request. These data are defined by the data requirements of the module and typically provide patient-dependent information.
patientReference0..1The patient in context, if any.
encounterReference0..1The encounter in context, if any.
initiatingOrganizationReference0..1The organization initiating the request.
initiatingPersonReference0..1The person initiating the request.
userTypeCodeableConcept0..1The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.).
userLanguageCodeableConcept0..1Preferred language of the person using the system.
userTaskContextCodeableConcept0..1The task the system user is performing, e.g. laboratory results review, medication list review, etc. This information can be used to tailor decision support outputs, such as recommended information resources.
receivingOrganizationReference0..1The organization that will receive the response.
receivingPersonReference0..1The person in the receiving organization that will receive the response.
recipientTypeCodeableConcept0..1The type of individual that will consume the response content. This may be different from the requesting user type (e.g. if a clinician is getting disease management guidance for provision to a patient). E.g. patient, healthcare provider or specific type of healthcare provider (physician, nurse, etc.).
recipientLanguageCodeableConcept0..1Preferred language of the person that will consume the content.
settingCodeableConcept0..1The current setting of the request (inpatient, outpatient, etc).
settingContextCodeableConcept0..1Additional detail about the setting of the request, if any.

Output Parameters (1)

NameTypeCard.Description
returnGuidanceResponse1..1The result of the request as a GuidanceResponse resource.

Additional Information

Date
2019-10-24T11:53:00+11:00