FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 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

Clinical Decision Support Work GroupMaturity Level: 2 Trial UseCompartments: Not linked to any defined compartments

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
Typeid
Summarytrue
GuidanceResponse.identifier
Definition

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

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Summarytrue
GuidanceResponse.module
Definition

A reference to the knowledge module that was invoked.

Control1..1
TypeReference(ServiceDefinition)
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
Terminology BindingGuidanceResponseStatus (Required)
Typecode
Is Modifiertrue
Summarytrue
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

GuidanceResponse.subject
Definition

The patient for which the request was processed.

Control0..1
TypeReference(Patient | Group)
GuidanceResponse.context
Definition

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

Control0..1
TypeReference(Encounter | EpisodeOfCare)
GuidanceResponse.occurrenceDateTime
Definition

Indicates when the guidance response was processed.

Control0..1
TypedateTime
GuidanceResponse.performer
Definition

Provides a reference to the device that performed the guidance.

Control0..1
TypeReference(Device)
GuidanceResponse.reason[x]
Definition

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.

Control0..1
TypeCodeableConcept|Reference(Any)
[x] NoteSee Choice of Data Types for further information about how to use [x]
GuidanceResponse.note
Definition

Provides a mechanism to communicate additional information about the response.

Control0..*
TypeAnnotation
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.result
Definition

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

Control0..1
TypeReference(CarePlan | RequestGroup)
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