FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

14.15 Resource GuidanceResponse - Content

Clinical Decision Support icon Work GroupMaturity Level: 2 Trial UseSecurity Category: Patient Compartments: Group, Patient

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.

14.15.1 Scope and Usage

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:

  • Keeping a record of past service requests, including the ability to reference the context of the request such as the disease state
  • Representing additional data requirements for subsequent service requests
  • Representing Public Health case reporting and recording
  • Sharing the results of decision support guidance and determination of reportability with clinicians and public health agencies

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.

14.15.2 References to this Resource

14.15.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse TU DomainResource The formal response to a guidance request

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... requestIdentifier Σ 0..1 Identifier The identifier of the request associated with this response, if any
... identifier Σ 0..* Identifier Business identifier

... module[x] Σ 1..1 What guidance was requested
Binding: Guidance Module Code (Example)
.... moduleUri uri
.... moduleCanonical canonical()
.... moduleCodeableConcept CodeableConcept
... subject 0..1 Reference(Patient | Group) Patient the request was performed for
... encounter 0..1 Reference(Encounter) Encounter during which the response was returned
... occurrenceDateTime 0..1 dateTime When the guidance response was processed
... performer 0..1 Reference(Device) Device returning the guidance
... reason 0..* CodeableReference() Why guidance is needed

... note 0..* Annotation Additional notes about the response

... evaluationMessage 0..1 Reference(OperationOutcome) Messages resulting from the evaluation of the artifact or artifacts
... outputParameters 0..1 Reference(Parameters) The output parameters of the evaluation, if any
... result 0..* Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | Task | VisionPrescription) Proposed actions, if any

... dataRequirement 0..* DataRequirement Additional required data


doco Documentation for this format icon

See the Extensions for this resource

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

14.15.3.1 Terminology Bindings

Path ValueSet Type Documentation
GuidanceResponse.module[x] GuidanceModuleCode Example

Example guidance module codes.
GuidanceResponse.status GuidanceResponseStatus Required

The status of a guidance response.

14.15.4 GuidanceResponse Search

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.

14.15.5 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
identifier token The identifier of the guidance response GuidanceResponse.identifier 65 Resources
patient reference The identity of a patient to search for guidance response results GuidanceResponse.subject.where(resolve() is Patient)
(Patient)		 65 Resources
request token The identifier of the request associated with the response GuidanceResponse.requestIdentifier
status token The status of the guidance response GuidanceResponse.status
subject reference The subject that the guidance response is about GuidanceResponse.subject
(Group, Patient)