Path | Short | Definition | Comments |
---|---|---|---|
The formal response to a guidance request | 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. | ||
requestIdentifier | The identifier of the request associated with this response, if any | The identifier of the request associated with this response. If an identifier 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. | |
identifier | Business identifier | Allows a service to provide unique, business identifiers for the response. | |
module[x] | What guidance was requested | An identifier, CodeableConcept or canonical reference to the guidance that was requested. | |
status | success | data-requested | data-required | in-progress | failure | entered-in-error | 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. | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
subject | Patient the request was performed for | The patient for which the request was processed. | |
encounter | Encounter during which the response was returned | The encounter during which this response was created or to which the creation of this record is tightly associated. | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official copmletion of an encounter but still be tied to the context of the encounter. |
occurrenceDateTime | When the guidance response was processed | Indicates when the guidance response was processed. | |
performer | Device returning the guidance | Provides a reference to the device that performed the guidance. | |
reasonCode | Why guidance is needed | Describes the reason for the guidance response in coded or textual form. | |
reasonReference | Why guidance is needed | 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. | |
note | Additional notes about the response | Provides a mechanism to communicate additional information about the response. | |
evaluationMessage | Messages resulting from the evaluation of the artifact or artifacts | 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. | |
outputParameters | The output parameters of the evaluation, if any | 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. | |
result | Proposed actions, if any | The actions, if any, produced by the evaluation of the artifact. | |
dataRequirement | Additional required data | 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. |
The GuidanceResponse resource is used to represent the result of invoking a decision support service. It provides a container for the status of the response, any warnings or messages returned by the service, as well as any output data from the service and any suggested actions to be performed.
Use cases for the GuidanceResponse resource include:
In addition, the GuidanceResponse resource is aligned with the CDS Hooks response structure and so provides a mechanism to record the results of CDS Hooks interactions. For a detailed discussion of how the GuidanceResponse resource can be used for this purpose, refer to the Evaluation topic in the Clinical Reasoning module.
Although the GuidanceResponse resource does define search parameters, it is up to the individual decision support service whether or not historical records of guidance requests are preserved. A service might not support searching on GuidanceResponses at all, or it may support searching only for a pre-defined expiration period. The search parameters are defined to provide consumers with a consistent interface to searching if it is available for a specific service implementation. In any case, services should detail the support they do provide using a CapabilityStatement.
identifier | The identifier of the guidance response | GuidanceResponse.identifier |
patient | The identity of a patient to search for guidance response results | GuidanceResponse.subject.where(resolve() is Patient) |
request | The identifier of the request associated with the response | GuidanceResponse.requestIdentifier |
subject | The subject that the guidance response is about | GuidanceResponse.subject |
Defines a GuidanceResponse that represents the response container for a CDS Hooks response
Path | Short | Definition | Comments |
---|---|---|---|
The formal response to a guidance request | 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. | ||
requestIdentifier | The identifier of the request associated with this response, if any | The identifier of the request associated with this response. If an identifier 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. | |
identifier | Business identifier | Allows a service to provide unique, business identifiers for the response. | |
module[x] | What guidance was requested | An identifier, CodeableConcept or canonical reference to the guidance that was requested. | |
status | success | data-requested | data-required | in-progress | failure | entered-in-error | 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. | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
subject | Patient the request was performed for | The patient for which the request was processed. | |
encounter | Encounter during which the response was returned | The encounter during which this response was created or to which the creation of this record is tightly associated. | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official copmletion of an encounter but still be tied to the context of the encounter. |
occurrenceDateTime | When the guidance response was processed | Indicates when the guidance response was processed. | |
performer | Device returning the guidance | Provides a reference to the device that performed the guidance. | |
reasonCode | Why guidance is needed | Describes the reason for the guidance response in coded or textual form. | |
reasonReference | Why guidance is needed | 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. | |
note | Additional notes about the response | Provides a mechanism to communicate additional information about the response. | |
evaluationMessage | Messages resulting from the evaluation of the artifact or artifacts | 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. | |
outputParameters | The output parameters of the evaluation, if any | 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. | |
result | Proposed actions, if any | The actions, if any, produced by the evaluation of the artifact. | |
dataRequirement | Additional required data | 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. |