FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Orders and Observations icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Patient Compartments: Device, Encounter, Patient, Practitioner

Detailed Descriptions for the elements in the DeviceRequest resource.

DeviceRequest
Element IdDeviceRequest
Definition

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.

Short DisplayMedical device request
Cardinality0..*
TypeDomainResource
Summaryfalse
DeviceRequest.identifier
Element IdDeviceRequest.identifier
Definition

Identifiers assigned to this order by the orderer or by the receiver.

Short DisplayExternal Request identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Summarytrue
DeviceRequest.instantiatesCanonical
Element IdDeviceRequest.instantiatesCanonical
Definition

The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.

Short DisplayInstantiates FHIR protocol or definition
Cardinality0..*
Typecanonical(ActivityDefinition | PlanDefinition)
Summarytrue
Comments

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.

DeviceRequest.instantiatesUri
Element IdDeviceRequest.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 DeviceRequest.

Short DisplayInstantiates external protocol or definition
Cardinality0..*
Typeuri
Summarytrue
Comments

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

DeviceRequest.basedOn
Element IdDeviceRequest.basedOn
Definition

Plan/proposal/order fulfilled by this request.

Short DisplayWhat request fulfills
Cardinality0..*
TypeReference(Any)
Summarytrue
DeviceRequest.replaces
Element IdDeviceRequest.replaces
Definition

The request takes the place of the referenced completed or terminated request(s).

Short DisplayWhat request replaces
Cardinality0..*
TypeReference(DeviceRequest)
Summarytrue
DeviceRequest.groupIdentifier
Element IdDeviceRequest.groupIdentifier
Definition

A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.

Short DisplayIdentifier of composite request
Cardinality0..1
TypeIdentifier
Summarytrue
DeviceRequest.status
Element IdDeviceRequest.status
Definition

The status of the request.

Short Displaydraft | active | on-hold | revoked | completed | entered-in-error | unknown
Cardinality0..1
Terminology BindingRequestStatus (Required)
Typecode
Is Modifiertrue (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)
Summarytrue
Comments

This element is labeled as a modifier because the status contains the codes revoked and entered-in-error that mark the request as not currently valid.

DeviceRequest.intent
Element IdDeviceRequest.intent
Definition

Whether the request is a proposal, plan, an original order or a reflex order.

Short Displayproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Cardinality1..1
Terminology BindingRequestIntent (Required)
Typecode
Is Modifiertrue (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)
Summarytrue
DeviceRequest.priority
Element IdDeviceRequest.priority
Definition

Indicates how quickly the request should be addressed with respect to other requests.

Short Displayroutine | urgent | asap | stat
Cardinality0..1
Terminology BindingRequestPriority (Required)
Typecode
Meaning if MissingIf missing, normal priority
Summarytrue
DeviceRequest.doNotPerform
Element IdDeviceRequest.doNotPerform
Definition

If true, indicates that the provider is asking for the patient to either stop using or to not start using the specified device or category of devices. For example, the patient has undergone surgery and the provider is indicating that the patient should not wear contact lenses.

Short DisplayTrue if the request is to stop or not to start using the device
Cardinality0..1
Typeboolean
Is Modifiertrue (Reason: This element is labeled as a modifier because this element negates the request to occur (ie, this is a request for the medication not to be ordered or prescribed, etc.))
Summarytrue
Comments

If do not perform is not specified, the request is a positive request e.g. "do perform". DeviceRequest.reasonCode includes the reason for marking the DeviceRequest as 'do not perform'.

DeviceRequest.code
Element IdDeviceRequest.code
Definition

The details of the device to be used.

Short DisplayDevice requested
Cardinality1..1
Terminology BindingDevice Type (Example)
TypeCodeableReference(Device | DeviceDefinition)
Summarytrue
DeviceRequest.quantity
Element IdDeviceRequest.quantity
Definition

The number of devices to be provided.

Short DisplayQuantity of devices to supply
Cardinality0..1
Typeinteger
Summaryfalse
DeviceRequest.parameter
Element IdDeviceRequest.parameter
Definition

Specific parameters for the ordered item. For example, the prism value for lenses.

Short DisplayDevice details
Cardinality0..*
Summaryfalse
DeviceRequest.parameter.code
Element IdDeviceRequest.parameter.code
Definition

A code or string that identifies the device detail being asserted.

Short DisplayDevice detail
Cardinality0..1
Terminology BindingParameterCode:
TypeCodeableConcept
Summaryfalse
DeviceRequest.parameter.value[x]
Element IdDeviceRequest.parameter.value[x]
Definition

The value of the device detail.

Short DisplayValue of detail
Cardinality0..1
TypeCodeableConcept|Quantity|Range|boolean
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
Comments

Range means device should have a value that falls somewhere within the specified range.

DeviceRequest.subject
Element IdDeviceRequest.subject
Definition

The patient who will use the device.

Short DisplayFocus of request
Cardinality1..1
TypeReference(Patient | Group | Location | Device)
Summarytrue
DeviceRequest.encounter
Element IdDeviceRequest.encounter
Definition

An encounter that provides additional context in which this request is made.

Short DisplayEncounter motivating request
Cardinality0..1
TypeReference(Encounter)
Summarytrue
DeviceRequest.occurrence[x]
Element IdDeviceRequest.occurrence[x]
Definition

The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".

Short DisplayDesired time or schedule for use
Cardinality0..1
TypedateTime|Period|Timing
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
DeviceRequest.authoredOn
Element IdDeviceRequest.authoredOn
Definition

When the request transitioned to being actionable.

Short DisplayWhen recorded
Cardinality0..1
TypedateTime
Summarytrue
DeviceRequest.requester
Element IdDeviceRequest.requester
Definition

The individual or entity who initiated the request and has responsibility for its activation.

Short DisplayWho/what submitted the device request
Cardinality0..1
TypeReference(Device | Practitioner | PractitionerRole | Organization)
Summarytrue
DeviceRequest.performer
Element IdDeviceRequest.performer
Definition

The desired individual or entity to provide the device to the subject of the request (e.g., patient, location).

Short DisplayRequested Filler
Cardinality0..1
TypeCodeableReference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)
Summarytrue
DeviceRequest.reason
Element IdDeviceRequest.reason
Definition

Reason or justification for the use of this device.

Short DisplayCoded/Linked Reason for request
Cardinality0..*
Terminology BindingCondition/Problem/Diagnosis Codes (Example)
TypeCodeableReference(Condition | Observation | DiagnosticReport | DocumentReference)
Summarytrue
DeviceRequest.asNeeded
Element IdDeviceRequest.asNeeded
Definition

This status is to indicate whether the request is a PRN or may be given as needed.

Short DisplayPRN status of request
Cardinality0..1
Typeboolean
Summaryfalse
DeviceRequest.asNeededFor
Element IdDeviceRequest.asNeededFor
Definition

The reason for using the device.

Short DisplayDevice usage reason
Cardinality0..1
TypeCodeableConcept
Summaryfalse
DeviceRequest.insurance
Element IdDeviceRequest.insurance
Definition

Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.

Short DisplayAssociated insurance coverage
Cardinality0..*
TypeReference(Coverage | ClaimResponse)
Summaryfalse
DeviceRequest.supportingInfo
Element IdDeviceRequest.supportingInfo
Definition

Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body the device will be used (i.e. the target site).

Short DisplayAdditional clinical information
Cardinality0..*
TypeReference(Any)
Requirements

Knowing where the device is targeted is important for tracking if multiple sites are possible.

Summaryfalse
DeviceRequest.note
Element IdDeviceRequest.note
Definition

Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.

Short DisplayNotes or comments
Cardinality0..*
TypeAnnotation
Summaryfalse
DeviceRequest.relevantHistory
Element IdDeviceRequest.relevantHistory
Definition

Key events in the history of the request.

Short DisplayRequest provenance
Cardinality0..*
TypeReference(Provenance)
Summaryfalse
Comments

This might not include provenances for all versions of the request - only those deemed "relevant" or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a "relevant" change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.