View raw Markdown
type: resource-definitionsresource: DeviceRequest

DeviceRequest Definitions

<a id="DeviceRequest"></a>

DeviceRequest

Medical device request

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.

Cardinality: 0..*

Mappings: workflow=Request; v2=ORC; rim=Act[moodCode<=INT]; w5=workflow.order

<a id="DeviceRequest.identifier"></a>

DeviceRequest.identifier

External Request identifier

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

Cardinality: 0..*

Type: Identifier

Summary: true

Mappings: workflow=Request.identifier; w5=FiveWs.identifier; v2=ORC.2, ORC.3; rim=.identifier; quick=ClinicalStatement.identifier

<a id="DeviceRequest.basedOn"></a>

DeviceRequest.basedOn

What request fulfills

Definition: Plan/proposal/order fulfilled by this request.

Cardinality: 0..*

Type: Reference(Resource)

Summary: true

Mappings: workflow=Request.basedOn; v2=ORC.8 (plus others); rim=.outboundRelationship[typeCode=FLFS].target; quick=Proposal.prnReason.reason

<a id="DeviceRequest.replaces"></a>

DeviceRequest.replaces

What request replaces

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

Cardinality: 0..*

Type: Reference(DeviceRequest)

Summary: true

Mappings: workflow=Request.replaces; v2=Handled by message location of ORC (ORC.1=RO or RU); rim=.outboundRelationship[typeCode=RPLC].target

<a id="DeviceRequest.groupIdentifier"></a>

DeviceRequest.groupIdentifier

Identifier of composite request

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.

Cardinality: 0..1

Type: Identifier

Summary: true

Mappings: workflow=Request.groupIdentifier; v2=ORC.4; rim=.inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier

<a id="DeviceRequest.status"></a>

DeviceRequest.status

draft | active | on-hold | entered-in-error | ended | completed | revoked | unknown

Definition: The status of the request.

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.

Cardinality: 0..1

Type: code

Binding: required:request-status

Summary: true

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)

Mappings: workflow=Request.status; w5=FiveWs.status; v2=ORC.5; rim=.status; quick=Action.currentStatus

<a id="DeviceRequest.intent"></a>

DeviceRequest.intent

proposal | solicit-offer | offer-response | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option

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

Comments: This element is immutable. It cannot be changed for the same resource instance.

Cardinality: 1..1

Type: code

Binding: required:request-intent

Summary: true

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)

Mappings: workflow=Request.intent; w5=FiveWs.class; v2=N/A; rim=.moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)

<a id="DeviceRequest.priority"></a>

DeviceRequest.priority

routine | urgent | asap | stat

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

Meaning if Missing: If missing, normal priority

Cardinality: 0..1

Type: code

Binding: required:request-priority

Summary: true

Mappings: workflow=Request.priority; w5=FiveWs.grade; v2=TQ1.9; rim=.priorityCode

<a id="DeviceRequest.doNotPerform"></a>

DeviceRequest.doNotPerform

True if the request is to stop or not to start using the device

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.

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

Cardinality: 0..1

Type: boolean

Summary: true

Is Modifier: true (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.))

Mappings: workflow=Request.doNotPerform

<a id="DeviceRequest.product[x]"></a>

DeviceRequest.product[x]

Device requested

Definition: The details of the device to be used.

Cardinality: 1..1

Type: CodeableConcept, Reference(Device), canonical

Binding: example:device-type

Summary: true

Mappings: workflow=Request.product; w5=FiveWs.what[x]; v2=Varies by domain; rim=.code; quick=DeviceUse.device

<a id="DeviceRequest.quantity"></a>

DeviceRequest.quantity

Quantity of devices to supply

Definition: The number of devices to be provided.

Cardinality: 0..1

Type: integer

Mappings: rim=quantity

<a id="DeviceRequest.parameter"></a>

DeviceRequest.parameter

Device details

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

Cardinality: 0..*

Type: BackboneElement

Mappings: w5=FiveWs.what[x]; v2=Varies by domain; rim=.code; quick=DeviceUse.device

<a id="DeviceRequest.parameter.code"></a>

DeviceRequest.parameter.code

Device detail

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

Cardinality: 0..1

Type: CodeableConcept

Binding: example:request-orderdetail-parameter-code

Mappings: w5=FiveWs.what[x]; v2=Varies by domain; rim=.code; quick=DeviceUse.device

<a id="DeviceRequest.parameter.value[x]"></a>

DeviceRequest.parameter.value[x]

Value of detail

Definition: The value of the device detail.

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

Cardinality: 0..1

Type: CodeableConcept, Quantity, Range, boolean

Mappings: w5=FiveWs.what[x]; v2=Varies by domain; rim=.code; quick=DeviceUse.device

<a id="DeviceRequest.subject"></a>

DeviceRequest.subject

Focus of request

Definition: The patient who will use the device.

Cardinality: 1..1

Type: Reference(Patient, Group, Location, Device)

Summary: true

Mappings: workflow=Request.subject; w5=FiveWs.subject; v2=Accompanying PID segment; rim=.participation[typeCode=SBJ].role; quick=ClinicalStatement.subject

<a id="DeviceRequest.encounter"></a>

DeviceRequest.encounter

Encounter motivating request

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

Cardinality: 0..1

Type: Reference(Encounter)

Summary: true

Mappings: workflow=Request.encounter; w5=FiveWs.context; v2=Accompanying PV1; rim=.inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]; quick=ClinicalStatement.encounter

<a id="DeviceRequest.occurrence[x]"></a>

DeviceRequest.occurrence[x]

Desired time or schedule for use

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

Cardinality: 0..1

Type: dateTime, Period, Timing

Summary: true

Mappings: workflow=Request.occurrence[x]; w5=FiveWs.planned; v2=Accompanying TQ1/TQ2 segments; rim=.effectiveTime; quick=DeviceUse.applicationSchedule

<a id="DeviceRequest.authoredOn"></a>

DeviceRequest.authoredOn

When recorded

Definition: When the request transitioned to being actionable.

Cardinality: 0..1

Type: dateTime

Summary: true

Mappings: workflow=Request.authoredOn; w5=FiveWs.recorded; v2=ORC.9; rim=.participation[typeCode=AUT].time; quick=ClinicalStatement.statementDateTime

<a id="DeviceRequest.requester"></a>

DeviceRequest.requester

Who/what submitted the device request

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

Cardinality: 0..1

Type: Reference(Device, Practitioner, PractitionerRole, Organization, CareTeam, Group, Patient, RelatedPerson)

Summary: true

Mappings: workflow=Request.requester; w5=FiveWs.author; v2=ORC.12; rim=.participation[typeCode=AUT].role

<a id="DeviceRequest.performer"></a>

DeviceRequest.performer

Requested Filler

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

Cardinality: 0..1

Type: CodeableReference

Summary: true

Mappings: workflow=Request.performer; w5=FiveWs.actor; v2=PRT; rim=.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]

<a id="DeviceRequest.location"></a>

DeviceRequest.location

Requested location

Definition: The preferred location(s) where the device should actually be used in coded or free text form. E.g. at home or nursing day care center.

Cardinality: 0..*

Type: CodeableReference

Binding: example:v3-ServiceDeliveryLocationRoleType

Summary: true

Is Modifier: false

Mappings: w5=FiveWs.actor; rim=.participation[typeCode=LOC].role[scoper.determinerCode=KIND].code

<a id="DeviceRequest.reason"></a>

DeviceRequest.reason

Coded/Linked Reason for request

Definition: Reason or justification for the use of this device.

Comments: When doNotPerform is true, this is the reason for requesting not to provide the device.

Cardinality: 0..*

Type: CodeableReference

Binding: example:condition-code

Summary: true

Mappings: workflow=Request.reason; w5=FiveWs.why[x]; v2=ORC.16; rim=.reasonCode; quick=Action.indication.reason

<a id="DeviceRequest.asNeeded"></a>

DeviceRequest.asNeeded

PRN status of request

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

Cardinality: 0..1

Type: boolean

<a id="DeviceRequest.asNeededFor"></a>

DeviceRequest.asNeededFor

Device usage reason

Definition: The reason for using the device.

Cardinality: 0..1

Type: CodeableConcept

<a id="DeviceRequest.insurance"></a>

DeviceRequest.insurance

Associated insurance coverage

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

Cardinality: 0..*

Type: Reference(Coverage, ClaimResponse)

Mappings: workflow=Request.insurance; v2=IN1/IN2; rim=.outboundRelationship[typeCode=COVBY].target

<a id="DeviceRequest.supportingInfo"></a>

DeviceRequest.supportingInfo

Additional clinical information

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

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

Cardinality: 0..*

Type: Reference(Resource)

Mappings: workflow=Request.supportingInfo; v2=Accompanying segments; rim=.outboundRelationship[typeCode=PERT].target

<a id="DeviceRequest.note"></a>

DeviceRequest.note

Notes or comments

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.

Cardinality: 0..*

Type: Annotation

Mappings: workflow=Request.note; v2=NTE; rim=.inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]; quick=ClinicalStatement.additionalText

<a id="DeviceRequest.relevantHistory"></a>

DeviceRequest.relevantHistory

Request provenance

Definition: Key events in the history of the request.

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.

Cardinality: 0..*

Type: Reference(Provenance)

Mappings: workflow=Request.relevantHistory; v2=N/A; rim=.inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]