DeviceRequest - FHIR Resource (stu3)


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

Resource Attributes

AttributeField is listTypeDescription
authoredOnfalsedateTime When recorded
basedOntrueReference What request fulfills
codeCodeableConceptfalseCodeableConcept "codeCodeableConcept" : { CodeableConcept },
codeReferencefalseReference "codeReference" : { Reference(Device) },
contextfalseReference Encounter or Episode motivating request
definitiontrueReference Protocol or definition
groupIdentifierfalseIdentifier Identifier of composite request
identifiertrueIdentifier External Request identifier
intentfalseCodeableConcept proposal | plan | original-order | encoded | reflex-order
notetrueAnnotation Notes or comments
occurrenceDateTimefalsedateTime "occurrenceDateTime" : "<dateTime>",
occurrencePeriodfalsePeriod "occurrencePeriod" : { Period },
occurrenceTimingfalseTiming "occurrenceTiming" : { Timing },
performerfalseReference "performer" : { Reference(Practitioner|Organization|Patient|Device|
performerTypefalseCodeableConcept Fille role
priorRequesttrueReference What request replaces
priorityfalsecode Indicates how quickly the {{title}} should be addressed with respect to other requests
reasonCodetrueCodeableConcept Coded Reason for request
reasonReferencetrueReference Linked Reason for request
relevantHistorytrueReference Request provenance
requesterfalseData Type Who/what is requesting diagnostics
statusfalsecode draft | active | suspended | completed | entered-in-error | cancelled
subjectfalseReference Focus of request
supportingInfotrueReference Additional clinical information

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 the like so:

https://api.1up.health/fhir/stu3/DeviceRequest?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
authored-ondateauthoredOn
based-onreferencebasedOn
codetextcode.as
definitionreferencedefinition
devicereferencecode.as
encounterreferencecontext
event-datedateoccurrence.as
group-identifiertextgroupIdentifier
identifiertextidentifier
intenttextintent
patientreferencesubject
performerreferenceperformer
priorrequestreferencepriorRequest
requesterreferencerequester.agent
statustextstatus
subjectreferencesubject