FHIR Release 3 (STU) CI-Build

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon . Page versions: R5 R4B R4 R3

14.3 14.13 Resource GuidanceResponse - Content

Responsible Owner: Clinical Decision Support icon Work Group   Normative Maturity Level : 2   Trial Use Security Category : Patient Compartments : Not linked to any defined 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.3.1 14.13.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 the any output data of from the module service and any suggested actions to be performed.

For Use cases for the GuidanceResponse resource include:

  • Keeping a detailed discussion record of past service requests, including the evaluation process, refer ability to reference the Guidance Request topic in context of the Clinical Reasoning module. Note to implementers: The user-facing external clinical decision support use request such as the disease state
  • Representing additional data requirements for subsequent service requests
  • Representing Public Health case supported by reporting and recording
  • Sharing the ServiceDefinition/$evaluate operation results of the Clinical Reasoning module has significant overlap decision support guidance and determination of reportability with clinicians and public health agencies

In addition, the functionality provided by the CDS Hooks specification. As part of FHIR Release 4, it GuidanceResponse resource is the intention to unify aligned with the CDS Hooks specification with the Clinical Reasoning module, ensuring that implementers have response structure and so provides a single consistent mechanism to support this use case that meets record the requirements results of both the Clinical Quality Framework and CDS Hooks communities. Although interactions. For a detailed discussion of how the functionality in both specifications is conceptually aligned, this unification will likely result in changes to both specifications. The CQF and CDS Hooks project teams are committed to GuidanceResponse resource can be used for this unification and will work purpose, refer to ensure that the resulting changes have as little impact as possible on current and ongoing implementation efforts, while meeting the needs of both communities. The project team is planning on a workable implementation tested at the connectathon in May of 2017, with a trial ballot following Evaluation topic in September 2017, targeting publication as part of the FHIR Release 4 specification. Clinical Reasoning module.

14.13.2 References to this Resource

14.3.2 14.13.3 Resource Content

Structure

0..1 ?! Patient the request
Name Flags Card. Type Description & Constraints      Filter: Filters doco
. . GuidanceResponse N DomainResource The formal response to a guidance request

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

. . module . module[x] Σ 1..1 Reference What guidance was requested
Binding: Guidance Module Code ( ServiceDefinition Example )
A reference to a knowledge module
. . . . status moduleUri uri
. . . . moduleCanonical canonical ()
Σ . . . . moduleCodeableConcept 1..1 CodeableConcept
. . . subject Σ 0..1 Reference ( Patient | Group ) Individual service was performed for done for/to
. . context . encounter Σ 0..1 Reference ( Encounter | EpisodeOfCare ) Encounter or Episode during which the guidance response was returned is part of
. . . occurrenceDateTime Σ 0..1 dateTime When the guidance response was processed
. . . performer 0..1 Reference ( Device ) Device returning the guidance
. . reason[x] . location Σ 0..1 Reason for the Reference ( Location ) Where guidance response occurred
. . reasonCodeableConcept . reason CodeableConcept Σ reasonReference 0..* Reference ( Any CodeableReference ) () Why guidance is needed

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

. . . evaluationMessage 0..* 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..1 0..* Reference ( Appointment | AppointmentResponse | CarePlan | RequestGroup Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | Task | VisionPrescription ) Proposed actions, if any

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


doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

GuidanceResponse ( DomainResource ) The id identifier of the request associated with this response. If an id 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 requestId requestIdentifier : id Identifier [0..1] Allows a service Business identifiers assigned to provide a unique, business identifier for the 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 identifier : Identifier [0..1] [0..*] A An identifier, CodeableConcept or canonical reference to the knowledge module guidance that was invoked requested module module[x] : Reference DataType [1..1] ServiceDefinition « uri | canonical | CodeableConcept ; null (Strength=Example) GuidanceModuleCode ?? » 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] « The status of a guidance response null (Strength=Required) GuidanceResponseStatus ! » The patient for which individual or set of individuals the request action is being or was processed performed on subject : Reference [0..1] « Patient | Group » Allows the context of the The Encounter during which this guidance response was created or to be provided if available. In a service context, which the creation of this would likely be unavailable record is tightly associated context encounter : Reference [0..1] « Encounter | EpisodeOfCare » Indicates when the guidance response was processed occurrenceDateTime : dateTime [0..1] Provides a reference to the device that performed the guidance performer : Reference [0..1] « Device » The principal physical location where the guidance response was performed location : 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 response reason[x] reason : Type [0..1] CodeableConcept | Reference ( Any CodeableReference ) [0..*] « » Provides a mechanism to communicate additional information about the response note : 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 element evaluationMessage : Reference [0..*] [0..1] « OperationOutcome » 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 outputParameters : Reference [0..1] « Parameters » The actions, if any, produced by the evaluation of the artifact result : Reference [0..1] [0..*] « Appointment | AppointmentResponse | CarePlan | RequestGroup Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | 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 data dataRequirement : 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 -->
 <
 <</identifier>
 <</module>
 <
 <</subject>
 <</context>
 <

 <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]>
 <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>
 <</reason[x]>

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

 <evaluationMessage><!-- 0..1 Reference(OperationOutcome) Messages resulting from the evaluation of the artifact or artifacts --></evaluationMessage>

 <outputParameters><!-- 0..1 Reference(Parameters) The output parameters of the evaluation, if any --></outputParameters>
 <</result>

 <result><!-- 0..* Reference(Appointment|AppointmentResponse|CarePlan|Claim|
   CommunicationRequest|Contract|CoverageEligibilityRequest|DeviceRequest|
   EnrollmentRequest|MedicationRequest|NutritionOrder|RequestOrchestration|
   ServiceRequest|Task|VisionPrescription) Proposed actions, if any --></result>
 <dataRequirement><!-- 0..* DataRequirement Additional required data --></dataRequirement>
</GuidanceResponse>

JSON Template 

{doco
  "resourceType" : "",

  "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 },
  "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
  "outputParameters" : { Reference(Parameters) }, // The output parameters of the evaluation, if any
  "result" : [{ Reference(Appointment|AppointmentResponse|CarePlan|Claim|
   CommunicationRequest|Contract|CoverageEligibilityRequest|DeviceRequest|
   EnrollmentRequest|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 
  # from 
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  # . One of these 2
    fhir: ]
    fhir:) ]
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:

  # 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: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..1 Messages resulting from the evaluation of the artifact or artifacts
  fhir:outputParameters [ Reference(Parameters) ] ; # 0..1 The output parameters of the evaluation, if any
  fhir:result  ( [ Reference(Appointment|AppointmentResponse|CarePlan|Claim|CommunicationRequest|Contract|
  CoverageEligibilityRequest|DeviceRequest|EnrollmentRequest|MedicationRequest|
  NutritionOrder|RequestOrchestration|ServiceRequest|Task|VisionPrescription) ] ... ) ; # 0..* Proposed actions, if any

  fhir:dataRequirement  ( [ DataRequirement ] ... ) ; # 0..* Additional required data

]

Changes since DSTU2 from both R4 and R4B

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

This resource did not exist in Release 2 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

0..1 ?! Patient the request
Name Flags Card. Type Description & Constraints      Filter: Filters doco
. . GuidanceResponse N DomainResource The formal response to a guidance request

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

. . module . module[x] Σ 1..1 Reference What guidance was requested
Binding: Guidance Module Code ( ServiceDefinition Example )
A reference to a knowledge module
. . . . status moduleUri uri
. . . . moduleCanonical canonical ()
Σ . . . . moduleCodeableConcept 1..1 CodeableConcept
. . . subject Σ 0..1 Reference ( Patient | Group ) Individual service was performed for done for/to
. . context . encounter Σ 0..1 Reference ( Encounter | EpisodeOfCare ) Encounter or Episode during which the guidance response was returned is part of
. . . occurrenceDateTime Σ 0..1 dateTime When the guidance response was processed
. . . performer 0..1 Reference ( Device ) Device returning the guidance
. . reason[x] . location Σ 0..1 Reason for the Reference ( Location ) Where guidance response occurred
. . reasonCodeableConcept . reason CodeableConcept Σ reasonReference 0..* Reference ( Any CodeableReference ) () Why guidance is needed

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

. . . evaluationMessage 0..* 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..1 0..* Reference ( Appointment | AppointmentResponse | CarePlan | RequestGroup Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | Task | VisionPrescription ) Proposed actions, if any

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


doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

GuidanceResponse ( DomainResource ) The id identifier of the request associated with this response. If an id 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 requestId requestIdentifier : id Identifier [0..1] Allows a service Business identifiers assigned to provide a unique, business identifier for the 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 identifier : Identifier [0..1] [0..*] A An identifier, CodeableConcept or canonical reference to the knowledge module guidance that was invoked requested module module[x] : Reference DataType [1..1] ServiceDefinition « uri | canonical | CodeableConcept ; null (Strength=Example) GuidanceModuleCode ?? » 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] « The status of a guidance response null (Strength=Required) GuidanceResponseStatus ! » The patient for which individual or set of individuals the request action is being or was processed performed on subject : Reference [0..1] « Patient | Group » Allows the context of the The Encounter during which this guidance response was created or to be provided if available. In a service context, which the creation of this would likely be unavailable record is tightly associated context encounter : Reference [0..1] « Encounter | EpisodeOfCare » Indicates when the guidance response was processed occurrenceDateTime : dateTime [0..1] Provides a reference to the device that performed the guidance performer : Reference [0..1] « Device » The principal physical location where the guidance response was performed location : 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 response reason[x] reason : Type [0..1] CodeableConcept | Reference ( Any CodeableReference ) [0..*] « » Provides a mechanism to communicate additional information about the response note : 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 element evaluationMessage : Reference [0..*] [0..1] « OperationOutcome » 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 outputParameters : Reference [0..1] « Parameters » The actions, if any, produced by the evaluation of the artifact result : Reference [0..1] [0..*] « Appointment | AppointmentResponse | CarePlan | RequestGroup Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | 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 data dataRequirement : 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 -->
 <
 <</identifier>
 <</module>
 <
 <</subject>
 <</context>
 <

 <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]>
 <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>
 <</reason[x]>

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

 <evaluationMessage><!-- 0..1 Reference(OperationOutcome) Messages resulting from the evaluation of the artifact or artifacts --></evaluationMessage>

 <outputParameters><!-- 0..1 Reference(Parameters) The output parameters of the evaluation, if any --></outputParameters>
 <</result>

 <result><!-- 0..* Reference(Appointment|AppointmentResponse|CarePlan|Claim|
   CommunicationRequest|Contract|CoverageEligibilityRequest|DeviceRequest|
   EnrollmentRequest|MedicationRequest|NutritionOrder|RequestOrchestration|
   ServiceRequest|Task|VisionPrescription) Proposed actions, if any --></result>
 <dataRequirement><!-- 0..* DataRequirement Additional required data --></dataRequirement>
</GuidanceResponse>

JSON Template 

{doco
  "resourceType" : "",

  "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 },
  "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
  "outputParameters" : { Reference(Parameters) }, // The output parameters of the evaluation, if any
  "result" : [{ Reference(Appointment|AppointmentResponse|CarePlan|Claim|
   CommunicationRequest|Contract|CoverageEligibilityRequest|DeviceRequest|
   EnrollmentRequest|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 
  # from 
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  # . One of these 2
    fhir: ]
    fhir:) ]
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:

  # 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: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..1 Messages resulting from the evaluation of the artifact or artifacts
  fhir:outputParameters [ Reference(Parameters) ] ; # 0..1 The output parameters of the evaluation, if any
  fhir:result  ( [ Reference(Appointment|AppointmentResponse|CarePlan|Claim|CommunicationRequest|Contract|
  CoverageEligibilityRequest|DeviceRequest|EnrollmentRequest|MedicationRequest|
  NutritionOrder|RequestOrchestration|ServiceRequest|Task|VisionPrescription) ] ... ) ; # 0..* Proposed actions, if any

  fhir:dataRequirement  ( [ DataRequirement ] ... ) ; # 0..* Additional required data

]

Changes since DSTU2 from both R4 and R4B

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

This resource did not exist in Release 2 See the Full Difference for further information

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

 

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

14.3.2.1 14.13.3.1 Terminology Bindings

GuidanceResponse.status
Path Definition ValueSet Type Reference Documentation
GuidanceResponse.module[x] GuidanceModuleCode Example The status of a

Example guidance response module codes.

GuidanceResponse.status GuidanceResponseStatus Required GuidanceResponseStatus

The status of a guidance response.

14.3.3 14.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 may 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.3.4 14.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
identifier token The identifier of the guidance response GuidanceResponse.identifier 58 Resources
patient reference The identity of a patient to search for guidance response results GuidanceResponse.subject GuidanceResponse.subject.where(resolve() is Patient)
( Patient ) 		60 Resources
request token The identifier of the request associated with the response GuidanceResponse.requestId 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 )