Connectathon 11 Snapshot

This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

4.18 Resource GuidanceResponse - Content

Clinical Decision Support Work GroupMaturity Level: 0Compartments: Not linked to any defined compartments

A guidance response is the formal response to a previous guidance request. It is a derivative of the knowledge response that provides additional information relevant specifically to clinical decision support such as a description of any proposed actions to be taken.

4.18.1 Scope and Usage

This resource is a draft proposal for use as part of an approach to Clinical Quality within FHIR, and is documented as part of the Clinical Quality Improvement Framework Implementation Guide. Future updates to this resource will incorporate documentation from that guide.

4.18.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse DomainResourceThe formal response to a guidance request
... requestId 0..1stringThe id of the request associated with this response, if any
... module ?! Σ1..1Reference(DecisionSupportServiceModule | DecisionSupportRule)A reference to a knowledge module
... status ?! Σ1..1codesuccess | data-requested | data-required | in-progress | failure
GuidanceResponseStatus (Required)
... evaluationMessage 0..*Reference(OperationOutcome)Messages resulting from the evaluation of the artifact or artifacts
... outputParameters 0..1Reference(Parameters)The output parameters of the evaluation, if any
... action 0..*BackboneElement
.... actionIdentifier 0..1Identifier
.... number 0..1string
.... supportingEvidence 0..*Attachment
.... documentation 0..*Attachment
.... participant 0..*Reference(Patient | Person | Practitioner | RelatedPerson)
.... title 0..1string
.... description 0..1string
.... textEquivalent 0..1string
.... concept 0..*CodeableConcept
.... type 0..1codecreate | update | remove | fire-event
GuidanceResponseActionType (Required)
.... resource 0..1Reference(Any)
.... actions 0..*see action

doco Documentation for this format

UML Diagram

GuidanceResponse (DomainResource)The id of the request associated with this response. If an id was provided as part of the request, it will be provided here to enable the requester to more easily identify the response in a multi-request scenariorequestId : string [0..1]A reference to a knowledge module involved in an interaction (this element modifies the meaning of other elements)module : Reference [1..1] « DecisionSupportServiceModule| DecisionSupportRule »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 (Strength=Required)GuidanceResponseStatus! »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 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 »ActionA unique identifier for the actionactionIdentifier : Identifier [0..1]A user-visible number for the actionnumber : string [0..1]Supporting evidence for the actionsupportingEvidence : Attachment [0..*]Supporting documentation for the actiondocumentation : Attachment [0..*]The participant in the actionparticipant : Reference [0..*] « Patient|Person|Practitioner| RelatedPerson »The title of the actiontitle : string [0..1]A short description of the actiondescription : string [0..1]A text equivalent of the action to be performedtextEquivalent : string [0..1]Concepts associated with the actionconcept : CodeableConcept [0..*]The type of action to perform (create, update, remove)type : code [0..1] « The type of action to be performed (Strength=Required)GuidanceResponseActionType! »The resource that is the target of the action (e.g. CommunicationRequest)resource : Reference [0..1] « Any »Sub actionsactions[0..*]The actions, if any, produced by the evaluation of the artifactaction[0..*]

XML Template

<GuidanceResponse xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <requestId value="[string]"/><!-- 0..1 The id of the request associated with this response, if any -->
 <module><!-- 1..1 Reference(DecisionSupportServiceModule|DecisionSupportRule) A reference to a knowledge module --></module>
 <status value="[code]"/><!-- 1..1 success | data-requested | data-required | in-progress | failure -->
 <evaluationMessage><!-- 0..* 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>
 <action>  <!-- 0..* -->
  <actionIdentifier><!-- 0..1 Identifier  --></actionIdentifier>
  <number value="[string]"/><!-- 0..1  -->
  <supportingEvidence><!-- 0..* Attachment  --></supportingEvidence>
  <documentation><!-- 0..* Attachment  --></documentation>
  <participant><!-- 0..* Reference(Patient|Person|Practitioner|RelatedPerson)  --></participant>
  <title value="[string]"/><!-- 0..1  -->
  <description value="[string]"/><!-- 0..1  -->
  <textEquivalent value="[string]"/><!-- 0..1  -->
  <concept><!-- 0..* CodeableConcept  --></concept>
  <type value="[code]"/><!-- 0..1 create | update | remove | fire-event -->
  <resource><!-- 0..1 Reference(Any)  --></resource>
  <actions><!-- 0..* Content as for GuidanceResponse.action  --></actions>
 </action>
</GuidanceResponse>

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse DomainResourceThe formal response to a guidance request
... requestId 0..1stringThe id of the request associated with this response, if any
... module ?! Σ1..1Reference(DecisionSupportServiceModule | DecisionSupportRule)A reference to a knowledge module
... status ?! Σ1..1codesuccess | data-requested | data-required | in-progress | failure
GuidanceResponseStatus (Required)
... evaluationMessage 0..*Reference(OperationOutcome)Messages resulting from the evaluation of the artifact or artifacts
... outputParameters 0..1Reference(Parameters)The output parameters of the evaluation, if any
... action 0..*BackboneElement
.... actionIdentifier 0..1Identifier
.... number 0..1string
.... supportingEvidence 0..*Attachment
.... documentation 0..*Attachment
.... participant 0..*Reference(Patient | Person | Practitioner | RelatedPerson)
.... title 0..1string
.... description 0..1string
.... textEquivalent 0..1string
.... concept 0..*CodeableConcept
.... type 0..1codecreate | update | remove | fire-event
GuidanceResponseActionType (Required)
.... resource 0..1Reference(Any)
.... actions 0..*see action

doco Documentation for this format

UML Diagram

GuidanceResponse (DomainResource)The id of the request associated with this response. If an id was provided as part of the request, it will be provided here to enable the requester to more easily identify the response in a multi-request scenariorequestId : string [0..1]A reference to a knowledge module involved in an interaction (this element modifies the meaning of other elements)module : Reference [1..1] « DecisionSupportServiceModule| DecisionSupportRule »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 (Strength=Required)GuidanceResponseStatus! »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 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 »ActionA unique identifier for the actionactionIdentifier : Identifier [0..1]A user-visible number for the actionnumber : string [0..1]Supporting evidence for the actionsupportingEvidence : Attachment [0..*]Supporting documentation for the actiondocumentation : Attachment [0..*]The participant in the actionparticipant : Reference [0..*] « Patient|Person|Practitioner| RelatedPerson »The title of the actiontitle : string [0..1]A short description of the actiondescription : string [0..1]A text equivalent of the action to be performedtextEquivalent : string [0..1]Concepts associated with the actionconcept : CodeableConcept [0..*]The type of action to perform (create, update, remove)type : code [0..1] « The type of action to be performed (Strength=Required)GuidanceResponseActionType! »The resource that is the target of the action (e.g. CommunicationRequest)resource : Reference [0..1] « Any »Sub actionsactions[0..*]The actions, if any, produced by the evaluation of the artifactaction[0..*]

XML Template

<GuidanceResponse xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <requestId value="[string]"/><!-- 0..1 The id of the request associated with this response, if any -->
 <module><!-- 1..1 Reference(DecisionSupportServiceModule|DecisionSupportRule) A reference to a knowledge module --></module>
 <status value="[code]"/><!-- 1..1 success | data-requested | data-required | in-progress | failure -->
 <evaluationMessage><!-- 0..* 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>
 <action>  <!-- 0..* -->
  <actionIdentifier><!-- 0..1 Identifier  --></actionIdentifier>
  <number value="[string]"/><!-- 0..1  -->
  <supportingEvidence><!-- 0..* Attachment  --></supportingEvidence>
  <documentation><!-- 0..* Attachment  --></documentation>
  <participant><!-- 0..* Reference(Patient|Person|Practitioner|RelatedPerson)  --></participant>
  <title value="[string]"/><!-- 0..1  -->
  <description value="[string]"/><!-- 0..1  -->
  <textEquivalent value="[string]"/><!-- 0..1  -->
  <concept><!-- 0..* CodeableConcept  --></concept>
  <type value="[code]"/><!-- 0..1 create | update | remove | fire-event -->
  <resource><!-- 0..1 Reference(Any)  --></resource>
  <actions><!-- 0..* Content as for GuidanceResponse.action  --></actions>
 </action>
</GuidanceResponse>

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire

4.18.2.1 Terminology Bindings

PathDefinitionTypeReference
GuidanceResponse.status The status of a guidance responseRequiredGuidanceResponseStatus
GuidanceResponse.action.type The type of action to be performedRequiredGuidanceResponseActionType