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
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. |
Control | 1..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. |
Control | 0..1 |
Type | string |
GuidanceResponse.module | |
Definition | A reference to a knowledge module involved in an interaction. |
Control | 1..1 |
Type | Reference(DecisionSupportServiceModule | DecisionSupportRule) |
Is Modifier | true |
Summary | true |
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. |
Control | 1..1 |
Binding | GuidanceResponseStatus: The status of a guidance response (Required) |
Type | code |
Is Modifier | true |
Summary | true |
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. |
Control | 0..* |
Type | Reference(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. |
Control | 0..1 |
Type | Reference(Parameters) |
GuidanceResponse.action | |
Definition | The actions, if any, produced by the evaluation of the artifact. |
Control | 0..* |
GuidanceResponse.action.actionIdentifier | |
Definition | A unique identifier for the action. |
Control | 0..1 |
Type | Identifier |
GuidanceResponse.action.number | |
Definition | A user-visible number for the action. |
Control | 0..1 |
Type | string |
GuidanceResponse.action.supportingEvidence | |
Definition | Supporting evidence for the action. |
Control | 0..* |
Type | Attachment |
GuidanceResponse.action.documentation | |
Definition | Supporting documentation for the action. |
Control | 0..* |
Type | Attachment |
GuidanceResponse.action.participant | |
Definition | The participant in the action. |
Control | 0..* |
Type | Reference(Patient | Person | Practitioner | RelatedPerson) |
GuidanceResponse.action.title | |
Definition | The title of the action. |
Control | 0..1 |
Type | string |
GuidanceResponse.action.description | |
Definition | A short description of the action. |
Control | 0..1 |
Type | string |
GuidanceResponse.action.textEquivalent | |
Definition | A text equivalent of the action to be performed. |
Control | 0..1 |
Type | string |
GuidanceResponse.action.concept | |
Definition | Concepts associated with the action. |
Control | 0..* |
Type | CodeableConcept |
GuidanceResponse.action.type | |
Definition | The type of action to perform (create, update, remove). |
Control | 0..1 |
Binding | GuidanceResponseActionType: The type of action to be performed (Required) |
Type | code |
GuidanceResponse.action.resource | |
Definition | The resource that is the target of the action (e.g. CommunicationRequest). |
Control | 0..1 |
Type | Reference(Any) |
GuidanceResponse.action.actions | |
Definition | Sub actions. |
Control | 0..* |
Type | See GuidanceResponse.action |