This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
v6.0.0-ballot4:
Release
6
Ballot
(1st
Full
Ballot)
(see
Ballot
Notes
)
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
for
published
versions
.
Page
versions:
R5
R4B
R4
R3
Responsible
Owner:
Orders
and
Observations
Work
Group
|
|
Security Category : Patient | Compartments : Device , Encounter , Group , Patient , Practitioner , RelatedPerson |
Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.
Note to Balloters: To ensure the DeviceRequest resource is ready for Normative status, we are seeking ballot comments on the substantive content. The key changes made since R5 include:
- DeviceRequest.instantiatesCanonical and DeviceRequest.instantiatesUri have been removed and are replaced with the workflow instantiation extensions .
- DeviceRequest.code was renamed DeviceRequest.product to follow the request workflow pattern.
- Added DeviceRequest.location.
- Updates to search parameters to address the changes.
This
resource
describes
the
request
for
the
use
of
a
device
by
a
patient.
The
device
may
be
any
pertinent
device
specified
in
the
Device
resource.
Examples
of
devices
that
may
be
requested
include
wheelchair,
hearing
aids,
or
an
insulin
pump.
The
request
may
lead
to
the
dispensing
delivery
of
the
device
to
the
patient
directly,
or
to,
e.g.,
a
surgery
suite
for
use
by
the
patient.
an
implantation
procedure.
The device use request may represent an order or a prescription entered by a practitioner in a CPOE system or a proposal made by a clinical decision support (CDS) system based on a patient's clinical record and context of care.
This
resource
deals
with
the
allocation
of
a
device
to
a
patient
and
while
it
may
contain
instructions
on
how
to
use
the
device,
the
data
about
getting
the
device
to
the
patient
is
addressed
in
other
resources.
For
example,
certain
when
requesting
an
oxygen
pump
for
home
use
instructions
on
how
to
use
it
may
be
included.
For
devices
that
must
be
implanted
via
a
surgical
or
other
procedure
and
the
implantation
or
explantation
is
represented
in
the
[Procedure](procedure.html)
or
[ServiceRequest](servicerequest.html)
Procedure
resource.
The
SupplyRequest
DeviceRequest
resource
is
similar
in
that
it
deals
with
requesting
a
particular
item
represents
an
authorization
for
a
specific
patient.
However,
DeviceRequest
is
concerned
device
to
be
provided.
Details
about
the
fulfillment
of
the
authorization
are
handled
by
the
Task
resource.
For
further
information
about
this
separation
of
responsibilities,
refer
to
the
Fulfillment/Execution
section
of
the
Request
pattern.
VisionPrescription
may
appear
to
overlap
with
items
where
DeviceRequest,
but
not
completely
as
there
is
are
specific
vision
lens
specification
details
that
are
present
in
VisionPrescription.
To
illustrate
this,
the
devicerequest-left-lens
and
devicerequest-right-lens
examples
are
based
on
the
general
glasses
example
.
To
determine
the
purchase
date,
a
patient
focus,
search
of
DeviceRequest,
SupplyRequest,
DeviceDispense,
or
instructions
regarding
their
use,
whereas
SupplyRequest
SupplyDelivery
as
defined
in
an
implementation
guide
can
be
done,
as
the
context
of
the
use
case
actually
determines
which
date
of
either
resource
is
concerned
with
inventory
management.
considered
the
purchase
date.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
|
|
DomainResource |
Medical
device
request
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
External
Request
identifier
|
|
Σ | 0..* | Reference ( Any ) |
What
request
fulfills
|
|
Σ | 0..* |
Reference
(
|
What
request
replaces
|
|
Σ | 0..1 | Identifier |
Identifier
of
composite
request
|
|
?! Σ | 0..1 | code |
draft
|
active
|
on-hold
|
Binding: RequestStatus ( Required ) |
|
?! Σ | 1..1 | code |
proposal
|
solicit-offer
|
offer-response
|
plan
|
directive
|
order
|
original-order
|
reflex-order
|
filler-order
|
instance-order
|
option
Binding: RequestIntent ( Required ) |
|
Σ | 0..1 | code |
routine
|
urgent
|
asap
|
stat
|
|
?! Σ | 0..1 | boolean |
True
if
the
request
is
to
stop
or
not
to
start
using
the
device
|
|
Σ | 1..1 |
Device
requested
|
|
|
CodeableConcept | |||
| Reference ( Device ) | |||
|
canonical ( DeviceDefinition ) | |||
|
0..1 | integer |
Quantity
of
devices
to
supply
|
|
|
0..* | BackboneElement |
Device
details
|
|
|
0..1 | CodeableConcept |
Device
detail
Binding: Request OrderDetail Parameter Code ( Example ) |
|
|
0..1 |
Value
of
detail
|
||
|
CodeableConcept | |||
|
Quantity | |||
|
Range | |||
|
boolean | |||
|
Σ | 1..1 | Reference ( Patient | Group | Location | Device ) |
Focus
of
request
|
|
Σ | 0..1 | Reference ( Encounter ) |
Encounter
motivating
request
|
|
Σ | 0..1 |
Desired
time
or
schedule
for
use
|
|
|
dateTime | |||
|
Period | |||
|
Timing | |||
|
Σ | 0..1 | dateTime |
When
recorded
|
|
Σ | 0..1 |
Reference
(
Device
|
Practitioner
|
PractitionerRole
|
Organization
|
Who/what
submitted
the
device
request
|
|
Σ | 0..1 |
|
Requested
Filler
|
|
Σ | 0..* |
|
Requested
location
Binding: ServiceDeliveryLocationRoleType
|
|
Σ | 0..* |
|
Coded/Linked
Reason
for
request
Binding: Condition/Problem/Diagnosis Codes ( Example ) |
|
0..1 | boolean |
PRN
status
of
request
|
|
| 0..1 | CodeableConcept |
Device
usage
reason
| |
![]() ![]() | 0..* | Reference ( Coverage | ClaimResponse ) |
Associated
insurance
coverage
|
|
|
0..* | Reference ( Any ) |
Additional
clinical
information
|
|
|
0..* | Annotation |
Notes
or
comments
|
|
|
0..* | Reference ( Provenance ) |
Request
provenance
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
UML Diagram ( Legend )
XML Template
<DeviceRequest xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier External Request identifier --></identifier>
<</instantiatesCanonical> <<basedOn><!-- 0..* Reference(Any) What request fulfills --></basedOn><</priorRequest> <</groupIdentifier> < < < <</code[x]><replaces><!-- 0..* Reference(DeviceRequest) What request replaces --></replaces> <groupIdentifier><!-- 0..1 Identifier Identifier of composite request --></groupIdentifier> <status value="[code]"/><!-- 0..1 draft | active | on-hold | entered-in-error | ended | completed | revoked | unknown --> <intent value="[code]"/><!-- 1..1 proposal | solicit-offer | offer-response | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option --> <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat --> <doNotPerform value="[boolean]"/><!-- 0..1 True if the request is to stop or not to start using the device --> <product[x]><!-- 1..1 CodeableConcept|Reference(Device)|canonical( DeviceDefinition) Device requested --></product[x]> <quantity value="[integer]"/><!-- 0..1 Quantity of devices to supply --> <parameter> <!-- 0..* Device details --><</code><code><!-- 0..1 CodeableConcept Device detail --></code> <value[x]><!-- 0..1 CodeableConcept|Quantity|Range|boolean Value of detail --></value[x]> </parameter><</subject><subject><!-- 1..1 Reference(Device|Group|Location|Patient) Focus of request --></subject> <encounter><!-- 0..1 Reference(Encounter) Encounter motivating request --></encounter> <occurrence[x]><!-- 0..1 dateTime|Period|Timing Desired time or schedule for use --></occurrence[x]> <authoredOn value="[dateTime]"/><!-- 0..1 When recorded --><</requester> <</performerType> <| </performer> <</reasonCode> <| </reasonReference> <</insurance><requester><!-- 0..1 Reference(CareTeam|Device|Group|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson) Who/what submitted the device request --></requester> <performer><!-- 0..1 CodeableReference(CareTeam|Device|HealthcareService| Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) Requested Filler --></performer> <location><!-- 0..* CodeableReference(Location) Requested location--></location> <reason><!-- 0..* CodeableReference(Condition|DiagnosticReport|DocumentReference| Observation) Coded/Linked Reason for request --></reason> <asNeeded value="[boolean]"/><!-- 0..1 PRN status of request --> <asNeededFor><!-- 0..1 CodeableConcept Device usage reason --></asNeededFor> <insurance><!-- 0..* Reference(ClaimResponse|Coverage) Associated insurance coverage --></insurance> <supportingInfo><!-- 0..* Reference(Any) Additional clinical information --></supportingInfo> <note><!-- 0..* Annotation Notes or comments --></note> <relevantHistory><!-- 0..* Reference(Provenance) Request provenance --></relevantHistory> </DeviceRequest>
JSON Template
{
"resourceType" : "DeviceRequest",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // External Request identifier
"
"
"basedOn" : [{ Reference(Any) }], // What request fulfills
"
"
"
"
"
" },
" },
"replaces" : [{ Reference(DeviceRequest) }], // What request replaces
"groupIdentifier" : { Identifier }, // Identifier of composite request
"status" : "<code>", // draft | active | on-hold | entered-in-error | ended | completed | revoked | unknown
"intent" : "<code>", // R! proposal | solicit-offer | offer-response | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
"priority" : "<code>", // routine | urgent | asap | stat
"doNotPerform" : <boolean>, // True if the request is to stop or not to start using the device
// product[x]: Device requested. One of these 3:
"productCodeableConcept" : { CodeableConcept },
"productReference" : { Reference(Device) },
"productCanonical" : "<canonical(DeviceDefinition)>",
"quantity" : <integer>, // Quantity of devices to supply
"parameter" : [{ // Device details
"
"code" : { CodeableConcept }, // Device detail
// value[x]: Value of detail. One of these 4:
" }
" }
" }
"valueCodeableConcept" : { CodeableConcept },
"valueQuantity" : { Quantity },
"valueRange" : { Range },
"valueBoolean" : <boolean>
}],
"
"subject" : { Reference(Device|Group|Location|Patient) }, // R! Focus of request
"encounter" : { Reference(Encounter) }, // Encounter motivating request
// occurrence[x]: Desired time or schedule for use. One of these 3:
"occurrenceDateTime" : "<dateTime>",
"occurrencePeriod" : { Period },
"occurrenceTiming" : { Timing },
"authoredOn" : "<dateTime>", // When recorded
"
"
"|
"
"|
"
"requester" : { Reference(CareTeam|Device|Group|Organization|Patient|
Practitioner|PractitionerRole|RelatedPerson) }, // Who/what submitted the device request
"performer" : { CodeableReference(CareTeam|Device|HealthcareService|
Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) }, // Requested Filler
"location" : [{ CodeableReference(Location) }], // Requested location
"reason" : [{ CodeableReference(Condition|DiagnosticReport|DocumentReference|
Observation) }], // Coded/Linked Reason for request
"asNeeded" : <boolean>, // PRN status of request
"asNeededFor" : { CodeableConcept }, // Device usage reason
"insurance" : [{ Reference(ClaimResponse|Coverage) }], // Associated insurance coverage
"supportingInfo" : [{ Reference(Any) }], // Additional clinical information
"note" : [{ Annotation }], // Notes or comments
"relevantHistory" : [{ Reference(Provenance) }] // Request provenance
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:DeviceRequest; fhir:nodeRole fhir:treeRoot; # if this is the parser root
# from # from fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: # . One of these 2 fhir:) ] fhir: ] fhir: fhir: # . One of these 4 fhir: ] fhir: ] fhir: ] fhir: ] ], ...; fhir: fhir: # . One of these 3 fhir: ] fhir: ] fhir: ] fhir: fhir: fhir: fhir:| fhir: fhir: fhir: fhir: fhir: fhir:# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:identifier ( [ Identifier ] ... ) ; # 0..* External Request identifier fhir:basedOn ( [ Reference(Any) ] ... ) ; # 0..* What request fulfills fhir:replaces ( [ Reference(DeviceRequest) ] ... ) ; # 0..* What request replaces fhir:groupIdentifier [ Identifier ] ; # 0..1 Identifier of composite request fhir:status [ code ] ; # 0..1 draft | active | on-hold | entered-in-error | ended | completed | revoked | unknown fhir:intent [ code ] ; # 1..1 proposal | solicit-offer | offer-response | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option fhir:priority [ code ] ; # 0..1 routine | urgent | asap | stat fhir:doNotPerform [ boolean ] ; # 0..1 True if the request is to stop or not to start using the device # product[x] : 1..1 Device requested. One of these 3 fhir:product [ a fhir:CodeableConcept ; CodeableConcept ] fhir:product [ a fhir:Reference ; Reference(Device) ] fhir:product [ a fhir:Canonical ; canonical(DeviceDefinition) ] fhir:quantity [ integer ] ; # 0..1 Quantity of devices to supply fhir:parameter ( [ # 0..* Device details fhir:code [ CodeableConcept ] ; # 0..1 Device detail # value[x] : 0..1 Value of detail. One of these 4 fhir:value [ a fhir:CodeableConcept ; CodeableConcept ] fhir:value [ a fhir:Quantity ; Quantity ] fhir:value [ a fhir:Range ; Range ] fhir:value [ a fhir:Boolean ; boolean ] ] ... ) ; fhir:subject [ Reference(Device|Group|Location|Patient) ] ; # 1..1 Focus of request fhir:encounter [ Reference(Encounter) ] ; # 0..1 Encounter motivating request # occurrence[x] : 0..1 Desired time or schedule for use. One of these 3 fhir:occurrence [ a fhir:DateTime ; dateTime ] fhir:occurrence [ a fhir:Period ; Period ] fhir:occurrence [ a fhir:Timing ; Timing ] fhir:authoredOn [ dateTime ] ; # 0..1 When recorded fhir:requester [ Reference(CareTeam|Device|Group|Organization|Patient|Practitioner|PractitionerRole| RelatedPerson) ] ; # 0..1 Who/what submitted the device request fhir:performer [ CodeableReference(CareTeam|Device|HealthcareService|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) ] ; # 0..1 Requested Filler fhir:location ( [ CodeableReference(Location) ] ... ) ; # 0..* Requested location fhir:reason ( [ CodeableReference(Condition|DiagnosticReport|DocumentReference|Observation) ] ... ) ; # 0..* Coded/Linked Reason for request fhir:asNeeded [ boolean ] ; # 0..1 PRN status of request fhir:asNeededFor [ CodeableConcept ] ; # 0..1 Device usage reason fhir:insurance ( [ Reference(ClaimResponse|Coverage) ] ... ) ; # 0..* Associated insurance coverage fhir:supportingInfo ( [ Reference(Any) ] ... ) ; # 0..* Additional clinical information fhir:note ( [ Annotation ] ... ) ; # 0..* Notes or comments fhir:relevantHistory ( [ Reference(Provenance) ] ... ) ; # 0..* Request provenance ]
Changes
since
R3
from
R5
to
R6
| DeviceRequest | |
|
|
|
|
|
|
|
|
|
|
|
|
| DeviceRequest.location |
|
| DeviceRequest.instantiatesCanonical |
|
| DeviceRequest.instantiatesUri |
|
Changes
from
CodeableConcept
R4
and
R4B
to
code
R6
| DeviceRequest | |
| DeviceRequest.replaces |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| DeviceRequest.requester |
|
| DeviceRequest.performer |
|
|
|
|
|
|
|
|
|
|
| DeviceRequest.asNeededFor |
|
|
|
|
| DeviceRequest.instantiatesUri |
|
|
|
|
|
|
|
|
|
|
See the Full Difference for further information
This
analysis
is
available
for
R4
as
XML
or
JSON
.
See
R3
<-->
R4
Conversion
Maps
(status
=
2
tests
that
all
execute
ok.
2
fail
round-trip
testing
and
1
r3
resources
are
invalid
(0
errors).
)
for
R4B
as
XML
or
JSON
.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
|
|
DomainResource |
Medical
device
request
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
External
Request
identifier
|
|
Σ | 0..* | Reference ( Any ) |
What
request
fulfills
|
|
Σ | 0..* |
Reference
(
|
What
request
replaces
|
|
Σ | 0..1 | Identifier |
Identifier
of
composite
request
|
|
?! Σ | 0..1 | code |
draft
|
active
|
on-hold
|
Binding: RequestStatus ( Required ) |
|
?! Σ | 1..1 | code |
proposal
|
solicit-offer
|
offer-response
|
plan
|
directive
|
order
|
original-order
|
reflex-order
|
filler-order
|
instance-order
|
option
Binding: RequestIntent ( Required ) |
|
Σ | 0..1 | code |
routine
|
urgent
|
asap
|
stat
|
|
?! Σ | 0..1 | boolean |
True
if
the
request
is
to
stop
or
not
to
start
using
the
device
|
|
Σ | 1..1 |
Device
requested
|
|
|
CodeableConcept | |||
| Reference ( Device ) | |||
|
canonical ( DeviceDefinition ) | |||
|
0..1 | integer |
Quantity
of
devices
to
supply
|
|
|
0..* | BackboneElement |
Device
details
|
|
|
0..1 | CodeableConcept |
Device
detail
Binding: Request OrderDetail Parameter Code ( Example ) |
|
|
0..1 |
Value
of
detail
|
||
|
CodeableConcept | |||
|
Quantity | |||
|
Range | |||
|
boolean | |||
|
Σ | 1..1 | Reference ( Patient | Group | Location | Device ) |
Focus
of
request
|
|
Σ | 0..1 | Reference ( Encounter ) |
Encounter
motivating
request
|
|
Σ | 0..1 |
Desired
time
or
schedule
for
use
|
|
|
dateTime | |||
|
Period | |||
|
Timing | |||
|
Σ | 0..1 | dateTime |
When
recorded
|
|
Σ | 0..1 |
Reference
(
Device
|
Practitioner
|
PractitionerRole
|
Organization
|
Who/what
submitted
the
device
request
|
|
Σ | 0..1 |
|
Requested
Filler
|
|
Σ | 0..* |
|
Requested
location
Binding: ServiceDeliveryLocationRoleType
|
|
Σ | 0..* |
|
Coded/Linked
Reason
for
request
Binding: Condition/Problem/Diagnosis Codes ( Example ) |
|
0..1 | boolean |
PRN
status
of
request
|
|
| 0..1 | CodeableConcept |
Device
usage
reason
| |
![]() ![]() | 0..* | Reference ( Coverage | ClaimResponse ) |
Associated
insurance
coverage
|
|
|
0..* | Reference ( Any ) |
Additional
clinical
information
|
|
|
0..* | Annotation |
Notes
or
comments
|
|
|
0..* | Reference ( Provenance ) |
Request
provenance
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
XML Template
<DeviceRequest xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier External Request identifier --></identifier>
<</instantiatesCanonical> <<basedOn><!-- 0..* Reference(Any) What request fulfills --></basedOn><</priorRequest> <</groupIdentifier> < < < <</code[x]><replaces><!-- 0..* Reference(DeviceRequest) What request replaces --></replaces> <groupIdentifier><!-- 0..1 Identifier Identifier of composite request --></groupIdentifier> <status value="[code]"/><!-- 0..1 draft | active | on-hold | entered-in-error | ended | completed | revoked | unknown --> <intent value="[code]"/><!-- 1..1 proposal | solicit-offer | offer-response | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option --> <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat --> <doNotPerform value="[boolean]"/><!-- 0..1 True if the request is to stop or not to start using the device --> <product[x]><!-- 1..1 CodeableConcept|Reference(Device)|canonical( DeviceDefinition) Device requested --></product[x]> <quantity value="[integer]"/><!-- 0..1 Quantity of devices to supply --> <parameter> <!-- 0..* Device details --><</code><code><!-- 0..1 CodeableConcept Device detail --></code> <value[x]><!-- 0..1 CodeableConcept|Quantity|Range|boolean Value of detail --></value[x]> </parameter><</subject><subject><!-- 1..1 Reference(Device|Group|Location|Patient) Focus of request --></subject> <encounter><!-- 0..1 Reference(Encounter) Encounter motivating request --></encounter> <occurrence[x]><!-- 0..1 dateTime|Period|Timing Desired time or schedule for use --></occurrence[x]> <authoredOn value="[dateTime]"/><!-- 0..1 When recorded --><</requester> <</performerType> <| </performer> <</reasonCode> <| </reasonReference> <</insurance><requester><!-- 0..1 Reference(CareTeam|Device|Group|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson) Who/what submitted the device request --></requester> <performer><!-- 0..1 CodeableReference(CareTeam|Device|HealthcareService| Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) Requested Filler --></performer> <location><!-- 0..* CodeableReference(Location) Requested location--></location> <reason><!-- 0..* CodeableReference(Condition|DiagnosticReport|DocumentReference| Observation) Coded/Linked Reason for request --></reason> <asNeeded value="[boolean]"/><!-- 0..1 PRN status of request --> <asNeededFor><!-- 0..1 CodeableConcept Device usage reason --></asNeededFor> <insurance><!-- 0..* Reference(ClaimResponse|Coverage) Associated insurance coverage --></insurance> <supportingInfo><!-- 0..* Reference(Any) Additional clinical information --></supportingInfo> <note><!-- 0..* Annotation Notes or comments --></note> <relevantHistory><!-- 0..* Reference(Provenance) Request provenance --></relevantHistory> </DeviceRequest>
JSON Template
{
"resourceType" : "DeviceRequest",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // External Request identifier
"
"
"basedOn" : [{ Reference(Any) }], // What request fulfills
"
"
"
"
"
" },
" },
"replaces" : [{ Reference(DeviceRequest) }], // What request replaces
"groupIdentifier" : { Identifier }, // Identifier of composite request
"status" : "<code>", // draft | active | on-hold | entered-in-error | ended | completed | revoked | unknown
"intent" : "<code>", // R! proposal | solicit-offer | offer-response | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
"priority" : "<code>", // routine | urgent | asap | stat
"doNotPerform" : <boolean>, // True if the request is to stop or not to start using the device
// product[x]: Device requested. One of these 3:
"productCodeableConcept" : { CodeableConcept },
"productReference" : { Reference(Device) },
"productCanonical" : "<canonical(DeviceDefinition)>",
"quantity" : <integer>, // Quantity of devices to supply
"parameter" : [{ // Device details
"
"code" : { CodeableConcept }, // Device detail
// value[x]: Value of detail. One of these 4:
" }
" }
" }
"valueCodeableConcept" : { CodeableConcept },
"valueQuantity" : { Quantity },
"valueRange" : { Range },
"valueBoolean" : <boolean>
}],
"
"subject" : { Reference(Device|Group|Location|Patient) }, // R! Focus of request
"encounter" : { Reference(Encounter) }, // Encounter motivating request
// occurrence[x]: Desired time or schedule for use. One of these 3:
"occurrenceDateTime" : "<dateTime>",
"occurrencePeriod" : { Period },
"occurrenceTiming" : { Timing },
"authoredOn" : "<dateTime>", // When recorded
"
"
"|
"
"|
"
"requester" : { Reference(CareTeam|Device|Group|Organization|Patient|
Practitioner|PractitionerRole|RelatedPerson) }, // Who/what submitted the device request
"performer" : { CodeableReference(CareTeam|Device|HealthcareService|
Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) }, // Requested Filler
"location" : [{ CodeableReference(Location) }], // Requested location
"reason" : [{ CodeableReference(Condition|DiagnosticReport|DocumentReference|
Observation) }], // Coded/Linked Reason for request
"asNeeded" : <boolean>, // PRN status of request
"asNeededFor" : { CodeableConcept }, // Device usage reason
"insurance" : [{ Reference(ClaimResponse|Coverage) }], // Associated insurance coverage
"supportingInfo" : [{ Reference(Any) }], // Additional clinical information
"note" : [{ Annotation }], // Notes or comments
"relevantHistory" : [{ Reference(Provenance) }] // Request provenance
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:DeviceRequest; fhir:nodeRole fhir:treeRoot; # if this is the parser root
# from # from fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: # . One of these 2 fhir:) ] fhir: ] fhir: fhir: # . One of these 4 fhir: ] fhir: ] fhir: ] fhir: ] ], ...; fhir: fhir: # . One of these 3 fhir: ] fhir: ] fhir: ] fhir: fhir: fhir: fhir:| fhir: fhir: fhir: fhir: fhir: fhir:# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:identifier ( [ Identifier ] ... ) ; # 0..* External Request identifier fhir:basedOn ( [ Reference(Any) ] ... ) ; # 0..* What request fulfills fhir:replaces ( [ Reference(DeviceRequest) ] ... ) ; # 0..* What request replaces fhir:groupIdentifier [ Identifier ] ; # 0..1 Identifier of composite request fhir:status [ code ] ; # 0..1 draft | active | on-hold | entered-in-error | ended | completed | revoked | unknown fhir:intent [ code ] ; # 1..1 proposal | solicit-offer | offer-response | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option fhir:priority [ code ] ; # 0..1 routine | urgent | asap | stat fhir:doNotPerform [ boolean ] ; # 0..1 True if the request is to stop or not to start using the device # product[x] : 1..1 Device requested. One of these 3 fhir:product [ a fhir:CodeableConcept ; CodeableConcept ] fhir:product [ a fhir:Reference ; Reference(Device) ] fhir:product [ a fhir:Canonical ; canonical(DeviceDefinition) ] fhir:quantity [ integer ] ; # 0..1 Quantity of devices to supply fhir:parameter ( [ # 0..* Device details fhir:code [ CodeableConcept ] ; # 0..1 Device detail # value[x] : 0..1 Value of detail. One of these 4 fhir:value [ a fhir:CodeableConcept ; CodeableConcept ] fhir:value [ a fhir:Quantity ; Quantity ] fhir:value [ a fhir:Range ; Range ] fhir:value [ a fhir:Boolean ; boolean ] ] ... ) ; fhir:subject [ Reference(Device|Group|Location|Patient) ] ; # 1..1 Focus of request fhir:encounter [ Reference(Encounter) ] ; # 0..1 Encounter motivating request # occurrence[x] : 0..1 Desired time or schedule for use. One of these 3 fhir:occurrence [ a fhir:DateTime ; dateTime ] fhir:occurrence [ a fhir:Period ; Period ] fhir:occurrence [ a fhir:Timing ; Timing ] fhir:authoredOn [ dateTime ] ; # 0..1 When recorded fhir:requester [ Reference(CareTeam|Device|Group|Organization|Patient|Practitioner|PractitionerRole| RelatedPerson) ] ; # 0..1 Who/what submitted the device request fhir:performer [ CodeableReference(CareTeam|Device|HealthcareService|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) ] ; # 0..1 Requested Filler fhir:location ( [ CodeableReference(Location) ] ... ) ; # 0..* Requested location fhir:reason ( [ CodeableReference(Condition|DiagnosticReport|DocumentReference|Observation) ] ... ) ; # 0..* Coded/Linked Reason for request fhir:asNeeded [ boolean ] ; # 0..1 PRN status of request fhir:asNeededFor [ CodeableConcept ] ; # 0..1 Device usage reason fhir:insurance ( [ Reference(ClaimResponse|Coverage) ] ... ) ; # 0..* Associated insurance coverage fhir:supportingInfo ( [ Reference(Any) ] ... ) ; # 0..* Additional clinical information fhir:note ( [ Annotation ] ... ) ; # 0..* Notes or comments fhir:relevantHistory ( [ Reference(Provenance) ] ... ) ; # 0..* Request provenance ]
Changes
since
Release
3
from
R5
to
R6
| DeviceRequest | |
|
|
|
|
|
|
|
|
|
|
|
|
| DeviceRequest.location |
|
| DeviceRequest.instantiatesCanonical |
|
| DeviceRequest.instantiatesUri |
|
Changes
from
CodeableConcept
R4
and
R4B
to
code
R6
| DeviceRequest | |
| DeviceRequest.replaces |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| DeviceRequest.requester |
|
| DeviceRequest.performer |
|
|
|
|
|
|
|
|
|
|
| DeviceRequest.asNeededFor |
|
|
|
|
|
|
|
| DeviceRequest.performerType |
|
|
|
|
|
|
|
See the Full Difference for further information
This
analysis
is
available
for
R4
as
XML
or
JSON
.
See
R3
<-->
R4
Conversion
Maps
(status
=
2
tests
that
all
execute
ok.
2
fail
round-trip
testing
and
1
r3
resources
are
invalid
(0
errors).
)
for
R4B
as
XML
or
JSON
.
See
the
Profiles
&
Extensions
and
the
alternate
Additional
definitions:
Master
Definition
XML
+
JSON
,
XML
Schema
/
Schematron
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
the
extensions
,
the
spreadsheet
version
&
the
dependency
analysis
| Path |
|
Type |
|
|---|---|---|---|
| DeviceRequest.status |
|
Required |
Codes identifying the lifecycle stage of a request. |
| DeviceRequest.intent |
|
Required |
Codes indicating the degree of authority/intentionality associated with a request. |
| DeviceRequest.priority | RequestPriority | Required |
Identifies
the
level
of
importance
to
be
assigned
to
actioning
the
request.
|
| DeviceRequest.product[x] |
|
Example |
Codes used to identify medical devices. Includes concepts from SNOMED CT (http://www.snomed.org/) where concept is-a 49062001 (Device) and is provided as a suggestive example. |
| DeviceRequest.parameter.code |
|
Example |
The order detail parameter codes. |
| DeviceRequest.location |
![]() |
Example |
A role of a place that further classifies the setting (e.g., accident site, road side, work site, community location) in which services are delivered. |
|
|
|
Example |
Example value set for Condition/Problem/Diagnosis codes. |
Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to 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 |
| authored-on | date | When the request transitioned to being actionable | DeviceRequest.authoredOn | |
| based-on | reference | Plan/proposal/order fulfilled by this request |
DeviceRequest.basedOn
(Any) |
|
|
|
reference | Reference to resource that is being requested/ordered |
( Device , DeviceDefinition ) |
|
| encounter | reference | Encounter during which request was created |
DeviceRequest.encounter
( Encounter ) |
|
| event-date | date | When service should occur |
|
|
| group-identifier | token | Composite request this is part of | DeviceRequest.groupIdentifier | |
| identifier | token | Business identifier for request/order | DeviceRequest.identifier |
|
|
|
reference |
|
( |
|
|
|
|
|
|
|
|
|
token |
|
|
|
| patient | reference | Individual the service is ordered for |
DeviceRequest.subject.where(resolve()
is
Patient)
( Patient ) |
|
| performer | reference | Desired performer for service |
| |
|
|
token | Desired performer for service | DeviceRequest.performer.concept | |
| prior-request | reference | Request takes the place of referenced completed or terminated requests |
|
|
| product | token | Code for what is being requested/ordered | DeviceRequest.product.ofType(CodeableConcept) | |
| requester | reference | Who/what is requesting service |
DeviceRequest.requester
( Practitioner , Group , Organization , CareTeam , Device , Patient , PractitionerRole , RelatedPerson ) |
|
| status | token | entered-in-error | draft | active |suspended | completed | DeviceRequest.status | |
| subject | reference | Individual the service is ordered for |
DeviceRequest.subject
( Group , Device , Patient , Location ) |