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.

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.

Allows a service to provide a unique, business identifier for the response.

A reference to the knowledge module that was invoked.

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.

The patient for which the request was processed.

Allows the context of the guidance response to be provided if available. In a service context, this would likely be unavailable.

Indicates when the guidance response was processed.

Provides a reference to the device that performed the guidance.

Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.

Provides a mechanism to communicate additional information about the response.

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.

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.

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

A unique identifier for the action. The identifier SHALL be unique within the container in which it appears, and MAY be universally unique.

A user-visible label for the action.

The title of the action displayed to a user.

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

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.

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

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.

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

The unique identifier of the related action.

The relationship of this action to the related action.

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

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.

An optional value describing when the action should be performed.

The participant in the action.

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

Defines the grouping behavior for the action and its children.

Defines the selection behavior for the action and its children.

Defines the requiredness behavior for the action.

Defines whether the action should usually be preselected.

Defines whether the action can be selected multiple times.

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

Sub actions.

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.