DeviceRequest - FHIR Resource (stu3)
This DeviceRequest Resource uses the FHIR API standard for access and structure.
Validate an DeviceRequest FHIR Resource (stu3)
DeviceRequest Attributes
AttributeField is listTypeDescription
Description: "codeReference" : { Reference(Device) },
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"codeReference": {
"reference": "Device/example"
}Learn more about the (DeviceRequest) codeReference FHIR attribute
Description: Request provenance
FHIR Version: stu3
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
Description: "performer" : { Reference(Practitioner|Organization|Patient|Device|
FHIR Version: stu3
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: stu3
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: What request replaces
FHIR Version: stu3
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: Focus of request
FHIR Version: stu3
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: Notes or comments
FHIR Version: stu3
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: What request fulfills
FHIR Version: stu3
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: Indicates how quickly the {{title}} should be addressed with respect to other requests
FHIR Version: stu3
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: "occurrencePeriod" : { Period },
FHIR Version: stu3
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"occurrencePeriod": Learn more about the (DeviceRequest) occurrencePeriod FHIR attribute
Description: draft | active | suspended | completed | entered-in-error | cancelled
FHIR Version: stu3
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: "codeCodeableConcept" : { CodeableConcept },
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"codeCodeableConcept": Learn more about the (DeviceRequest) codeCodeableConcept FHIR attribute
Description: Identifier of composite request
FHIR Version: stu3
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: Additional clinical information
FHIR Version: stu3
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: proposal | plan | original-order | encoded | reflex-order
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"intent": {
"coding": [
{
"code": "original-order"
}
]
}Learn more about the (DeviceRequest) intent FHIR attribute
Description: Who/what is requesting diagnostics
FHIR Version: stu3
Attribute Type : Data Type
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: "occurrenceDateTime" : "<dateTime>",
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"occurrenceDateTime": Learn more about the (DeviceRequest) occurrenceDateTime FHIR attribute
Description: Protocol or definition
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"definition": Learn more about the (DeviceRequest) definition FHIR attribute
Description: When recorded
FHIR Version: stu3
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: Linked Reason for request
FHIR Version: stu3
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: Fille role
FHIR Version: stu3
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: "occurrenceTiming" : { Timing },
FHIR Version: stu3
Attribute Type : Timing
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"occurrenceTiming": Learn more about the (DeviceRequest) occurrenceTiming FHIR attribute
Description: Encounter or Episode motivating request
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"context": Learn more about the (DeviceRequest) context FHIR attribute
Description: External Request identifier
FHIR Version: stu3
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
DeviceRequest Example
{
"status": "completed",
"codeReference": {
"reference": "Device/example"
},
"resourceType": "DeviceRequest",
"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 <span>(Details : {[not stated] code 'original-order' = 'original-order)</span></p><p><b>code</b>: <a>Device/example</a></p><p><b>subject</b>: <a>Patient/example</a></p></div>"
},
"intent": {
"coding": [
{
"code": "original-order"
}
]
},
"id": "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
"definition" : [{ Reference(ActivityDefinition|PlanDefinition) }], // 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 | suspended | completed | entered-in-error | cancelled
"intent" : { CodeableConcept }, // R! proposal | plan | original-order | encoded | reflex-order
"priority" : "<code>", // Indicates how quickly the {{title}} should be addressed with respect to other requests
// code[x]: Device requested. One of these 2:
"codeReference" : { Reference(Device) },
"codeCodeableConcept" : { CodeableConcept },
"subject" : { Reference(Patient|Group|Location|Device) }, // R! Focus of request
"context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or Episode 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" : { // Who/what is requesting diagnostics
"agent" : { Reference(Device|Practitioner|Organization) }, // R! Individual making the request
"onBehalfOf" : { Reference(Organization) } // Organization agent is acting for
},
"performerType" : { CodeableConcept }, // Fille role
"performer" : { Reference(Practitioner|Organization|Patient|Device|
RelatedPerson|HealthcareService) }, // Requested Filler
"reasonCode" : [{ CodeableConcept }], // Coded Reason for request
"reasonReference" : [{ Reference(Any) }], // Linked Reason for request
"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/stu3/DeviceRequest?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
authored-on | date | authoredOn |
based-on | reference | basedOn |
code | text | code.as |
definition | reference | definition |
device | reference | code.as |
encounter | reference | context |
event-date | date | occurrence.as |
group-identifier | text | groupIdentifier |
identifier | text | identifier |
intent | text | intent |
patient | reference | subject |
performer | reference | performer |
priorrequest | reference | priorRequest |
requester | reference | requester.agent |
status | text | status |
subject | reference | subject |
