Release 4B Ballot #1

This page is part of the FHIR Specification v4.1.0: R4B Ballot. About the R4B version of FHIR. 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

Orders and Observations 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.

Cardinality0..*
TypeDomainResource
Summaryfalse
DeviceRequest.identifier
Element IdDeviceRequest.identifier
Definition

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

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.

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.

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.

Cardinality0..*
TypeReference(Any)
Summarytrue
DeviceRequest.priorRequest
Element IdDeviceRequest.priorRequest
Definition

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

Cardinality0..*
TypeReference(Any)
Summarytrue
DeviceRequest.groupIdentifier
Element IdDeviceRequest.groupIdentifier
Definition

Composite request this is part of.

Cardinality0..1
TypeIdentifier
Summarytrue
DeviceRequest.status
Element IdDeviceRequest.status
Definition

The status of the request.

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 cancelled 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.

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 {{title}} should be addressed with respect to other requests.

Cardinality0..1
Terminology BindingRequestPriority (Required)
Typecode
Meaning if MissingIf missing, normal priority
Summarytrue
DeviceRequest.code[x]
Element IdDeviceRequest.code[x]
Definition

The details of the device to be used.

Cardinality1..1
Terminology BindingFHIR Device Types (Example)
TypeReference(Device)|CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
DeviceRequest.parameter
Element IdDeviceRequest.parameter
Definition

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

Cardinality0..*
Summaryfalse
DeviceRequest.parameter.code
Element IdDeviceRequest.parameter.code
Definition

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

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

The value of the device detail.

Cardinality0..1
TypeCodeableConcept|Quantity|Range|boolean
[x] NoteSee Choice of Data Types 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.

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.

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".

Cardinality0..1
TypedateTime|Period|Timing
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
DeviceRequest.authoredOn
Element IdDeviceRequest.authoredOn
Definition

When the request transitioned to being actionable.

Cardinality0..1
TypedateTime
Summarytrue
DeviceRequest.requester
Element IdDeviceRequest.requester
Definition

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

Cardinality0..1
TypeReference(Device | Practitioner | PractitionerRole | Organization)
Summarytrue
DeviceRequest.performerType
Element IdDeviceRequest.performerType
Definition

Desired type of performer for doing the diagnostic testing.

Cardinality0..1
Terminology BindingParticipant Roles (Example)
TypeCodeableConcept
Summarytrue
DeviceRequest.performer
Element IdDeviceRequest.performer
Definition

The desired performer for doing the diagnostic testing.

Cardinality0..1
TypeReference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)
Summarytrue
DeviceRequest.reasonCode
Element IdDeviceRequest.reasonCode
Definition

Reason or justification for the use of this device.

Cardinality0..*
Terminology BindingCondition/Problem/Diagnosis Codes (Example)
TypeCodeableConcept
Summarytrue
DeviceRequest.reasonReference
Element IdDeviceRequest.reasonReference
Definition

Reason or justification for the use of this device.

Cardinality0..*
TypeReference(Condition | Observation | DiagnosticReport | DocumentReference)
Summarytrue
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.

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).

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.

Cardinality0..*
TypeAnnotation
Summaryfalse
DeviceRequest.relevantHistory
Element IdDeviceRequest.relevantHistory
Definition

Key events in the history of the request.

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.