DeviceRequest - FHIR Resource (r4)
This DeviceRequest Resource uses the FHIR API standard for access and structure.
Validate an DeviceRequest FHIR Resource (r4)
DeviceRequest Attributes
AttributeField is listTypeDescription
Description: External Request identifier
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (DeviceRequest) identifier FHIR attribute
Description: Instantiates FHIR protocol or definition
FHIR Version: r4
Attribute Type : canonical(ActivityDefinition | PlanDefinition)
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"instantiatesCanonical": Learn more about the (DeviceRequest) instantiatesCanonical FHIR attribute
Description: Instantiates external protocol or definition
FHIR Version: r4
Attribute Type : uri
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"instantiatesUri": Learn more about the (DeviceRequest) instantiatesUri FHIR attribute
Description: What request fulfills
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"basedOn": Learn more about the (DeviceRequest) basedOn FHIR attribute
Description: What request replaces
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"priorRequest": Learn more about the (DeviceRequest) priorRequest FHIR attribute
Description: Identifier of composite request
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"groupIdentifier": Learn more about the (DeviceRequest) groupIdentifier FHIR attribute
Description: draft | active | on-hold | revoked | completed | entered-in-error | unknown
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "completed"Learn more about the (DeviceRequest) status FHIR attribute
Description: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"intent": "original-order"Learn more about the (DeviceRequest) intent FHIR attribute
Description: routine | urgent | asap | stat
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"priority": Learn more about the (DeviceRequest) priority FHIR attribute
Description:
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"code[x]": Learn more about the (DeviceRequest) code[x] FHIR attribute
Description: Device details
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"parameter": Learn more about the (DeviceRequest) parameter FHIR attribute
Description: Focus of request
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": {
"reference": "Patient/example"
}Learn more about the (DeviceRequest) subject FHIR attribute
Description: Encounter motivating request
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"encounter": Learn more about the (DeviceRequest) encounter FHIR attribute
Description:
FHIR Version: r4
Attribute Type : dateTime|Period|Timing
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"occurrence[x]": Learn more about the (DeviceRequest) occurrence[x] FHIR attribute
Description: When recorded
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"authoredOn": Learn more about the (DeviceRequest) authoredOn FHIR attribute
Description: Who/what is requesting diagnostics
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"requester": Learn more about the (DeviceRequest) requester FHIR attribute
Description: Filler role
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"performerType": Learn more about the (DeviceRequest) performerType FHIR attribute
Description: "performer" : { Reference(Practitioner|PractitionerRole|Organization|
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"performer": Learn more about the (DeviceRequest) performer FHIR attribute
Description: Coded Reason for request
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonCode": Learn more about the (DeviceRequest) reasonCode FHIR attribute
Description: "reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonReference": Learn more about the (DeviceRequest) reasonReference FHIR attribute
Description: Associated insurance coverage
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"insurance": Learn more about the (DeviceRequest) insurance FHIR attribute
Description: Additional clinical information
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"supportingInfo": Learn more about the (DeviceRequest) supportingInfo FHIR attribute
Description: Notes or comments
FHIR Version: r4
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": Learn more about the (DeviceRequest) note FHIR attribute
Description: Request provenance
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"relevantHistory": Learn more about the (DeviceRequest) relevantHistory FHIR attribute
DeviceRequest Example
{
"resourceType": "DeviceRequest",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>status</b>: completed</p><p><b>intent</b>: original-order</p><p><b>code</b>: <a>Device/example</a></p><p><b>subject</b>: <a>Patient/example</a></p></div>"
},
"status": "completed",
"intent": "original-order",
"codeReference": {
"reference": "Device/example"
},
"subject": {
"reference": "Patient/example"
}
}DeviceRequest Structure
{
"resourceType" : "DeviceRequest",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // External Request identifier
"instantiatesCanonical" : [{ canonical(ActivityDefinition|PlanDefinition) }], // Instantiates FHIR protocol or definition
"instantiatesUri" : ["<uri>"], // Instantiates external protocol or definition
"basedOn" : [{ Reference(Any) }], // What request fulfills
"priorRequest" : [{ Reference(Any) }], // What request replaces
"groupIdentifier" : { Identifier }, // Identifier of composite request
"status" : "<code>", // draft | active | on-hold | revoked | completed | entered-in-error | unknown
"intent" : "<code>", // R! proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
"priority" : "<code>", // routine | urgent | asap | stat
// code[x]: Device requested. One of these 2:
"codeReference" : { Reference(Device) },
"codeCodeableConcept" : { CodeableConcept },
"parameter" : [{ // Device details
"code" : { CodeableConcept }, // Device detail
// value[x]: Value of detail. One of these 4:
"valueCodeableConcept" : { CodeableConcept }
"valueQuantity" : { Quantity }
"valueRange" : { Range }
"valueBoolean" : <boolean>
}],
"subject" : { Reference(Patient|Group|Location|Device) }, // R! Focus of request
"encounter" : { Reference(Encounter) }, // Encounter motivating request
// occurrence[x]: Desired time or schedule for use. One of these 3:
"occurrenceDateTime" : "<dateTime>",
"occurrencePeriod" : { Period },
"occurrenceTiming" : { Timing },
"authoredOn" : "<dateTime>", // When recorded
"requester" : { Reference(Device|Practitioner|PractitionerRole|Organization) }, // Who/what is requesting diagnostics
"performerType" : { CodeableConcept }, // Filler role
"performer" : { Reference(Practitioner|PractitionerRole|Organization|
CareTeam|HealthcareService|Patient|Device|RelatedPerson) }, // Requested Filler
"reasonCode" : [{ CodeableConcept }], // Coded Reason for request
"reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
DocumentReference) }], // Linked Reason for request
"insurance" : [{ Reference(Coverage|ClaimResponse) }], // Associated insurance coverage
"supportingInfo" : [{ Reference(Any) }], // Additional clinical information
"note" : [{ Annotation }], // Notes or comments
"relevantHistory" : [{ Reference(Provenance) }] // Request provenance
}
DeviceRequest Search Parameters
The following search parameters can be used to query DeviceRequest resources. Just submit them like so:
https://api.1up.health/fhir/r4/DeviceRequest?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
authored-on | date | authoredOn |
based-on | reference | basedOn |
code | text | code |
device | reference | code |
encounter | reference | encounter |
event-date | date | occurrence |
group-identifier | text | groupIdentifier |
identifier | text | identifier |
instantiates-canonical | reference | instantiatesCanonical |
instantiates-uri | uri | instantiatesUri |
insurance | reference | insurance |
intent | text | intent |
patient | reference | subject.where |
performer | reference | performer |
prior-request | reference | priorRequest |
requester | reference | requester |
status | text | status |
subject | reference | subject |
