Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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 UseSecurity Category: Patient Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the GuidanceResponse resource.

GuidanceResponse
Element IdGuidanceResponse
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.

Short DisplayThe formal response to a guidance request
Cardinality0..*
TypeDomainResource
Requirements

The GuidanceResponse resource supports recording the results of decision support interactions, reportability determination for public health, as well as the communication of additional data requirements for subsequent interactions.

Summaryfalse
GuidanceResponse.requestIdentifier
Element IdGuidanceResponse.requestIdentifier
Definition

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.

Short DisplayThe identifier of the request associated with this response, if any
Cardinality0..1
TypeIdentifier
Summarytrue
GuidanceResponse.identifier
Element IdGuidanceResponse.identifier
Definition

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

Short DisplayBusiness identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Summarytrue
GuidanceResponse.module[x]
Element IdGuidanceResponse.module[x]
Definition

An identifier, CodeableConcept or canonical reference to the guidance that was requested.

Short DisplayWhat guidance was requested
Cardinality1..1
Terminology BindingGuidanceModuleCode (Example)
Typeuri|canonical|CodeableConcept
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
GuidanceResponse.status
Element IdGuidanceResponse.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.

Short Displaysuccess | data-requested | data-required | in-progress | failure | entered-in-error
Cardinality1..1
Terminology BindingGuidanceResponseStatus (Required)
Typecode
Is Modifiertrue (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid)
Summarytrue
Comments

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

GuidanceResponse.subject
Element IdGuidanceResponse.subject
Definition

The patient for which the request was processed.

Short DisplayPatient the request was performed for
Cardinality0..1
TypeReference(Patient | Group)
Summaryfalse
GuidanceResponse.encounter
Element IdGuidanceResponse.encounter
Definition

The encounter during which this response was created or to which the creation of this record is tightly associated.

Short DisplayEncounter during which the response was returned
Cardinality0..1
TypeReference(Encounter)
Summaryfalse
Comments

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.

GuidanceResponse.occurrenceDateTime
Element IdGuidanceResponse.occurrenceDateTime
Definition

Indicates when the guidance response was processed.

Short DisplayWhen the guidance response was processed
Cardinality0..1
TypedateTime
Summaryfalse
GuidanceResponse.performer
Element IdGuidanceResponse.performer
Definition

Provides a reference to the device that performed the guidance.

Short DisplayDevice returning the guidance
Cardinality0..1
TypeReference(Device)
Summaryfalse
GuidanceResponse.reason
Element IdGuidanceResponse.reason
Definition

Describes the reason for the guidance response in coded or textual form, or 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.

Short DisplayWhy guidance is needed
Cardinality0..*
TypeCodeableReference
Summaryfalse
Comments

Although this reference can be used to point to any resource, it is typically expected to refer to subject-specific data appropriate to the subject of the guidance. For example, patient-based decision support would be expected to reference patient-level data. In addition, implementations should provide as much detail as possible by using the targetElement and targetPath extensions to indicate the specific elements relevant to providing the reason for the guidance.

GuidanceResponse.note
Element IdGuidanceResponse.note
Definition

Provides a mechanism to communicate additional information about the response.

Short DisplayAdditional notes about the response
Cardinality0..*
TypeAnnotation
Summaryfalse
GuidanceResponse.evaluationMessage
Element IdGuidanceResponse.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.

Short DisplayMessages resulting from the evaluation of the artifact or artifacts
Cardinality0..*
TypeReference(OperationOutcome)
Summaryfalse
GuidanceResponse.outputParameters
Element IdGuidanceResponse.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.

Short DisplayThe output parameters of the evaluation, if any
Cardinality0..1
TypeReference(Parameters)
Summaryfalse
GuidanceResponse.result
Element IdGuidanceResponse.result
Definition

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

Short DisplayProposed actions, if any
Cardinality0..1
TypeReference(CarePlan | RequestOrchestration)
Summaryfalse
GuidanceResponse.dataRequirement
Element IdGuidanceResponse.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.

Short DisplayAdditional required data
Cardinality0..*
TypeDataRequirement
Summaryfalse