This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
(v5.0.0-snapshot1:
R5
Snapshot
#1).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
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
|
|---|---|---|---|---|
|
TU | DomainResource |
A
group
of
related
requests
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
Business
identifier
|
|
Σ | 0..* | canonical () |
Instantiates
FHIR
protocol
or
definition
|
|
Σ | 0..* | uri |
Instantiates
external
protocol
or
definition
|
|
0..* | Reference ( Any ) |
Fulfills
plan,
proposal,
or
order
|
|
|
0..* | Reference ( Any ) |
Request(s)
replaced
by
this
request
|
|
|
Σ | 0..1 | Identifier | Composite request this is part of |
|
?! Σ | 1..1 | code |
draft
|
active
|
on-hold
|
revoked
|
completed
|
entered-in-error
|
unknown
RequestStatus ( Required ) |
|
?! Σ | 1..1 | code |
proposal
|
plan
|
directive
|
order
|
original-order
|
reflex-order
|
filler-order
|
instance-order
|
option
RequestIntent ( Required ) |
|
Σ | 0..1 | code |
routine
|
urgent
|
asap
|
stat
|
|
Σ | 0..1 | CodeableConcept |
What's
being
requested/ordered
ActionCode ( Example ) |
|
0..1 | Reference ( Patient | Group ) | Who the request group is about | |
|
0..1 | Reference ( Encounter ) | Created as part of | |
|
0..1 | dateTime | When the request group was authored | |
|
0..1 | Reference ( Device | Practitioner | PractitionerRole ) | Device or practitioner that authored the request group | |
|
0..* |
|
Why
the
request
group
is
needed
ActionReasonCode ( Example ) |
|
|
0..* |
Reference
(
|
|
|
|
0..* | Annotation |
Additional
notes
about
the
response
|
|
|
I | 0..* | BackboneElement |
Proposed
actions,
if
any
+ Rule: Must have resource or action but not both |
|
0..1 | string | Pointer to specific item from the PlanDefinition | |
![]() ![]() ![]() | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |
|
0..1 | string | User-visible title | |
|
Σ | 0..1 | string | Short description of the action |
|
Σ | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system |
|
0..1 | code |
routine
|
urgent
|
asap
|
stat
|
|
|
0..* | CodeableConcept |
Code
representing
the
meaning
of
the
action
or
sub-actions
ActionCode ( Example ) |
|
|
0..* | RelatedArtifact |
Supporting
documentation
for
the
intended
performer
of
the
action
|
|
| 0..* | Reference ( Goal ) |
What
goals
| |
![]() ![]()
|
0..* | BackboneElement |
Whether
or
not
the
action
is
applicable
|
|
|
1..1 | code |
applicability
|
start
|
stop
ActionConditionKind ( Required ) |
|
|
0..1 | Expression | Boolean-valued expression | |
|
0..* | BackboneElement |
Relationship
to
another
action
|
|
|
1..1 | id | What action this is related to | |
|
1..1 | code |
before-start
|
before
|
before-end
|
concurrent-with-start
|
concurrent
|
concurrent-with-end
|
after-start
|
after
|
after-end
ActionRelationshipType ( Required ) |
|
|
0..1 | Time offset for the relationship | ||
|
Duration | |||
|
Range | |||
|
0..1 | When the action should take place | ||
|
dateTime | |||
|
Age | |||
|
Period | |||
|
Duration | |||
|
Range | |||
|
Timing | |||
| 0..1 | CodeableReference ( Location ) | Where it should happen | |
![]() ![]() ![]() |
0..* | BackboneElement |
Who
should
perform
the
action
| |
![]() ![]() ![]() ![]() |
| code |
careteam
|
device
|
group
|
healthcareservice
|
location
|
organization
|
patient
|
practitioner
|
practitionerrole
|
relatedperson
ActionParticipantType ( Required ) | |
![]() ![]() ![]() ![]() | 0..1 | Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) | Who or what can participate | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept |
E.g.
Nurse,
Surgeon,
Parent,
etc.
ActionParticipantRole
(
Example
)
| |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept |
E.g.
Author,
Reviewer,
Witness,
etc.
ActionParticipantFunction ( Example ) | |
![]() ![]() ![]() ![]() | 0..1 | Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) |
|
|
|
0..1 | CodeableConcept |
create
|
update
|
remove
|
fire-event
ActionType ( Extensible ) |
|
|
0..1 | code |
visual-group
|
logical-group
|
sentence-group
ActionGroupingBehavior ( Required ) |
|
|
0..1 | code |
any
|
all
|
all-or-none
|
exactly-one
|
at-most-one
|
one-or-more
ActionSelectionBehavior ( Required ) |
|
|
0..1 | code |
must
|
could
|
must-unless-documented
ActionRequiredBehavior ( Required ) |
|
|
0..1 | code |
yes
|
no
ActionPrecheckBehavior ( Required ) |
|
|
0..1 | code |
single
|
multiple
ActionCardinalityBehavior ( Required ) |
|
|
I | 0..1 | Reference ( Any ) | The target of the 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> <</subject><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><</reasonCode> <| </reasonReference><reason><!-- 0..* CodeableReference(Condition|DiagnosticReport|DocumentReference| Observation) Why the request group is needed --></reason> <goal><!-- 0..* Reference(Goal) What goals --></goal> <note><!-- 0..* Annotation Additional notes about the response --></note> <action> <!-- 0..* Proposed actions, if any --><<linkId value="[string]"/><!-- 0..1 Pointer to specific item from the PlanDefinition --> <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><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> <goal><!-- 0..* Reference(Goal) What goals --></goal> <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]><| </participant><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.--></role> <function><!-- 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc. --></function> <actor><!-- 0..1 Reference(CareTeam|Device|Group|HealthcareService|Location| Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) Who/what is participating? --></actor> </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
{
"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
"goal" : [{ Reference(Goal) }], // What goals
"note" : [{ Annotation }], // Additional notes about the response
"action" : [{ // Proposed actions, if any
"
"linkId" : "<string>", // Pointer to specific item from the PlanDefinition
"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
"goal" : [{ Reference(Goal) }], // What goals
"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/> .[ 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: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 groupfhir: fhir:fhir:RequestGroup.reason [ CodeableReference(Condition|DiagnosticReport|DocumentReference|Observation) ], ... ; # 0..* Why the request group is needed fhir:RequestGroup.goal [ Reference(Goal) ], ... ; # 0..* What goals fhir:RequestGroup.note [ Annotation ], ... ; # 0..* Additional notes about the response fhir:RequestGroup.action [ # 0..* Proposed actions, if anyfhir:fhir:RequestGroup.action.linkId [ string ]; # 0..1 Pointer to specific item from the PlanDefinition 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.goal [ Reference(Goal) ], ... ; # 0..* What goals 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 actionfhir:fhir:RequestGroup.action.relatedAction.targetId [ 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:fhir:RequestGroup.action.location [ CodeableReference(Location) ]; # 0..1 Where it should happen fhir:RequestGroup.action.participant [ # 0..* Who should perform the action fhir:RequestGroup.action.participant.type [ code ]; # 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson fhir:RequestGroup.action.participant.typeReference [ Reference(CareTeam|Device|Group|HealthcareService|Location|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Who or what can participate fhir:RequestGroup.action.participant.role [ CodeableConcept ]; # 0..1 E.g. Nurse, Surgeon, Parent, etc. fhir:RequestGroup.action.participant.function [ CodeableConcept ]; # 0..1 E.g. Author, Reviewer, Witness, etc. fhir:RequestGroup.action.participant.actor [ Reference(CareTeam|Device|Group|HealthcareService|Location|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Who/what is participating? ], ...; 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 |
|
| RequestGroup.intent |
|
| RequestGroup.priority |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| RequestGroup.action.participant.role |
|
|
|
|
| RequestGroup.action.participant.actor |
|
| RequestGroup.action.groupingBehavior |
|
| RequestGroup.action.selectionBehavior |
|
| RequestGroup.action.requiredBehavior |
|
| RequestGroup.action.precheckBehavior |
|
| RequestGroup.action.cardinalityBehavior |
|
|
|
|
|
|
|
|
|
|
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
|
|---|---|---|---|---|
|
TU | DomainResource |
A
group
of
related
requests
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
Business
identifier
|
|
Σ | 0..* | canonical () |
Instantiates
FHIR
protocol
or
definition
|
|
Σ | 0..* | uri |
Instantiates
external
protocol
or
definition
|
|
0..* | Reference ( Any ) |
Fulfills
plan,
proposal,
or
order
|
|
|
0..* | Reference ( Any ) |
Request(s)
replaced
by
this
request
|
|
|
Σ | 0..1 | Identifier | Composite request this is part of |
|
?! Σ | 1..1 | code |
draft
|
active
|
on-hold
|
revoked
|
completed
|
entered-in-error
|
unknown
RequestStatus ( Required ) |
|
?! Σ | 1..1 | code |
proposal
|
plan
|
directive
|
order
|
original-order
|
reflex-order
|
filler-order
|
instance-order
|
option
RequestIntent ( Required ) |
|
Σ | 0..1 | code |
routine
|
urgent
|
asap
|
stat
|
|
Σ | 0..1 | CodeableConcept |
What's
being
requested/ordered
ActionCode ( Example ) |
|
0..1 | Reference ( Patient | Group ) | Who the request group is about | |
|
0..1 | Reference ( Encounter ) | Created as part of | |
|
0..1 | dateTime | When the request group was authored | |
|
0..1 | Reference ( Device | Practitioner | PractitionerRole ) | Device or practitioner that authored the request group | |
|
0..* |
|
Why
the
request
group
is
needed
ActionReasonCode ( Example ) |
|
|
0..* |
Reference
(
|
|
|
|
0..* | Annotation |
Additional
notes
about
the
response
|
|
|
I | 0..* | BackboneElement |
Proposed
actions,
if
any
+ Rule: Must have resource or action but not both |
|
0..1 | string | Pointer to specific item from the PlanDefinition | |
![]() ![]() ![]() | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |
|
0..1 | string | User-visible title | |
|
Σ | 0..1 | string | Short description of the action |
|
Σ | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system |
|
0..1 | code |
routine
|
urgent
|
asap
|
stat
|
|
|
0..* | CodeableConcept |
Code
representing
the
meaning
of
the
action
or
sub-actions
ActionCode ( Example ) |
|
|
0..* | RelatedArtifact |
Supporting
documentation
for
the
intended
performer
of
the
action
|
|
| 0..* | Reference ( Goal ) |
What
goals
| |
![]() ![]()
|
0..* | BackboneElement |
Whether
or
not
the
action
is
applicable
|
|
|
1..1 | code |
applicability
|
start
|
stop
ActionConditionKind ( Required ) |
|
|
0..1 | Expression | Boolean-valued expression | |
|
0..* | BackboneElement |
Relationship
to
another
action
|
|
|
1..1 | id | What action this is related to | |
|
1..1 | code |
before-start
|
before
|
before-end
|
concurrent-with-start
|
concurrent
|
concurrent-with-end
|
after-start
|
after
|
after-end
ActionRelationshipType ( Required ) |
|
|
0..1 | Time offset for the relationship | ||
|
Duration | |||
|
Range | |||
|
0..1 | When the action should take place | ||
|
dateTime | |||
|
Age | |||
|
Period | |||
|
Duration | |||
|
Range | |||
|
Timing | |||
| 0..1 | CodeableReference ( Location ) | Where it should happen | |
![]() ![]() ![]() |
0..* | BackboneElement |
Who
should
perform
the
action
| |
![]() ![]() ![]() ![]() |
|
code |
careteam
|
device
|
group
|
healthcareservice
|
location
|
organization
|
patient
|
practitioner
|
practitionerrole
|
relatedperson
ActionParticipantType ( Required ) | |
![]() ![]() ![]() ![]() | 0..1 | Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) | Who or what can participate | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept |
E.g.
Nurse,
Surgeon,
Parent,
etc.
ActionParticipantRole
(
Example
)
| |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept |
E.g.
Author,
Reviewer,
Witness,
etc.
ActionParticipantFunction ( Example ) | |
![]() ![]() ![]() ![]() | 0..1 | Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) |
|
|
|
0..1 | CodeableConcept |
create
|
update
|
remove
|
fire-event
ActionType ( Extensible ) |
|
|
0..1 | code |
visual-group
|
logical-group
|
sentence-group
ActionGroupingBehavior ( Required ) |
|
|
0..1 | code |
any
|
all
|
all-or-none
|
exactly-one
|
at-most-one
|
one-or-more
ActionSelectionBehavior ( Required ) |
|
|
0..1 | code |
must
|
could
|
must-unless-documented
ActionRequiredBehavior ( Required ) |
|
|
0..1 | code |
yes
|
no
ActionPrecheckBehavior ( Required ) |
|
|
0..1 | code |
single
|
multiple
ActionCardinalityBehavior ( Required ) |
|
|
I | 0..1 | Reference ( Any ) | The target of the action |
|
I | 0..* | see action |
Sub
action
|
Documentation
for
this
format
|
||||
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> <</subject><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><</reasonCode> <| </reasonReference><reason><!-- 0..* CodeableReference(Condition|DiagnosticReport|DocumentReference| Observation) Why the request group is needed --></reason> <goal><!-- 0..* Reference(Goal) What goals --></goal> <note><!-- 0..* Annotation Additional notes about the response --></note> <action> <!-- 0..* Proposed actions, if any --><<linkId value="[string]"/><!-- 0..1 Pointer to specific item from the PlanDefinition --> <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><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> <goal><!-- 0..* Reference(Goal) What goals --></goal> <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]><| </participant><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.--></role> <function><!-- 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc. --></function> <actor><!-- 0..1 Reference(CareTeam|Device|Group|HealthcareService|Location| Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) Who/what is participating? --></actor> </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
{
"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
"goal" : [{ Reference(Goal) }], // What goals
"note" : [{ Annotation }], // Additional notes about the response
"action" : [{ // Proposed actions, if any
"
"linkId" : "<string>", // Pointer to specific item from the PlanDefinition
"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
"goal" : [{ Reference(Goal) }], // What goals
"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/> .[ 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: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 groupfhir: fhir:fhir:RequestGroup.reason [ CodeableReference(Condition|DiagnosticReport|DocumentReference|Observation) ], ... ; # 0..* Why the request group is needed fhir:RequestGroup.goal [ Reference(Goal) ], ... ; # 0..* What goals fhir:RequestGroup.note [ Annotation ], ... ; # 0..* Additional notes about the response fhir:RequestGroup.action [ # 0..* Proposed actions, if anyfhir:fhir:RequestGroup.action.linkId [ string ]; # 0..1 Pointer to specific item from the PlanDefinition 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.goal [ Reference(Goal) ], ... ; # 0..* What goals 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 actionfhir:fhir:RequestGroup.action.relatedAction.targetId [ 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:fhir:RequestGroup.action.location [ CodeableReference(Location) ]; # 0..1 Where it should happen fhir:RequestGroup.action.participant [ # 0..* Who should perform the action fhir:RequestGroup.action.participant.type [ code ]; # 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson fhir:RequestGroup.action.participant.typeReference [ Reference(CareTeam|Device|Group|HealthcareService|Location|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Who or what can participate fhir:RequestGroup.action.participant.role [ CodeableConcept ]; # 0..1 E.g. Nurse, Surgeon, Parent, etc. fhir:RequestGroup.action.participant.function [ CodeableConcept ]; # 0..1 E.g. Author, Reviewer, Witness, etc. fhir:RequestGroup.action.participant.actor [ Reference(CareTeam|Device|Group|HealthcareService|Location|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Who/what is participating? ], ...; 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 |
|
| RequestGroup.intent |
|
| RequestGroup.priority |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| RequestGroup.action.participant.role |
|
|
|
|
| RequestGroup.action.participant.actor |
|
| RequestGroup.action.groupingBehavior |
|
| RequestGroup.action.selectionBehavior |
|
| RequestGroup.action.requiredBehavior |
|
| RequestGroup.action.precheckBehavior |
|
| RequestGroup.action.cardinalityBehavior |
|
|
|
|
|
|
|
|
|
|
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 |
( 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 ) |