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.18.4 Resource GuidanceRequest - Detailed Descriptions

Detailed Descriptions for the elements in the GuidanceRequest resource.

GuidanceRequest
Definition

A guidance request is a request to evaluate a particular knowledge module focused on decision support, providing information relevant to decision support such as workflow and user context.

Control1..1
GuidanceRequest.module
Definition

A reference to a knowledge module involved in an interaction.

Control1..1
TypeReference(DecisionSupportRule | DecisionSupportServiceModule)
Is Modifiertrue
Summarytrue
GuidanceRequest.dateTime
Definition

The date and time of the request, with respect to the initiator.

Control0..1
TypedateTime
GuidanceRequest.evaluateAtDateTime
Definition

Indicates 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 requestDateTime is assumed.

Control0..1
TypedateTime
GuidanceRequest.inputParameters
Definition

The input parameters for a request, if any. These parameters are used to provide patient-independent information to the evaluation. Patient-specific information is either accessed directly as part of the evaluation (because the evaluation engine and the patient-data are co-located) or provided as part of the operation input in the form of resources.

Control0..1
TypeReference(Parameters)
GuidanceRequest.initiatingOrganization
Definition

The organization initiating the request.

Control0..1
TypeReference(Organization)
GuidanceRequest.initiatingPerson
Definition

The person initiating the request.

Control0..1
TypeReference(Person | Patient | Practitioner | RelatedPerson)
GuidanceRequest.userType
Definition

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

Control0..1
TypeCodeableConcept
GuidanceRequest.userLanguage
Definition

Preferred language of the person using the system.

Control0..1
BindingLanguage : Required: IETF language tag (A human language.)
TypeCodeableConcept
GuidanceRequest.userTaskContext
Definition

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.

Control0..1
TypeCodeableConcept
GuidanceRequest.receivingOrganization
Definition

The organization that will receive the response.

Control0..1
TypeReference(Organization)
GuidanceRequest.receivingPerson
Definition

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

Control0..1
TypeReference(Person | Patient | Practitioner | RelatedPerson)
GuidanceRequest.recipientType
Definition

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

Control0..1
TypeCodeableConcept
GuidanceRequest.recipientLanguage
Definition

Preferred language of the person that will consume the content.

Control0..1
BindingLanguage : Required: IETF language tag (A human language.)
TypeCodeableConcept
GuidanceRequest.encounterClass
Definition

The class of encounter (inpatient, outpatient, etc).

Control0..1
BindingEncounterClass: Classification of the encounter (Required)
TypeCodeableConcept
GuidanceRequest.encounterType
Definition

The type of the encounter.

Control0..1
BindingEncounterType: The type of encounter (Example)
TypeCodeableConcept