Home
API reference
FHIR® API
FHIR® resources
DeviceRequest
_search

DeviceRequest _search

post/DeviceRequest/_search
Page View

This resource contains a request for a patient to use a medical device, either implantable or external. 

You can review or retrieve device requests.

_search

Query for a device request order.

This is a flexible option with query parameters to refine your search. The response returns a bundle of resources, known as a searchset bundle type. Learn about bundles and bundle types in our FHIR® glossary.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/DeviceRequest/_search' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/x-www-form-urlencoded' \
5
--data-urlencode 'patient=string' \
6
--data-urlencode 'patient.identifier=string'

Request Body Schema

  • patient
    Array of string

    Who the medical equipment is for

  • patient.identifier
    Array of string

    One or more external identifiers for the patient

Response fields and example

Example payload generated from schema
1
{
2
  "resourceType": "Bundle",
3
  "type": "searchset",
4
  "total": 1,
5
  "entry": [
6
    {
7
      "resource": {
8
        "resourceType": "DeviceRequest",
9
        "id": "76ce9ca9-352f-4953-a506-16af84210732",
10
        "subject": {
11
          "reference": "Patient/81c2f5eb-f99f-40c4-b504-59483e6148d7"
12
        },
13
        "encounter": {
14
          "reference": "Encounter/6a39fcdd-9f7e-7b97-b4c1-5fd61e4dbaf9"
15
        },
16
        "intent": "order",
17
        "status": "completed",
18
        "occurrenceDateTime": "2023-04-06T23:50:50-05:00",
19
        "codeCodeableConcept": {
20
          "coding": [
21
            {
22
              "code": "170615005",
23
              "system": "http://snomed.info/sct",
24
              "display": "Home nebulizer (physical object)"
25
            }
26
          ]
27
        }
28
      },
29
      "search": {
30
        "mode": "match"
31
      }
32
    }
33
  ]
34
}

    Response to a Device Request search operation

  • resourceType
    required, string

    Identifies the type of the resource

    Value: Bundle
  • type
    required, string

    Identifies this bundle as a response to a search

    Value: searchset
  • total
    required, number

    The total number of matches

  • entry
    Array of DeviceRequest or Other

    A resource matching the search criteria or related to a matching resource

    • resource
      required, object

      A record of the allocation of a device to a patient

      • resourceType
        required, string

        Identifies the type of the resource

        Value: DeviceRequest
      • intent
        required, string

        intent is unsupported, but required by FHIR.

        Possible Values: proposal, plan, directive, order, original-order, reflex-order, filler-order, instance-order, option
      • _intent
        required, object

        This element contains extensions for intent. Depending on the extensions present it could be used in place of intent or contain additional information about intent. See the extension element for more details on the possible extensions being sent.

        • extension
          Array of object

          Identifies this field as unsupported

          • url
            required, string

            Source of the definition for the extension code - a logical name or a URL.

            Value: http://hl7.org/fhir/StructureDefinition/data-absent-reason
          • valueCode
            required, string

            The reason a required field is missing

            Value: unsupported
      • subject
        required, object

        The patient who will use the device.

        Must be a resource of type Patient.

        • reference
          string

          A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

      • codeCodeableConcept
        required, object

        The details of the device to be used.

        • coding
          Array of object

          A reference to a code defined by a terminology system.

          • system
            string

            The identification of the code system that defines the meaning of the symbol in the code.

          • code
            string

            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        • text
          string

          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

      • id
        string

        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      • extension
        Array of DeviceRequestQuantity or Other

        May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          A quantity of medical devices or equipment that is associated with the request.

        • url
          required, string

          Source of the definition for the extension code - a logical name or a URL.

          Value: https://fhir.redoxengine.com/StructureDefinition/device-request-quantity
        • valueInteger
          number

          The quantity

          Only one of valueInteger, valueString may be present.

        • valueString
          string

          The quantity

          Only one of valueInteger, valueString may be present.

      • identifier
        Array of object

        Identifiers assigned to this order by the orderer or by the receiver.

        • extension
          Array of Boolean, String, CodeableConcept, Coding, HumanName or Reference

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          • url
            required, string

            Source of the definition for the extension code - a logical name or a URL.

          • valueBoolean
            boolean

            A single value for the extension.

        • use
          string

          The purpose of this identifier.

          Possible Values: usual, official, temp, secondary, old (If known)
        • system
          string

          Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

        • value
          string

          The portion of the identifier typically relevant to the user and which is unique within the context of the system.

      • status
        string

        The status of the request.

        Possible Values: draft, active, on-hold, revoked, completed, entered-in-error, unknown
      • _status
        object

        This element contains extensions for status. Depending on the extensions present it could be used in place of status or contain additional information about status. See the extension element for more details on the possible extensions being sent.

        • extension
          Array of OriginalText or Other

          May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user.

            See http://hl7.org/fhir/StructureDefinition/originalText for more information

          • url
            required, string

            Source of the definition for the extension code - a logical name or a URL.

            Value: http://hl7.org/fhir/StructureDefinition/originalText
          • valueString
            required, string

            The original text

      • encounter
        object

        An encounter that provides additional context in which this request is made.

        Must be a resource of type Encounter.

        • reference
          string

          A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

      • occurrenceDateTime
        string

        The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".

    • search
      required, object

      Information about the search process that lead to the creation of this entry.

      • mode
        required, string

        Identifies the DeviceRequest as matching the search parameters

        Value: match