DeviceRequest - FHIR Resource (r4)

This DeviceRequest Resource uses the FHIR API standard for access and structure.

Validate an DeviceRequest FHIR Resource (r4)

Validate this DeviceRequest

Resource Attributes

Attribute	Field is list	Type	Description
authoredOn	false	dateTime	# When recorded
basedOn	true	Reference	# What request fulfills
code[x]	false	Reference	#undefined
encounter	false	Reference	# Encounter motivating request
groupIdentifier	false	Identifier	# Identifier of composite request
identifier	true	Identifier	# External Request identifier
instantiatesCanonical	true	canonical(ActivityDefinition | PlanDefinition)	# Instantiates FHIR protocol or definition
instantiatesUri	true	uri	# Instantiates external protocol or definition
insurance	true	Reference	# Associated insurance coverage
intent	false	code	# proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
note	true	Annotation	# Notes or comments
occurrence[x]	false	dateTime|Period|Timing	#undefined
parameter	true	Data Type	# Device details
performer	false	Reference	# "performer" : { Reference(Practitioner|PractitionerRole|Organization|
performerType	false	CodeableConcept	# Filler role
priorRequest	true	Reference	# What request replaces
priority	false	code	# routine | urgent | asap | stat
reasonCode	true	CodeableConcept	# Coded Reason for request
reasonReference	true	Reference	# "reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
relevantHistory	true	Reference	# Request provenance
requester	false	Reference	# Who/what is requesting diagnostics
status	false	code	# draft | active | on-hold | revoked | completed | entered-in-error | unknown
subject	false	Reference	# Focus of request
supportingInfo	true	Reference	# Additional clinical information

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