STU3 Candidate

This page is part of the FHIR Specification (v1.8.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: R4B R4 R3

14.6 Resource RequestGroup - Content

Clinical Decision Support Work GroupMaturity Level: 0Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson

A group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".

14.6.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 RequestGroup resource is used to represent a group of optional activities that may be performed for a specific patient or context.

For a detailed discussion of how this resource is used in the evaluation process, refer to the Guidance Request topic in the Clinical Reasoning module.

This resource is referenced by guidanceresponse

14.6.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. RequestGroup DomainResourceA group of related requests
... identifier Σ0..1IdentifierBusiness identifier
... subject 0..1Reference(Patient | Group)Subject of the request group
... context 0..1Reference(Encounter | EpisodeOfCare)Encounter or Episode for the request group
... occurrenceDateTime 0..1dateTimeWhen the request group was authored
... author 0..1Reference(Device | Practitioner)Device or practitioner that authored the request group
... reason[x] 0..1Reason for the request group
.... reasonCodeableConceptCodeableConcept
.... reasonReferenceReference(Any)
... note 0..*AnnotationAdditional notes about the response
... action I0..*BackboneElementProposed actions, if any
Must have resource or action but not both
.... 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
.... code 0..*CodeableConceptThe meaning of the action or its sub-actions
.... documentation 0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... condition 0..*BackboneElementWhether or not the action is applicable
..... kind 1..1codeapplicability | start | stop
PlanActionConditionKind (Required)
..... description 0..1stringNatural language description of the condition
..... language 0..1stringLanguage of the expression
..... expression 0..1stringBoolean-valued expression
.... relatedAction 0..*BackboneElementRelationship to another action
..... actionIdentifier 1..1IdentifierIdentifier of the related action
..... relationship 1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
PlanActionRelationshipType (Required)
..... offset[x] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] 0..1When the action should take place
..... timingDateTimedateTime
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... 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 I0..1Reference(Any)The target of the action
.... action I0..*see actionSub action

doco Documentation for this format

UML Diagram (Legend)

RequestGroup (DomainResource)Allows a service to provide a unique, business identifier for the responseidentifier : Identifier [0..1]The subject for which the request group was createdsubject : Reference [0..1] « Patient|Group »Describes the context of the request group, if anycontext : Reference [0..1] « Encounter|EpisodeOfCare »Indicates when the request group was createdoccurrenceDateTime : dateTime [0..1]Provides a reference to the author of the request groupauthor : Reference [0..1] « Device|Practitioner »Indicates the reason the request group was created. 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..*]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-actionscode : 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 : RelatedArtifact [0..*]An optional value describing when the action should be performedtiming[x] : Type [0..1] « dateTime|Period|Duration|Range|Timing »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 »ConditionThe kind of conditionkind : code [1..1] « The kind of condition for the action (Strength=Required)PlanActionConditionKind! »A brief, natural language description of the condition that effectively communicates the intended semanticsdescription : string [0..1]The media type of the language for the expressionlanguage : string [0..1]An expression that returns true or false, indicating whether or not the condition is satisfiedexpression : string [0..1]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 expression that describes applicability criteria, or start/stop conditions for the actioncondition[0..*]A relationship to another action such as "before" or "30-60 minutes after start of"relatedAction[0..*]Sub actionsaction[0..*]The actions, if any, produced by the evaluation of the artifactaction[0..*]

XML Template

<RequestGroup xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier Business identifier --></identifier>
 <subject><!-- 0..1 Reference(Patient|Group) Subject of the request group --></subject>
 <context><!-- 0..1 Reference(Encounter|EpisodeOfCare) Encounter or Episode for the request group --></context>
 <occurrenceDateTime value="[dateTime]"/><!-- 0..1 When the request group was authored -->
 <author><!-- 0..1 Reference(Device|Practitioner) Device or practitioner that authored the request group --></author>
 <reason[x]><!-- 0..1 CodeableConcept|Reference(Any) Reason for the request group --></reason[x]>
 <note><!-- 0..* Annotation Additional notes about the response --></note>
 <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 -->
  <code><!-- 0..* CodeableConcept The meaning of the action or its sub-actions --></code>
  <documentation><!-- 0..* RelatedArtifact Supporting documentation for the intended performer of the action --></documentation>
  <condition>  <!-- 0..* Whether or not the action is applicable -->
   <kind value="[code]"/><!-- 1..1 applicability | start | stop -->
   <description value="[string]"/><!-- 0..1 Natural language description of the condition -->
   <language value="[string]"/><!-- 0..1 Language of the expression -->
   <expression value="[string]"/><!-- 0..1 Boolean-valued expression -->
  </condition>
  <relatedAction>  <!-- 0..* Relationship to another action -->
   <actionIdentifier><!-- 1..1 Identifier Identifier of the related action --></actionIdentifier>
   <relationship value="[code]"/><!-- 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end -->
   <offset[x]><!-- 0..1 Duration|Range Time offset for the relationship --></offset[x]>
  </relatedAction>
  <timing[x]><!-- 0..1 dateTime|Period|Duration|Range|Timing 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 RequestGroup.action Sub action --></action>
 </action>
</RequestGroup>

JSON Template

{doco
  "resourceType" : "RequestGroup",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // Business identifier
  "subject" : { Reference(Patient|Group) }, // Subject of the request group
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or Episode for the request group
  "occurrenceDateTime" : "<dateTime>", // When the request group was authored
  "author" : { Reference(Device|Practitioner) }, // Device or practitioner that authored the request group
  // reason[x]: Reason for the request group. One of these 2:
  "reasonCodeableConcept" : { CodeableConcept },
  "reasonReference" : { Reference(Any) },
  "note" : [{ Annotation }], // Additional notes about the response
  "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
    "code" : [{ CodeableConcept }], // The meaning of the action or its sub-actions
    "documentation" : [{ RelatedArtifact }], // Supporting documentation for the intended performer of the action
    "condition" : [{ // Whether or not the action is applicable
      "kind" : "<code>", // R!  applicability | start | stop
      "description" : "<string>", // Natural language description of the condition
      "language" : "<string>", // Language of the expression
      "expression" : "<string>" // Boolean-valued expression
    }],
    "relatedAction" : [{ // Relationship to another action
      "actionIdentifier" : { Identifier }, // R!  Identifier of the related action
      "relationship" : "<code>", // R!  before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
      // offset[x]: Time offset for the relationship. One of these 2:
      "offsetDuration" : { Duration }
      "offsetRange" : { Range }
    }],
    // timing[x]: When the action should take place. One of these 5:
    "timingDateTime" : "<dateTime>",
    "timingPeriod" : { Period },
    "timingDuration" : { Duration },
    "timingRange" : { Range },
    "timingTiming" : { Timing },
    "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) }, // C? The target of the action
    "action" : [{ Content as for RequestGroup.action }] // C? Sub action
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:RequestGroup;
  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:RequestGroup.identifier [ Identifier ]; # 0..1 Business identifier
  fhir:RequestGroup.subject [ Reference(Patient|Group) ]; # 0..1 Subject of the request group
  fhir:RequestGroup.context [ Reference(Encounter|EpisodeOfCare) ]; # 0..1 Encounter or Episode for the request group
  fhir:RequestGroup.occurrenceDateTime [ dateTime ]; # 0..1 When the request group was authored
  fhir:RequestGroup.author [ Reference(Device|Practitioner) ]; # 0..1 Device or practitioner that authored the request group
  # RequestGroup.reason[x] : 0..1 Reason for the request group. One of these 2
    fhir:RequestGroup.reasonCodeableConcept [ CodeableConcept ]
    fhir:RequestGroup.reasonReference [ Reference(Any) ]
  fhir:RequestGroup.note [ Annotation ], ... ; # 0..* Additional notes about the response
  fhir:RequestGroup.action [ # 0..* Proposed actions, if any
    fhir:RequestGroup.action.actionIdentifier [ Identifier ]; # 0..1 Unique identifier
    fhir:RequestGroup.action.label [ string ]; # 0..1 User-visible label for the action (e.g. 1. or A.)
    fhir:RequestGroup.action.title [ string ]; # 0..1 User-visible title
    fhir:RequestGroup.action.description [ string ]; # 0..1 Short description of the action
    fhir:RequestGroup.action.textEquivalent [ string ]; # 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    fhir:RequestGroup.action.code [ CodeableConcept ], ... ; # 0..* The meaning of the action or its sub-actions
    fhir:RequestGroup.action.documentation [ RelatedArtifact ], ... ; # 0..* Supporting documentation for the intended performer of the action
    fhir:RequestGroup.action.condition [ # 0..* Whether or not the action is applicable
      fhir:RequestGroup.action.condition.kind [ code ]; # 1..1 applicability | start | stop
      fhir:RequestGroup.action.condition.description [ string ]; # 0..1 Natural language description of the condition
      fhir:RequestGroup.action.condition.language [ string ]; # 0..1 Language of the expression
      fhir:RequestGroup.action.condition.expression [ string ]; # 0..1 Boolean-valued expression
    ], ...;
    fhir:RequestGroup.action.relatedAction [ # 0..* Relationship to another action
      fhir:RequestGroup.action.relatedAction.actionIdentifier [ Identifier ]; # 1..1 Identifier of the related action
      fhir:RequestGroup.action.relatedAction.relationship [ code ]; # 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
      # RequestGroup.action.relatedAction.offset[x] : 0..1 Time offset for the relationship. One of these 2
        fhir:RequestGroup.action.relatedAction.offsetDuration [ Duration ]
        fhir:RequestGroup.action.relatedAction.offsetRange [ Range ]
    ], ...;
    # RequestGroup.action.timing[x] : 0..1 When the action should take place. One of these 5
      fhir:RequestGroup.action.timingDateTime [ dateTime ]
      fhir:RequestGroup.action.timingPeriod [ Period ]
      fhir:RequestGroup.action.timingDuration [ Duration ]
      fhir:RequestGroup.action.timingRange [ Range ]
      fhir:RequestGroup.action.timingTiming [ Timing ]
    fhir:RequestGroup.action.participant [ Reference(Patient|Person|Practitioner|RelatedPerson) ], ... ; # 0..* Participant
    fhir:RequestGroup.action.type [ Coding ]; # 0..1 create | update | remove | fire-event
    fhir:RequestGroup.action.groupingBehavior [ code ]; # 0..1 visual-group | logical-group | sentence-group
    fhir:RequestGroup.action.selectionBehavior [ code ]; # 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more
    fhir:RequestGroup.action.requiredBehavior [ code ]; # 0..1 must | could | must-unless-documented
    fhir:RequestGroup.action.precheckBehavior [ code ]; # 0..1 yes | no
    fhir:RequestGroup.action.cardinalityBehavior [ code ]; # 0..1 single | multiple
    fhir:RequestGroup.action.resource [ Reference(Any) ]; # 0..1 The target of the action
    fhir:RequestGroup.action.action [ See RequestGroup.action ], ... ; # 0..* Sub action
  ], ...;
]

Changes since DSTU2

This resource did not exist in Release 2

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. RequestGroup DomainResourceA group of related requests
... identifier Σ0..1IdentifierBusiness identifier
... subject 0..1Reference(Patient | Group)Subject of the request group
... context 0..1Reference(Encounter | EpisodeOfCare)Encounter or Episode for the request group
... occurrenceDateTime 0..1dateTimeWhen the request group was authored
... author 0..1Reference(Device | Practitioner)Device or practitioner that authored the request group
... reason[x] 0..1Reason for the request group
.... reasonCodeableConceptCodeableConcept
.... reasonReferenceReference(Any)
... note 0..*AnnotationAdditional notes about the response
... action I0..*BackboneElementProposed actions, if any
Must have resource or action but not both
.... 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
.... code 0..*CodeableConceptThe meaning of the action or its sub-actions
.... documentation 0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... condition 0..*BackboneElementWhether or not the action is applicable
..... kind 1..1codeapplicability | start | stop
PlanActionConditionKind (Required)
..... description 0..1stringNatural language description of the condition
..... language 0..1stringLanguage of the expression
..... expression 0..1stringBoolean-valued expression
.... relatedAction 0..*BackboneElementRelationship to another action
..... actionIdentifier 1..1IdentifierIdentifier of the related action
..... relationship 1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
PlanActionRelationshipType (Required)
..... offset[x] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] 0..1When the action should take place
..... timingDateTimedateTime
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... 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 I0..1Reference(Any)The target of the action
.... action I0..*see actionSub action

doco Documentation for this format

UML Diagram (Legend)

RequestGroup (DomainResource)Allows a service to provide a unique, business identifier for the responseidentifier : Identifier [0..1]The subject for which the request group was createdsubject : Reference [0..1] « Patient|Group »Describes the context of the request group, if anycontext : Reference [0..1] « Encounter|EpisodeOfCare »Indicates when the request group was createdoccurrenceDateTime : dateTime [0..1]Provides a reference to the author of the request groupauthor : Reference [0..1] « Device|Practitioner »Indicates the reason the request group was created. 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..*]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-actionscode : 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 : RelatedArtifact [0..*]An optional value describing when the action should be performedtiming[x] : Type [0..1] « dateTime|Period|Duration|Range|Timing »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 »ConditionThe kind of conditionkind : code [1..1] « The kind of condition for the action (Strength=Required)PlanActionConditionKind! »A brief, natural language description of the condition that effectively communicates the intended semanticsdescription : string [0..1]The media type of the language for the expressionlanguage : string [0..1]An expression that returns true or false, indicating whether or not the condition is satisfiedexpression : string [0..1]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 expression that describes applicability criteria, or start/stop conditions for the actioncondition[0..*]A relationship to another action such as "before" or "30-60 minutes after start of"relatedAction[0..*]Sub actionsaction[0..*]The actions, if any, produced by the evaluation of the artifactaction[0..*]

XML Template

<RequestGroup xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier Business identifier --></identifier>
 <subject><!-- 0..1 Reference(Patient|Group) Subject of the request group --></subject>
 <context><!-- 0..1 Reference(Encounter|EpisodeOfCare) Encounter or Episode for the request group --></context>
 <occurrenceDateTime value="[dateTime]"/><!-- 0..1 When the request group was authored -->
 <author><!-- 0..1 Reference(Device|Practitioner) Device or practitioner that authored the request group --></author>
 <reason[x]><!-- 0..1 CodeableConcept|Reference(Any) Reason for the request group --></reason[x]>
 <note><!-- 0..* Annotation Additional notes about the response --></note>
 <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 -->
  <code><!-- 0..* CodeableConcept The meaning of the action or its sub-actions --></code>
  <documentation><!-- 0..* RelatedArtifact Supporting documentation for the intended performer of the action --></documentation>
  <condition>  <!-- 0..* Whether or not the action is applicable -->
   <kind value="[code]"/><!-- 1..1 applicability | start | stop -->
   <description value="[string]"/><!-- 0..1 Natural language description of the condition -->
   <language value="[string]"/><!-- 0..1 Language of the expression -->
   <expression value="[string]"/><!-- 0..1 Boolean-valued expression -->
  </condition>
  <relatedAction>  <!-- 0..* Relationship to another action -->
   <actionIdentifier><!-- 1..1 Identifier Identifier of the related action --></actionIdentifier>
   <relationship value="[code]"/><!-- 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end -->
   <offset[x]><!-- 0..1 Duration|Range Time offset for the relationship --></offset[x]>
  </relatedAction>
  <timing[x]><!-- 0..1 dateTime|Period|Duration|Range|Timing 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 RequestGroup.action Sub action --></action>
 </action>
</RequestGroup>

JSON Template

{doco
  "resourceType" : "RequestGroup",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // Business identifier
  "subject" : { Reference(Patient|Group) }, // Subject of the request group
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or Episode for the request group
  "occurrenceDateTime" : "<dateTime>", // When the request group was authored
  "author" : { Reference(Device|Practitioner) }, // Device or practitioner that authored the request group
  // reason[x]: Reason for the request group. One of these 2:
  "reasonCodeableConcept" : { CodeableConcept },
  "reasonReference" : { Reference(Any) },
  "note" : [{ Annotation }], // Additional notes about the response
  "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
    "code" : [{ CodeableConcept }], // The meaning of the action or its sub-actions
    "documentation" : [{ RelatedArtifact }], // Supporting documentation for the intended performer of the action
    "condition" : [{ // Whether or not the action is applicable
      "kind" : "<code>", // R!  applicability | start | stop
      "description" : "<string>", // Natural language description of the condition
      "language" : "<string>", // Language of the expression
      "expression" : "<string>" // Boolean-valued expression
    }],
    "relatedAction" : [{ // Relationship to another action
      "actionIdentifier" : { Identifier }, // R!  Identifier of the related action
      "relationship" : "<code>", // R!  before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
      // offset[x]: Time offset for the relationship. One of these 2:
      "offsetDuration" : { Duration }
      "offsetRange" : { Range }
    }],
    // timing[x]: When the action should take place. One of these 5:
    "timingDateTime" : "<dateTime>",
    "timingPeriod" : { Period },
    "timingDuration" : { Duration },
    "timingRange" : { Range },
    "timingTiming" : { Timing },
    "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) }, // C? The target of the action
    "action" : [{ Content as for RequestGroup.action }] // C? Sub action
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:RequestGroup;
  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:RequestGroup.identifier [ Identifier ]; # 0..1 Business identifier
  fhir:RequestGroup.subject [ Reference(Patient|Group) ]; # 0..1 Subject of the request group
  fhir:RequestGroup.context [ Reference(Encounter|EpisodeOfCare) ]; # 0..1 Encounter or Episode for the request group
  fhir:RequestGroup.occurrenceDateTime [ dateTime ]; # 0..1 When the request group was authored
  fhir:RequestGroup.author [ Reference(Device|Practitioner) ]; # 0..1 Device or practitioner that authored the request group
  # RequestGroup.reason[x] : 0..1 Reason for the request group. One of these 2
    fhir:RequestGroup.reasonCodeableConcept [ CodeableConcept ]
    fhir:RequestGroup.reasonReference [ Reference(Any) ]
  fhir:RequestGroup.note [ Annotation ], ... ; # 0..* Additional notes about the response
  fhir:RequestGroup.action [ # 0..* Proposed actions, if any
    fhir:RequestGroup.action.actionIdentifier [ Identifier ]; # 0..1 Unique identifier
    fhir:RequestGroup.action.label [ string ]; # 0..1 User-visible label for the action (e.g. 1. or A.)
    fhir:RequestGroup.action.title [ string ]; # 0..1 User-visible title
    fhir:RequestGroup.action.description [ string ]; # 0..1 Short description of the action
    fhir:RequestGroup.action.textEquivalent [ string ]; # 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    fhir:RequestGroup.action.code [ CodeableConcept ], ... ; # 0..* The meaning of the action or its sub-actions
    fhir:RequestGroup.action.documentation [ RelatedArtifact ], ... ; # 0..* Supporting documentation for the intended performer of the action
    fhir:RequestGroup.action.condition [ # 0..* Whether or not the action is applicable
      fhir:RequestGroup.action.condition.kind [ code ]; # 1..1 applicability | start | stop
      fhir:RequestGroup.action.condition.description [ string ]; # 0..1 Natural language description of the condition
      fhir:RequestGroup.action.condition.language [ string ]; # 0..1 Language of the expression
      fhir:RequestGroup.action.condition.expression [ string ]; # 0..1 Boolean-valued expression
    ], ...;
    fhir:RequestGroup.action.relatedAction [ # 0..* Relationship to another action
      fhir:RequestGroup.action.relatedAction.actionIdentifier [ Identifier ]; # 1..1 Identifier of the related action
      fhir:RequestGroup.action.relatedAction.relationship [ code ]; # 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
      # RequestGroup.action.relatedAction.offset[x] : 0..1 Time offset for the relationship. One of these 2
        fhir:RequestGroup.action.relatedAction.offsetDuration [ Duration ]
        fhir:RequestGroup.action.relatedAction.offsetRange [ Range ]
    ], ...;
    # RequestGroup.action.timing[x] : 0..1 When the action should take place. One of these 5
      fhir:RequestGroup.action.timingDateTime [ dateTime ]
      fhir:RequestGroup.action.timingPeriod [ Period ]
      fhir:RequestGroup.action.timingDuration [ Duration ]
      fhir:RequestGroup.action.timingRange [ Range ]
      fhir:RequestGroup.action.timingTiming [ Timing ]
    fhir:RequestGroup.action.participant [ Reference(Patient|Person|Practitioner|RelatedPerson) ], ... ; # 0..* Participant
    fhir:RequestGroup.action.type [ Coding ]; # 0..1 create | update | remove | fire-event
    fhir:RequestGroup.action.groupingBehavior [ code ]; # 0..1 visual-group | logical-group | sentence-group
    fhir:RequestGroup.action.selectionBehavior [ code ]; # 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more
    fhir:RequestGroup.action.requiredBehavior [ code ]; # 0..1 must | could | must-unless-documented
    fhir:RequestGroup.action.precheckBehavior [ code ]; # 0..1 yes | no
    fhir:RequestGroup.action.cardinalityBehavior [ code ]; # 0..1 single | multiple
    fhir:RequestGroup.action.resource [ Reference(Any) ]; # 0..1 The target of the action
    fhir:RequestGroup.action.action [ See RequestGroup.action ], ... ; # 0..* Sub action
  ], ...;
]

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), JSON-LD (for RDF as JSON-LD),

14.6.2.1 Terminology Bindings

PathDefinitionTypeReference
RequestGroup.action.condition.kind The kind of condition for the actionRequiredPlanActionConditionKind
RequestGroup.action.relatedAction.relationship Defines the types of relationships between actionsRequiredPlanActionRelationshipType
RequestGroup.action.type The type of action to be performedExtensiblePlanActionType
RequestGroup.action.groupingBehavior Defines organization behavior of a groupRequiredPlanActionGroupingBehavior
RequestGroup.action.selectionBehavior Defines selection behavior of a groupRequiredPlanActionSelectionBehavior
RequestGroup.action.requiredBehavior Defines requiredness behavior for selecting an action or an action groupRequiredPlanActionRequiredBehavior
RequestGroup.action.precheckBehavior Defines selection frequency behavior for an action or groupRequiredPlanActionPrecheckBehavior
RequestGroup.action.cardinalityBehavior Defines behavior for an action or a group for how many times that item may be repeatedRequiredPlanActionCardinalityBehavior

14.6.2.2 Constraints

  • rqg-1: On RequestGroup.action: Must have resource or action but not both (expression on RequestGroup.action: resource.exists() != action.exists())

14.6.3 Usage

The RequestGroup resource is used when there are temporal, co-occurrence or other dependencies between one or more steps of an overall workflow. For example, "do procedure A or procedure B, but not both" or "do procedure A after procedure B" or "Act on this DiagnosticRequest, then use the value of that observation in the calculation of the dose of this subsequent MedicationRequest". RequestGroups that define actions (i.e. that are more than just narrative representations) will always reference other Request resources with an intent of "option".

Each "option" request can only be interpreted in the context of a RequestGroup that references it. This is because the RequestGroup defines the context in which the option request may/should/must occur, including any triggers, timing constraints, choices, sequencing requirements, etc. Typically such "option" requests will be contained resources due to this dependency. However, in some cases "option" requests may be stand-alone if they are immutable or tightly tied to a ActivityDefinition such that the option resources can safely be referenced without a risk of their content/intent changing

Elements in the "option" requests may include extensions for timing or other elements that allow calculation based on information found in the RequestGroup or other referenced "option" resources, as well as to expose elements within the "option" resource for referencing in other "option" resources. These extensions are:

  • TODO

The RequestGroup and all of its referenced "option" Requests are treated as a single integrated Request whose status is the status of the RequestGroup. If there is a need to manage statuses of the different parts, separately, refer to the guidance here.

14.6.4 Search Parameters

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

NameTypeDescriptionPathsIn Common
authorreferenceThe author of the request groupRequestGroup.author
(Practitioner, Device)
contextreferenceThe context the request group applies toRequestGroup.context
(EpisodeOfCare, Encounter)
encounterreferenceThe encounter the request group applies toRequestGroup.context
(Encounter)
participantreferenceThe participant in the requests in the groupRequestGroup.action.participant
(Practitioner, Patient, Person, RelatedPerson)
patientreferenceThe identity of a patient to search for request groupsRequestGroup.subject
(Patient)
subjectreferenceThe subject that the request group is aboutRequestGroup.subject
(Group, Patient)