Invocations

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

Parameters (In)

NameCardinalityTypeStructureDefinitionDocumentation
requestId0..1Id

An optional client-provided identifier to track the request.

evaluateAtDateTime0..1DateTime

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.

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 typically supply patient-independent information to the module.

inputData0..*Any

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

patient0..1ReferencePatient

The patient in context, if any.

encounter0..1ReferenceEncounter

The encounter in context, if any.

initiatingOrganization0..1ReferenceOrganization

The organization initiating the request.

initiatingPerson0..1Reference

The person initiating the request.

userType0..1CodeableConcept

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

userLanguage0..1CodeableConcept

Preferred language of the person using the system.

userTaskContext0..1CodeableConcept

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.

receivingOrganization0..1ReferenceOrganization

The organization that will receive the response.

receivingPerson0..1Reference

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

recipientType0..1CodeableConcept

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

recipientLanguage0..1CodeableConcept

Preferred language of the person that will consume the content.

setting0..1CodeableConcept

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

settingContext0..1CodeableConcept

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

Return Values (Out)

NameCardinalityTypeDocumentation
return1..1GuidanceResponse

The result of the request as a GuidanceResponse resource.