This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
This resource is marked as a draft.
Orders and Observations Work Group | Maturity Level: 0 | Compartments: Device, Encounter, Patient, Practitioner |
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.
These resources have not yet undergone proper review by PC, CQI, CDS, and OO. At this time, they are to be considered only as draft resource proposals for potential submission.
This resource is a request resource from a FHIR workflow perspective - see Workflow.
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 of the device to the patient or for use by the patient.
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.
Certain devices must be implanted via a surgical or other procedure. The data about the implantation or explantation is represented in the Procedure or ProcedureRequest resource, as appropriate. Some devices create observations. These observations are recorded as resources of type DeviceObservationReport.
This resource is referenced by CarePlan and ClinicalImpression
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceUseRequest | DomainResource | Medical device request | ||
identifier | Σ | 0..* | Identifier | Request identifier |
definition | Σ | 0..* | Reference(Any) | Protocol or definition |
basedOn | Σ | 0..* | Reference(Any) | What request fulfills |
replaces | Σ | 0..* | Reference(Any) | What request replaces |
requisition | Σ | 0..1 | Identifier | Identifier of composite request |
status | ?!Σ | 0..1 | code | draft | active | suspended | completed | entered-in-error | cancelled RequestStatus (Required) |
stage | ?!Σ | 1..1 | CodeableConcept | proposal | plan | original-order | encoded | reflex-order RequestStage (Extensible) |
device[x] | Σ | 1..1 | Device requested Device Types (Example) | |
deviceReference | Reference(Device) | |||
deviceCodeableConcept | CodeableConcept | |||
subject | Σ | 1..1 | Reference(Patient | Group | Location | Device) | Focus of request |
context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode motivating request |
occurrence[x] | Σ | 0..1 | Desired time or schedule for use | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
occurrenceTiming | Timing | |||
authored | Σ | 0..1 | dateTime | When recorded |
requester | Σ | 0..1 | Reference(Device | Practitioner | Organization) | Who/what is requesting diagnostics |
performerType | Σ | 0..1 | CodeableConcept | Fille role Participant Roles (Example) |
performer | Σ | 0..1 | Reference(Practitioner | Organization | Patient | Device | RelatedPerson) | Requested Filler |
reasonCode | Σ | 0..* | CodeableConcept | Coded Reason for request Condition/Problem/Diagnosis Codes (Example) |
reasonReference | Σ | 0..* | Reference(Any) | Linked Reason for request |
supportingInfo | 0..* | Reference(Any) | Additional clinical information | |
note | 0..* | Annotation | Notes or comments | |
relevantHistory | 0..* | Reference(Provenance) | Request provenance | |
Documentation for this format |
UML Diagram (Legend)
XML Template
<DeviceUseRequest xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Request identifier --></identifier> <definition><!-- 0..* Reference(Any) Protocol or definition --></definition> <basedOn><!-- 0..* Reference(Any) What request fulfills --></basedOn> <replaces><!-- 0..* Reference(Any) What request replaces --></replaces> <requisition><!-- 0..1 Identifier Identifier of composite request --></requisition> <status value="[code]"/><!-- 0..1 draft | active | suspended | completed | entered-in-error | cancelled --> <stage><!-- 1..1 CodeableConcept proposal | plan | original-order | encoded | reflex-order --></stage> <device[x]><!-- 1..1 Reference(Device)|CodeableConcept Device requested --></device[x]> <subject><!-- 1..1 Reference(Patient|Group|Location|Device) Focus of request --></subject> <context><!-- 0..1 Reference(Encounter|EpisodeOfCare) Encounter or Episode motivating request --></context> <occurrence[x]><!-- 0..1 dateTime|Period|Timing Desired time or schedule for use --></occurrence[x]> <authored value="[dateTime]"/><!-- 0..1 When recorded --> <requester><!-- 0..1 Reference(Device|Practitioner|Organization) Who/what is requesting diagnostics --></requester> <performerType><!-- 0..1 CodeableConcept Fille role --></performerType> <performer><!-- 0..1 Reference(Practitioner|Organization|Patient|Device| RelatedPerson) Requested Filler --></performer> <reasonCode><!-- 0..* CodeableConcept Coded Reason for request --></reasonCode> <reasonReference><!-- 0..* Reference(Any) Linked Reason for request --></reasonReference> <supportingInfo><!-- 0..* Reference(Any) Additional clinical information --></supportingInfo> <note><!-- 0..* Annotation Notes or comments --></note> <relevantHistory><!-- 0..* Reference(Provenance) Request provenance --></relevantHistory> </DeviceUseRequest>
JSON Template
{ "resourceType" : "DeviceUseRequest", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // Request identifier "definition" : [{ Reference(Any) }], // Protocol or definition "basedOn" : [{ Reference(Any) }], // What request fulfills "replaces" : [{ Reference(Any) }], // What request replaces "requisition" : { Identifier }, // Identifier of composite request "status" : "<code>", // draft | active | suspended | completed | entered-in-error | cancelled "stage" : { CodeableConcept }, // R! proposal | plan | original-order | encoded | reflex-order // device[x]: Device requested. One of these 2: "deviceReference" : { Reference(Device) }, "deviceCodeableConcept" : { CodeableConcept }, "subject" : { Reference(Patient|Group|Location|Device) }, // R! Focus of request "context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or Episode motivating request // occurrence[x]: Desired time or schedule for use. One of these 3: "occurrenceDateTime" : "<dateTime>", "occurrencePeriod" : { Period }, "occurrenceTiming" : { Timing }, "authored" : "<dateTime>", // When recorded "requester" : { Reference(Device|Practitioner|Organization) }, // Who/what is requesting diagnostics "performerType" : { CodeableConcept }, // Fille role "performer" : { Reference(Practitioner|Organization|Patient|Device| RelatedPerson) }, // Requested Filler "reasonCode" : [{ CodeableConcept }], // Coded Reason for request "reasonReference" : [{ Reference(Any) }], // Linked Reason for request "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:DeviceUseRequest; 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:DeviceUseRequest.identifier [ Identifier ], ... ; # 0..* Request identifier fhir:DeviceUseRequest.definition [ Reference(Any) ], ... ; # 0..* Protocol or definition fhir:DeviceUseRequest.basedOn [ Reference(Any) ], ... ; # 0..* What request fulfills fhir:DeviceUseRequest.replaces [ Reference(Any) ], ... ; # 0..* What request replaces fhir:DeviceUseRequest.requisition [ Identifier ]; # 0..1 Identifier of composite request fhir:DeviceUseRequest.status [ code ]; # 0..1 draft | active | suspended | completed | entered-in-error | cancelled fhir:DeviceUseRequest.stage [ CodeableConcept ]; # 1..1 proposal | plan | original-order | encoded | reflex-order # DeviceUseRequest.device[x] : 1..1 Device requested. One of these 2 fhir:DeviceUseRequest.deviceReference [ Reference(Device) ] fhir:DeviceUseRequest.deviceCodeableConcept [ CodeableConcept ] fhir:DeviceUseRequest.subject [ Reference(Patient|Group|Location|Device) ]; # 1..1 Focus of request fhir:DeviceUseRequest.context [ Reference(Encounter|EpisodeOfCare) ]; # 0..1 Encounter or Episode motivating request # DeviceUseRequest.occurrence[x] : 0..1 Desired time or schedule for use. One of these 3 fhir:DeviceUseRequest.occurrenceDateTime [ dateTime ] fhir:DeviceUseRequest.occurrencePeriod [ Period ] fhir:DeviceUseRequest.occurrenceTiming [ Timing ] fhir:DeviceUseRequest.authored [ dateTime ]; # 0..1 When recorded fhir:DeviceUseRequest.requester [ Reference(Device|Practitioner|Organization) ]; # 0..1 Who/what is requesting diagnostics fhir:DeviceUseRequest.performerType [ CodeableConcept ]; # 0..1 Fille role fhir:DeviceUseRequest.performer [ Reference(Practitioner|Organization|Patient|Device|RelatedPerson) ]; # 0..1 Requested Filler fhir:DeviceUseRequest.reasonCode [ CodeableConcept ], ... ; # 0..* Coded Reason for request fhir:DeviceUseRequest.reasonReference [ Reference(Any) ], ... ; # 0..* Linked Reason for request fhir:DeviceUseRequest.supportingInfo [ Reference(Any) ], ... ; # 0..* Additional clinical information fhir:DeviceUseRequest.note [ Annotation ], ... ; # 0..* Notes or comments fhir:DeviceUseRequest.relevantHistory [ Reference(Provenance) ], ... ; # 0..* Request provenance ]
Changes since DSTU2
DeviceUseRequest | |
DeviceUseRequest.definition | added |
DeviceUseRequest.basedOn | added |
DeviceUseRequest.replaces | added |
DeviceUseRequest.requisition | added |
DeviceUseRequest.status | Change value set from http://hl7.org/fhir/ValueSet/device-use-request-status to http://hl7.org/fhir/ValueSet/request-status |
DeviceUseRequest.stage | added |
DeviceUseRequest.device[x] |
Renamed from device to device[x] Add CodeableConcept |
DeviceUseRequest.subject | Add Reference(Group), Add Reference(Location), Add Reference(Device) |
DeviceUseRequest.context |
Renamed from encounter to context Add Reference(EpisodeOfCare) |
DeviceUseRequest.occurrence[x] | added |
DeviceUseRequest.authored | Renamed from orderedOn to authored |
DeviceUseRequest.requester | added |
DeviceUseRequest.performerType | added |
DeviceUseRequest.performer | added |
DeviceUseRequest.reasonCode | Renamed from indication to reasonCode |
DeviceUseRequest.reasonReference | added |
DeviceUseRequest.supportingInfo | added |
DeviceUseRequest.note |
Renamed from notes to note Type changed from string to Annotation |
DeviceUseRequest.relevantHistory | added |
DeviceUseRequest.bodySite[x] | deleted |
DeviceUseRequest.prnReason | deleted |
DeviceUseRequest.recordedOn | deleted |
DeviceUseRequest.timing[x] | deleted |
DeviceUseRequest.priority | deleted |
See the Full Difference for further information
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceUseRequest | DomainResource | Medical device request | ||
identifier | Σ | 0..* | Identifier | Request identifier |
definition | Σ | 0..* | Reference(Any) | Protocol or definition |
basedOn | Σ | 0..* | Reference(Any) | What request fulfills |
replaces | Σ | 0..* | Reference(Any) | What request replaces |
requisition | Σ | 0..1 | Identifier | Identifier of composite request |
status | ?!Σ | 0..1 | code | draft | active | suspended | completed | entered-in-error | cancelled RequestStatus (Required) |
stage | ?!Σ | 1..1 | CodeableConcept | proposal | plan | original-order | encoded | reflex-order RequestStage (Extensible) |
device[x] | Σ | 1..1 | Device requested Device Types (Example) | |
deviceReference | Reference(Device) | |||
deviceCodeableConcept | CodeableConcept | |||
subject | Σ | 1..1 | Reference(Patient | Group | Location | Device) | Focus of request |
context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode motivating request |
occurrence[x] | Σ | 0..1 | Desired time or schedule for use | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
occurrenceTiming | Timing | |||
authored | Σ | 0..1 | dateTime | When recorded |
requester | Σ | 0..1 | Reference(Device | Practitioner | Organization) | Who/what is requesting diagnostics |
performerType | Σ | 0..1 | CodeableConcept | Fille role Participant Roles (Example) |
performer | Σ | 0..1 | Reference(Practitioner | Organization | Patient | Device | RelatedPerson) | Requested Filler |
reasonCode | Σ | 0..* | CodeableConcept | Coded Reason for request Condition/Problem/Diagnosis Codes (Example) |
reasonReference | Σ | 0..* | Reference(Any) | Linked Reason for request |
supportingInfo | 0..* | Reference(Any) | Additional clinical information | |
note | 0..* | Annotation | Notes or comments | |
relevantHistory | 0..* | Reference(Provenance) | Request provenance | |
Documentation for this format |
XML Template
<DeviceUseRequest xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Request identifier --></identifier> <definition><!-- 0..* Reference(Any) Protocol or definition --></definition> <basedOn><!-- 0..* Reference(Any) What request fulfills --></basedOn> <replaces><!-- 0..* Reference(Any) What request replaces --></replaces> <requisition><!-- 0..1 Identifier Identifier of composite request --></requisition> <status value="[code]"/><!-- 0..1 draft | active | suspended | completed | entered-in-error | cancelled --> <stage><!-- 1..1 CodeableConcept proposal | plan | original-order | encoded | reflex-order --></stage> <device[x]><!-- 1..1 Reference(Device)|CodeableConcept Device requested --></device[x]> <subject><!-- 1..1 Reference(Patient|Group|Location|Device) Focus of request --></subject> <context><!-- 0..1 Reference(Encounter|EpisodeOfCare) Encounter or Episode motivating request --></context> <occurrence[x]><!-- 0..1 dateTime|Period|Timing Desired time or schedule for use --></occurrence[x]> <authored value="[dateTime]"/><!-- 0..1 When recorded --> <requester><!-- 0..1 Reference(Device|Practitioner|Organization) Who/what is requesting diagnostics --></requester> <performerType><!-- 0..1 CodeableConcept Fille role --></performerType> <performer><!-- 0..1 Reference(Practitioner|Organization|Patient|Device| RelatedPerson) Requested Filler --></performer> <reasonCode><!-- 0..* CodeableConcept Coded Reason for request --></reasonCode> <reasonReference><!-- 0..* Reference(Any) Linked Reason for request --></reasonReference> <supportingInfo><!-- 0..* Reference(Any) Additional clinical information --></supportingInfo> <note><!-- 0..* Annotation Notes or comments --></note> <relevantHistory><!-- 0..* Reference(Provenance) Request provenance --></relevantHistory> </DeviceUseRequest>
JSON Template
{ "resourceType" : "DeviceUseRequest", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // Request identifier "definition" : [{ Reference(Any) }], // Protocol or definition "basedOn" : [{ Reference(Any) }], // What request fulfills "replaces" : [{ Reference(Any) }], // What request replaces "requisition" : { Identifier }, // Identifier of composite request "status" : "<code>", // draft | active | suspended | completed | entered-in-error | cancelled "stage" : { CodeableConcept }, // R! proposal | plan | original-order | encoded | reflex-order // device[x]: Device requested. One of these 2: "deviceReference" : { Reference(Device) }, "deviceCodeableConcept" : { CodeableConcept }, "subject" : { Reference(Patient|Group|Location|Device) }, // R! Focus of request "context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or Episode motivating request // occurrence[x]: Desired time or schedule for use. One of these 3: "occurrenceDateTime" : "<dateTime>", "occurrencePeriod" : { Period }, "occurrenceTiming" : { Timing }, "authored" : "<dateTime>", // When recorded "requester" : { Reference(Device|Practitioner|Organization) }, // Who/what is requesting diagnostics "performerType" : { CodeableConcept }, // Fille role "performer" : { Reference(Practitioner|Organization|Patient|Device| RelatedPerson) }, // Requested Filler "reasonCode" : [{ CodeableConcept }], // Coded Reason for request "reasonReference" : [{ Reference(Any) }], // Linked Reason for request "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:DeviceUseRequest; 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:DeviceUseRequest.identifier [ Identifier ], ... ; # 0..* Request identifier fhir:DeviceUseRequest.definition [ Reference(Any) ], ... ; # 0..* Protocol or definition fhir:DeviceUseRequest.basedOn [ Reference(Any) ], ... ; # 0..* What request fulfills fhir:DeviceUseRequest.replaces [ Reference(Any) ], ... ; # 0..* What request replaces fhir:DeviceUseRequest.requisition [ Identifier ]; # 0..1 Identifier of composite request fhir:DeviceUseRequest.status [ code ]; # 0..1 draft | active | suspended | completed | entered-in-error | cancelled fhir:DeviceUseRequest.stage [ CodeableConcept ]; # 1..1 proposal | plan | original-order | encoded | reflex-order # DeviceUseRequest.device[x] : 1..1 Device requested. One of these 2 fhir:DeviceUseRequest.deviceReference [ Reference(Device) ] fhir:DeviceUseRequest.deviceCodeableConcept [ CodeableConcept ] fhir:DeviceUseRequest.subject [ Reference(Patient|Group|Location|Device) ]; # 1..1 Focus of request fhir:DeviceUseRequest.context [ Reference(Encounter|EpisodeOfCare) ]; # 0..1 Encounter or Episode motivating request # DeviceUseRequest.occurrence[x] : 0..1 Desired time or schedule for use. One of these 3 fhir:DeviceUseRequest.occurrenceDateTime [ dateTime ] fhir:DeviceUseRequest.occurrencePeriod [ Period ] fhir:DeviceUseRequest.occurrenceTiming [ Timing ] fhir:DeviceUseRequest.authored [ dateTime ]; # 0..1 When recorded fhir:DeviceUseRequest.requester [ Reference(Device|Practitioner|Organization) ]; # 0..1 Who/what is requesting diagnostics fhir:DeviceUseRequest.performerType [ CodeableConcept ]; # 0..1 Fille role fhir:DeviceUseRequest.performer [ Reference(Practitioner|Organization|Patient|Device|RelatedPerson) ]; # 0..1 Requested Filler fhir:DeviceUseRequest.reasonCode [ CodeableConcept ], ... ; # 0..* Coded Reason for request fhir:DeviceUseRequest.reasonReference [ Reference(Any) ], ... ; # 0..* Linked Reason for request fhir:DeviceUseRequest.supportingInfo [ Reference(Any) ], ... ; # 0..* Additional clinical information fhir:DeviceUseRequest.note [ Annotation ], ... ; # 0..* Notes or comments fhir:DeviceUseRequest.relevantHistory [ Reference(Provenance) ], ... ; # 0..* Request provenance ]
Changes since DSTU2
DeviceUseRequest | |
DeviceUseRequest.definition | added |
DeviceUseRequest.basedOn | added |
DeviceUseRequest.replaces | added |
DeviceUseRequest.requisition | added |
DeviceUseRequest.status | Change value set from http://hl7.org/fhir/ValueSet/device-use-request-status to http://hl7.org/fhir/ValueSet/request-status |
DeviceUseRequest.stage | added |
DeviceUseRequest.device[x] |
Renamed from device to device[x] Add CodeableConcept |
DeviceUseRequest.subject | Add Reference(Group), Add Reference(Location), Add Reference(Device) |
DeviceUseRequest.context |
Renamed from encounter to context Add Reference(EpisodeOfCare) |
DeviceUseRequest.occurrence[x] | added |
DeviceUseRequest.authored | Renamed from orderedOn to authored |
DeviceUseRequest.requester | added |
DeviceUseRequest.performerType | added |
DeviceUseRequest.performer | added |
DeviceUseRequest.reasonCode | Renamed from indication to reasonCode |
DeviceUseRequest.reasonReference | added |
DeviceUseRequest.supportingInfo | added |
DeviceUseRequest.note |
Renamed from notes to note Type changed from string to Annotation |
DeviceUseRequest.relevantHistory | added |
DeviceUseRequest.bodySite[x] | deleted |
DeviceUseRequest.prnReason | deleted |
DeviceUseRequest.recordedOn | deleted |
DeviceUseRequest.timing[x] | deleted |
DeviceUseRequest.priority | deleted |
See the Full Difference for further information
Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)
Path | Definition | Type | Reference |
---|---|---|---|
DeviceUseRequest.status | Codes representing the status of the request. | Required | RequestStatus |
DeviceUseRequest.stage | The kind of diagnostic request | Extensible | RequestStage |
DeviceUseRequest.device[x] | Codes for devices that can be requested | Example | Device Types |
DeviceUseRequest.performerType | Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | Example | Participant Roles |
DeviceUseRequest.reasonCode | Diagnosis or problem codes justifying the reason for requesting the device. | Example | Condition/Problem/Diagnosis Codes |
Notes to reviewers:
At this time, the code bindings are placeholders to be fleshed out upon further review by the community.
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 | Paths |
author-date | date | When the request transitioned to being actionable | DeviceUseRequest.authored |
based-on | reference | Plan/proposal/order fulfilled by this request | DeviceUseRequest.basedOn (Any) |
code | token | Code for what is being requested/ordered | DeviceUseRequest.deviceCodeableConcept |
definition | reference | Protocol or definition followed by this request | DeviceUseRequest.definition (Any) |
device | reference | Reference to resource that is being requested/ordered | DeviceUseRequest.deviceReference (Device) |
encounter | reference | Encounter or Episode during which request was created | DeviceUseRequest.context (EpisodeOfCare, Encounter) |
event-date | date | When service should occur | DeviceUseRequest.occurrenceDateTime, DeviceUseRequest.occurrencePeriod |
filler | reference | Desired performer for service | DeviceUseRequest.performer (Practitioner, Organization, Device, Patient, RelatedPerson) |
identifier | token | Business identifier for request/order | DeviceUseRequest.identifier |
patient | reference | Individual the service is ordered for | DeviceUseRequest.subject (Patient) |
replaces | reference | Request takes the place of referenced completed or terminated requests | DeviceUseRequest.replaces (Any) |
requester | reference | Who/what is requesting service | DeviceUseRequest.requester (Practitioner, Organization, Device) |
requisition | token | Composite request this is part of | DeviceUseRequest.requisition |
stage | token | proposal | plan | original-order |reflex-order | DeviceUseRequest.stage |
status | token | entered-in-error | draft | active |suspended | completed | DeviceUseRequest.status |
subject | reference | Individual the service is ordered for | DeviceUseRequest.subject (Group, Device, Patient, Location) |