DeviceRequest - FHIR Resource (r4)


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

Validate an DeviceRequest FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
authoredOnfalsedateTime# When recorded
basedOntrueReference# What request fulfills
code[x]falseReference#undefined
encounterfalseReference# Encounter motivating request
groupIdentifierfalseIdentifier# Identifier of composite request
identifiertrueIdentifier# External Request identifier
instantiatesCanonicaltruecanonical(ActivityDefinition | PlanDefinition)# Instantiates FHIR protocol or definition
instantiatesUritrueuri# Instantiates external protocol or definition
insurancetrueReference# Associated insurance coverage
intentfalsecode# proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
notetrueAnnotation# Notes or comments
occurrence[x]falsedateTime|Period|Timing#undefined
parametertrueData Type# Device details
performerfalseReference# "performer" : { Reference(Practitioner|PractitionerRole|Organization|
performerTypefalseCodeableConcept# Filler role
priorRequesttrueReference# What request replaces
priorityfalsecode# routine | urgent | asap | stat
reasonCodetrueCodeableConcept# Coded Reason for request
reasonReferencetrueReference# "reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
relevantHistorytrueReference# Request provenance
requesterfalseReference# Who/what is requesting diagnostics
statusfalsecode# draft | active | on-hold | revoked | completed | entered-in-error | unknown
subjectfalseReference# Focus of request
supportingInfotrueReference# 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 ParameterField TypeResource Fields Searched
authored-ondateauthoredOn
based-onreferencebasedOn
codetextcode
devicereferencecode
encounterreferenceencounter
event-datedateoccurrence
group-identifiertextgroupIdentifier
identifiertextidentifier
instantiates-canonicalreferenceinstantiatesCanonical
instantiates-uriuriinstantiatesUri
insurancereferenceinsurance
intenttextintent
patientreferencesubject.where
performerreferenceperformer
prior-requestreferencepriorRequest
requesterreferencerequester
statustextstatus
subjectreferencesubject