This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3
Clinical Decision Support Work Group | Maturity Level: 2 | Trial Use | Security Category: Patient | Compartments: 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.
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:
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.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
GuidanceResponse | TU | DomainResource | The formal response to a guidance request Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
requestIdentifier | Σ | 0..1 | Identifier | The identifier of the request associated with this response, if any |
identifier | Σ | 0..* | Identifier | Business identifier |
module[x] | Σ | 1..1 | What guidance was requested Binding: Guidance Module Code (Example) | |
moduleUri | uri | |||
moduleCanonical | canonical() | |||
moduleCodeableConcept | CodeableConcept | |||
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) | Patient the request was performed for | |
encounter | 0..1 | Reference(Encounter) | Encounter during which the response was returned | |
occurrenceDateTime | 0..1 | dateTime | When the guidance response was processed | |
performer | 0..1 | Reference(Device) | Device returning the guidance | |
reason | 0..* | CodeableReference() | Why guidance is needed | |
note | 0..* | Annotation | Additional notes about the response | |
evaluationMessage | 0..1 | Reference(OperationOutcome) | Messages resulting from the evaluation of the artifact or artifacts | |
outputParameters | 0..1 | Reference(Parameters) | The output parameters of the evaluation, if any | |
result | 0..* | Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | Task | VisionPrescription) | Proposed actions, if any | |
dataRequirement | 0..* | DataRequirement | Additional required data | |
Documentation for this format |
See the Extensions for this resource
UML Diagram (Legend)
XML Template
<GuidanceResponse xmlns="http://hl7.org/fhir"> <!-- 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 --></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) Patient the request was performed for --></subject> <encounter><!-- 0..1 Reference(Encounter) Encounter during which the response was returned --></encounter> <occurrenceDateTime value="[dateTime]"/><!-- 0..1 When the guidance response was processed --> <performer><!-- 0..1 Reference(Device) Device returning the guidance --></performer> <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|ImmunizationRecommendation|MedicationRequest|NutritionOrder| RequestOrchestration|ServiceRequest|SupplyRequest|Task|VisionPrescription) Proposed actions, if any --></result> <dataRequirement><!-- 0..* DataRequirement Additional required data --></dataRequirement> </GuidanceResponse>
JSON Template
{ "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 // 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) }, // Patient the request was performed for "encounter" : { Reference(Encounter) }, // Encounter during which the response was returned "occurrenceDateTime" : "<dateTime>", // When the guidance response was processed "performer" : { Reference(Device) }, // Device returning the guidance "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|ImmunizationRecommendation|MedicationRequest|NutritionOrder| RequestOrchestration|ServiceRequest|SupplyRequest|Task|VisionPrescription) }], // Proposed actions, if any "dataRequirement" : [{ DataRequirement }] // Additional required data }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:GuidanceResponse; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:requestIdentifier [ Identifier ] ; # 0..1 The identifier of the request associated with this response, if any fhir:identifier ( [ Identifier ] ... ) ; # 0..* Business identifier # 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 Patient the request was performed for fhir:encounter [ Reference(Encounter) ] ; # 0..1 Encounter during which the response was returned fhir:occurrenceDateTime [ dateTime ] ; # 0..1 When the guidance response was processed fhir:performer [ Reference(Device) ] ; # 0..1 Device returning the guidance 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| ImmunizationRecommendation|MedicationRequest|NutritionOrder| RequestOrchestration|ServiceRequest|SupplyRequest|Task|VisionPrescription) ] ... ) ; # 0..* Proposed actions, if any fhir:dataRequirement ( [ DataRequirement ] ... ) ; # 0..* Additional required data ]
Changes from both R4 and R4B
GuidanceResponse | |
GuidanceResponse.reason |
|
GuidanceResponse.evaluationMessage |
|
GuidanceResponse.result |
|
GuidanceResponse.reasonCode |
|
GuidanceResponse.reasonReference |
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.
See R4 <--> R5 Conversion Maps (status = See Conversions Summary.)
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
GuidanceResponse | TU | DomainResource | The formal response to a guidance request Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
requestIdentifier | Σ | 0..1 | Identifier | The identifier of the request associated with this response, if any |
identifier | Σ | 0..* | Identifier | Business identifier |
module[x] | Σ | 1..1 | What guidance was requested Binding: Guidance Module Code (Example) | |
moduleUri | uri | |||
moduleCanonical | canonical() | |||
moduleCodeableConcept | CodeableConcept | |||
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) | Patient the request was performed for | |
encounter | 0..1 | Reference(Encounter) | Encounter during which the response was returned | |
occurrenceDateTime | 0..1 | dateTime | When the guidance response was processed | |
performer | 0..1 | Reference(Device) | Device returning the guidance | |
reason | 0..* | CodeableReference() | Why guidance is needed | |
note | 0..* | Annotation | Additional notes about the response | |
evaluationMessage | 0..1 | Reference(OperationOutcome) | Messages resulting from the evaluation of the artifact or artifacts | |
outputParameters | 0..1 | Reference(Parameters) | The output parameters of the evaluation, if any | |
result | 0..* | Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | Task | VisionPrescription) | Proposed actions, if any | |
dataRequirement | 0..* | DataRequirement | Additional required data | |
Documentation for this format |
See the Extensions for this resource
XML Template
<GuidanceResponse xmlns="http://hl7.org/fhir"> <!-- 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 --></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) Patient the request was performed for --></subject> <encounter><!-- 0..1 Reference(Encounter) Encounter during which the response was returned --></encounter> <occurrenceDateTime value="[dateTime]"/><!-- 0..1 When the guidance response was processed --> <performer><!-- 0..1 Reference(Device) Device returning the guidance --></performer> <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|ImmunizationRecommendation|MedicationRequest|NutritionOrder| RequestOrchestration|ServiceRequest|SupplyRequest|Task|VisionPrescription) Proposed actions, if any --></result> <dataRequirement><!-- 0..* DataRequirement Additional required data --></dataRequirement> </GuidanceResponse>
JSON Template
{ "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 // 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) }, // Patient the request was performed for "encounter" : { Reference(Encounter) }, // Encounter during which the response was returned "occurrenceDateTime" : "<dateTime>", // When the guidance response was processed "performer" : { Reference(Device) }, // Device returning the guidance "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|ImmunizationRecommendation|MedicationRequest|NutritionOrder| RequestOrchestration|ServiceRequest|SupplyRequest|Task|VisionPrescription) }], // Proposed actions, if any "dataRequirement" : [{ DataRequirement }] // Additional required data }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:GuidanceResponse; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:requestIdentifier [ Identifier ] ; # 0..1 The identifier of the request associated with this response, if any fhir:identifier ( [ Identifier ] ... ) ; # 0..* Business identifier # 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 Patient the request was performed for fhir:encounter [ Reference(Encounter) ] ; # 0..1 Encounter during which the response was returned fhir:occurrenceDateTime [ dateTime ] ; # 0..1 When the guidance response was processed fhir:performer [ Reference(Device) ] ; # 0..1 Device returning the guidance 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| ImmunizationRecommendation|MedicationRequest|NutritionOrder| RequestOrchestration|ServiceRequest|SupplyRequest|Task|VisionPrescription) ] ... ) ; # 0..* Proposed actions, if any fhir:dataRequirement ( [ DataRequirement ] ... ) ; # 0..* Additional required data ]
Changes from both R4 and R4B
GuidanceResponse | |
GuidanceResponse.reason |
|
GuidanceResponse.evaluationMessage |
|
GuidanceResponse.result |
|
GuidanceResponse.reasonCode |
|
GuidanceResponse.reasonReference |
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.
See R4 <--> R5 Conversion Maps (status = See Conversions Summary.)
Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis
Path | ValueSet | Type | Documentation |
---|---|---|---|
GuidanceResponse.module[x] | GuidanceModuleCode | Example | Example guidance module codes. |
GuidanceResponse.status | GuidanceResponseStatus | Required | The status of a guidance response. |
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.
Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Expression | In Common |
identifier | token | The identifier of the guidance response | GuidanceResponse.identifier | 65 Resources |
patient | reference | The identity of a patient to search for guidance response results | GuidanceResponse.subject.where(resolve() is Patient) (Patient) | 66 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) |