GAO Ballot Package

This page is part of the FHIR Specification (v1.1.0: STU 3 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

This is a frozen snapshot of the FHIR specification created for the purpose of balloting the GAO implementation Guide. It includes draft changes that may be part of the future DSTU 2.1 release but further change is expected. Readers should focus solely on the GAO implementation content, and FHIR DSTU 2 for other purposes.

4.11 Resource DecisionSupportRule - Content

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

This resource defines a decision support rule of the form [on Event] if Condition then Action.

4.11.1 Scope and Usage

Todo

This resource is referenced by GuidanceRequest and GuidanceResponse

4.11.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DecisionSupportRule DomainResourceA decision support rule
... identifier Σ0..*IdentifierLogical identifier
... version Σ0..1stringThe version of the module, if any
... moduleMetadata 0..1Reference(ModuleMetadata)Module information for the rule
... library 0..*Reference(Library)A library containing logic used by the rule
... trigger 0..*BackboneElement
.... type 1..1codenamed-event | periodic | data-added | data-modified | data-removed | data-accessed | data-access-ended
DecisionSupportRuleTriggerType (Required)
.... eventName 0..1string
.... eventTiming[x] 0..1
..... eventTimingTimingTiming
..... eventTimingReferenceReference(Schedule)
..... eventTimingDatedate
..... eventTimingDateTimedateTime
... condition 0..1string
... action 0..*BackboneElement
.... actionIdentifier 0..1Identifier
.... number 0..1string
.... supportingEvidence 0..*Attachment
.... documentation 0..*Attachment
.... participantType 0..*codepatient | person | practitioner | related-person
DecisionSupportRuleParticipantType (Required)
.... title 0..1string
.... description 0..1string
.... textEquivalent 0..1string
.... concept 0..*CodeableConcept
.... type 0..1codecreate | update | remove | fire-event
DecisionSupportRuleActionType (Extensible)
.... resource 0..1Reference(Any)
.... customization 0..*BackboneElement
..... path 1..1string
..... expression 1..1string
.... actions 0..*see action

doco Documentation for this format

UML Diagram

DecisionSupportRule (DomainResource)A logical identifier for the module such as the CMS or NQF identifiers for a measure artifactidentifier : Identifier [0..*]The version of the module, if any. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge modules, refer to the Decision Support Service specificationversion : string [0..1]A reference to a ModuleMetadata resource that provides metadata for the rulemoduleMetadata : Reference [0..1] « ModuleMetadata »A reference to a Library containing the formal logic used by the rulelibrary : Reference [0..*] « Library »The condition for the artifactcondition : string [0..1]TriggerThe type of triggering eventtype : code [1..1] « The type of trigger (Strength=Required)DecisionSupportRuleTriggerType! »The name of the event (if this is a named-event trigger)eventName : string [0..1]The timing of the event (if this is a period trigger)eventTiming[x] : Type [0..1] « Timing|Reference(Schedule)|date| dateTime »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 type of participant in the actionparticipantType : code [0..*] « The type of participant for an action in the module (Strength=Required)DecisionSupportRuleParticipan...! »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=Extensible)DecisionSupportRuleActionType+ »The resource that is the target of the action (e.g. CommunicationRequest)resource : Reference [0..1] « Any »CustomizationThe path to the element to be customizedpath : string [1..1]An expression specifying the value of the customized elementexpression : string [1..1]A description of a triggering eventtrigger[0..*]Customizations that should be applied to the statically defined resourcecustomization[0..*]Sub actionsactions[0..*]The definition of the actions that should be returned by evaluation of the artifactaction[0..*]

XML Template

<DecisionSupportRule xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Logical identifier --></identifier>
 <version value="[string]"/><!-- 0..1 The version of the module, if any -->
 <moduleMetadata><!-- 0..1 Reference(ModuleMetadata) Module information for the rule --></moduleMetadata>
 <library><!-- 0..* Reference(Library) A library containing logic used by the rule --></library>
 <trigger>  <!-- 0..* -->
  <type value="[code]"/><!-- 1..1 named-event | periodic | data-added | data-modified | data-removed | data-accessed | data-access-ended -->
  <eventName value="[string]"/><!-- 0..1  -->
  <eventTiming[x]><!-- 0..1 Timing|Reference(Schedule)|date|dateTime  --></eventTiming[x]>
 </trigger>
 <condition value="[string]"/><!-- 0..1  -->
 <action>  <!-- 0..* -->
  <actionIdentifier><!-- 0..1 Identifier  --></actionIdentifier>
  <number value="[string]"/><!-- 0..1  -->
  <supportingEvidence><!-- 0..* Attachment  --></supportingEvidence>
  <documentation><!-- 0..* Attachment  --></documentation>
  <participantType value="[code]"/><!-- 0..* patient | person | practitioner | related-person -->
  <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>
  <customization>  <!-- 0..* -->
   <path value="[string]"/><!-- 1..1  -->
   <expression value="[string]"/><!-- 1..1  -->
  </customization>
  <actions><!-- 0..* Content as for DecisionSupportRule.action  --></actions>
 </action>
</DecisionSupportRule>

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DecisionSupportRule DomainResourceA decision support rule
... identifier Σ0..*IdentifierLogical identifier
... version Σ0..1stringThe version of the module, if any
... moduleMetadata 0..1Reference(ModuleMetadata)Module information for the rule
... library 0..*Reference(Library)A library containing logic used by the rule
... trigger 0..*BackboneElement
.... type 1..1codenamed-event | periodic | data-added | data-modified | data-removed | data-accessed | data-access-ended
DecisionSupportRuleTriggerType (Required)
.... eventName 0..1string
.... eventTiming[x] 0..1
..... eventTimingTimingTiming
..... eventTimingReferenceReference(Schedule)
..... eventTimingDatedate
..... eventTimingDateTimedateTime
... condition 0..1string
... action 0..*BackboneElement
.... actionIdentifier 0..1Identifier
.... number 0..1string
.... supportingEvidence 0..*Attachment
.... documentation 0..*Attachment
.... participantType 0..*codepatient | person | practitioner | related-person
DecisionSupportRuleParticipantType (Required)
.... title 0..1string
.... description 0..1string
.... textEquivalent 0..1string
.... concept 0..*CodeableConcept
.... type 0..1codecreate | update | remove | fire-event
DecisionSupportRuleActionType (Extensible)
.... resource 0..1Reference(Any)
.... customization 0..*BackboneElement
..... path 1..1string
..... expression 1..1string
.... actions 0..*see action

doco Documentation for this format

UML Diagram

DecisionSupportRule (DomainResource)A logical identifier for the module such as the CMS or NQF identifiers for a measure artifactidentifier : Identifier [0..*]The version of the module, if any. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge modules, refer to the Decision Support Service specificationversion : string [0..1]A reference to a ModuleMetadata resource that provides metadata for the rulemoduleMetadata : Reference [0..1] « ModuleMetadata »A reference to a Library containing the formal logic used by the rulelibrary : Reference [0..*] « Library »The condition for the artifactcondition : string [0..1]TriggerThe type of triggering eventtype : code [1..1] « The type of trigger (Strength=Required)DecisionSupportRuleTriggerType! »The name of the event (if this is a named-event trigger)eventName : string [0..1]The timing of the event (if this is a period trigger)eventTiming[x] : Type [0..1] « Timing|Reference(Schedule)|date| dateTime »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 type of participant in the actionparticipantType : code [0..*] « The type of participant for an action in the module (Strength=Required)DecisionSupportRuleParticipan...! »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=Extensible)DecisionSupportRuleActionType+ »The resource that is the target of the action (e.g. CommunicationRequest)resource : Reference [0..1] « Any »CustomizationThe path to the element to be customizedpath : string [1..1]An expression specifying the value of the customized elementexpression : string [1..1]A description of a triggering eventtrigger[0..*]Customizations that should be applied to the statically defined resourcecustomization[0..*]Sub actionsactions[0..*]The definition of the actions that should be returned by evaluation of the artifactaction[0..*]

XML Template

<DecisionSupportRule xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Logical identifier --></identifier>
 <version value="[string]"/><!-- 0..1 The version of the module, if any -->
 <moduleMetadata><!-- 0..1 Reference(ModuleMetadata) Module information for the rule --></moduleMetadata>
 <library><!-- 0..* Reference(Library) A library containing logic used by the rule --></library>
 <trigger>  <!-- 0..* -->
  <type value="[code]"/><!-- 1..1 named-event | periodic | data-added | data-modified | data-removed | data-accessed | data-access-ended -->
  <eventName value="[string]"/><!-- 0..1  -->
  <eventTiming[x]><!-- 0..1 Timing|Reference(Schedule)|date|dateTime  --></eventTiming[x]>
 </trigger>
 <condition value="[string]"/><!-- 0..1  -->
 <action>  <!-- 0..* -->
  <actionIdentifier><!-- 0..1 Identifier  --></actionIdentifier>
  <number value="[string]"/><!-- 0..1  -->
  <supportingEvidence><!-- 0..* Attachment  --></supportingEvidence>
  <documentation><!-- 0..* Attachment  --></documentation>
  <participantType value="[code]"/><!-- 0..* patient | person | practitioner | related-person -->
  <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>
  <customization>  <!-- 0..* -->
   <path value="[string]"/><!-- 1..1  -->
   <expression value="[string]"/><!-- 1..1  -->
  </customization>
  <actions><!-- 0..* Content as for DecisionSupportRule.action  --></actions>
 </action>
</DecisionSupportRule>

 

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

4.11.2.1 Terminology Bindings

PathDefinitionTypeReference
DecisionSupportRule.trigger.type The type of triggerRequiredDecisionSupportRuleTriggerType
DecisionSupportRule.action.participantType The type of participant for an action in the moduleRequiredDecisionSupportRuleParticipantType
DecisionSupportRule.action.type The type of action to be performedExtensibleDecisionSupportRuleActionType