Release 4 5 Preview #3
This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Clinical Decision Support Work Group Maturity Level : 2   Trial Use Security Category : Patient Compartments : Not linked to any defined compartments

Detailed Descriptions for the elements in the GuidanceResponse resource.

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

Cardinality 0..*
Type DomainResource
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.

GuidanceResponse.requestIdentifier
Element Id GuidanceResponse.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.

Cardinality 0..1
Type Identifier
Summary true
GuidanceResponse.identifier
Element Id GuidanceResponse.identifier
Definition

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

Note This is a business identifier, not a resource identifier (see discussion )
Cardinality 0..*
Type Identifier
Summary true
GuidanceResponse.module[x]
Element Id GuidanceResponse.module[x]
Definition

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

Cardinality 1..1
Type uri | canonical | CodeableConcept
[x] Note See Choice of Data Types for further information about how to use [x]
Summary true
GuidanceResponse.status
Element Id 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.

Cardinality 1..1
Terminology Binding GuidanceResponseStatus ( Required )
Type code
Is Modifier true (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)
Summary true
Comments

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

GuidanceResponse.subject
Element Id GuidanceResponse.subject
Definition

The patient for which the request was processed.

Cardinality 0..1
Type Reference ( Patient | Group )
Patterns Reference(Patient,Group): Common patterns = Participant
GuidanceResponse.encounter
Element Id GuidanceResponse.encounter
Definition

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

Cardinality 0..1
Type Reference ( Encounter )
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 Id GuidanceResponse.occurrenceDateTime
Definition

Indicates when the guidance response was processed.

Cardinality 0..1
Type dateTime
GuidanceResponse.performer
Element Id GuidanceResponse.performer
Definition

Provides a reference to the device that performed the guidance.

Cardinality 0..1
Type Reference ( Device )
GuidanceResponse.reasonCode GuidanceResponse.reason
Element Id GuidanceResponse.reasonCode GuidanceResponse.reason
Definition

Describes the reason for the guidance response in coded or textual form. Cardinality 0..* Type CodeableConcept GuidanceResponse.reasonReference Element Id GuidanceResponse.reasonReference Definition 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.

Cardinality 0..*
Type Reference CodeableReference ( Condition | Observation | DiagnosticReport | DocumentReference )
Patterns CodeableReference(Condition,Observation,DiagnosticReport,DocumentReference): Common patterns = Event
GuidanceResponse.note
Element Id GuidanceResponse.note
Definition

Provides a mechanism to communicate additional information about the response.

Cardinality 0..*
Type Annotation
GuidanceResponse.evaluationMessage
Element Id 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.

Cardinality 0..*
Type Reference ( OperationOutcome )
GuidanceResponse.outputParameters
Element Id 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.

Cardinality 0..1
Type Reference ( Parameters )
GuidanceResponse.result
Element Id GuidanceResponse.result
Definition

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

Cardinality 0..1
Type Reference ( CarePlan | RequestGroup )
Patterns Reference(CarePlan,RequestGroup): Common patterns = Request
GuidanceResponse.dataRequirement
Element Id 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.

Cardinality 0..*
Type DataRequirement