SupplyRequest read

get/SupplyRequest/{id}

Page View

This resource contains a request for any kind of medical supplies to be used for a patient’s care, including a medication, device, or substance.

You can review or retrieve supply requests.

Supported fields

We support any valid FHIR® field. However, we only display the fields that we’ve defined in the schema, which are usually based on what’s included in the U.S. Core profile.

read

Review a specific SupplyRequest resource with details about a supply request order.

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}/SupplyRequest/{id}' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN'

Request Parameters

id
required, string
SupplyRequest identifier

Response fields and example

json

1
{}

A profile on the supply request resource that conforms to Redox requirements.

resourceType
required, string
Identifies the type of the resource
Value: SupplyRequest
quantity
required, object
The amount that is being ordered of the indicated item.
- value
  number
  The value of the measured amount. The value includes an implicit precision in the presentation of the value.
itemCodeableConcept
required, object
The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.
- extension
  Array of OriginalText or Other
  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.
  Any of:
  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
- 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.
identifier
Array of object
Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
- 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.
  One of:
  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
Status of the supply request.
Possible Values: draft, active, suspended, cancelled, 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.
  Any of:
  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
deliverTo
object
Where the supply is destined to go.

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.
occurrenceDateTime
string
When the request should be fulfilled.

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.