Home
API reference
FHIR® API
FHIR® resources
DeviceRequest
read

DeviceRequest read

get/DeviceRequest/{id}
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.

read

This interaction allows you to review a specific DeviceRequest resource with a device order for a patient.

To use a read interaction, you must know the related resource ID, which you may not have in your real workflows. A read is likely only a follow-up option after receiving the specific resource in a recent FHIR® passthrough or data on demand exchange.

Typically, you should use the more flexible _search with query parameters, unless you're guaranteed to request data directly from a FHIR® server using the resource ID. Learn more about using FHIR® identifiers.

Request parameters

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/DeviceRequest/{id}' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN'

Request Parameters

  • id
    required, string

    DeviceRequest identifier

Response fields and example

json
1
{}

    Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.

  • 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".