Home
API reference
Redox Data Models
Order
Query

Order

This data model allows providers to request services with instructions for a patient's treatment. The order is generally triggered when the provider places an order or when the provider releases it (e.g., after ordering, a clinician takes action on a worklist of pending orders).

Orders commonly contain lab orders. If so, the EHR system sends a message with an expected date and time when a practitioner places an order (e.g., glucose test). When a nurse doing lab rounds (inpatient) or at a collection center (outpatient) collects the specimen, the EHR might send Order.Update with additional information about the collection (e.g., collection user, collection date/time).

This data model has event types that allow you to:

  • receive a notification for new, updated, canceled, or grouped orders; or
  • query for and receive orders.

Query

Query for orders by defining the search criteria. If you specify multiple criteria, the order(s) must match all the provided criteria to be returned. Results are returned in Order.QueryReponse.

Beta
Data on Demand Enabled

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      Order

    • EventType
      required, string
      Reliable

      Query

    • EventDateTime
      string, null
      Reliable

      Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
      ISO 8601 Format

    • Test
      boolean, null
      Reliable

      Indicates whether the request is a test or not.

    • Source
      object

      Contains the information for the system initiating the message, including the source ID and name.
      Included in messages from Redox

      • ID
        string, null
        Reliable

        Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
        UUID

      • Name
        string, null
        Reliable

        Displays the name of the system initiating the message.

    • Destinations
      Array of object

      Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
      Required when sending data to Redox.

      • ID
        string, null
        Reliable

        Identifies the endpoint that the request is directed to.
        UUID

      • Name
        string, null
        Reliable

        Displays the name of the endpoint that the request is directed to.

    • Logs
      Array of object

      Contains the log identifier(s) for the request.

      • ID
        string, null
        Reliable

        Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
        UUID

      • AttemptID
        string, null
        Reliable

        Identifies the request log attempt value, which is useful when retries are possible.
        UUID

    • FacilityCode
      string, null
      Possible

      Code for the facility related to the message.
      Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

  • Patients
    Array of object

    Array of patients to find orders for.
    If multiple patients are provided, all orders associated with any of the patients will be returned.

    • Identifiers
      Array of object

      List of IDs and ID types that identify the patient.
      If multiple identifiers are provided, only patients with all identifiers will be considered.

      • ID
        string, null
        Reliable

        ID for the patient.

      • IDType
        string, null
        Reliable

        Type of ID.
        E.g. MRN, EPI

  • VisitNumbers
    Array of string

    Use to find order corresponding to a single visit. If multiple visit IDs orders for all matching visits will be returned.
    Unique ID of a single visit

  • StartDateTime
    string, null
    Probable

    Start of the time range to search for orders. This is based on the Order.TransactionDateTime.
    ISO 8601 Format

  • EndDateTime
    string, null
    Probable

    End of the time range to search for orders. This is based on the Order.TransactionDateTime.
    ISO 8601 Format

  • OrderIDs
    Array of string

    Array of order IDs assigned by the ordering system to filter queries by.
    If multiple orders are provided, all matching orders will be returned.

  • Procedures
    Array of object

    Procedures to search/filter by.
    All orders associated with any of the procedure codes provided will be returned.

    • Code
      string, null
      Probable

      Code for the procedure

    • Codeset
      string, null
      Probable
      Value Set

      Code set used to identify the procedure.
      If no code set is specified, a health system specific identifier is being used.

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "Order",
4
    "EventType": "Query",
5
    "EventDateTime": "2024-12-20T18:11:36.537Z",
6
    "Test": true,
7
    "Source": {
8
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
9
      "Name": "Redox Dev Tools"
10
    },
11
    "Destinations": [
12
      {
13
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
14
        "Name": "Redox EMR"
15
      }
16
    ],
17
    "Logs": [
18
      {
19
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
20
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
21
      }
22
    ],
23
    "FacilityCode": null
24
  },
25
  "Patients": [
26
    {
27
      "Identifiers": [
28
        {
29
          "ID": "0000000001",
30
          "IDType": "MR"
31
        },
32
        {
33
          "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
34
          "IDType": "EHRID"
35
        },
36
        {
37
          "ID": "a1d4ee8aba494ca",
38
          "IDType": "NIST"
39
        }
40
      ]
41
    }
42
  ],
43
  "VisitNumbers": [],
44
  "StartDateTime": "2020-05-05T06:00:00.000Z",
45
  "EndDateTime": "2020-05-05T07:00:00.000Z",
46
  "OrderIDs": [
47
    "157968300"
48
  ],
49
  "Procedures": [
50
    {
51
      "Code": "49086-2",
52
      "Codeset": null
53
    }
54
  ]
55
}