type: resource-definitionsresource: GuidanceResponse

GuidanceResponse Definitions

GuidanceResponse

The formal response to a guidance request

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..*

Mappings: workflow=Event; w5=clinical.general

GuidanceResponse.requestIdentifier

The identifier of the request associated with this response, if any

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

Business identifier for guidance response

Definition: Business identifiers assigned to this guidance response by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.

Comments: Note: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

Requirements: Allows identification of the guidance response as it is known by various participating systems and in a way that remains consistent across servers.

Cardinality: 0..*

Type: Identifier

Summary: true

Mappings: workflow=Event.identifier; w5=FiveWs.identifier

GuidanceResponse.module[x]

What guidance was requested

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

Cardinality: 1..1

Type: uri, canonical, CodeableConcept

Binding: example:guidance-module-code

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.

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

Cardinality: 1..1

Type: code

Binding: required:guidance-response-status

Summary: true

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)

Mappings: workflow=Event.status; w5=FiveWs.status

GuidanceResponse.subject

Individual service was done for/to

Definition: The individual or set of individuals the action is being or was performed on.

Requirements: Links the guidance response to the Patient context. May also affect access control.

Cardinality: 0..1

Type: Reference(Patient, Group)

Summary: true

Mappings: workflow=Event.subject; w5=FiveWs.subject

GuidanceResponse.encounter

Encounter the guidance response is part of

Definition: The Encounter during which this guidance response was created or to which the creation of this record is tightly associated.

Comments: This will typically be the encounter the guidance response was created during, but some guidance responses may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests).

Requirements: Links the guidance response to the Encounter context. May also affect access control.

Cardinality: 0..1

Type: Reference(Encounter)

Summary: true

Mappings: workflow=Event.encounter; w5=FiveWs.context

GuidanceResponse.occurrenceDateTime

When the guidance response was processed

Definition: Indicates when the guidance response was processed.

Cardinality: 0..1

Type: dateTime

Summary: true

Mappings: workflow=Event.occurrence[x]; w5=FiveWs.done[x]

GuidanceResponse.performer

Device returning the guidance

Definition: Provides a reference to the device that performed the guidance.

Cardinality: 0..1

Type: Reference(Device)

Mappings: workflow=Event.performer.actor; w5=FiveWs.actor

GuidanceResponse.location

Where guidance response occurred

Definition: The principal physical location where the guidance response was performed.

Requirements: Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting).

Cardinality: 0..1

Type: Reference(Location)

Summary: true

Mappings: workflow=Event.location

GuidanceResponse.reason

Why guidance is needed

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.

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 [[[http://hl7.org/fhir/StructureDefinition/targetElement]]] and [[[http://hl7.org/fhir/StructureDefinition/targetPath]]] extensions to indicate the specific elements relevant to providing the reason for the guidance.

Cardinality: 0..*

Type: CodeableReference

Summary: true

Mappings: workflow=Event.reason; w5=FiveWs.why[x]

GuidanceResponse.note

Additional notes about the response

Definition: Provides a mechanism to communicate additional information about the response.

Cardinality: 0..*

Type: Annotation

Mappings: workflow=Event.note

GuidanceResponse.evaluationMessage

Messages resulting from the evaluation of the artifact or artifacts

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..1

Type: Reference(OperationOutcome)

GuidanceResponse.outputParameters

The output parameters of the evaluation, if any

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

Proposed actions, if any

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

Cardinality: 0..*

Type: Reference(Appointment, AppointmentResponse, CarePlan, Claim, CommunicationRequest, Contract, CoverageEligibilityRequest, DeviceRequest, EnrollmentRequest, MedicationRequest, NutritionOrder, RequestOrchestration, ServiceRequest, Task, VisionPrescription)

GuidanceResponse.dataRequirement

Additional required data

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