This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
(v4.0.1:
R4
-
Mixed
Normative
and
STU
3).
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
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
R4
R3
Clinical
Decision
Support
Work
Group
|
Maturity Level : 2 |
|
Security Category : Business | Compartments : Device , Encounter , Patient , Practitioner , RelatedPerson |
Detailed Descriptions for the elements in the RequestGroup resource.
| RequestGroup | |||||||||
| Element Id | RequestGroup | ||||||||
| Definition |
A
group
of
related
requests
that
can
be
used
to
capture
intended
activities
that
have
inter-dependencies
such
as
|
||||||||
|
|
| ||||||||
| Type | DomainResource | ||||||||
| RequestGroup.identifier | |||||||||
| Element Id | RequestGroup.identifier | ||||||||
| Definition |
Allows a service to provide a unique, business identifier for the request. |
||||||||
| Note |
This
is
a
business
|
||||||||
|
|
0..* | ||||||||
| Type | Identifier | ||||||||
| Requirements |
Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers. |
||||||||
| Summary | true | ||||||||
|
|
|||||||||
| Element Id | RequestGroup.instantiatesCanonical | ||||||||
| Definition |
A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. |
||||||||
|
|
0..* | ||||||||
| Type |
|
||||||||
|
Summary
|
true | ||||||||
| RequestGroup.instantiatesUri | |||||||||
| Element Id | RequestGroup.instantiatesUri | ||||||||
| Definition | A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. | ||||||||
| Cardinality | 0..* | ||||||||
| Type | uri | ||||||||
| Summary | true | ||||||||
| RequestGroup.basedOn | |||||||||
| Element Id | RequestGroup.basedOn | ||||||||
| Definition |
A plan, proposal or order that is fulfilled in whole or in part by this request. |
||||||||
|
|
0..* | ||||||||
| Type | Reference ( Any ) | ||||||||
| Requirements |
Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon. |
||||||||
| Alternate Names | fulfills | ||||||||
| RequestGroup.replaces | |||||||||
| Element Id | RequestGroup.replaces | ||||||||
| Definition |
Completed or terminated request(s) whose function is taken by this new request. |
||||||||
|
|
0..* | ||||||||
| Type | Reference ( Any ) | ||||||||
| Requirements |
Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests. |
||||||||
| Alternate Names | supersedes; prior; renewed order | ||||||||
| Comments |
The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing. |
||||||||
| RequestGroup.groupIdentifier | |||||||||
| Element Id | RequestGroup.groupIdentifier | ||||||||
| Definition |
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 form. |
||||||||
|
|
0..1 | ||||||||
| Type | Identifier | ||||||||
| Requirements |
Some
business
processes
need
to
know
if
multiple
items
were
ordered
as
part
of
the
same
|
||||||||
| Alternate Names | grouperid; requisition | ||||||||
| Summary | true | ||||||||
| Comments |
Requests
are
linked
either
by
a
|
||||||||
| RequestGroup.status | |||||||||
| Element Id | RequestGroup.status | ||||||||
| Definition |
The current state of the request. For request groups, the status reflects the status of all the requests in the group. |
||||||||
|
|
1..1 | ||||||||
| Terminology Binding | RequestStatus ( Required ) | ||||||||
| Type | code | ||||||||
| Is Modifier | true (Reason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid) | ||||||||
| Summary | true | ||||||||
| RequestGroup.intent | |||||||||
| Element Id | RequestGroup.intent | ||||||||
| Definition |
Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. |
||||||||
|
|
1..1 | ||||||||
| Terminology Binding | RequestIntent ( Required ) | ||||||||
| Type | code | ||||||||
| Is Modifier | true (Reason: This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request) | ||||||||
| Requirements |
Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain. |
||||||||
| Alternate Names | category | ||||||||
| Summary | true | ||||||||
| RequestGroup.priority | |||||||||
| Element Id | RequestGroup.priority | ||||||||
| Definition |
Indicates how quickly the request should be addressed with respect to other requests. |
||||||||
|
|
0..1 | ||||||||
| Terminology Binding |
|
||||||||
| Type | code | ||||||||
| Meaning if Missing | If missing, this request should be performed with normal priority | ||||||||
| Summary | true | ||||||||
| RequestGroup.code | |||||||||
| Element Id | RequestGroup.code | ||||||||
| Definition | A code that identifies what the overall request group is. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | true | ||||||||
| Comments | This element can be used to provide a code that captures the meaning of the request group as a whole, as opposed to the code of the action element, which captures the meaning of the individual actions within the request group. | ||||||||
| RequestGroup.subject | |||||||||
| Element Id | RequestGroup.subject | ||||||||
| Definition |
The subject for which the request group was created. |
||||||||
|
|
0..1 | ||||||||
| Type | Reference ( Patient | Group ) | ||||||||
|
|
|||||||||
| Element Id | RequestGroup.encounter | ||||||||
| Definition |
Describes the context of the request group, if any. |
||||||||
|
|
0..1 | ||||||||
| Type |
Reference
(
Encounter
|
||||||||
| RequestGroup.authoredOn | |||||||||
| Element Id | RequestGroup.authoredOn | ||||||||
| Definition |
Indicates when the request group was created. |
||||||||
|
|
0..1 | ||||||||
| Type | dateTime | ||||||||
| RequestGroup.author | |||||||||
| Element Id | RequestGroup.author | ||||||||
| Definition |
Provides a reference to the author of the request group. |
||||||||
|
|
0..1 | ||||||||
| Type | Reference ( Device | Practitioner | PractitionerRole ) | ||||||||
|
|
|||||||||
| Element Id | RequestGroup.reasonCode | ||||||||
| Definition |
|
||||||||
|
|
|
||||||||
| Type |
CodeableConcept
|
||||||||
|
| |||||||||
| Element Id | RequestGroup.reasonReference | ||||||||
| Definition | Indicates another resource whose existence justifies this request group. | ||||||||
|
Cardinality
|
0..* | ||||||||
|
|
|
||||||||
| RequestGroup.note | |||||||||
| Element Id | RequestGroup.note | ||||||||
| Definition |
Provides a mechanism to communicate additional information about the response. |
||||||||
|
|
0..* | ||||||||
| Type | Annotation | ||||||||
| RequestGroup.action | |||||||||
| Element Id | RequestGroup.action | ||||||||
| Definition |
The actions, if any, produced by the evaluation of the artifact. |
||||||||
|
|
0..* | ||||||||
| Invariants |
|
||||||||
|
|
|||||||||
| Element Id | RequestGroup.action.prefix | ||||||||
| Definition |
A
user-visible
|
||||||||
|
|
0..1 | ||||||||
| Type | string | ||||||||
| RequestGroup.action.title | |||||||||
| Element Id | RequestGroup.action.title | ||||||||
| Definition |
The title of the action displayed to a user. |
||||||||
|
|
0..1 | ||||||||
| Type | string | ||||||||
| RequestGroup.action.description | |||||||||
| Element Id | RequestGroup.action.description | ||||||||
| Definition |
A short description of the action used to provide a summary to display to the user. |
||||||||
|
|
0..1 | ||||||||
| Type | string | ||||||||
| Summary | true | ||||||||
| RequestGroup.action.textEquivalent | |||||||||
| Element Id | RequestGroup.action.textEquivalent | ||||||||
| Definition |
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
|
||||||||
|
|
0..1 | ||||||||
| Type | string | ||||||||
| Summary | true | ||||||||
| RequestGroup.action.priority | |||||||||
| Element Id | RequestGroup.action.priority | ||||||||
| Definition | Indicates how quickly the action should be addressed with respect to other actions. | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | Request priority ( Required ) | ||||||||
| Type | code | ||||||||
| RequestGroup.action.code | |||||||||
| Element Id | RequestGroup.action.code | ||||||||
| Definition |
A
code
that
provides
meaning
for
the
action
or
action
group.
For
example,
a
section
may
have
a
LOINC
code
for
a
|
||||||||
|
|
0..* | ||||||||
| Type | CodeableConcept | ||||||||
| RequestGroup.action.documentation | |||||||||
| Element Id | RequestGroup.action.documentation | ||||||||
| Definition |
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 resources. |
||||||||
|
|
0..* | ||||||||
| Type | RelatedArtifact | ||||||||
| RequestGroup.action.condition | |||||||||
| Element Id | RequestGroup.action.condition | ||||||||
| Definition |
An expression that describes applicability criteria, or start/stop conditions for the action. |
||||||||
|
|
0..* | ||||||||
| Comments | When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all of the conditions are true. | ||||||||
| RequestGroup.action.condition.kind | |||||||||
| Element Id | RequestGroup.action.condition.kind | ||||||||
| Definition |
The kind of condition. |
||||||||
|
|
1..1 | ||||||||
| Terminology Binding | ActionConditionKind ( Required ) | ||||||||
| Type | code | ||||||||
| Comments |
Applicability
criteria
are
used
to
determine
immediate
applicability
when
a
plan
definition
is
applied
to
a
given
context.
Start
and
stop
criteria
are
carried
through
application
and
used
to
describe
|
||||||||
|
|
|||||||||
|
|
|
||||||||
| Definition |
An expression that returns true or false, indicating whether or not the condition is satisfied. |
||||||||
|
|
0..1 | ||||||||
| Type |
|
||||||||
| Comments |
The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element. |
||||||||
| RequestGroup.action.relatedAction | |||||||||
| Element Id | RequestGroup.action.relatedAction | ||||||||
| Definition |
A
relationship
to
another
action
such
as
|
||||||||
|
|
0..* | ||||||||
| RequestGroup.action.relatedAction.actionId | |||||||||
| Element Id | RequestGroup.action.relatedAction.actionId | ||||||||
| Definition |
The element id of the action this is related to. |
||||||||
|
|
1..1 | ||||||||
| Type | id | ||||||||
| RequestGroup.action.relatedAction.relationship | |||||||||
| Element Id | RequestGroup.action.relatedAction.relationship | ||||||||
| Definition |
The relationship of this action to the related action. |
||||||||
|
|
1..1 | ||||||||
| Terminology Binding | ActionRelationshipType ( Required ) | ||||||||
| Type | code | ||||||||
| RequestGroup.action.relatedAction.offset[x] | |||||||||
| Element Id | RequestGroup.action.relatedAction.offset[x] | ||||||||
| Definition |
A duration or range of durations to apply to the relationship. For example, 30-60 minutes before. |
||||||||
|
|
0..1 | ||||||||
| Type | Duration | Range | ||||||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
| RequestGroup.action.timing[x] | |||||||||
| Element Id | RequestGroup.action.timing[x] | ||||||||
| Definition |
An optional value describing when the action should be performed. |
||||||||
|
|
0..1 | ||||||||
| Type | dateTime | Age | Period | Duration | Range | Timing | ||||||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
| RequestGroup.action.participant | |||||||||
| Element Id | RequestGroup.action.participant | ||||||||
| Definition |
The participant that should perform or be responsible for this action. |
||||||||
|
|
0..* | ||||||||
| Type |
Reference
(
Patient
|
|
||||||||
| RequestGroup.action.type | |||||||||
| Element Id | RequestGroup.action.type | ||||||||
| Definition |
The type of action to perform (create, update, remove). |
||||||||
|
|
0..1 | ||||||||
| Terminology Binding | ActionType ( Extensible ) | ||||||||
| Type |
|
||||||||
| RequestGroup.action.groupingBehavior | |||||||||
| Element Id | RequestGroup.action.groupingBehavior | ||||||||
| Definition |
Defines the grouping behavior for the action and its children. |
||||||||
|
|
0..1 | ||||||||
| Terminology Binding | ActionGroupingBehavior ( Required ) | ||||||||
| Type | code | ||||||||
| RequestGroup.action.selectionBehavior | |||||||||
| Element Id | RequestGroup.action.selectionBehavior | ||||||||
| Definition |
Defines the selection behavior for the action and its children. |
||||||||
|
|
0..1 | ||||||||
| Terminology Binding | ActionSelectionBehavior ( Required ) | ||||||||
| Type | code | ||||||||
| RequestGroup.action.requiredBehavior | |||||||||
| Element Id | RequestGroup.action.requiredBehavior | ||||||||
| Definition |
Defines
|
||||||||
|
|
0..1 | ||||||||
| Terminology Binding | ActionRequiredBehavior ( Required ) | ||||||||
| Type | code | ||||||||
| RequestGroup.action.precheckBehavior | |||||||||
| Element Id | RequestGroup.action.precheckBehavior | ||||||||
| Definition |
Defines whether the action should usually be preselected. |
||||||||
|
|
0..1 | ||||||||
| Terminology Binding | ActionPrecheckBehavior ( Required ) | ||||||||
| Type | code | ||||||||
| RequestGroup.action.cardinalityBehavior | |||||||||
| Element Id | RequestGroup.action.cardinalityBehavior | ||||||||
| Definition |
Defines whether the action can be selected multiple times. |
||||||||
|
|
0..1 | ||||||||
| Terminology Binding | ActionCardinalityBehavior ( Required ) | ||||||||
| Type | code | ||||||||
| RequestGroup.action.resource | |||||||||
| Element Id | RequestGroup.action.resource | ||||||||
| Definition |
The resource that is the target of the action (e.g. CommunicationRequest). |
||||||||
|
|
0..1 | ||||||||
| Type | Reference ( Any ) | ||||||||
| Comments |
The
target
resource
SHALL
be
a
Request
resource
with
a
Request.intent
set
to
|
||||||||
| Invariants |
|
||||||||
| RequestGroup.action.action | |||||||||
| Element Id | RequestGroup.action.action | ||||||||
| Definition |
Sub actions. |
||||||||
|
|
0..* | ||||||||
| Type | See RequestGroup.action | ||||||||
| Invariants |
|
||||||||