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 . Page versions: R5 R4B R4 R3

4.18.4 Resource GuidanceResponse - Detailed Descriptions

Detailed Descriptions for the elements in the GuidanceResponse resource.

GuidanceResponse
Definition

A guidance response is the formal response to a previous guidance request. It is a derivative of the knowledge response that provides additional information relevant specifically to clinical decision support such as a description of any proposed actions to be taken.

Control1..1
GuidanceResponse.requestId
Definition

The id of the request associated with this response. If an id was provided as part of the request, it will be provided here to enable the requester to more easily identify the response in a multi-request scenario.

Control0..1
Typestring
GuidanceResponse.module
Definition

A reference to a knowledge module involved in an interaction.

Control1..1
TypeReference(DecisionSupportServiceModule | DecisionSupportRule)
Is Modifiertrue
Summarytrue
GuidanceResponse.status
Definition

The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.

Control1..1
BindingGuidanceResponseStatus: The status of a guidance response (Required)
Typecode
Is Modifiertrue
Summarytrue
GuidanceResponse.evaluationMessage
Definition

Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.

Control0..*
TypeReference(OperationOutcome)
GuidanceResponse.outputParameters
Definition

The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.

Control0..1
TypeReference(Parameters)
GuidanceResponse.action
Definition

The actions, if any, produced by the evaluation of the artifact.

Control0..*
GuidanceResponse.action.actionIdentifier
Definition

A unique identifier for the action.

Control0..1
TypeIdentifier
GuidanceResponse.action.number
Definition

A user-visible number for the action.

Control0..1
Typestring
GuidanceResponse.action.supportingEvidence
Definition

Supporting evidence for the action.

Control0..*
TypeAttachment
GuidanceResponse.action.documentation
Definition

Supporting documentation for the action.

Control0..*
TypeAttachment
GuidanceResponse.action.participant
Definition

The participant in the action.

Control0..*
TypeReference(Patient | Person | Practitioner | RelatedPerson)
GuidanceResponse.action.title
Definition

The title of the action.

Control0..1
Typestring
GuidanceResponse.action.description
Definition

A short description of the action.

Control0..1
Typestring
GuidanceResponse.action.textEquivalent
Definition

A text equivalent of the action to be performed.

Control0..1
Typestring
GuidanceResponse.action.concept
Definition

Concepts associated with the action.

Control0..*
TypeCodeableConcept
GuidanceResponse.action.type
Definition

The type of action to perform (create, update, remove).

Control0..1
BindingGuidanceResponseActionType: The type of action to be performed (Required)
Typecode
GuidanceResponse.action.resource
Definition

The resource that is the target of the action (e.g. CommunicationRequest).

Control0..1
TypeReference(Any)
GuidanceResponse.action.actions
Definition

Sub actions.

Control0..*
TypeSee GuidanceResponse.action