STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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

14.5 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 guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.

14.5.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 Reasoning module.

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 output data of the module and any suggested actions to be performed.

For a detailed discussion of the evaluation process, refer to the Guidance Request topic in the Clinical Reasoning module.

14.5.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse DomainResourceThe formal response to a guidance request
... requestId 0..1idThe id of the request associated with this response, if any
... identifier Σ0..1IdentifierBusiness identifier
... module ?!Σ1..1Reference(DecisionSupportServiceModule)A reference to a knowledge module
... status ?!Σ1..1codesuccess | data-requested | data-required | in-progress | failure
GuidanceResponseStatus (Required)
... subject 0..1Reference(Patient | Group)Patient the request was performed for
... context 0..1Reference(Encounter | EpisodeOfCare)Encounter or Episode during which the response was returned
... occurrenceDateTime 0..1dateTimeWhen the guidance response was processed
... performer 0..1Reference(Device)Device returning the guidance
... reason[x] 0..1Reason for the response
.... reasonCodeableConceptCodeableConcept
.... reasonReferenceReference(Any)
... note 0..*AnnotationAdditional notes about the response
... 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..*BackboneElementProposed actions, if any
.... actionIdentifier 0..1IdentifierUnique identifier
.... label 0..1stringUser-visible label for the action (e.g. 1. or A.)
.... title 0..1stringUser-visible title
.... description 0..1stringShort description of the action
.... textEquivalent 0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... concept 0..*CodeableConceptThe meaning of the action or its sub-actions
.... documentation 0..*RelatedResourceSupporting documentation for the intended performer of the action
.... relatedAction 0..1BackboneElementRelationship to another action
..... actionIdentifier 1..1IdentifierIdentifier of the related action
..... relationship 1..1codebefore | after
PlanActionRelationshipType (Required)
..... offset[x] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
..... anchor 0..1codestart | end
PlanActionRelationshipAnchor (Required)
.... timing[x] 0..1When the action should take place
..... timingDateTimedateTime
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
.... participant 0..*Reference(Patient | Person | Practitioner | RelatedPerson)Participant
.... type 0..1Codingcreate | update | remove | fire-event
PlanActionType (Extensible)
.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
PlanActionGroupingBehavior (Required)
.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
PlanActionSelectionBehavior (Required)
.... requiredBehavior 0..1codemust | could | must-unless-documented
PlanActionRequiredBehavior (Required)
.... precheckBehavior 0..1codeyes | no
PlanActionPrecheckBehavior (Required)
.... cardinalityBehavior 0..1codesingle | multiple
PlanActionCardinalityBehavior (Required)
.... resource 0..1Reference(Any)The target of the action
.... action 0..*see actionSub action
... dataRequirement 0..*DataRequirementAdditional required data

doco Documentation for this format

UML Diagram (Legend)

GuidanceResponse (DomainResource)The id of the request associated with this response. If an id 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 scenariorequestId : id [0..1]Allows a service to provide a unique, business identifier for the responseidentifier : Identifier [0..1]A reference to the knowledge module that was invoked (this element modifies the meaning of other elements)module : Reference [1..1] « DecisionSupportServiceModule »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! »The patient for which the request was processedsubject : Reference [0..1] « Patient|Group »Allows the context of the guidance response to be provided if available. In a service context, this would likely be unavailablecontext : Reference [0..1] « Encounter|EpisodeOfCare »Indicates when the guidance response was processedoccurrenceDateTime : dateTime [0..1]Provides a reference to the device that performed the guidanceperformer : Reference [0..1] « Device »Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the responsereason[x] : Type [0..1] « CodeableConcept|Reference(Any) »Provides a mechanism to communicate additional information about the responsenote : Annotation [0..*]Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this elementevaluationMessage : Reference [0..*] « OperationOutcome »The 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 »If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this datadataRequirement : DataRequirement [0..*]ActionA unique identifier for the action. The identifier SHALL be unique within the container in which it appears, and MAY be universally uniqueactionIdentifier : Identifier [0..1]A user-visible label for the actionlabel : string [0..1]The title of the action displayed to a usertitle : string [0..1]A short description of the action used to provide a summary to display to the userdescription : string [0..1]A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that may not be capable of interpreting it dynamicallytextEquivalent : string [0..1]The concept represented by this action or its sub-actionsconcept : CodeableConcept [0..*]Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resourcesdocumentation : RelatedResource [0..*]An optional value describing when the action should be performedtiming[x] : Type [0..1] « dateTime|Period|Duration|Range »The participant in the actionparticipant : Reference [0..*] « Patient|Person|Practitioner| RelatedPerson »The type of action to perform (create, update, remove)type : Coding [0..1] « The type of action to be performed (Strength=Extensible)PlanActionType+ »Defines the grouping behavior for the action and its childrengroupingBehavior : code [0..1] « Defines organization behavior of a group (Strength=Required)PlanActionGroupingBehavior! »Defines the selection behavior for the action and its childrenselectionBehavior : code [0..1] « Defines selection behavior of a group (Strength=Required)PlanActionSelectionBehavior! »Defines the requiredness behavior for the actionrequiredBehavior : code [0..1] « Defines requiredness behavior for selecting an action or an action group (Strength=Required)PlanActionRequiredBehavior! »Defines whether the action should usually be preselectedprecheckBehavior : code [0..1] « Defines selection frequency behavior for an action or group (Strength=Required)PlanActionPrecheckBehavior! »Defines whether the action can be selected multiple timescardinalityBehavior : code [0..1] « Defines behavior for an action or a group for how many times that item may be repeated (Strength=Required)PlanActionCardinalityBehavior! »The resource that is the target of the action (e.g. CommunicationRequest)resource : Reference [0..1] « Any »RelatedActionThe unique identifier of the related actionactionIdentifier : Identifier [1..1]The relationship of this action to the related actionrelationship : code [1..1] « Defines the types of relationships between actions (Strength=Required)PlanActionRelationshipType! »A duration or range of durations to apply to the relationship. For example, 30-60 minutes beforeoffset[x] : Type [0..1] « Duration|Range »An optional indicator for how the relationship is anchored to the related action. For example "before the start" or "before the end" of the related actionanchor : code [0..1] « Defines possible anchors for the relationship between actions (Strength=Required)PlanActionRelationshipAnchor! »A relationship to another action such as "before" or "30-60 minutes after start of"relatedAction[0..1]Sub actionsaction[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="[id]"/><!-- 0..1 The id of the request associated with this response, if any -->
 <identifier><!-- 0..1 Identifier Business identifier --></identifier>
 <module><!-- 1..1 Reference(DecisionSupportServiceModule) A reference to a knowledge module --></module>
 <status value="[code]"/><!-- 1..1 success | data-requested | data-required | in-progress | failure -->
 <subject><!-- 0..1 Reference(Patient|Group) Patient the request was performed for --></subject>
 <context><!-- 0..1 Reference(Encounter|EpisodeOfCare) Encounter or Episode during which the response was returned --></context>
 <occurrenceDateTime value="[dateTime]"/><!-- 0..1 When the guidance response was processed -->
 <performer><!-- 0..1 Reference(Device) Device returning the guidance --></performer>
 <reason[x]><!-- 0..1 CodeableConcept|Reference(Any) Reason for the response --></reason[x]>
 <note><!-- 0..* Annotation Additional notes about the response --></note>
 <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..* Proposed actions, if any -->
  <actionIdentifier><!-- 0..1 Identifier Unique identifier --></actionIdentifier>
  <label value="[string]"/><!-- 0..1 User-visible label for the action (e.g. 1. or A.) -->
  <title value="[string]"/><!-- 0..1 User-visible title -->
  <description value="[string]"/><!-- 0..1 Short description of the action -->
  <textEquivalent value="[string]"/><!-- 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system -->
  <concept><!-- 0..* CodeableConcept The meaning of the action or its sub-actions --></concept>
  <documentation><!-- 0..* RelatedResource Supporting documentation for the intended performer of the action --></documentation>
  <relatedAction>  <!-- 0..1 Relationship to another action -->
   <actionIdentifier><!-- 1..1 Identifier Identifier of the related action --></actionIdentifier>
   <relationship value="[code]"/><!-- 1..1 before | after -->
   <offset[x]><!-- 0..1 Duration|Range Time offset for the relationship --></offset[x]>
   <anchor value="[code]"/><!-- 0..1 start | end -->
  </relatedAction>
  <timing[x]><!-- 0..1 dateTime|Period|Duration|Range When the action should take place --></timing[x]>
  <participant><!-- 0..* Reference(Patient|Person|Practitioner|RelatedPerson) Participant --></participant>
  <type><!-- 0..1 Coding create | update | remove | fire-event --></type>
  <groupingBehavior value="[code]"/><!-- 0..1 visual-group | logical-group | sentence-group -->
  <selectionBehavior value="[code]"/><!-- 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more -->
  <requiredBehavior value="[code]"/><!-- 0..1 must | could | must-unless-documented -->
  <precheckBehavior value="[code]"/><!-- 0..1 yes | no -->
  <cardinalityBehavior value="[code]"/><!-- 0..1 single | multiple -->
  <resource><!-- 0..1 Reference(Any) The target of the action --></resource>
  <action><!-- 0..* Content as for GuidanceResponse.action Sub action --></action>
 </action>
 <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
  "requestId" : "<id>", // The id of the request associated with this response, if any
  "identifier" : { Identifier }, // Business identifier
  "module" : { Reference(DecisionSupportServiceModule) }, // R!  A reference to a knowledge module
  "status" : "<code>", // R!  success | data-requested | data-required | in-progress | failure
  "subject" : { Reference(Patient|Group) }, // Patient the request was performed for
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or Episode during which the response was returned
  "occurrenceDateTime" : "<dateTime>", // When the guidance response was processed
  "performer" : { Reference(Device) }, // Device returning the guidance
  // reason[x]: Reason for the response. One of these 2:
  "reasonCodeableConcept" : { CodeableConcept },
  "reasonReference" : { Reference(Any) },
  "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
  "action" : [{ // Proposed actions, if any
    "actionIdentifier" : { Identifier }, // Unique identifier
    "label" : "<string>", // User-visible label for the action (e.g. 1. or A.)
    "title" : "<string>", // User-visible title
    "description" : "<string>", // Short description of the action
    "textEquivalent" : "<string>", // Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    "concept" : [{ CodeableConcept }], // The meaning of the action or its sub-actions
    "documentation" : [{ RelatedResource }], // Supporting documentation for the intended performer of the action
    "relatedAction" : { // Relationship to another action
      "actionIdentifier" : { Identifier }, // R!  Identifier of the related action
      "relationship" : "<code>", // R!  before | after
      // offset[x]: Time offset for the relationship. One of these 2:
      "offsetDuration" : { Duration },
      "offsetRange" : { Range },
      "anchor" : "<code>" // start | end
    },
    // timing[x]: When the action should take place. One of these 4:
    "timingDateTime" : "<dateTime>",
    "timingPeriod" : { Period },
    "timingDuration" : { Duration },
    "timingRange" : { Range },
    "participant" : [{ Reference(Patient|Person|Practitioner|RelatedPerson) }], // Participant
    "type" : { Coding }, // create | update | remove | fire-event
    "groupingBehavior" : "<code>", // visual-group | logical-group | sentence-group
    "selectionBehavior" : "<code>", // any | all | all-or-none | exactly-one | at-most-one | one-or-more
    "requiredBehavior" : "<code>", // must | could | must-unless-documented
    "precheckBehavior" : "<code>", // yes | no
    "cardinalityBehavior" : "<code>", // single | multiple
    "resource" : { Reference(Any) }, // The target of the action
    "action" : [{ Content as for GuidanceResponse.action }] // Sub action
  }],
  "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: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:GuidanceResponse.requestId [ id ]; # 0..1 The id of the request associated with this response, if any
  fhir:GuidanceResponse.identifier [ Identifier ]; # 0..1 Business identifier
  fhir:GuidanceResponse.module [ Reference(DecisionSupportServiceModule) ]; # 1..1 A reference to a knowledge module
  fhir:GuidanceResponse.status [ code ]; # 1..1 success | data-requested | data-required | in-progress | failure
  fhir:GuidanceResponse.subject [ Reference(Patient|Group) ]; # 0..1 Patient the request was performed for
  fhir:GuidanceResponse.context [ Reference(Encounter|EpisodeOfCare) ]; # 0..1 Encounter or Episode during which the response was returned
  fhir:GuidanceResponse.occurrenceDateTime [ dateTime ]; # 0..1 When the guidance response was processed
  fhir:GuidanceResponse.performer [ Reference(Device) ]; # 0..1 Device returning the guidance
  # GuidanceResponse.reason[x] : 0..1 Reason for the response. One of these 2
    fhir:GuidanceResponse.reasonCodeableConcept [ CodeableConcept ]
    fhir:GuidanceResponse.reasonReference [ Reference(Any) ]
  fhir:GuidanceResponse.note [ Annotation ], ... ; # 0..* Additional notes about the response
  fhir:GuidanceResponse.evaluationMessage [ Reference(OperationOutcome) ], ... ; # 0..* Messages resulting from the evaluation of the artifact or artifacts
  fhir:GuidanceResponse.outputParameters [ Reference(Parameters) ]; # 0..1 The output parameters of the evaluation, if any
  fhir:GuidanceResponse.action [ # 0..* Proposed actions, if any
    fhir:GuidanceResponse.action.actionIdentifier [ Identifier ]; # 0..1 Unique identifier
    fhir:GuidanceResponse.action.label [ string ]; # 0..1 User-visible label for the action (e.g. 1. or A.)
    fhir:GuidanceResponse.action.title [ string ]; # 0..1 User-visible title
    fhir:GuidanceResponse.action.description [ string ]; # 0..1 Short description of the action
    fhir:GuidanceResponse.action.textEquivalent [ string ]; # 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    fhir:GuidanceResponse.action.concept [ CodeableConcept ], ... ; # 0..* The meaning of the action or its sub-actions
    fhir:GuidanceResponse.action.documentation [ RelatedResource ], ... ; # 0..* Supporting documentation for the intended performer of the action
    fhir:GuidanceResponse.action.relatedAction [ # 0..1 Relationship to another action
      fhir:GuidanceResponse.action.relatedAction.actionIdentifier [ Identifier ]; # 1..1 Identifier of the related action
      fhir:GuidanceResponse.action.relatedAction.relationship [ code ]; # 1..1 before | after
      # GuidanceResponse.action.relatedAction.offset[x] : 0..1 Time offset for the relationship. One of these 2
        fhir:GuidanceResponse.action.relatedAction.offsetDuration [ Duration ]
        fhir:GuidanceResponse.action.relatedAction.offsetRange [ Range ]
      fhir:GuidanceResponse.action.relatedAction.anchor [ code ]; # 0..1 start | end
    ];
    # GuidanceResponse.action.timing[x] : 0..1 When the action should take place. One of these 4
      fhir:GuidanceResponse.action.timingDateTime [ dateTime ]
      fhir:GuidanceResponse.action.timingPeriod [ Period ]
      fhir:GuidanceResponse.action.timingDuration [ Duration ]
      fhir:GuidanceResponse.action.timingRange [ Range ]
    fhir:GuidanceResponse.action.participant [ Reference(Patient|Person|Practitioner|RelatedPerson) ], ... ; # 0..* Participant
    fhir:GuidanceResponse.action.type [ Coding ]; # 0..1 create | update | remove | fire-event
    fhir:GuidanceResponse.action.groupingBehavior [ code ]; # 0..1 visual-group | logical-group | sentence-group
    fhir:GuidanceResponse.action.selectionBehavior [ code ]; # 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more
    fhir:GuidanceResponse.action.requiredBehavior [ code ]; # 0..1 must | could | must-unless-documented
    fhir:GuidanceResponse.action.precheckBehavior [ code ]; # 0..1 yes | no
    fhir:GuidanceResponse.action.cardinalityBehavior [ code ]; # 0..1 single | multiple
    fhir:GuidanceResponse.action.resource [ Reference(Any) ]; # 0..1 The target of the action
    fhir:GuidanceResponse.action.action [ See GuidanceResponse.action ], ... ; # 0..* Sub action
  ], ...;
  fhir:GuidanceResponse.dataRequirement [ DataRequirement ], ... ; # 0..* Additional required data
]

Changes since DSTU2

This resource did not exist in Release 2

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse DomainResourceThe formal response to a guidance request
... requestId 0..1idThe id of the request associated with this response, if any
... identifier Σ0..1IdentifierBusiness identifier
... module ?!Σ1..1Reference(DecisionSupportServiceModule)A reference to a knowledge module
... status ?!Σ1..1codesuccess | data-requested | data-required | in-progress | failure
GuidanceResponseStatus (Required)
... subject 0..1Reference(Patient | Group)Patient the request was performed for
... context 0..1Reference(Encounter | EpisodeOfCare)Encounter or Episode during which the response was returned
... occurrenceDateTime 0..1dateTimeWhen the guidance response was processed
... performer 0..1Reference(Device)Device returning the guidance
... reason[x] 0..1Reason for the response
.... reasonCodeableConceptCodeableConcept
.... reasonReferenceReference(Any)
... note 0..*AnnotationAdditional notes about the response
... 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..*BackboneElementProposed actions, if any
.... actionIdentifier 0..1IdentifierUnique identifier
.... label 0..1stringUser-visible label for the action (e.g. 1. or A.)
.... title 0..1stringUser-visible title
.... description 0..1stringShort description of the action
.... textEquivalent 0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... concept 0..*CodeableConceptThe meaning of the action or its sub-actions
.... documentation 0..*RelatedResourceSupporting documentation for the intended performer of the action
.... relatedAction 0..1BackboneElementRelationship to another action
..... actionIdentifier 1..1IdentifierIdentifier of the related action
..... relationship 1..1codebefore | after
PlanActionRelationshipType (Required)
..... offset[x] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
..... anchor 0..1codestart | end
PlanActionRelationshipAnchor (Required)
.... timing[x] 0..1When the action should take place
..... timingDateTimedateTime
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
.... participant 0..*Reference(Patient | Person | Practitioner | RelatedPerson)Participant
.... type 0..1Codingcreate | update | remove | fire-event
PlanActionType (Extensible)
.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
PlanActionGroupingBehavior (Required)
.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
PlanActionSelectionBehavior (Required)
.... requiredBehavior 0..1codemust | could | must-unless-documented
PlanActionRequiredBehavior (Required)
.... precheckBehavior 0..1codeyes | no
PlanActionPrecheckBehavior (Required)
.... cardinalityBehavior 0..1codesingle | multiple
PlanActionCardinalityBehavior (Required)
.... resource 0..1Reference(Any)The target of the action
.... action 0..*see actionSub action
... dataRequirement 0..*DataRequirementAdditional required data

doco Documentation for this format

UML Diagram (Legend)

GuidanceResponse (DomainResource)The id of the request associated with this response. If an id 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 scenariorequestId : id [0..1]Allows a service to provide a unique, business identifier for the responseidentifier : Identifier [0..1]A reference to the knowledge module that was invoked (this element modifies the meaning of other elements)module : Reference [1..1] « DecisionSupportServiceModule »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! »The patient for which the request was processedsubject : Reference [0..1] « Patient|Group »Allows the context of the guidance response to be provided if available. In a service context, this would likely be unavailablecontext : Reference [0..1] « Encounter|EpisodeOfCare »Indicates when the guidance response was processedoccurrenceDateTime : dateTime [0..1]Provides a reference to the device that performed the guidanceperformer : Reference [0..1] « Device »Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the responsereason[x] : Type [0..1] « CodeableConcept|Reference(Any) »Provides a mechanism to communicate additional information about the responsenote : Annotation [0..*]Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this elementevaluationMessage : Reference [0..*] « OperationOutcome »The 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 »If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this datadataRequirement : DataRequirement [0..*]ActionA unique identifier for the action. The identifier SHALL be unique within the container in which it appears, and MAY be universally uniqueactionIdentifier : Identifier [0..1]A user-visible label for the actionlabel : string [0..1]The title of the action displayed to a usertitle : string [0..1]A short description of the action used to provide a summary to display to the userdescription : string [0..1]A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that may not be capable of interpreting it dynamicallytextEquivalent : string [0..1]The concept represented by this action or its sub-actionsconcept : CodeableConcept [0..*]Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resourcesdocumentation : RelatedResource [0..*]An optional value describing when the action should be performedtiming[x] : Type [0..1] « dateTime|Period|Duration|Range »The participant in the actionparticipant : Reference [0..*] « Patient|Person|Practitioner| RelatedPerson »The type of action to perform (create, update, remove)type : Coding [0..1] « The type of action to be performed (Strength=Extensible)PlanActionType+ »Defines the grouping behavior for the action and its childrengroupingBehavior : code [0..1] « Defines organization behavior of a group (Strength=Required)PlanActionGroupingBehavior! »Defines the selection behavior for the action and its childrenselectionBehavior : code [0..1] « Defines selection behavior of a group (Strength=Required)PlanActionSelectionBehavior! »Defines the requiredness behavior for the actionrequiredBehavior : code [0..1] « Defines requiredness behavior for selecting an action or an action group (Strength=Required)PlanActionRequiredBehavior! »Defines whether the action should usually be preselectedprecheckBehavior : code [0..1] « Defines selection frequency behavior for an action or group (Strength=Required)PlanActionPrecheckBehavior! »Defines whether the action can be selected multiple timescardinalityBehavior : code [0..1] « Defines behavior for an action or a group for how many times that item may be repeated (Strength=Required)PlanActionCardinalityBehavior! »The resource that is the target of the action (e.g. CommunicationRequest)resource : Reference [0..1] « Any »RelatedActionThe unique identifier of the related actionactionIdentifier : Identifier [1..1]The relationship of this action to the related actionrelationship : code [1..1] « Defines the types of relationships between actions (Strength=Required)PlanActionRelationshipType! »A duration or range of durations to apply to the relationship. For example, 30-60 minutes beforeoffset[x] : Type [0..1] « Duration|Range »An optional indicator for how the relationship is anchored to the related action. For example "before the start" or "before the end" of the related actionanchor : code [0..1] « Defines possible anchors for the relationship between actions (Strength=Required)PlanActionRelationshipAnchor! »A relationship to another action such as "before" or "30-60 minutes after start of"relatedAction[0..1]Sub actionsaction[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="[id]"/><!-- 0..1 The id of the request associated with this response, if any -->
 <identifier><!-- 0..1 Identifier Business identifier --></identifier>
 <module><!-- 1..1 Reference(DecisionSupportServiceModule) A reference to a knowledge module --></module>
 <status value="[code]"/><!-- 1..1 success | data-requested | data-required | in-progress | failure -->
 <subject><!-- 0..1 Reference(Patient|Group) Patient the request was performed for --></subject>
 <context><!-- 0..1 Reference(Encounter|EpisodeOfCare) Encounter or Episode during which the response was returned --></context>
 <occurrenceDateTime value="[dateTime]"/><!-- 0..1 When the guidance response was processed -->
 <performer><!-- 0..1 Reference(Device) Device returning the guidance --></performer>
 <reason[x]><!-- 0..1 CodeableConcept|Reference(Any) Reason for the response --></reason[x]>
 <note><!-- 0..* Annotation Additional notes about the response --></note>
 <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..* Proposed actions, if any -->
  <actionIdentifier><!-- 0..1 Identifier Unique identifier --></actionIdentifier>
  <label value="[string]"/><!-- 0..1 User-visible label for the action (e.g. 1. or A.) -->
  <title value="[string]"/><!-- 0..1 User-visible title -->
  <description value="[string]"/><!-- 0..1 Short description of the action -->
  <textEquivalent value="[string]"/><!-- 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system -->
  <concept><!-- 0..* CodeableConcept The meaning of the action or its sub-actions --></concept>
  <documentation><!-- 0..* RelatedResource Supporting documentation for the intended performer of the action --></documentation>
  <relatedAction>  <!-- 0..1 Relationship to another action -->
   <actionIdentifier><!-- 1..1 Identifier Identifier of the related action --></actionIdentifier>
   <relationship value="[code]"/><!-- 1..1 before | after -->
   <offset[x]><!-- 0..1 Duration|Range Time offset for the relationship --></offset[x]>
   <anchor value="[code]"/><!-- 0..1 start | end -->
  </relatedAction>
  <timing[x]><!-- 0..1 dateTime|Period|Duration|Range When the action should take place --></timing[x]>
  <participant><!-- 0..* Reference(Patient|Person|Practitioner|RelatedPerson) Participant --></participant>
  <type><!-- 0..1 Coding create | update | remove | fire-event --></type>
  <groupingBehavior value="[code]"/><!-- 0..1 visual-group | logical-group | sentence-group -->
  <selectionBehavior value="[code]"/><!-- 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more -->
  <requiredBehavior value="[code]"/><!-- 0..1 must | could | must-unless-documented -->
  <precheckBehavior value="[code]"/><!-- 0..1 yes | no -->
  <cardinalityBehavior value="[code]"/><!-- 0..1 single | multiple -->
  <resource><!-- 0..1 Reference(Any) The target of the action --></resource>
  <action><!-- 0..* Content as for GuidanceResponse.action Sub action --></action>
 </action>
 <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
  "requestId" : "<id>", // The id of the request associated with this response, if any
  "identifier" : { Identifier }, // Business identifier
  "module" : { Reference(DecisionSupportServiceModule) }, // R!  A reference to a knowledge module
  "status" : "<code>", // R!  success | data-requested | data-required | in-progress | failure
  "subject" : { Reference(Patient|Group) }, // Patient the request was performed for
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or Episode during which the response was returned
  "occurrenceDateTime" : "<dateTime>", // When the guidance response was processed
  "performer" : { Reference(Device) }, // Device returning the guidance
  // reason[x]: Reason for the response. One of these 2:
  "reasonCodeableConcept" : { CodeableConcept },
  "reasonReference" : { Reference(Any) },
  "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
  "action" : [{ // Proposed actions, if any
    "actionIdentifier" : { Identifier }, // Unique identifier
    "label" : "<string>", // User-visible label for the action (e.g. 1. or A.)
    "title" : "<string>", // User-visible title
    "description" : "<string>", // Short description of the action
    "textEquivalent" : "<string>", // Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    "concept" : [{ CodeableConcept }], // The meaning of the action or its sub-actions
    "documentation" : [{ RelatedResource }], // Supporting documentation for the intended performer of the action
    "relatedAction" : { // Relationship to another action
      "actionIdentifier" : { Identifier }, // R!  Identifier of the related action
      "relationship" : "<code>", // R!  before | after
      // offset[x]: Time offset for the relationship. One of these 2:
      "offsetDuration" : { Duration },
      "offsetRange" : { Range },
      "anchor" : "<code>" // start | end
    },
    // timing[x]: When the action should take place. One of these 4:
    "timingDateTime" : "<dateTime>",
    "timingPeriod" : { Period },
    "timingDuration" : { Duration },
    "timingRange" : { Range },
    "participant" : [{ Reference(Patient|Person|Practitioner|RelatedPerson) }], // Participant
    "type" : { Coding }, // create | update | remove | fire-event
    "groupingBehavior" : "<code>", // visual-group | logical-group | sentence-group
    "selectionBehavior" : "<code>", // any | all | all-or-none | exactly-one | at-most-one | one-or-more
    "requiredBehavior" : "<code>", // must | could | must-unless-documented
    "precheckBehavior" : "<code>", // yes | no
    "cardinalityBehavior" : "<code>", // single | multiple
    "resource" : { Reference(Any) }, // The target of the action
    "action" : [{ Content as for GuidanceResponse.action }] // Sub action
  }],
  "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: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:GuidanceResponse.requestId [ id ]; # 0..1 The id of the request associated with this response, if any
  fhir:GuidanceResponse.identifier [ Identifier ]; # 0..1 Business identifier
  fhir:GuidanceResponse.module [ Reference(DecisionSupportServiceModule) ]; # 1..1 A reference to a knowledge module
  fhir:GuidanceResponse.status [ code ]; # 1..1 success | data-requested | data-required | in-progress | failure
  fhir:GuidanceResponse.subject [ Reference(Patient|Group) ]; # 0..1 Patient the request was performed for
  fhir:GuidanceResponse.context [ Reference(Encounter|EpisodeOfCare) ]; # 0..1 Encounter or Episode during which the response was returned
  fhir:GuidanceResponse.occurrenceDateTime [ dateTime ]; # 0..1 When the guidance response was processed
  fhir:GuidanceResponse.performer [ Reference(Device) ]; # 0..1 Device returning the guidance
  # GuidanceResponse.reason[x] : 0..1 Reason for the response. One of these 2
    fhir:GuidanceResponse.reasonCodeableConcept [ CodeableConcept ]
    fhir:GuidanceResponse.reasonReference [ Reference(Any) ]
  fhir:GuidanceResponse.note [ Annotation ], ... ; # 0..* Additional notes about the response
  fhir:GuidanceResponse.evaluationMessage [ Reference(OperationOutcome) ], ... ; # 0..* Messages resulting from the evaluation of the artifact or artifacts
  fhir:GuidanceResponse.outputParameters [ Reference(Parameters) ]; # 0..1 The output parameters of the evaluation, if any
  fhir:GuidanceResponse.action [ # 0..* Proposed actions, if any
    fhir:GuidanceResponse.action.actionIdentifier [ Identifier ]; # 0..1 Unique identifier
    fhir:GuidanceResponse.action.label [ string ]; # 0..1 User-visible label for the action (e.g. 1. or A.)
    fhir:GuidanceResponse.action.title [ string ]; # 0..1 User-visible title
    fhir:GuidanceResponse.action.description [ string ]; # 0..1 Short description of the action
    fhir:GuidanceResponse.action.textEquivalent [ string ]; # 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    fhir:GuidanceResponse.action.concept [ CodeableConcept ], ... ; # 0..* The meaning of the action or its sub-actions
    fhir:GuidanceResponse.action.documentation [ RelatedResource ], ... ; # 0..* Supporting documentation for the intended performer of the action
    fhir:GuidanceResponse.action.relatedAction [ # 0..1 Relationship to another action
      fhir:GuidanceResponse.action.relatedAction.actionIdentifier [ Identifier ]; # 1..1 Identifier of the related action
      fhir:GuidanceResponse.action.relatedAction.relationship [ code ]; # 1..1 before | after
      # GuidanceResponse.action.relatedAction.offset[x] : 0..1 Time offset for the relationship. One of these 2
        fhir:GuidanceResponse.action.relatedAction.offsetDuration [ Duration ]
        fhir:GuidanceResponse.action.relatedAction.offsetRange [ Range ]
      fhir:GuidanceResponse.action.relatedAction.anchor [ code ]; # 0..1 start | end
    ];
    # GuidanceResponse.action.timing[x] : 0..1 When the action should take place. One of these 4
      fhir:GuidanceResponse.action.timingDateTime [ dateTime ]
      fhir:GuidanceResponse.action.timingPeriod [ Period ]
      fhir:GuidanceResponse.action.timingDuration [ Duration ]
      fhir:GuidanceResponse.action.timingRange [ Range ]
    fhir:GuidanceResponse.action.participant [ Reference(Patient|Person|Practitioner|RelatedPerson) ], ... ; # 0..* Participant
    fhir:GuidanceResponse.action.type [ Coding ]; # 0..1 create | update | remove | fire-event
    fhir:GuidanceResponse.action.groupingBehavior [ code ]; # 0..1 visual-group | logical-group | sentence-group
    fhir:GuidanceResponse.action.selectionBehavior [ code ]; # 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more
    fhir:GuidanceResponse.action.requiredBehavior [ code ]; # 0..1 must | could | must-unless-documented
    fhir:GuidanceResponse.action.precheckBehavior [ code ]; # 0..1 yes | no
    fhir:GuidanceResponse.action.cardinalityBehavior [ code ]; # 0..1 single | multiple
    fhir:GuidanceResponse.action.resource [ Reference(Any) ]; # 0..1 The target of the action
    fhir:GuidanceResponse.action.action [ See GuidanceResponse.action ], ... ; # 0..* Sub action
  ], ...;
  fhir:GuidanceResponse.dataRequirement [ DataRequirement ], ... ; # 0..* Additional required data
]

Changes since DSTU2

This resource did not exist in Release 2

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)

14.5.2.1 Terminology Bindings

PathDefinitionTypeReference
GuidanceResponse.status The status of a guidance responseRequiredGuidanceResponseStatus
GuidanceResponse.action.relatedAction.relationship Defines the types of relationships between actionsRequiredPlanActionRelationshipType
GuidanceResponse.action.relatedAction.anchor Defines possible anchors for the relationship between actionsRequiredPlanActionRelationshipAnchor
GuidanceResponse.action.type The type of action to be performedExtensiblePlanActionType
GuidanceResponse.action.groupingBehavior Defines organization behavior of a groupRequiredPlanActionGroupingBehavior
GuidanceResponse.action.selectionBehavior Defines selection behavior of a groupRequiredPlanActionSelectionBehavior
GuidanceResponse.action.requiredBehavior Defines requiredness behavior for selecting an action or an action groupRequiredPlanActionRequiredBehavior
GuidanceResponse.action.precheckBehavior Defines selection frequency behavior for an action or groupRequiredPlanActionPrecheckBehavior
GuidanceResponse.action.cardinalityBehavior Defines behavior for an action or a group for how many times that item may be repeatedRequiredPlanActionCardinalityBehavior

14.5.3 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPaths
patientreferenceThe identity of a patient to search for guidance response resultsGuidanceResponse.subject
(Patient)
subjectreferenceThe subject that the guidance response is aboutGuidanceResponse.subject
(Group, Patient)