Release 5 Preview #2

This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). 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.18 Resource RequestGroup - Content

Clinical Decision Support Work GroupMaturity Level: 2 Trial UseSecurity Category: Business Compartments: 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.18.1 Scope and Usage

This resource is a request resource from a FHIR workflow perspective - see Workflow, specifically Request.

The RequestGroup resource is used to represent a group of optional activities that may be performed for a specific patient or context. This resource is often, but not always, the result of applying a specific PlanDefinition to a particular patient. Other than differences that tie the RequestGroup to a particular subject and setting, the actionDefinition element of PlanDefinition is identical to the action element of the RequestGroup, allowing the same features and functionality to be used in both places to describe optionality of and relationships between activities in a workflow.

RequestGroups can contain hierarchical groups of actions, where each specific action references the action to be performed (in terms of a Request resource), and each group describes additional behavior, relationships, and applicable conditions between the actions in the overall group.

14.18.2 References

This resource is referenced by CarePlan and GuidanceResponse.

This resource implements the Request pattern.

14.18.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. RequestGroup TUDomainResourceA group of related requests
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierBusiness identifier
... instantiatesCanonical Σ0..*canonical()Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... replaces 0..*Reference(Any)Request(s) replaced by this request
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
RequestStatus (Required)
... intent ?!Σ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
RequestIntent (Required)
... priority Σ0..1coderoutine | urgent | asap | stat
Request priority (Required)
... code Σ0..1CodeableConceptWhat's being requested/ordered
... subject 0..1Reference(Patient | Group)Who the request group is about
... encounter 0..1Reference(Encounter)Created as part of
... authoredOn 0..1dateTimeWhen the request group was authored
... author 0..1Reference(Device | Practitioner | PractitionerRole)Device or practitioner that authored the request group
... reason 0..*CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference)Why the request group is needed
... note 0..*AnnotationAdditional notes about the response
... action I0..*BackboneElementProposed actions, if any
+ Rule: Must have resource or action but not both
.... prefix 0..1stringUser-visible prefix 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
.... priority 0..1coderoutine | urgent | asap | stat
Request priority (Required)
.... code 0..*CodeableConceptCode representing the meaning of the action or 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
ActionConditionKind (Required)
..... expression 0..1ExpressionBoolean-valued expression
.... relatedAction 0..*BackboneElementRelationship to another action
..... actionId 1..1idWhat action this is related to
..... relationship 1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
ActionRelationshipType (Required)
..... offset[x] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] 0..1When the action should take place
..... timingDateTimedateTime
..... timingAgeAge
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... participant 0..*Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device)Who should perform the action
.... type 0..1CodeableConceptcreate | update | remove | fire-event
ActionType (Extensible)
.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
ActionGroupingBehavior (Required)
.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
ActionSelectionBehavior (Required)
.... requiredBehavior 0..1codemust | could | must-unless-documented
ActionRequiredBehavior (Required)
.... precheckBehavior 0..1codeyes | no
ActionPrecheckBehavior (Required)
.... cardinalityBehavior 0..1codesingle | multiple
ActionCardinalityBehavior (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 requestidentifier : Identifier [0..*]A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this requestinstantiatesCanonical : canonical [0..*] « »A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this requestinstantiatesUri : uri [0..*]A plan, proposal or order that is fulfilled in whole or in part by this requestbasedOn : Reference [0..*] « Any »Completed or terminated request(s) whose function is taken by this new requestreplaces : Reference [0..*] « Any »A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar formgroupIdentifier : Identifier [0..1]The current state of the request. For request groups, the status reflects the status of all the requests in the group (this element modifies the meaning of other elements)status : code [1..1] « Codes identifying the lifecycle stage of a request. (Strength=Required)RequestStatus! »Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain (this element modifies the meaning of other elements)intent : code [1..1] « Codes indicating the degree of authority/intentionality associated with a request. (Strength=Required)RequestIntent! »Indicates how quickly the request should be addressed with respect to other requestspriority : code [0..1] « Identifies the level of importance to be assigned to actioning the request. (Strength=Required)RequestPriority! »A code that identifies what the overall request group iscode : CodeableConcept [0..1]The subject for which the request group was createdsubject : Reference [0..1] « Patient|Group »Describes the context of the request group, if anyencounter : Reference [0..1] « Encounter »Indicates when the request group was createdauthoredOn : dateTime [0..1]Provides a reference to the author of the request groupauthor : Reference [0..1] « Device|Practitioner|PractitionerRole »Describes the reason for the request group in coded or textual formreason : DataType [0..*] « Condition|Observation|DiagnosticReport| DocumentReference »Provides a mechanism to communicate additional information about the responsenote : Annotation [0..*]ActionA user-visible prefix for the actionprefix : 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 might not be capable of interpreting it dynamicallytextEquivalent : string [0..1]Indicates how quickly the action should be addressed with respect to other actionspriority : code [0..1] « Identifies the level of importance to be assigned to actioning the request. (Strength=Required)RequestPriority! »A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation templatecode : 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] : DataType [0..1] « dateTime|Age|Period|Duration|Range| Timing »The participant that should perform or be responsible for this actionparticipant : Reference [0..*] « Patient|Practitioner| PractitionerRole|RelatedPerson|Device »The type of action to perform (create, update, remove)type : CodeableConcept [0..1] « The type of action to be performed. (Strength=Extensible)ActionType+ »Defines the grouping behavior for the action and its childrengroupingBehavior : code [0..1] « Defines organization behavior of a group. (Strength=Required)ActionGroupingBehavior! »Defines the selection behavior for the action and its childrenselectionBehavior : code [0..1] « Defines selection behavior of a group. (Strength=Required)ActionSelectionBehavior! »Defines expectations around whether an action is requiredrequiredBehavior : code [0..1] « Defines expectations around whether an action or action group is required. (Strength=Required)ActionRequiredBehavior! »Defines whether the action should usually be preselectedprecheckBehavior : code [0..1] « Defines selection frequency behavior for an action or group. (Strength=Required)ActionPrecheckBehavior! »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)ActionCardinalityBehavior! »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)ActionConditionKind! »An expression that returns true or false, indicating whether or not the condition is satisfiedexpression : Expression [0..1]RelatedActionThe element id of the action this is related toactionId : id [1..1]The relationship of this action to the related actionrelationship : code [1..1] « Defines the types of relationships between actions. (Strength=Required)ActionRelationshipType! »A duration or range of durations to apply to the relationship. For example, 30-60 minutes beforeoffset[x] : DataType [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..* Identifier Business identifier --></identifier>
 <instantiatesCanonical value="[canonical]"/><!-- 0..* Instantiates FHIR protocol or definition -->
 <instantiatesUri value="[uri]"/><!-- 0..* Instantiates external protocol or definition -->
 <basedOn><!-- 0..* Reference(Any) Fulfills plan, proposal, or order --></basedOn>
 <replaces><!-- 0..* Reference(Any) Request(s) replaced by this request --></replaces>
 <groupIdentifier><!-- 0..1 Identifier Composite request this is part of --></groupIdentifier>
 <status value="[code]"/><!-- 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown -->
 <intent value="[code]"/><!-- 1..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option -->
 <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
 <code><!-- 0..1 CodeableConcept What's being requested/ordered --></code>
 <subject><!-- 0..1 Reference(Group|Patient) Who the request group is about --></subject>
 <encounter><!-- 0..1 Reference(Encounter) Created as part of --></encounter>
 <authoredOn value="[dateTime]"/><!-- 0..1 When the request group was authored -->
 <author><!-- 0..1 Reference(Device|Practitioner|PractitionerRole) Device or practitioner that authored the request group --></author>
 <reason><!-- 0..* CodeableReference(Condition|DiagnosticReport|DocumentReference|
   Observation) Why the request group is needed --></reason>
 <note><!-- 0..* Annotation Additional notes about the response --></note>
 <action>  <!-- 0..* Proposed actions, if any -->
  <prefix value="[string]"/><!-- 0..1 User-visible prefix 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 -->
  <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
  <code><!-- 0..* CodeableConcept Code representing the meaning of the action or 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 -->
   <expression><!-- 0..1 Expression Boolean-valued expression --></expression>
  </condition>
  <relatedAction>  <!-- 0..* Relationship to another action -->
   <actionId value="[id]"/><!-- 1..1 What action this is related to -->
   <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|Age|Period|Duration|Range|Timing When the action should take place --></timing[x]>
  <participant><!-- 0..* Reference(Device|Patient|Practitioner|PractitionerRole|
    RelatedPerson) Who should perform the action --></participant>
  <type><!-- 0..1 CodeableConcept 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
  "instantiatesCanonical" : ["<canonical>"], // Instantiates FHIR protocol or definition
  "instantiatesUri" : ["<uri>"], // Instantiates external protocol or definition
  "basedOn" : [{ Reference(Any) }], // Fulfills plan, proposal, or order
  "replaces" : [{ Reference(Any) }], // Request(s) replaced by this request
  "groupIdentifier" : { Identifier }, // Composite request this is part of
  "status" : "<code>", // R!  draft | active | on-hold | revoked | completed | entered-in-error | unknown
  "intent" : "<code>", // R!  proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
  "priority" : "<code>", // routine | urgent | asap | stat
  "code" : { CodeableConcept }, // What's being requested/ordered
  "subject" : { Reference(Group|Patient) }, // Who the request group is about
  "encounter" : { Reference(Encounter) }, // Created as part of
  "authoredOn" : "<dateTime>", // When the request group was authored
  "author" : { Reference(Device|Practitioner|PractitionerRole) }, // Device or practitioner that authored the request group
  "reason" : [{ CodeableReference(Condition|DiagnosticReport|DocumentReference|
   Observation) }], // Why the request group is needed
  "note" : [{ Annotation }], // Additional notes about the response
  "action" : [{ // Proposed actions, if any
    "prefix" : "<string>", // User-visible prefix 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
    "priority" : "<code>", // routine | urgent | asap | stat
    "code" : [{ CodeableConcept }], // Code representing the meaning of the action or 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
      "expression" : { Expression } // Boolean-valued expression
    }],
    "relatedAction" : [{ // Relationship to another action
      "actionId" : "<id>", // R!  What action this is related to
      "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 6:
    "timingDateTime" : "<dateTime>",
    "timingAge" : { Age },
    "timingPeriod" : { Period },
    "timingDuration" : { Duration },
    "timingRange" : { Range },
    "timingTiming" : { Timing },
    "participant" : [{ Reference(Device|Patient|Practitioner|PractitionerRole|
    RelatedPerson) }], // Who should perform the action
    "type" : { CodeableConcept }, // 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..* Business identifier
  fhir:RequestGroup.instantiatesCanonical [ canonical ], ... ; # 0..* Instantiates FHIR protocol or definition
  fhir:RequestGroup.instantiatesUri [ uri ], ... ; # 0..* Instantiates external protocol or definition
  fhir:RequestGroup.basedOn [ Reference(Any) ], ... ; # 0..* Fulfills plan, proposal, or order
  fhir:RequestGroup.replaces [ Reference(Any) ], ... ; # 0..* Request(s) replaced by this request
  fhir:RequestGroup.groupIdentifier [ Identifier ]; # 0..1 Composite request this is part of
  fhir:RequestGroup.status [ code ]; # 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown
  fhir:RequestGroup.intent [ code ]; # 1..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
  fhir:RequestGroup.priority [ code ]; # 0..1 routine | urgent | asap | stat
  fhir:RequestGroup.code [ CodeableConcept ]; # 0..1 What's being requested/ordered
  fhir:RequestGroup.subject [ Reference(Group|Patient) ]; # 0..1 Who the request group is about
  fhir:RequestGroup.encounter [ Reference(Encounter) ]; # 0..1 Created as part of
  fhir:RequestGroup.authoredOn [ dateTime ]; # 0..1 When the request group was authored
  fhir:RequestGroup.author [ Reference(Device|Practitioner|PractitionerRole) ]; # 0..1 Device or practitioner that authored the request group
  fhir:RequestGroup.reason [ CodeableReference(Condition|DiagnosticReport|DocumentReference|Observation) ], ... ; # 0..* Why the request group is needed
  fhir:RequestGroup.note [ Annotation ], ... ; # 0..* Additional notes about the response
  fhir:RequestGroup.action [ # 0..* Proposed actions, if any
    fhir:RequestGroup.action.prefix [ string ]; # 0..1 User-visible prefix 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.priority [ code ]; # 0..1 routine | urgent | asap | stat
    fhir:RequestGroup.action.code [ CodeableConcept ], ... ; # 0..* Code representing the meaning of the action or 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.expression [ Expression ]; # 0..1 Boolean-valued expression
    ], ...;
    fhir:RequestGroup.action.relatedAction [ # 0..* Relationship to another action
      fhir:RequestGroup.action.relatedAction.actionId [ id ]; # 1..1 What action this is related to
      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 6
      fhir:RequestGroup.action.timingDateTime [ dateTime ]
      fhir:RequestGroup.action.timingAge [ Age ]
      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(Device|Patient|Practitioner|PractitionerRole|RelatedPerson) ], ... ; # 0..* Who should perform the action
    fhir:RequestGroup.action.type [ CodeableConcept ]; # 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 R3

RequestGroup
RequestGroup.status
  • Change value set from http://hl7.org/fhir/ValueSet/request-status|4.0.0 to http://hl7.org/fhir/ValueSet/request-status|4.4.0
RequestGroup.intent
  • Change value set from http://hl7.org/fhir/ValueSet/request-intent|4.0.0 to http://hl7.org/fhir/ValueSet/request-intent|4.4.0
RequestGroup.priority
  • Change value set from http://hl7.org/fhir/ValueSet/request-priority|4.0.0 to http://hl7.org/fhir/ValueSet/request-priority|4.4.0
RequestGroup.reason
  • Added Element
RequestGroup.action.priority
  • Change value set from http://hl7.org/fhir/ValueSet/request-priority|4.0.0 to http://hl7.org/fhir/ValueSet/request-priority|4.4.0
RequestGroup.action.condition.kind
  • Change value set from http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.0 to http://hl7.org/fhir/ValueSet/action-condition-kind|4.4.0
RequestGroup.action.relatedAction.relationship
  • Change value set from http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.0 to http://hl7.org/fhir/ValueSet/action-relationship-type|4.4.0
RequestGroup.action.groupingBehavior
  • Change value set from http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.0 to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.4.0
RequestGroup.action.selectionBehavior
  • Change value set from http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.0 to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.4.0
RequestGroup.action.requiredBehavior
  • Change value set from http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.0 to http://hl7.org/fhir/ValueSet/action-required-behavior|4.4.0
RequestGroup.action.precheckBehavior
  • Change value set from http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.0 to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.4.0
RequestGroup.action.cardinalityBehavior
  • Change value set from http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.0 to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.4.0
RequestGroup.reasonCode
  • deleted
RequestGroup.reasonReference
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 2 tests that all execute ok. All tests pass round-trip testing and 2 r3 resources are invalid (0 errors).)

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. RequestGroup TUDomainResourceA group of related requests
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierBusiness identifier
... instantiatesCanonical Σ0..*canonical()Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... replaces 0..*Reference(Any)Request(s) replaced by this request
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
RequestStatus (Required)
... intent ?!Σ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
RequestIntent (Required)
... priority Σ0..1coderoutine | urgent | asap | stat
Request priority (Required)
... code Σ0..1CodeableConceptWhat's being requested/ordered
... subject 0..1Reference(Patient | Group)Who the request group is about
... encounter 0..1Reference(Encounter)Created as part of
... authoredOn 0..1dateTimeWhen the request group was authored
... author 0..1Reference(Device | Practitioner | PractitionerRole)Device or practitioner that authored the request group
... reason 0..*CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference)Why the request group is needed
... note 0..*AnnotationAdditional notes about the response
... action I0..*BackboneElementProposed actions, if any
+ Rule: Must have resource or action but not both
.... prefix 0..1stringUser-visible prefix 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
.... priority 0..1coderoutine | urgent | asap | stat
Request priority (Required)
.... code 0..*CodeableConceptCode representing the meaning of the action or 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
ActionConditionKind (Required)
..... expression 0..1ExpressionBoolean-valued expression
.... relatedAction 0..*BackboneElementRelationship to another action
..... actionId 1..1idWhat action this is related to
..... relationship 1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
ActionRelationshipType (Required)
..... offset[x] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] 0..1When the action should take place
..... timingDateTimedateTime
..... timingAgeAge
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... participant 0..*Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device)Who should perform the action
.... type 0..1CodeableConceptcreate | update | remove | fire-event
ActionType (Extensible)
.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
ActionGroupingBehavior (Required)
.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
ActionSelectionBehavior (Required)
.... requiredBehavior 0..1codemust | could | must-unless-documented
ActionRequiredBehavior (Required)
.... precheckBehavior 0..1codeyes | no
ActionPrecheckBehavior (Required)
.... cardinalityBehavior 0..1codesingle | multiple
ActionCardinalityBehavior (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 requestidentifier : Identifier [0..*]A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this requestinstantiatesCanonical : canonical [0..*] « »A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this requestinstantiatesUri : uri [0..*]A plan, proposal or order that is fulfilled in whole or in part by this requestbasedOn : Reference [0..*] « Any »Completed or terminated request(s) whose function is taken by this new requestreplaces : Reference [0..*] « Any »A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar formgroupIdentifier : Identifier [0..1]The current state of the request. For request groups, the status reflects the status of all the requests in the group (this element modifies the meaning of other elements)status : code [1..1] « Codes identifying the lifecycle stage of a request. (Strength=Required)RequestStatus! »Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain (this element modifies the meaning of other elements)intent : code [1..1] « Codes indicating the degree of authority/intentionality associated with a request. (Strength=Required)RequestIntent! »Indicates how quickly the request should be addressed with respect to other requestspriority : code [0..1] « Identifies the level of importance to be assigned to actioning the request. (Strength=Required)RequestPriority! »A code that identifies what the overall request group iscode : CodeableConcept [0..1]The subject for which the request group was createdsubject : Reference [0..1] « Patient|Group »Describes the context of the request group, if anyencounter : Reference [0..1] « Encounter »Indicates when the request group was createdauthoredOn : dateTime [0..1]Provides a reference to the author of the request groupauthor : Reference [0..1] « Device|Practitioner|PractitionerRole »Describes the reason for the request group in coded or textual formreason : DataType [0..*] « Condition|Observation|DiagnosticReport| DocumentReference »Provides a mechanism to communicate additional information about the responsenote : Annotation [0..*]ActionA user-visible prefix for the actionprefix : 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 might not be capable of interpreting it dynamicallytextEquivalent : string [0..1]Indicates how quickly the action should be addressed with respect to other actionspriority : code [0..1] « Identifies the level of importance to be assigned to actioning the request. (Strength=Required)RequestPriority! »A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation templatecode : 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] : DataType [0..1] « dateTime|Age|Period|Duration|Range| Timing »The participant that should perform or be responsible for this actionparticipant : Reference [0..*] « Patient|Practitioner| PractitionerRole|RelatedPerson|Device »The type of action to perform (create, update, remove)type : CodeableConcept [0..1] « The type of action to be performed. (Strength=Extensible)ActionType+ »Defines the grouping behavior for the action and its childrengroupingBehavior : code [0..1] « Defines organization behavior of a group. (Strength=Required)ActionGroupingBehavior! »Defines the selection behavior for the action and its childrenselectionBehavior : code [0..1] « Defines selection behavior of a group. (Strength=Required)ActionSelectionBehavior! »Defines expectations around whether an action is requiredrequiredBehavior : code [0..1] « Defines expectations around whether an action or action group is required. (Strength=Required)ActionRequiredBehavior! »Defines whether the action should usually be preselectedprecheckBehavior : code [0..1] « Defines selection frequency behavior for an action or group. (Strength=Required)ActionPrecheckBehavior! »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)ActionCardinalityBehavior! »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)ActionConditionKind! »An expression that returns true or false, indicating whether or not the condition is satisfiedexpression : Expression [0..1]RelatedActionThe element id of the action this is related toactionId : id [1..1]The relationship of this action to the related actionrelationship : code [1..1] « Defines the types of relationships between actions. (Strength=Required)ActionRelationshipType! »A duration or range of durations to apply to the relationship. For example, 30-60 minutes beforeoffset[x] : DataType [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..* Identifier Business identifier --></identifier>
 <instantiatesCanonical value="[canonical]"/><!-- 0..* Instantiates FHIR protocol or definition -->
 <instantiatesUri value="[uri]"/><!-- 0..* Instantiates external protocol or definition -->
 <basedOn><!-- 0..* Reference(Any) Fulfills plan, proposal, or order --></basedOn>
 <replaces><!-- 0..* Reference(Any) Request(s) replaced by this request --></replaces>
 <groupIdentifier><!-- 0..1 Identifier Composite request this is part of --></groupIdentifier>
 <status value="[code]"/><!-- 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown -->
 <intent value="[code]"/><!-- 1..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option -->
 <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
 <code><!-- 0..1 CodeableConcept What's being requested/ordered --></code>
 <subject><!-- 0..1 Reference(Group|Patient) Who the request group is about --></subject>
 <encounter><!-- 0..1 Reference(Encounter) Created as part of --></encounter>
 <authoredOn value="[dateTime]"/><!-- 0..1 When the request group was authored -->
 <author><!-- 0..1 Reference(Device|Practitioner|PractitionerRole) Device or practitioner that authored the request group --></author>
 <reason><!-- 0..* CodeableReference(Condition|DiagnosticReport|DocumentReference|
   Observation) Why the request group is needed --></reason>
 <note><!-- 0..* Annotation Additional notes about the response --></note>
 <action>  <!-- 0..* Proposed actions, if any -->
  <prefix value="[string]"/><!-- 0..1 User-visible prefix 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 -->
  <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
  <code><!-- 0..* CodeableConcept Code representing the meaning of the action or 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 -->
   <expression><!-- 0..1 Expression Boolean-valued expression --></expression>
  </condition>
  <relatedAction>  <!-- 0..* Relationship to another action -->
   <actionId value="[id]"/><!-- 1..1 What action this is related to -->
   <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|Age|Period|Duration|Range|Timing When the action should take place --></timing[x]>
  <participant><!-- 0..* Reference(Device|Patient|Practitioner|PractitionerRole|
    RelatedPerson) Who should perform the action --></participant>
  <type><!-- 0..1 CodeableConcept 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
  "instantiatesCanonical" : ["<canonical>"], // Instantiates FHIR protocol or definition
  "instantiatesUri" : ["<uri>"], // Instantiates external protocol or definition
  "basedOn" : [{ Reference(Any) }], // Fulfills plan, proposal, or order
  "replaces" : [{ Reference(Any) }], // Request(s) replaced by this request
  "groupIdentifier" : { Identifier }, // Composite request this is part of
  "status" : "<code>", // R!  draft | active | on-hold | revoked | completed | entered-in-error | unknown
  "intent" : "<code>", // R!  proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
  "priority" : "<code>", // routine | urgent | asap | stat
  "code" : { CodeableConcept }, // What's being requested/ordered
  "subject" : { Reference(Group|Patient) }, // Who the request group is about
  "encounter" : { Reference(Encounter) }, // Created as part of
  "authoredOn" : "<dateTime>", // When the request group was authored
  "author" : { Reference(Device|Practitioner|PractitionerRole) }, // Device or practitioner that authored the request group
  "reason" : [{ CodeableReference(Condition|DiagnosticReport|DocumentReference|
   Observation) }], // Why the request group is needed
  "note" : [{ Annotation }], // Additional notes about the response
  "action" : [{ // Proposed actions, if any
    "prefix" : "<string>", // User-visible prefix 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
    "priority" : "<code>", // routine | urgent | asap | stat
    "code" : [{ CodeableConcept }], // Code representing the meaning of the action or 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
      "expression" : { Expression } // Boolean-valued expression
    }],
    "relatedAction" : [{ // Relationship to another action
      "actionId" : "<id>", // R!  What action this is related to
      "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 6:
    "timingDateTime" : "<dateTime>",
    "timingAge" : { Age },
    "timingPeriod" : { Period },
    "timingDuration" : { Duration },
    "timingRange" : { Range },
    "timingTiming" : { Timing },
    "participant" : [{ Reference(Device|Patient|Practitioner|PractitionerRole|
    RelatedPerson) }], // Who should perform the action
    "type" : { CodeableConcept }, // 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..* Business identifier
  fhir:RequestGroup.instantiatesCanonical [ canonical ], ... ; # 0..* Instantiates FHIR protocol or definition
  fhir:RequestGroup.instantiatesUri [ uri ], ... ; # 0..* Instantiates external protocol or definition
  fhir:RequestGroup.basedOn [ Reference(Any) ], ... ; # 0..* Fulfills plan, proposal, or order
  fhir:RequestGroup.replaces [ Reference(Any) ], ... ; # 0..* Request(s) replaced by this request
  fhir:RequestGroup.groupIdentifier [ Identifier ]; # 0..1 Composite request this is part of
  fhir:RequestGroup.status [ code ]; # 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown
  fhir:RequestGroup.intent [ code ]; # 1..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
  fhir:RequestGroup.priority [ code ]; # 0..1 routine | urgent | asap | stat
  fhir:RequestGroup.code [ CodeableConcept ]; # 0..1 What's being requested/ordered
  fhir:RequestGroup.subject [ Reference(Group|Patient) ]; # 0..1 Who the request group is about
  fhir:RequestGroup.encounter [ Reference(Encounter) ]; # 0..1 Created as part of
  fhir:RequestGroup.authoredOn [ dateTime ]; # 0..1 When the request group was authored
  fhir:RequestGroup.author [ Reference(Device|Practitioner|PractitionerRole) ]; # 0..1 Device or practitioner that authored the request group
  fhir:RequestGroup.reason [ CodeableReference(Condition|DiagnosticReport|DocumentReference|Observation) ], ... ; # 0..* Why the request group is needed
  fhir:RequestGroup.note [ Annotation ], ... ; # 0..* Additional notes about the response
  fhir:RequestGroup.action [ # 0..* Proposed actions, if any
    fhir:RequestGroup.action.prefix [ string ]; # 0..1 User-visible prefix 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.priority [ code ]; # 0..1 routine | urgent | asap | stat
    fhir:RequestGroup.action.code [ CodeableConcept ], ... ; # 0..* Code representing the meaning of the action or 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.expression [ Expression ]; # 0..1 Boolean-valued expression
    ], ...;
    fhir:RequestGroup.action.relatedAction [ # 0..* Relationship to another action
      fhir:RequestGroup.action.relatedAction.actionId [ id ]; # 1..1 What action this is related to
      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 6
      fhir:RequestGroup.action.timingDateTime [ dateTime ]
      fhir:RequestGroup.action.timingAge [ Age ]
      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(Device|Patient|Practitioner|PractitionerRole|RelatedPerson) ], ... ; # 0..* Who should perform the action
    fhir:RequestGroup.action.type [ CodeableConcept ]; # 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 Release 3

RequestGroup
RequestGroup.status
  • Change value set from http://hl7.org/fhir/ValueSet/request-status|4.0.0 to http://hl7.org/fhir/ValueSet/request-status|4.4.0
RequestGroup.intent
  • Change value set from http://hl7.org/fhir/ValueSet/request-intent|4.0.0 to http://hl7.org/fhir/ValueSet/request-intent|4.4.0
RequestGroup.priority
  • Change value set from http://hl7.org/fhir/ValueSet/request-priority|4.0.0 to http://hl7.org/fhir/ValueSet/request-priority|4.4.0
RequestGroup.reason
  • Added Element
RequestGroup.action.priority
  • Change value set from http://hl7.org/fhir/ValueSet/request-priority|4.0.0 to http://hl7.org/fhir/ValueSet/request-priority|4.4.0
RequestGroup.action.condition.kind
  • Change value set from http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.0 to http://hl7.org/fhir/ValueSet/action-condition-kind|4.4.0
RequestGroup.action.relatedAction.relationship
  • Change value set from http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.0 to http://hl7.org/fhir/ValueSet/action-relationship-type|4.4.0
RequestGroup.action.groupingBehavior
  • Change value set from http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.0 to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.4.0
RequestGroup.action.selectionBehavior
  • Change value set from http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.0 to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.4.0
RequestGroup.action.requiredBehavior
  • Change value set from http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.0 to http://hl7.org/fhir/ValueSet/action-required-behavior|4.4.0
RequestGroup.action.precheckBehavior
  • Change value set from http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.0 to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.4.0
RequestGroup.action.cardinalityBehavior
  • Change value set from http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.0 to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.4.0
RequestGroup.reasonCode
  • deleted
RequestGroup.reasonReference
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 2 tests that all execute ok. All tests pass round-trip testing and 2 r3 resources are invalid (0 errors).)

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis a

14.18.3.1 Terminology Bindings

PathDefinitionTypeReference
RequestGroup.status Codes identifying the lifecycle stage of a request.RequiredRequestStatus
RequestGroup.intent Codes indicating the degree of authority/intentionality associated with a request.RequiredRequestIntent
RequestGroup.priority
RequestGroup.action.priority 		Identifies the level of importance to be assigned to actioning the request.RequiredRequestPriority
RequestGroup.action.condition.kind The kind of condition for the action.RequiredActionConditionKind
RequestGroup.action.relatedAction.relationship Defines the types of relationships between actions.RequiredActionRelationshipType
RequestGroup.action.type The type of action to be performed.ExtensibleActionType
RequestGroup.action.groupingBehavior Defines organization behavior of a group.RequiredActionGroupingBehavior
RequestGroup.action.selectionBehavior Defines selection behavior of a group.RequiredActionSelectionBehavior
RequestGroup.action.requiredBehavior Defines expectations around whether an action or action group is required.RequiredActionRequiredBehavior
RequestGroup.action.precheckBehavior Defines selection frequency behavior for an action or group.RequiredActionPrecheckBehavior
RequestGroup.action.cardinalityBehavior Defines behavior for an action or a group for how many times that item may be repeated.RequiredActionCardinalityBehavior

14.18.3.2 Constraints

idLevelLocationDescriptionExpression
rqg-1Rule RequestGroup.actionMust have resource or action but not bothresource.exists() != action.exists()

14.18.4 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 ServiceRequest, 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.18.5 Search Parameters

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

NameTypeDescriptionExpressionIn Common
authorreferenceThe author of the request groupRequestGroup.author
(Practitioner, Device, PractitionerRole)
authored NdateThe date the request group was authoredRequestGroup.authoredOn
codetokenThe code of the request groupRequestGroup.code
encounterreferenceThe encounter the request group applies toRequestGroup.encounter
(Encounter)
group-identifiertokenThe group identifier for the request groupRequestGroup.groupIdentifier
identifiertokenExternal identifiers for the request groupRequestGroup.identifier
instantiates-canonical NreferenceThe FHIR-based definition from which the request group is realizedRequestGroup.instantiatesCanonical
instantiates-uri NuriThe external definition from which the request group is realizedRequestGroup.instantiatesUri
intent NtokenThe intent of the request groupRequestGroup.intent
participantreferenceThe participant in the requests in the groupRequestGroup.action.participant
(Practitioner, Device, Patient, PractitionerRole, RelatedPerson)
patientreferenceThe identity of a patient to search for request groupsRequestGroup.subject.where(resolve() is Patient)
(Patient)
priority NtokenThe priority of the request groupRequestGroup.priority
status NtokenThe status of the request groupRequestGroup.status
subjectreferenceThe subject that the request group is aboutRequestGroup.subject
(Group, Patient)