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:
R5
R4B
R4
R3
R4
R3
FHIR
Infrastructure
![]() | Maturity Level : 1 | Informative |
Detailed
Descriptions
for
the
elements
in
the
request
resource.
pattern.
| Request | |
| Definition |
A pattern to be followed by resources that represent a specific proposal, plan and/or order for some sort of action or service. |
|
|
|
| Type | Logical |
| Request.identifier | |
| Definition |
|
| Note |
This
is
a
business
|
|
|
0..* |
| Type | Identifier |
| Requirements |
Allows
identification
of
the
|
| Summary | true |
| Comments |
The identifier.type element is used to distinguish between the identifiers assigned by the requester/placer and the performer/filler. Note: This is a business identifier, not a resource identifier (see discussion ). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. |
|
|
|
| Definition |
|
|
|
0..* |
| Type |
|
| Summary | true |
| Request.instantiatesUri | |
| Definition | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this {{title}}. |
| Cardinality | 0..* |
| Type | uri |
| Summary | true |
| Comments |
|
| Request.basedOn | |
| Definition |
A
plan,
proposal
or
order
that
is
fulfilled
in
whole
or
in
part
by
this
|
|
|
0..* |
| Type | Reference ( Request ) |
| Requirements |
Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon. |
| Alternate Names | fulfills |
| Summary | true |
| Comments |
[The allowed reference resources may be adjusted as appropriate for the request resource]. |
| Request.replaces | |
| Definition |
Completed
or
terminated
request(s)
whose
function
is
taken
by
this
new
|
|
|
0..* |
| Type | Reference ( Request ) |
| Requirements |
Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests. |
| Alternate Names | supersedes; prior; renewed order |
| Summary | true |
| 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. |
| Request.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
|
| Request.status | |
| Definition |
The
current
state
of
the
|
|
|
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 |
| Comments |
The
status
is
generally
fully
in
the
control
of
the
requester
-
they
determine
whether
the
order
is
draft
or
active
and,
after
it
has
been
activated,
completed,
cancelled
or
suspended.
States
relating
to
the
activities
of
the
performer
are
reflected
on
either
the
corresponding
Event
(s)
or
using
the
Task
resource.
A
nominal
state-transition
diagram
can
be
found
in
the
[[request.html#statemachine
|
Request
pattern]]
documentation
Unknown
does
not
represent
A status of completed for a "doNotPerform" request indicates that the period of non-performance is now satisfied and the request no longer holds. |
| To Do | Should this be a common code system for all requests? |
| Request.statusReason | |
| Definition | Captures the reason for the current state of the {{title}}. |
| Cardinality | 0..1 |
| Terminology Binding | RequestStatusReason : |
| Type | CodeableConcept |
| Alternate Names | Suspended Reason; Cancelled Reason |
| Comments | This is generally only used for "exception" statuses such as "suspended" or "cancelled". The reason why the {{title}} was created at all is captured in reasonCode, not here. [distinct reason codes for different statuses can be enforced using invariants if they are universal bindings]. |
| Request.intent | |
| Definition |
Indicates
the
level
of
authority/intentionality
associated
with
the
|
|
|
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 |
| Comments |
This element is expected to be immutable. E.g. A "proposal" instance should never change to be a "plan" instance or "order" instance. Instead, a new instance 'basedOn' the prior instance should be created with the new 'intent' value. One exception to this is that the granularity of Request.intent is allowed to change. For example, a Request identified as an "order" might later be clarified to be a "filler-order". Or, in rarer cases (to meet recipient constraints), the reverse might also occur.
When
resources
map
to
this
element,
they
are
free
to
define
as
many
codes
as
necessary
to
cover
their
space
and
will
map
to
|
| To Do | Should this be a common code system for all requests? |
| Request.priority | |
| Definition |
Indicates how quickly the {{title}} should be addressed with respect to other requests. |
|
|
0..1 |
| Terminology Binding | RequestPriority ( Required ) |
| Type | code |
| Meaning if Missing | If missing, this task should be performed with normal priority |
| Summary | true |
| Request.doNotPerform | |
| Definition | If true indicates that the {{title}} is asking for the specified action to not occur. |
| Cardinality | 0..1 |
| Type | boolean |
| Is Modifier | true (Reason: If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur.) |
| Meaning if Missing | If do not perform is not specified, the request is a positive request e.g. "do perform" |
| Requirements | Supports things like Do Not Recussitate, Nothing by mouth, etc. |
| Alternate Names | prohibited |
| Summary | true |
| Comments | The attributes provided with the request qualify what is not to be done. For example, if an effectiveTime is provided, the "do not" request only applies within the specified time. If a performerType is specified then the "do not" request only applies to performers of that type. Qualifiers include: code, subject, occurrence, perormerType and performer. In some cases, the Request.code may pre-coordinate prohibition into the requested action. E.g. "NPO" (nothing by mouth), "DNR" (do not recussitate). If this happens, doNotPerform SHALL NOT be set to true. I.e. The resource shall not have double negation. (E.g. "Do not DNR"). |
| Request.code | |
| Definition |
A
code
that
identifies
the
specific
service
or
action
being
|
|
|
0..1 |
| Terminology Binding | RequestCode : |
| Type | CodeableConcept |
| Alternate Names | type |
| Summary | true |
| Request.subject | |
| Definition |
The individual or set of individuals the action is to be performed/not performed on or for. |
|
|
1..1 |
| Type | Reference ( Patient | Group ) |
| Requirements |
Links the request to the Patient context. |
| Alternate Names | patient |
| Summary | true |
| Comments |
[For resources that aren't patient-specific, the set of allowed resources may be extended to include other things. Group should generally be retained unless there's certainty this resource won't be used for veterinary, research or public health settings where Group may be necessary (e.g. this cage of rats/crate of chickens, group of people in a 5 mile radious of the incident, etc.)]. |
| To Do | For mapping, is it better if we make this Any and then constrain it down? |
|
|
|
| Definition |
The
|
|
|
0..1 |
| Type |
Reference
(
Encounter
|
| Requirements |
Links
the
|
| Alternate Names |
|
| Summary | true |
| Comments |
This
will
typically
be
the
encounter
the
request
was
created
during,
but
some
requests
may
be
initiated
prior
to
or
after
the
official
completion
of
an
encounter
|
| Request.occurrence[x] | |
| Definition |
The date or time(s) at which the activity or service is desired to occur or not occur. |
|
|
0..1 |
| Type | dateTime | Period | Timing |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Alternate Names | timing |
| Summary | true |
| Comments |
[The list of types may be constrained as appropriate for the type of event]. |
| Request.authoredOn | |
| Definition |
For
draft
|
|
|
0..1 |
| Type | dateTime |
| Alternate Names | createdOn; signedOn |
| Summary | true |
| To Do |
Do
we
need
a
|
| Request.requester | |
| Definition |
|
|
|
0..1 |
| Type | Reference ( Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device ) |
| Alternate Names | author |
| Summary | true |
| Comments |
[Resources
may
choose
to
|
|
|
|
| Definition |
|
|
|
|
| Type |
boolean
|
Reference
(
|
|
|
|
|
|
|
| Alternate Names |
|
| Summary | true |
| Request.performerType | |
| Definition |
The
type
of
individual
that
is
desired
to
act
upon/
not
act
upon
the
|
|
|
0..1 |
| Terminology Binding | PerformerType : |
| Type | CodeableConcept |
| Summary | true |
| Comments |
If
|
| To Do | Need to define who.performer. |
| Request.performer | |
| Definition |
Indicates
who
or
what
is
being
asked
to
perform
(or
not
perform)
the
|
|
|
0..1 |
| Type | Reference ( Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson ) |
| Summary | true |
| Request.reasonCode | |
| Definition |
Describes why the request is being made in coded or textual form. |
|
|
0..* |
| Terminology Binding | RequestReason : |
| Type | CodeableConcept |
| Summary | true |
| Comments |
Textual
reasons
can
be
|
| Request.reasonReference | |
| Definition |
Indicates another resource whose existence justifies this request. |
|
|
0..* |
| Type | Reference ( Condition | Observation | DiagnosticReport | DocumentReference ) |
| Summary | true |
| Comments |
[Additional resources may be added as appropriate]. |
| Request.insurance | |
| Definition | Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant in delivering the requested service. |
| Cardinality | 0..* |
| Type | Reference ( Coverage | ClaimResponse ) |
| Request.supportingInfo | |
| Definition |
Information
that
may
be
needed
by/relevant
to
the
performer
in
their
execution
of
this
|
|
|
0..* |
| Type | Reference ( Any ) |
| Request.note | |
| Definition |
Comments
made
about
the
|
|
|
0..* |
| Type | Annotation |
| Request.relevantHistory | |
| Definition |
Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource. |
|
|
0..* |
| Type | Reference ( Provenance ) |
| Alternate Names | eventHistory |
| Comments |
This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude. Referenced provenances should adhere to the provenance-relevant-history profile. |