STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 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 . Page versions: R5 R4B R4 R3

4.20.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 guidance request, including any output parameters returned by the evaluation, as well as the 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 given as part of the request, it will be reproduced 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 the knowledge module that was invoked.

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. The identifier SHALL be unique within the container in which it appears, and MAY be universally unique.

Control0..1
TypeIdentifier
GuidanceResponse.action.label
Definition

A user-visible label for the action.

Control0..1
Typestring
GuidanceResponse.action.title
Definition

The title of the action displayed to a user.

Control0..1
Typestring
GuidanceResponse.action.description
Definition

A short description of the action used to provide a summary to display to the user.

Control0..1
Typestring
GuidanceResponse.action.textEquivalent
Definition

A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that may not be capable of interpreting it dynamically.

Control0..1
Typestring
GuidanceResponse.action.concept
Definition

The concept represented by this action or its sub-actions.

Control0..*
TypeCodeableConcept
GuidanceResponse.action.supportingEvidence
Definition

The evidence grade and the sources of evidence for this action.

Control0..*
TypeAttachment
GuidanceResponse.action.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

Control0..1
GuidanceResponse.action.relatedAction.actionIdentifier
Definition

The unique identifier of the related action.

Control1..1
TypeIdentifier
GuidanceResponse.action.relatedAction.relationship
Definition

The relationship of this action to the related action.

Control1..1
BindingActionRelationshipType: Defines the types of relationships between actions (Required)
Typecode
GuidanceResponse.action.relatedAction.offset[x]
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

Control0..1
TypeDuration|Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
GuidanceResponse.action.relatedAction.anchor
Definition

An optional indicator for how the relationship is anchored to the related action. For example "before the start" or "before the end" of the related action.

Control0..1
BindingActionRelationshipAnchor: Defines possible anchors for the relationship between actions (Required)
Typecode
GuidanceResponse.action.documentation
Definition

Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.

Control0..*
TypeAttachment
GuidanceResponse.action.participant
Definition

The participant in the action.

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

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

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

A behavior associated with the action. Behaviors define how the action is to be presented and/or executed within the receiving environment.

Control0..*
GuidanceResponse.action.behavior.type
Definition

The type of the behavior to be described, such as grouping, visual, or selection behaviors.

Control1..1
BindingActionBehaviorType: The type of behavior to be defined (Required)
TypeCoding
GuidanceResponse.action.behavior.value
Definition

The specific behavior. The code used here is determined by the type of behavior being described. For example, the grouping behavior uses the grouping-behavior-type valueset.

Control1..1
TypeCoding
GuidanceResponse.action.resource
Definition

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

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

Sub actions.

Control0..*
TypeSee GuidanceResponse.action
GuidanceResponse.dataRequirement
Definition

If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.

Control0..*
TypeDataRequirement