# DeviceRequest

Canonical page: https://docs.ovok.com/api/fhir/r4/device-request

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 interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/DeviceRequest/[id]` |
| Vread | `GET` | `/fhir/R4/DeviceRequest/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/DeviceRequest/[id]` |
| Patch | `PATCH` | `/fhir/R4/DeviceRequest/[id]` |
| Delete | `DELETE` | `/fhir/R4/DeviceRequest/[id]` |
| Create | `POST` | `/fhir/R4/DeviceRequest` |
| Search | `GET` | `/fhir/R4/DeviceRequest` |
| History | `GET` | `/fhir/R4/DeviceRequest/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | External Request identifier |
| <span id="element-instantiates-canonical"></span>`instantiatesCanonical` | [canonical](/fhir-elements/primitive/canonical) | `0..*` | Instantiates FHIR protocol or definition |
| <span id="element-instantiates-uri"></span>`instantiatesUri` | [uri](/fhir-elements/primitive/uri) | `0..*` | Instantiates external protocol or definition |
| <span id="element-based-on"></span>`basedOn` | [Reference](/fhir-elements/complex/reference) | `0..*` | What request fulfills |
| <span id="element-prior-request"></span>`priorRequest` | [Reference](/fhir-elements/complex/reference) | `0..*` | What request replaces |
| <span id="element-group-identifier"></span>`groupIdentifier` | [Identifier](/fhir-elements/complex/identifier) | `0..1` | Identifier of composite request |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `0..1` | draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown |
| <span id="element-intent"></span>`intent` | [code](/fhir-elements/primitive/code) | `1..1` | proposal \| plan \| directive \| order \| original-order \| reflex-order \| filler-order \| instance-order \| option |
| <span id="element-priority"></span>`priority` | [code](/fhir-elements/primitive/code) | `0..1` | routine \| urgent \| asap \| stat |
| <span id="element-code-x"></span>`code[x]` | [Reference](/fhir-elements/complex/reference), [CodeableConcept](/fhir-elements/complex/codeable-concept) | `1..1` | Device requested |
| <span id="element-parameter"></span>`parameter` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Device details |
| <span id="element-subject"></span>`subject` | [Reference](/fhir-elements/complex/reference) | `1..1` | Focus of request |
| <span id="element-encounter"></span>`encounter` | [Reference](/fhir-elements/complex/reference) | `0..1` | Encounter motivating request |
| <span id="element-occurrence-x"></span>`occurrence[x]` | [dateTime](/fhir-elements/primitive/date-time), [Period](/fhir-elements/complex/period), [Timing](/fhir-elements/complex/timing) | `0..1` | Desired time or schedule for use |
| <span id="element-authored-on"></span>`authoredOn` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | When recorded |
| <span id="element-requester"></span>`requester` | [Reference](/fhir-elements/complex/reference) | `0..1` | Who/what is requesting diagnostics |
| <span id="element-performer-type"></span>`performerType` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Filler role |
| <span id="element-performer"></span>`performer` | [Reference](/fhir-elements/complex/reference) | `0..1` | Requested Filler |
| <span id="element-reason-code"></span>`reasonCode` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Coded Reason for request |
| <span id="element-reason-reference"></span>`reasonReference` | [Reference](/fhir-elements/complex/reference) | `0..*` | Linked Reason for request |
| <span id="element-insurance"></span>`insurance` | [Reference](/fhir-elements/complex/reference) | `0..*` | Associated insurance coverage |
| <span id="element-supporting-info"></span>`supportingInfo` | [Reference](/fhir-elements/complex/reference) | `0..*` | Additional clinical information |
| <span id="element-note"></span>`note` | [Annotation](/fhir-elements/complex/annotation) | `0..*` | Notes or comments |
| <span id="element-relevant-history"></span>`relevantHistory` | [Reference](/fhir-elements/complex/reference) | `0..*` | Request provenance |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `authored-on` | date | When the request transitioned to being actionable |
| `based-on` | reference | Plan/proposal/order fulfilled by this request |
| `code` | token | Multiple Resources: AllergyIntolerance: Code that identifies the allergy or intolerance ; Condition: Code for the condition ; DeviceRequest: Code for what is being requested/ordered ; DiagnosticReport: The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result ; FamilyMemberHistory: A search by a condition code ; List: What the purpose of this list is ; Medication: Returns medications for a specific code ; MedicationAdministration: Return administrations of this medication code ; MedicationDispense: Returns dispenses of this medicine code ; MedicationRequest: Return prescriptions of this medication code ; MedicationStatement: Return statements of this medication code ; Observation: The code of the observation type ; Procedure: A code to identify a  procedure ; ServiceRequest: What is being requested/ordered  |
| `device` | reference | Reference to resource that is being requested/ordered |
| `encounter` | reference | Multiple Resources: Composition: Context of the Composition ; DeviceRequest: Encounter during which request was created ; DiagnosticReport: The Encounter when the order was made ; DocumentReference: Context of the document  content ; Flag: Alert relevant during encounter ; List: Context in which list created ; NutritionOrder: Return nutrition orders with this encounter identifier ; Observation: Encounter related to the observation ; Procedure: Encounter created as part of ; RiskAssessment: Where was assessment performed? ; ServiceRequest: An encounter in which this request is made ; VisionPrescription: Return prescriptions with this encounter identifier  |
| `event-date` | date | When service should occur |
| `group-identifier` | token | Composite request this is part of |
| `identifier` | token | Multiple Resources: AllergyIntolerance: External ids for this item ; CarePlan: External Ids for this plan ; CareTeam: External Ids for this team ; Composition: Version-independent identifier for the Composition ; Condition: A unique identifier of the condition record ; Consent: Identifier for this record (external references) ; DetectedIssue: Unique id for the detected issue ; DeviceRequest: Business identifier for request/order ; DiagnosticReport: An identifier for the report ; DocumentManifest: Unique Identifier for the set of documents ; DocumentReference: Master Version Specific Identifier ; Encounter: Identifier(s) by which this encounter is known ; EpisodeOfCare: Business Identifier(s) relevant for this EpisodeOfCare ; FamilyMemberHistory: A search by a record identifier ; Goal: External Ids for this goal ; ImagingStudy: Identifiers for the Study, such as DICOM Study Instance UID and Accession number ; Immunization: Business identifier ; List: Business identifier ; MedicationAdministration: Return administrations with this external identifier ; MedicationDispense: Returns dispenses with this external identifier ; MedicationRequest: Return prescriptions with this external identifier ; MedicationStatement: Return statements with this external identifier ; NutritionOrder: Return nutrition orders with this external identifier ; Observation: The unique id for a particular observation ; Procedure: A unique identifier for a procedure ; RiskAssessment: Unique identifier for the assessment ; ServiceRequest: Identifiers assigned to this order ; SupplyDelivery: External identifier ; SupplyRequest: Business Identifier for SupplyRequest ; VisionPrescription: Return prescriptions with this external identifier  |
| `instantiates-canonical` | reference | Instantiates FHIR protocol or definition |
| `instantiates-uri` | uri | Instantiates external protocol or definition |
| `insurance` | reference | Associated insurance coverage |
| `intent` | token | proposal \| plan \| original-order \|reflex-order |
| `patient` | reference | Multiple Resources: AllergyIntolerance: Who the sensitivity is for ; CarePlan: Who the care plan is for ; CareTeam: Who care team is for ; ClinicalImpression: Patient or group assessed ; Composition: Who and/or what the composition is about ; Condition: Who has the condition? ; Consent: Who the consent applies to ; DetectedIssue: Associated patient ; DeviceRequest: Individual the service is ordered for ; DeviceUseStatement: Search by subject - a patient ; DiagnosticReport: The subject of the report if a patient ; DocumentManifest: The subject of the set of documents ; DocumentReference: Who/what is the subject of the document ; Encounter: The patient or group present at the encounter ; EpisodeOfCare: The patient who is the focus of this episode of care ; FamilyMemberHistory: The identity of a subject to list family member history items for ; Flag: The identity of a subject to list flags for ; Goal: Who this goal is intended for ; ImagingStudy: Who the study is about ; Immunization: The patient for the vaccination record ; List: If all resources have the same subject ; MedicationAdministration: The identity of a patient to list administrations  for ; MedicationDispense: The identity of a patient to list dispenses  for ; MedicationRequest: Returns prescriptions for a specific patient ; MedicationStatement: Returns statements for a specific patient. ; NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement ; Observation: The subject that the observation is about (if patient) ; Procedure: Search by subject - a patient ; RiskAssessment: Who/what does assessment apply to? ; ServiceRequest: Search by subject - a patient ; SupplyDelivery: Patient for whom the item is supplied ; VisionPrescription: The identity of a patient to list dispenses for  |
| `performer` | reference | Desired performer for service |
| `prior-request` | reference | Request takes the place of referenced completed or terminated requests |
| `requester` | reference | Who/what is requesting service |
| `status` | token | entered-in-error \| draft \| active \|suspended \| completed |
| `subject` | reference | Individual the service is ordered for |

## Reference [#reference]

Official FHIR R4 spec: [DeviceRequest](https://hl7.org/fhir/R4/devicerequest.html).  
Maturity: Trial Use 1 (FMM 1).
