FHIR CI-Build

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

17.13 Resource GuidanceResponse - Content

Responsible Owner: Clinical Decision Support icon Work Group NormativeSecurity 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.

17.13.1 Scope and Usage

Note to Balloters: Changes made since the previous ballot

  • Substantive:
    • FHIR-55225 icon - Removed reference to EnrollmentRequest from GuidanceResponse.result
    • FHIR-55563 icon - Removed resource Contract from GuidanceResponse.result
    • FHIR-57450 icon - Expanded evaluationMessage to multiple cardinality
    • FHIR-53715 icon - Added search parameters for module and date
    • FHIR-53714 icon - Added the ability to capture input parameters in a GuidanceResponse.
    • FHIR-53712 icon - Added GuidanceResponse.indicator, bound extensible to CDS Hooks indicators.
    • FHIR-53710 icon - Added GuidanceResponse.topic and related search parameter.
  • Non-substantive:
    • FHIR-53709 icon - Clarified GuidanceResponse.status applies to the response, not the processing or acceptance of that response.
    • FHIR-55067 icon - Updated GuidanceModuleCode system and value set to clearly indicate they are examples.

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.

17.13.2 References to this Resource

17.13.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. GuidanceResponse N 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 for guidance response

... module[x] Σ 1..1 What guidance was requested
Binding: Guidance Module Code Example (Example)
.... moduleUri uri
.... moduleCanonical canonical()
.... moduleCodeableConcept CodeableConcept
... status ?!Σ 1..1 code success | data-requested | data-required | in-progress | failure | entered-in-error
Binding: Guidance Response Status (Required)
... subject Σ 0..1 Reference(Patient | Group) Individual service was done for/to
... encounter Σ 0..1 Reference(Encounter) Encounter the guidance response is part of
... occurrenceDateTime Σ 0..1 dateTime When the guidance response was processed
... performer 0..1 Reference(Device) Device returning the guidance
... location Σ 0..1 Reference(Location) Where guidance response occurred
... reason Σ 0..* CodeableReference() Why guidance is needed

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

... evaluationMessage 0..* Reference(OperationOutcome) Messages resulting from the evaluation of the artifact or artifacts

... inputParameters 0..1 Reference(Parameters) What parameters
... outputParameters 0..1 Reference(Parameters) The output parameters of the evaluation, if any
... indicator Σ 0..1 CodeableConcept Urgency/importance of the response
Binding: CDS Hooks Indicator (Extensible)
... result 0..* Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | CoverageEligibilityRequest | DeviceRequest | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | Task | VisionPrescription) Proposed actions, if any

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


doco Documentation for this format icon

UML Diagram (Legend)

GuidanceResponse (DomainResource)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 scenariorequestIdentifier : Identifier [0..1]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 serveridentifier : Identifier [0..*]An identifier, CodeableConcept or canonical reference to the guidance that was requestedmodule[x] : DataType [1..1] « uri|canonical|CodeableConcept; null (Strength=Example) GuidanceModuleCodeExample?? »Descriptive topics related to the guidance. Topics provide a high-level categorization of the guidance that can be useful for filtering and searchingtopic : CodeableConcept [0..*] « null (Strength=Example)DefinitionTopic?? »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 (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)GuidanceResponseStatus! »The individual or set of individuals the action is being or was performed onsubject : Reference [0..1] « Patient|Group »The Encounter during which this guidance response was created or to which the creation of this record is tightly associatedencounter : Reference [0..1] « Encounter »Indicates when the guidance response was processedoccurrenceDateTime : dateTime [0..1]Provides a reference to the device that performed the guidanceperformer : Reference [0..1] « Device »The principal physical location where the guidance response was performedlocation : Reference [0..1] « Location »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 responsereason : CodeableReference [0..*] « »Provides a mechanism to communicate additional information about the responsenote : Annotation [0..*]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 elementevaluationMessage : Reference [0..*] « OperationOutcome »The parameters that were provided as input to the operation that provided the guidance response. This is typically a reference to a contained Parameters resourceinputParameters : Reference [0..1] « Parameters »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 elementoutputParameters : Reference [0..1] « Parameters »An indicator of the urgency or importance of the guidance responseindicator : CodeableConcept [0..1] « null (Strength=Extensible)CDSHooksIndicator+ »The actions, if any, produced by the evaluation of the artifactresult : Reference [0..*] « Appointment|AppointmentResponse|CarePlan| Claim|CommunicationRequest|CoverageEligibilityRequest| DeviceRequest|MedicationRequest|NutritionOrder| RequestOrchestration|ServiceRequest|Task|VisionPrescription »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 datadataRequirement : DataRequirement [0..*]

XML Template

<GuidanceResponse xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <requestIdentifier><!-- 0..1 Identifier The identifier of the request associated with this response, if any --></requestIdentifier>
 <identifier><!-- 0..* Identifier Business identifier for guidance response --></identifier>
 <module[x]><!-- 1..1 uri|canonical|CodeableConcept What guidance was requested --></module[x]>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic>
 <status value="[code]"/><!-- 1..1 success | data-requested | data-required | in-progress | failure | entered-in-error -->
 <subject><!-- 0..1 Reference(Group|Patient) Individual service was done for/to --></subject>
 <encounter><!-- 0..1 Reference(Encounter) Encounter the guidance response is part of --></encounter>
 <occurrenceDateTime value="[dateTime]"/><!-- 0..1 When the guidance response was processed -->
 <performer><!-- 0..1 Reference(Device) Device returning the guidance --></performer>
 <location><!-- 0..1 Reference(Location) Where guidance response occurred --></location>
 <reason><!-- 0..* CodeableReference Why guidance is needed --></reason>
 <note><!-- 0..* Annotation Additional notes about the response --></note>
 <evaluationMessage><!-- 0..* Reference(OperationOutcome) Messages resulting from the evaluation of the artifact or artifacts --></evaluationMessage>
 <inputParameters><!-- 0..1 Reference(Parameters) What parameters --></inputParameters>
 <outputParameters><!-- 0..1 Reference(Parameters) The output parameters of the evaluation, if any --></outputParameters>
 <indicator><!-- 0..1 CodeableConcept Urgency/importance of the response --></indicator>
 <result><!-- 0..* Reference(Appointment|AppointmentResponse|CarePlan|Claim|
   CommunicationRequest|CoverageEligibilityRequest|DeviceRequest|
   MedicationRequest|NutritionOrder|RequestOrchestration|ServiceRequest|Task|
   VisionPrescription) Proposed actions, if any --></result>
 <dataRequirement><!-- 0..* DataRequirement Additional required data --></dataRequirement>
</GuidanceResponse>

JSON Template

{doco
  "resourceType" : "GuidanceResponse",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "requestIdentifier" : { Identifier }, // The identifier of the request associated with this response, if any
  "identifier" : [{ Identifier }], // Business identifier for guidance response
  // module[x]: What guidance was requested. One of these 3:
  "moduleUri" : "<uri>",
  "moduleCanonical" : "<canonical>",
  "moduleCodeableConcept" : { CodeableConcept },
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc
  "status" : "<code>", // R!  success | data-requested | data-required | in-progress | failure | entered-in-error
  "subject" : { Reference(Group|Patient) }, // Individual service was done for/to
  "encounter" : { Reference(Encounter) }, // Encounter the guidance response is part of
  "occurrenceDateTime" : "<dateTime>", // When the guidance response was processed
  "performer" : { Reference(Device) }, // Device returning the guidance
  "location" : { Reference(Location) }, // Where guidance response occurred
  "reason" : [{ CodeableReference }], // Why guidance is needed
  "note" : [{ Annotation }], // Additional notes about the response
  "evaluationMessage" : [{ Reference(OperationOutcome) }], // Messages resulting from the evaluation of the artifact or artifacts
  "inputParameters" : { Reference(Parameters) }, // What parameters
  "outputParameters" : { Reference(Parameters) }, // The output parameters of the evaluation, if any
  "indicator" : { CodeableConcept }, // Urgency/importance of the response
  "result" : [{ Reference(Appointment|AppointmentResponse|CarePlan|Claim|
   CommunicationRequest|CoverageEligibilityRequest|DeviceRequest|
   MedicationRequest|NutritionOrder|RequestOrchestration|ServiceRequest|Task|
   VisionPrescription) }], // Proposed actions, if any
  "dataRequirement" : [{ DataRequirement }] // Additional required data
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:GuidanceResponse;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension
  fhir:requestIdentifier [ Identifier ] ; # 0..1 The identifier of the request associated with this response, if any
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business identifier for guidance response
  # module[x] : 1..1 What guidance was requested. One of these 3
    fhir:module [  a fhir:Uri ; uri ]
    fhir:module [  a fhir:Canonical ; canonical ]
    fhir:module [  a fhir:CodeableConcept ; CodeableConcept ]
  fhir:topic  ( [ CodeableConcept ] ... ) ; # 0..* E.g. Education, Treatment, Assessment, etc
  fhir:status [ code ] ; # 1..1 success | data-requested | data-required | in-progress | failure | entered-in-error
  fhir:subject [ Reference(Group|Patient) ] ; # 0..1 Individual service was done for/to
  fhir:encounter [ Reference(Encounter) ] ; # 0..1 Encounter the guidance response is part of
  fhir:occurrenceDateTime [ dateTime ] ; # 0..1 When the guidance response was processed
  fhir:performer [ Reference(Device) ] ; # 0..1 Device returning the guidance
  fhir:location [ Reference(Location) ] ; # 0..1 Where guidance response occurred
  fhir:reason  ( [ CodeableReference ] ... ) ; # 0..* Why guidance is needed
  fhir:note  ( [ Annotation ] ... ) ; # 0..* Additional notes about the response
  fhir:evaluationMessage  ( [ Reference(OperationOutcome) ] ... ) ; # 0..* Messages resulting from the evaluation of the artifact or artifacts
  fhir:inputParameters [ Reference(Parameters) ] ; # 0..1 What parameters
  fhir:outputParameters [ Reference(Parameters) ] ; # 0..1 The output parameters of the evaluation, if any
  fhir:indicator [ CodeableConcept ] ; # 0..1 Urgency/importance of the response
  fhir:result  ( [ Reference(Appointment|AppointmentResponse|CarePlan|Claim|CommunicationRequest|
  CoverageEligibilityRequest|DeviceRequest|MedicationRequest|NutritionOrder|
  RequestOrchestration|ServiceRequest|Task|VisionPrescription) ] ... ) ; # 0..* Proposed actions, if any
  fhir:dataRequirement  ( [ DataRequirement ] ... ) ; # 0..* Additional required data
]

Changes from R5 to R6

GuidanceResponse
GuidanceResponse.topic
  • Added Element
GuidanceResponse.location
  • Added Element
GuidanceResponse.evaluationMessage
  • Max Cardinality changed from 1 to *
GuidanceResponse.inputParameters
  • Added Element
GuidanceResponse.indicator
  • Added Element
GuidanceResponse.result
  • Type Reference: Removed Target Types Contract, EnrollmentRequest, ImmunizationRecommendation, SupplyRequest

Changes from R4 and R4B to R6

GuidanceResponse
GuidanceResponse.topic
  • Added Element
GuidanceResponse.location
  • Added Element
GuidanceResponse.reason
  • Added Element
  • Merged both reasonCode and reasonReference into reason
GuidanceResponse.inputParameters
  • Added Element
GuidanceResponse.indicator
  • Added Element
GuidanceResponse.result
  • Max Cardinality changed from 1 to *
  • Type Reference: Added Target Types Appointment, AppointmentResponse, Claim, CommunicationRequest, CoverageEligibilityRequest, DeviceRequest, MedicationRequest, NutritionOrder, RequestOrchestration, ServiceRequest, Task, VisionPrescription
  • Type Reference: Removed Target Type RequestGroup
GuidanceResponse.reasonCode
  • Deleted (-> GuidanceResponse.reason)
GuidanceResponse.reasonReference
  • Deleted (-> GuidanceResponse.reason)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. GuidanceResponse N 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 for guidance response

... module[x] Σ 1..1 What guidance was requested
Binding: Guidance Module Code Example (Example)
.... moduleUri uri
.... moduleCanonical canonical()
.... moduleCodeableConcept CodeableConcept
... status ?!Σ 1..1 code success | data-requested | data-required | in-progress | failure | entered-in-error
Binding: Guidance Response Status (Required)
... subject Σ 0..1 Reference(Patient | Group) Individual service was done for/to
... encounter Σ 0..1 Reference(Encounter) Encounter the guidance response is part of
... occurrenceDateTime Σ 0..1 dateTime When the guidance response was processed
... performer 0..1 Reference(Device) Device returning the guidance
... location Σ 0..1 Reference(Location) Where guidance response occurred
... reason Σ 0..* CodeableReference() Why guidance is needed

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

... evaluationMessage 0..* Reference(OperationOutcome) Messages resulting from the evaluation of the artifact or artifacts

... inputParameters 0..1 Reference(Parameters) What parameters
... outputParameters 0..1 Reference(Parameters) The output parameters of the evaluation, if any
... indicator Σ 0..1 CodeableConcept Urgency/importance of the response
Binding: CDS Hooks Indicator (Extensible)
... result 0..* Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | CoverageEligibilityRequest | DeviceRequest | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | Task | VisionPrescription) Proposed actions, if any

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


doco Documentation for this format icon

UML Diagram (Legend)

GuidanceResponse (DomainResource)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 scenariorequestIdentifier : Identifier [0..1]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 serveridentifier : Identifier [0..*]An identifier, CodeableConcept or canonical reference to the guidance that was requestedmodule[x] : DataType [1..1] « uri|canonical|CodeableConcept; null (Strength=Example) GuidanceModuleCodeExample?? »Descriptive topics related to the guidance. Topics provide a high-level categorization of the guidance that can be useful for filtering and searchingtopic : CodeableConcept [0..*] « null (Strength=Example)DefinitionTopic?? »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 (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)GuidanceResponseStatus! »The individual or set of individuals the action is being or was performed onsubject : Reference [0..1] « Patient|Group »The Encounter during which this guidance response was created or to which the creation of this record is tightly associatedencounter : Reference [0..1] « Encounter »Indicates when the guidance response was processedoccurrenceDateTime : dateTime [0..1]Provides a reference to the device that performed the guidanceperformer : Reference [0..1] « Device »The principal physical location where the guidance response was performedlocation : Reference [0..1] « Location »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 responsereason : CodeableReference [0..*] « »Provides a mechanism to communicate additional information about the responsenote : Annotation [0..*]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 elementevaluationMessage : Reference [0..*] « OperationOutcome »The parameters that were provided as input to the operation that provided the guidance response. This is typically a reference to a contained Parameters resourceinputParameters : Reference [0..1] « Parameters »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 elementoutputParameters : Reference [0..1] « Parameters »An indicator of the urgency or importance of the guidance responseindicator : CodeableConcept [0..1] « null (Strength=Extensible)CDSHooksIndicator+ »The actions, if any, produced by the evaluation of the artifactresult : Reference [0..*] « Appointment|AppointmentResponse|CarePlan| Claim|CommunicationRequest|CoverageEligibilityRequest| DeviceRequest|MedicationRequest|NutritionOrder| RequestOrchestration|ServiceRequest|Task|VisionPrescription »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 datadataRequirement : DataRequirement [0..*]

XML Template

<GuidanceResponse xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <requestIdentifier><!-- 0..1 Identifier The identifier of the request associated with this response, if any --></requestIdentifier>
 <identifier><!-- 0..* Identifier Business identifier for guidance response --></identifier>
 <module[x]><!-- 1..1 uri|canonical|CodeableConcept What guidance was requested --></module[x]>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic>
 <status value="[code]"/><!-- 1..1 success | data-requested | data-required | in-progress | failure | entered-in-error -->
 <subject><!-- 0..1 Reference(Group|Patient) Individual service was done for/to --></subject>
 <encounter><!-- 0..1 Reference(Encounter) Encounter the guidance response is part of --></encounter>
 <occurrenceDateTime value="[dateTime]"/><!-- 0..1 When the guidance response was processed -->
 <performer><!-- 0..1 Reference(Device) Device returning the guidance --></performer>
 <location><!-- 0..1 Reference(Location) Where guidance response occurred --></location>
 <reason><!-- 0..* CodeableReference Why guidance is needed --></reason>
 <note><!-- 0..* Annotation Additional notes about the response --></note>
 <evaluationMessage><!-- 0..* Reference(OperationOutcome) Messages resulting from the evaluation of the artifact or artifacts --></evaluationMessage>
 <inputParameters><!-- 0..1 Reference(Parameters) What parameters --></inputParameters>
 <outputParameters><!-- 0..1 Reference(Parameters) The output parameters of the evaluation, if any --></outputParameters>
 <indicator><!-- 0..1 CodeableConcept Urgency/importance of the response --></indicator>
 <result><!-- 0..* Reference(Appointment|AppointmentResponse|CarePlan|Claim|
   CommunicationRequest|CoverageEligibilityRequest|DeviceRequest|
   MedicationRequest|NutritionOrder|RequestOrchestration|ServiceRequest|Task|
   VisionPrescription) Proposed actions, if any --></result>
 <dataRequirement><!-- 0..* DataRequirement Additional required data --></dataRequirement>
</GuidanceResponse>

JSON Template

{doco
  "resourceType" : "GuidanceResponse",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "requestIdentifier" : { Identifier }, // The identifier of the request associated with this response, if any
  "identifier" : [{ Identifier }], // Business identifier for guidance response
  // module[x]: What guidance was requested. One of these 3:
  "moduleUri" : "<uri>",
  "moduleCanonical" : "<canonical>",
  "moduleCodeableConcept" : { CodeableConcept },
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc
  "status" : "<code>", // R!  success | data-requested | data-required | in-progress | failure | entered-in-error
  "subject" : { Reference(Group|Patient) }, // Individual service was done for/to
  "encounter" : { Reference(Encounter) }, // Encounter the guidance response is part of
  "occurrenceDateTime" : "<dateTime>", // When the guidance response was processed
  "performer" : { Reference(Device) }, // Device returning the guidance
  "location" : { Reference(Location) }, // Where guidance response occurred
  "reason" : [{ CodeableReference }], // Why guidance is needed
  "note" : [{ Annotation }], // Additional notes about the response
  "evaluationMessage" : [{ Reference(OperationOutcome) }], // Messages resulting from the evaluation of the artifact or artifacts
  "inputParameters" : { Reference(Parameters) }, // What parameters
  "outputParameters" : { Reference(Parameters) }, // The output parameters of the evaluation, if any
  "indicator" : { CodeableConcept }, // Urgency/importance of the response
  "result" : [{ Reference(Appointment|AppointmentResponse|CarePlan|Claim|
   CommunicationRequest|CoverageEligibilityRequest|DeviceRequest|
   MedicationRequest|NutritionOrder|RequestOrchestration|ServiceRequest|Task|
   VisionPrescription) }], // Proposed actions, if any
  "dataRequirement" : [{ DataRequirement }] // Additional required data
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:GuidanceResponse;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension
  fhir:requestIdentifier [ Identifier ] ; # 0..1 The identifier of the request associated with this response, if any
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business identifier for guidance response
  # module[x] : 1..1 What guidance was requested. One of these 3
    fhir:module [  a fhir:Uri ; uri ]
    fhir:module [  a fhir:Canonical ; canonical ]
    fhir:module [  a fhir:CodeableConcept ; CodeableConcept ]
  fhir:topic  ( [ CodeableConcept ] ... ) ; # 0..* E.g. Education, Treatment, Assessment, etc
  fhir:status [ code ] ; # 1..1 success | data-requested | data-required | in-progress | failure | entered-in-error
  fhir:subject [ Reference(Group|Patient) ] ; # 0..1 Individual service was done for/to
  fhir:encounter [ Reference(Encounter) ] ; # 0..1 Encounter the guidance response is part of
  fhir:occurrenceDateTime [ dateTime ] ; # 0..1 When the guidance response was processed
  fhir:performer [ Reference(Device) ] ; # 0..1 Device returning the guidance
  fhir:location [ Reference(Location) ] ; # 0..1 Where guidance response occurred
  fhir:reason  ( [ CodeableReference ] ... ) ; # 0..* Why guidance is needed
  fhir:note  ( [ Annotation ] ... ) ; # 0..* Additional notes about the response
  fhir:evaluationMessage  ( [ Reference(OperationOutcome) ] ... ) ; # 0..* Messages resulting from the evaluation of the artifact or artifacts
  fhir:inputParameters [ Reference(Parameters) ] ; # 0..1 What parameters
  fhir:outputParameters [ Reference(Parameters) ] ; # 0..1 The output parameters of the evaluation, if any
  fhir:indicator [ CodeableConcept ] ; # 0..1 Urgency/importance of the response
  fhir:result  ( [ Reference(Appointment|AppointmentResponse|CarePlan|Claim|CommunicationRequest|
  CoverageEligibilityRequest|DeviceRequest|MedicationRequest|NutritionOrder|
  RequestOrchestration|ServiceRequest|Task|VisionPrescription) ] ... ) ; # 0..* Proposed actions, if any
  fhir:dataRequirement  ( [ DataRequirement ] ... ) ; # 0..* Additional required data
]

Changes from R5 to R6

GuidanceResponse
GuidanceResponse.topic
  • Added Element
GuidanceResponse.location
  • Added Element
GuidanceResponse.evaluationMessage
  • Max Cardinality changed from 1 to *
GuidanceResponse.inputParameters
  • Added Element
GuidanceResponse.indicator
  • Added Element
GuidanceResponse.result
  • Type Reference: Removed Target Types Contract, EnrollmentRequest, ImmunizationRecommendation, SupplyRequest

Changes from R4 and R4B to R6

GuidanceResponse
GuidanceResponse.topic
  • Added Element
GuidanceResponse.location
  • Added Element
GuidanceResponse.reason
  • Added Element
  • Merged both reasonCode and reasonReference into reason
GuidanceResponse.inputParameters
  • Added Element
GuidanceResponse.indicator
  • Added Element
GuidanceResponse.result
  • Max Cardinality changed from 1 to *
  • Type Reference: Added Target Types Appointment, AppointmentResponse, Claim, CommunicationRequest, CoverageEligibilityRequest, DeviceRequest, MedicationRequest, NutritionOrder, RequestOrchestration, ServiceRequest, Task, VisionPrescription
  • Type Reference: Removed Target Type RequestGroup
GuidanceResponse.reasonCode
  • Deleted (-> GuidanceResponse.reason)
GuidanceResponse.reasonReference
  • Deleted (-> GuidanceResponse.reason)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

 

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

17.13.3.1 Terminology Bindings

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

Example guidance module codes.
GuidanceResponse.topic DefinitionTopic Example

High-level categorization of the definition, used for searching, sorting, and filtering.
GuidanceResponse.status GuidanceResponseStatus Required

The status of a guidance response.
GuidanceResponse.indicator CDSHooksIndicator Extensible

This value set captures the set of indicator codes defined by the CDS Hooks specification.

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

17.13.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
date date The date on which the guidance was provided GuidanceResponse.occurrenceDateTime
identifier token The identifier of the guidance response GuidanceResponse.identifier 55 Resources
module-code token The module from which the guidance was provided GuidanceResponse.module as CodeableConcept
module-reference reference The module from which the guidance was provided GuidanceResponse.module as canonical
module-uri uri The module from which the guidance was provided GuidanceResponse.module as uri
patient reference The identity of a patient to search for guidance response results GuidanceResponse.subject.where(resolve() is Patient)
(Patient)		 57 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)
topic token Topics associated with the guidance GuidanceResponse.topic