Release 5 Draft Ballot
Clinical ReasoningThis page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - see ballot notes). 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
| Clinical Decision Support Work Group | Maturity Level: 2 | Trial Use | Security 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".
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.
This resource is referenced by CarePlan and GuidanceResponse.
This resource implements the Request pattern.
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  RequestGroup | TU | DomainResource | A group of related requests Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
  identifier | Σ | 0..* | Identifier | Business identifier |
 instantiatesCanonical | Σ | 0..* | canonical() | Instantiates FHIR protocol or definition |
 instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition |
| basedOn | 0..* | Reference(Any) | Fulfills plan, proposal, or order | |
| replaces | 0..* | Reference(Any) | Request(s) replaced by this request | |
| groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of |
| status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown RequestStatus (Required) |
| intent | ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option RequestIntent (Required) |
| priority | Σ | 0..1 | code | routine | urgent | asap | stat RequestPriority (Required) |
| code | Σ | 0..1 | CodeableConcept | What's being requested/ordered ActionCode (Example) |
| subject | 0..1 | Reference(Patient | Group) | Who the request group is about | |
| encounter | 0..1 | Reference(Encounter) | Created as part of | |
| authoredOn | 0..1 | dateTime | When the request group was authored | |
| author | 0..1 | Reference(Device | Practitioner | PractitionerRole) | Device or practitioner that authored the request group | |
| reason | 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) | Why the request group is needed ActionReasonCode (Example) | |
| note | 0..* | Annotation | Additional notes about the response | |
  action | I | 0..* | BackboneElement | Proposed actions, if any + Rule: Must have resource or action but not both |
 prefix | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |
| title | 0..1 | string | User-visible title | |
| description | Σ | 0..1 | string | Short description of the action |
| textEquivalent | Σ | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system |
| priority | 0..1 | code | routine | urgent | asap | stat RequestPriority (Required) | |
| code | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions ActionCode (Example) | |
| documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |
 condition | 0..* | BackboneElement | Whether or not the action is applicable | |
 kind | 1..1 | code | applicability | start | stop ActionConditionKind (Required) | |
 expression | 0..1 | Expression | Boolean-valued expression | |
| relatedAction | 0..* | BackboneElement | Relationship to another action | |
| targetId | 1..1 | id | What action this is related to | |
| relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end ActionRelationshipType (Required) | |
 offset[x] | 0..1 | Time offset for the relationship | ||
| offsetDuration | Duration | |||
| offsetRange | Range | |||
| timing[x] | 0..1 | When the action should take place | ||
| timingDateTime | dateTime | |||
| timingAge | Age | |||
| timingPeriod | Period | |||
| timingDuration | Duration | |||
| timingRange | Range | |||
| timingTiming | Timing | |||
| location | 0..1 | CodeableReference(Location) | Where it should happen | |
| participant | 0..* | BackboneElement | Who should perform the action | |
| type | 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson ActionParticipantType (Required) | |
| typeReference | 0..1 | Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who or what can participate | |
| role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc. ActionParticipantRole (Example) | |
| function | 0..1 | CodeableConcept | E.g. Author, Reviewer, Witness, etc. ActionParticipantFunction (Example) | |
| actor | 0..1 | Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who/what is participating? | |
| type | 0..1 | CodeableConcept | create | update | remove | fire-event ActionType (Extensible) | |
| groupingBehavior | 0..1 | code | visual-group | logical-group | sentence-group ActionGroupingBehavior (Required) | |
| selectionBehavior | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more ActionSelectionBehavior (Required) | |
| requiredBehavior | 0..1 | code | must | could | must-unless-documented ActionRequiredBehavior (Required) | |
| precheckBehavior | 0..1 | code | yes | no ActionPrecheckBehavior (Required) | |
| cardinalityBehavior | 0..1 | code | single | multiple ActionCardinalityBehavior (Required) | |
| resource | I | 0..1 | Reference(Any) | The target of the action |
 action | I | 0..* | see action | Sub action |
| Documentation for this format | ||||
UML Diagram (Legend)
XML Template
<RequestGroup xmlns="http://hl7.org/fhir"><!-- 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 --> <targetId 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]> <location><!-- 0..1 CodeableReference(Location) Where it should happen --></location> <participant> <!-- 0..* Who should perform the action --> <type value="[code]"/><!-- 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson --> <typeReference><!-- 0..1 Reference(CareTeam|Device|Group|HealthcareService| Location|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) Who or what can participate --></typeReference> <role><!-- 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.
0..1 Reference(Any) The target of the action --></resource> <action><!--
JSON Template
{
"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
"targetId" : "<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 },
"location" : { CodeableReference(Location) }, // Where it should happen
"participant" : [{ // Who should perform the action
"type" : "<code>", // careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
"typeReference" : { Reference(CareTeam|Device|Group|HealthcareService|
Location|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) }, // Who or what can participate
"role" : { CodeableConcept }, // E.g. Nurse, Surgeon, Parent, etc.
"function" : { CodeableConcept }, // E.g. Author, Reviewer, Witness, etc.
"actor" : { Reference(CareTeam|Device|Group|HealthcareService|Location|
Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) } // Who/what is participating?
}],
"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/> .
Changes since R3
| RequestGroup | |
| RequestGroup.status |
|
| RequestGroup.intent |
|
| RequestGroup.priority |
|
| RequestGroup.reason |
|
| RequestGroup.action.priority |
|
| RequestGroup.action.condition.kind |
|
| RequestGroup.action.relatedAction.targetId |
|
| RequestGroup.action.relatedAction.relationship |
|
| RequestGroup.action.location |
|
| RequestGroup.action.participant |
|
| RequestGroup.action.participant.type |
|
| RequestGroup.action.participant.typeReference |
|
| RequestGroup.action.participant.role |
|
| RequestGroup.action.participant.function |
|
| RequestGroup.action.participant.actor |
|
| RequestGroup.action.groupingBehavior |
|
| RequestGroup.action.selectionBehavior |
|
| RequestGroup.action.requiredBehavior |
|
| RequestGroup.action.precheckBehavior |
|
| RequestGroup.action.cardinalityBehavior |
|
| RequestGroup.reasonCode |
|
| RequestGroup.reasonReference |
|
| RequestGroup.action.relatedAction.actionId |
|
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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RequestGroup | TU | DomainResource | A group of related requests Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
| identifier | Σ | 0..* | Identifier | Business identifier |
| instantiatesCanonical | Σ | 0..* | canonical() | Instantiates FHIR protocol or definition |
| instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition |
| basedOn | 0..* | Reference(Any) | Fulfills plan, proposal, or order | |
| replaces | 0..* | Reference(Any) | Request(s) replaced by this request | |
| groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of |
| status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown RequestStatus (Required) |
| intent | ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option RequestIntent (Required) |
| priority | Σ | 0..1 | code | routine | urgent | asap | stat RequestPriority (Required) |
| code | Σ | 0..1 | CodeableConcept | What's being requested/ordered ActionCode (Example) |
| subject | 0..1 | Reference(Patient | Group) | Who the request group is about | |
| encounter | 0..1 | Reference(Encounter) | Created as part of | |
| authoredOn | 0..1 | dateTime | When the request group was authored | |
| author | 0..1 | Reference(Device | Practitioner | PractitionerRole) | Device or practitioner that authored the request group | |
| reason | 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) | Why the request group is needed ActionReasonCode (Example) | |
| note | 0..* | Annotation | Additional notes about the response | |
| action | I | 0..* | BackboneElement | Proposed actions, if any + Rule: Must have resource or action but not both |
| prefix | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |
| title | 0..1 | string | User-visible title | |
| description | Σ | 0..1 | string | Short description of the action |
| textEquivalent | Σ | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system |
| priority | 0..1 | code | routine | urgent | asap | stat RequestPriority (Required) | |
| code | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions ActionCode (Example) | |
| documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |
| condition | 0..* | BackboneElement | Whether or not the action is applicable | |
| kind | 1..1 | code | applicability | start | stop ActionConditionKind (Required) | |
| expression | 0..1 | Expression | Boolean-valued expression | |
| relatedAction | 0..* | BackboneElement | Relationship to another action | |
| targetId | 1..1 | id | What action this is related to | |
| relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end ActionRelationshipType (Required) | |
| offset[x] | 0..1 | Time offset for the relationship | ||
| offsetDuration | Duration | |||
| offsetRange | Range | |||
| timing[x] | 0..1 | When the action should take place | ||
| timingDateTime | dateTime | |||
| timingAge | Age | |||
| timingPeriod | Period | |||
| timingDuration | Duration | |||
| timingRange | Range | |||
| timingTiming | Timing | |||
| location | 0..1 | CodeableReference(Location) | Where it should happen | |
| participant | 0..* | BackboneElement | Who should perform the action | |
| type | 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson ActionParticipantType (Required) | |
| typeReference | 0..1 | Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who or what can participate | |
| role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc. ActionParticipantRole (Example) | |
| function | 0..1 | CodeableConcept | E.g. Author, Reviewer, Witness, etc. ActionParticipantFunction (Example) | |
| actor | 0..1 | Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who/what is participating? | |
| type | 0..1 | CodeableConcept | create | update | remove | fire-event ActionType (Extensible) | |
| groupingBehavior | 0..1 | code | visual-group | logical-group | sentence-group ActionGroupingBehavior (Required) | |
| selectionBehavior | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more ActionSelectionBehavior (Required) | |
| requiredBehavior | 0..1 | code | must | could | must-unless-documented ActionRequiredBehavior (Required) | |
| precheckBehavior | 0..1 | code | yes | no ActionPrecheckBehavior (Required) | |
| cardinalityBehavior | 0..1 | code | single | multiple ActionCardinalityBehavior (Required) | |
| resource | I | 0..1 | Reference(Any) | The target of the action |
| action | I | 0..* | see action | Sub action |
| Documentation for this format | ||||
XML Template
<RequestGroup xmlns="http://hl7.org/fhir">
JSON Template
{
"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
"targetId" : "<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 },
"location" : { CodeableReference(Location) }, // Where it should happen
"participant" : [{ // Who should perform the action
"type" : "<code>", // careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
"typeReference" : { Reference(CareTeam|Device|Group|HealthcareService|
Location|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) }, // Who or what can participate
"role" : { CodeableConcept }, // E.g. Nurse, Surgeon, Parent, etc.
"function" : { CodeableConcept }, // E.g. Author, Reviewer, Witness, etc.
"actor" : { Reference(CareTeam|Device|Group|HealthcareService|Location|
Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) } // Who/what is participating?
}],
"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/> .
Changes since Release 3
| RequestGroup | |
| RequestGroup.status |
|
| RequestGroup.intent |
|
| RequestGroup.priority |
|
| RequestGroup.reason |
|
| RequestGroup.action.priority |
|
| RequestGroup.action.condition.kind |
|
| RequestGroup.action.relatedAction.targetId |
|
| RequestGroup.action.relatedAction.relationship |
|
| RequestGroup.action.location |
|
| RequestGroup.action.participant |
|
| RequestGroup.action.participant.type |
|
| RequestGroup.action.participant.typeReference |
|
| RequestGroup.action.participant.role |
|
| RequestGroup.action.participant.function |
|
| RequestGroup.action.participant.actor |
|
| RequestGroup.action.groupingBehavior |
|
| RequestGroup.action.selectionBehavior |
|
| RequestGroup.action.requiredBehavior |
|
| RequestGroup.action.precheckBehavior |
|
| RequestGroup.action.cardinalityBehavior |
|
| RequestGroup.reasonCode |
|
| RequestGroup.reasonReference |
|
| RequestGroup.action.relatedAction.actionId |
|
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
| Path | Definition | Type | Reference |
|---|---|---|---|
| RequestGroup.status | Required | RequestStatus | |
| RequestGroup.intent | Required | RequestIntent | |
| RequestGroup.priority | Required | RequestPriority | |
| RequestGroup.code | Example | ActionCode | |
| RequestGroup.reason | Example | ActionReasonCode | |
| RequestGroup.action.priority | Required | RequestPriority | |
| RequestGroup.action.code | Example | ActionCode | |
| RequestGroup.action.condition.kind | Required | ActionConditionKind | |
| RequestGroup.action.relatedAction.relationship | Required | ActionRelationshipType | |
| RequestGroup.action.participant.type | Required | ActionParticipantType | |
| RequestGroup.action.participant.role | Example | ActionParticipantRole | |
| RequestGroup.action.participant.function | Example | ActionParticipantFunction | |
| RequestGroup.action.type | Extensible | ActionType | |
| RequestGroup.action.groupingBehavior | Required | ActionGroupingBehavior | |
| RequestGroup.action.selectionBehavior | Required | ActionSelectionBehavior | |
| RequestGroup.action.requiredBehavior | Required | ActionRequiredBehavior | |
| RequestGroup.action.precheckBehavior | Required | ActionPrecheckBehavior | |
| RequestGroup.action.cardinalityBehavior | Required | ActionCardinalityBehavior |
| id | Level | Location | Description | Expression |
| rqg-1 | Rule | RequestGroup.action | Must have resource or action but not both | resource.exists() != action.exists() |
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:
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.
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
| author | reference | The author of the request group | RequestGroup.author (Practitioner, Device, PractitionerRole) | |
| authored N | date | The date the request group was authored | RequestGroup.authoredOn | |
| code | token | The code of the request group | RequestGroup.code | |
| encounter | reference | The encounter the request group applies to | RequestGroup.encounter (Encounter) | |
| group-identifier | token | The group identifier for the request group | RequestGroup.groupIdentifier | |
| identifier | token | External identifiers for the request group | RequestGroup.identifier | |
| instantiates-canonical N | reference | The FHIR-based definition from which the request group is realized | RequestGroup.instantiatesCanonical | |
| instantiates-uri N | uri | The external definition from which the request group is realized | RequestGroup.instantiatesUri | |
| intent N | token | The intent of the request group | RequestGroup.intent | |
| participant | reference | The participant in the requests in the group | RequestGroup.action.participant.actor (Practitioner, Group, Organization, CareTeam, Device, Patient, HealthcareService, PractitionerRole, RelatedPerson, Location) | |
| patient | reference | The identity of a patient to search for request groups | RequestGroup.subject.where(resolve() is Patient) (Group, Patient) | |
| priority N | token | The priority of the request group | RequestGroup.priority | |
| status N | token | The status of the request group | RequestGroup.status | |
| subject | reference | The subject that the request group is about | RequestGroup.subject (Group, Patient) |
FHIR ®© HL7.org 2011+. FHIR R5 Draft Ballot hl7.fhir.core#4.6.0 generated on Thu, Apr 15, 2021 12:29+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change