FHIR Release 3 (STU)

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

Operation-servicedefinition-evaluate

Clinical Decision Support Work Group

Maturity Level: N/A

Ballot Status: Informative

Compartments: Not linked to any defined compartments

This is the narrative for the resource. See also the XML or JSON format.

Evaluate

OPERATION: Evaluate

The official URL for this operation definition is:

http://hl7.org/fhir/OperationDefinition/ServiceDefinition-evaluate

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

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

Parameters

Use

Name

Cardinality

Type

Binding

Documentation

IN

requestId

0..1

id

An optional client-provided identifier to track the request.

IN

evaluateAtDateTime

0..1

dateTime

An 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.

IN

inputParameters

0..1

Parameters

The 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.

IN

inputData

0..*

Any

The input data for the request. These data are defined by the data requirements of the module and typically provide patient-dependent information.

IN

patient

0..1

Reference

The patient in context, if any.

IN

encounter

0..1

Reference

The encounter in context, if any.

IN

initiatingOrganization

0..1

Reference

The organization initiating the request.

IN

initiatingPerson

0..1

Reference

The person initiating the request.

IN

userType

0..1

CodeableConcept

The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.).

IN

userLanguage

0..1

CodeableConcept

Preferred language of the person using the system.

IN

userTaskContext

0..1

CodeableConcept

The 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.

IN

receivingOrganization

0..1

Reference

The organization that will receive the response.

IN

receivingPerson

0..1

Reference

The person in the receiving organization that will receive the response.

IN

recipientType

0..1

CodeableConcept

The 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.).

IN

recipientLanguage

0..1

CodeableConcept

Preferred language of the person that will consume the content.

IN

setting

0..1

CodeableConcept

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

IN

settingContext

0..1

CodeableConcept

Additional detail about the setting of the request, if any.

OUT

return

1..1

GuidanceResponse

The result of the request as a GuidanceResponse resource.

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.