Release 4 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.14 Resource GuidanceResponse - Content

Responsible Owner: Clinical Decision Support icon Work Group   Trial Use Security 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.14.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.14.2 References to this Resource

14.14.3 Resource Content

Structure

Name Flags Card. Type Description & Constraints      Filter: Filters This page doco
. . 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 for guidance response

... 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 ) Individual service was done for/to
... encounter Σ 0..1 Reference ( Encounter ) Encounter the guidance response is part of
. . . occurrenceDateTime Σ 0..1 dateTime When the FHIR Specification (v4.0.1: R4 - Mixed Normative guidance response was processed
... performer and STU 0..1 Reference ( Device ) in it's permanent home (it 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..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 | 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 identifier of the request associated with this response. If an identifier was given as part of the request, it will always be available at reproduced here to enable the requester to more easily identify the response in a multi-request scenario requestIdentifier : Identifier [0..1] Business identifiers assigned to this URL). 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..*] An identifier, CodeableConcept or canonical reference to the guidance that was requested module[x] : DataType [1..1] « uri | canonical | CodeableConcept ; null (Strength=Example) GuidanceModuleCode ?? » The current version 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 on subject : Reference [0..1] « Patient | Group » The Encounter during which supercedes this version guidance response was created or to which the creation of this record is 5.0.0 . For tightly associated encounter : Reference [0..1] « Encounter » Indicates when the guidance response was processed occurrenceDateTime : dateTime [0..1] Provides a full list 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 available versions, see the Directory cause for the response reason : CodeableReference [0..*] « » Provides a mechanism to communicate additional information about the response note : Annotation [0..*] Messages resulting from the evaluation of published versions 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..1] « OperationOutcome » . Page versions: R4B 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..*] « Appointment | AppointmentResponse | CarePlan | 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 -->
 <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>
 <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..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><!-- 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" : "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 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 from both R4 and R4B

Valueset-gender-identity.json Standards Status : Informative
Vocabulary GuidanceResponse Work Group Maturity Level : N/A
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)

Raw 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

Name Flags Card. Type Description & Constraints      Filter: Filtersdoco
.. 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 for guidance response

... module[x] Σ 1..1 What guidance was requested
Binding: Guidance Module Code ( Example )
.... moduleUri uri
.... moduleCanonical canonical form + also see JSON Format Specification ()
.... moduleCodeableConcept CodeableConcept
... 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..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 | 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

Definition 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 scenario requestIdentifier : 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 server identifier : Identifier [0..*] An identifier, CodeableConcept or canonical reference to the guidance that was requested module[x] : DataType [1..1] « 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] « null (Strength=Required) GuidanceResponseStatus ! » The individual or set of individuals the action is being or was performed on subject : Reference [0..1] « Patient | Group » The Encounter during which this guidance response was created or to which the creation of this record is tightly associated encounter : Reference [0..1] « Encounter » 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 Value SetGender identity 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 : 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..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..*] « Appointment | AppointmentResponse | CarePlan | 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

{ "resourceType" : "ValueSet", "id" : "gender-identity", "meta" : { "lastUpdated" : "2019-11-01T09:29:23.356+11:00", "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablevalueset"] }, "text" : { "status" : "generated", "div" : "<div>!-- Snipped for Brevity --></div>" }, "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode" : "pa" }], "url" : "http://hl7.org/fhir/ValueSet/gender-identity", "identifier" : [{ "system" : "urn:ietf:rfc:3986", "value" : "urn:oid:2.16.840.1.113883.4.642.3.972" }], "version" : "4.0.1", "name" : "GenderIdentity", "title" : "Gender identity", "status" : "draft", "experimental" : false, "date" : "2019-11-01T09:29:23+11:00", "publisher" : "FHIR Project team", "contact" : [{ "telecom" : [{ "system" : "url", "value" : "http://hl7.org/fhir" }] }], "description" : "This example value set defines a set of codes that can be used to indicate a patient's gender identity.", "immutable" : true, "copyright" : "This resource includes content from SNOMED Clinical Terms® (SNOMED CT®) which is copyright of the International Health Terminology Standards Development Organisation (IHTSDO). Implementers of these specifications must have the appropriate SNOMED CT Affiliate license - for more information contact http://www.snomed.org/snomed-ct/get-snomed-ct or info@snomed.org", "compose" : { "include" : [{ "system" : "http://hl7.org/fhir/gender-identity", "concept" : [{ "code" : "male", "display" : "male" }, { "code" : "female", "display" : "female" }, { "code" : "non-binary", "display" : "non-binary" }, { "code" : "transgender-male", "display" : "transgender male" }, { "code" : "transgender-female", "display" : "transgender female" }, { "code" : "other", "display" : "other" }, { "code" : "non-disclose", "display" : "does not wish to disclose" }] }] } 
<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]>
 <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..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><!-- 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" : "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

}

Usage note: every effort has been made 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: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 from both R4 and R4B

GuidanceResponse
GuidanceResponse.location
  • Added Element
GuidanceResponse.reason
  • Added Element
GuidanceResponse.evaluationMessage
  • Max Cardinality changed from * to ensure that 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)

See the examples are correct Full Difference for further information

This analysis is available for R4 as XML or JSON and useful, but they 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

14.14.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.14.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 normative part 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.14.5 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource , and check the specification. 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 59 Resources
patient reference The identity of a patient to search for guidance response results GuidanceResponse.subject.where(resolve() is Patient)
( Patient ) 		61 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 )