Home
API reference
Redox Data Models
Order
QueryResponse

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.

QueryResponse

Receive order details based on the query parameters defined in Order.Query.

Beta
Data on Demand Enabled

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      Order

    • EventType
      required, string
      Reliable

      QueryResponse

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

  • Orders
    Array of object
    • Patient
      object
      • Identifiers
        Array of object

        List of IDs and ID types that identify the patient

        • ID
          string, null
          Reliable

          ID for the patient

        • IDType
          string, null
          Reliable

          Type of ID.
          E.g. MRN, EPI

    • Visit
      object
      • VisitNumber
        string, null
        Reliable

        Visit Number.
        Unique ID of the visit this order was placed within

    • ID
      string, null
      Reliable

      ID of the order assigned by the placing system

    • ApplicationOrderID
      string, null
      Possible

      ID assigned by the application fulfilling the order

    • Status
      string, null
      Reliable
      Value Set

      The status of an order.

    • TransactionDateTime
      string, null
      Reliable

      DateTime the order was placed

    • CollectionDateTime
      string, null
      Probable

      DateTime the specimen was collected

    • Specimen
      object
      • Source
        string, null
        Probable

        Source of the specimen

      • BodySite
        string, null
        Probable

        Body site from which the specimen was collected

      • ID
        string, null
        Possible

        ID of the collected specimen

    • Procedure
      object

      Procedure that was ordered

      • Code
        string, null
        Reliable

        Code for the procedure

      • Codeset
        string, null
        Reliable

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

      • Description
        string, null
        Reliable

        Description of the procedure

    • Provider
      object
      • NPI
        string, null
        Possible

        NPI of the ordering provider

      • ID
        string, null
        Possible

        ID of the ordering provider.
        This ID is often required for Inpatient Visits.

      • IDType
        string, null
        Possible

        ID type of the ID for the ordering provider

      • FirstName
        string, null
        Possible

        First name of the ordering provider

      • LastName
        string, null
        Possible

        Last name of the ordering provider

      • Credentials
        Array of string

        List of credentials for the ordering provider.
        e.g. MD, PhD

      • Address
        object

        Provider's address

        • StreetAddress
          string, null
          Possible

          Street address

        • City
          string, null
          Possible

          City

        • State
          string, null
          Possible

          State

        • ZIP
          string, null
          Possible

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

      • EmailAddresses
        Array of string

        Provider's email address(es)

      • PhoneNumber
        object
        • Office
          string, null
          Possible

          Provider's office phone number.
          In E. 164 Format. (e.g. +16085551234)

      • Location
        object

        Provider's location

        • Type
          string, null
          Possible

          Type of location.
          Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

        • Facility
          string, null
          Possible

          Facility.
          Example: Community Hospital

        • FacilityIdentifiers
          Array of object

          List of IDs specific to this facility

          • ID
            string, null
            Possible

            An ID specific to this facility

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Department
          string, null
          Possible

          Department

        • DepartmentIdentifiers
          Array of object

          List of IDs specific to this department

          • ID
            string, null
            Possible

            An ID specific to this department

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Room
          string, null
          Possible

          Room.
          Example: 136

    • ResultCopyProviders
      Array of object

      Array of providers to be copied on the results.

      • NPI
        string, null
        Possible

        NPI of the copied provider

      • ID
        string, null
        Possible

        ID of the copied provider.
        This ID is often required for Inpatient Visits.

      • IDType
        string, null
        Possible

        ID type of the ID for the copied provider

      • FirstName
        string, null
        Possible

        First name of the copied provider

      • LastName
        string, null
        Possible

        Last name of the copied provider

      • Credentials
        Array of string

        List of credentials for the copied provider.
        e.g. MD, PhD

      • Address
        object

        Provider's address

        • StreetAddress
          string, null
          Possible

          Street address

        • City
          string, null
          Possible

          City

        • State
          string, null
          Possible

          State

        • ZIP
          string, null
          Possible

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

      • EmailAddresses
        Array of string

        Provider's email address(es)

      • PhoneNumber
        object
        • Office
          string, null
          Possible

          Provider's office phone number.
          In E. 164 Format. (e.g. +16085551234)

      • Location
        object

        Provider's location

        • Type
          string, null
          Possible

          Type of location.
          Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

        • Facility
          string, null
          Possible

          Facility.
          Example: Community Hospital

        • FacilityIdentifiers
          Array of object

          List of IDs specific to this facility

          • ID
            string, null
            Possible

            An ID specific to this facility

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Department
          string, null
          Possible

          Department

        • DepartmentIdentifiers
          Array of object

          List of IDs specific to this department

          • ID
            string, null
            Possible

            An ID specific to this department

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Room
          string, null
          Possible

          Room.
          Example: 136

    • OrderingFacility
      object
      • Name
        string, null
        Possible

        Name of the facility this order was placed in

      • Address
        object

        Ordering facility's address

        • StreetAddress
          string, null
          Possible

          Street address

        • City
          string, null
          Possible

          City

        • State
          string, null
          Possible

          State

        • ZIP
          string, null
          Possible

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

      • PhoneNumber
        string, null
        Possible

        Ordering facility's phone number.
        In E. 164 Format. (i.e. +16085551234)

    • Priority
      string, null
      Reliable
      Value Set

      Priority of the order

    • Comments
      string, null
      Possible

      Clinically relevant comments regarding the order

    • Notes
      Array of string

      Order-level notes

    • Diagnoses
      Array of object

      List of diagnoses associated with this order

      • Code
        string, null
        Probable

        Code for the diagnosis

      • Codeset
        string, null
        Probable
        Value Set

        Code set used to identify the diagnosis.
        One of the following: ICD-9, ICD-10, HCPCS, CPT

      • Name
        string, null
        Probable

        Name of the diagnosis

      • Type
        string, null
        Possible
        Value Set

        Type of the diagnosis

      • DocumentedDateTime
        string, null
        Possible

        DateTime the diagnosis was documented.
        ISO 8601 Format

    • ClinicalInfo
      Array of object

      List of supplementary clinical information associated with the order. Often these are answers to Ask at Order Entry (AOE) questions.

      • Code
        string, null
        Probable

        Code for the information element

      • Codeset
        string, null
        Probable

        Code set used to identify the information element.
        Codeset will be blank for system-defined codes. LOINC is used for a subset of AOE questions.

      • Description
        string, null
        Probable

        Description of the information element.
        For AOEs, this is typically the text of the AOE question

      • Value
        string, null
        Reliable

        Value of the information element.
        For AOEs, this is typically the full answer

      • Units
        string, null
        Possible

        Units of the value.
        If the Value is a time range, this may be "WK"

      • Abbreviation
        string, null
        Probable

        Abbreviation of the value of the information element.
        Typically only present for text answer AOEs

      • Notes
        Array of string

        Notes related to the clinical info

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "Order",
4
    "EventType": "QueryResponse",
5
    "EventDateTime": "2024-11-18T21:23:08.746Z",
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
  "Orders": [
26
    {
27
      "Patient": {
28
        "Identifiers": [
29
          {
30
            "ID": "0000000001",
31
            "IDType": "MR"
32
          },
33
          {
34
            "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
35
            "IDType": "EHRID"
36
          },
37
          {
38
            "ID": "a1d4ee8aba494ca",
39
            "IDType": "NIST"
40
          }
41
        ]
42
      },
43
      "Visit": {
44
        "VisitNumber": 1234
45
      },
46
      "ID": "157968300",
47
      "ApplicationOrderID": null,
48
      "Status": "New",
49
      "TransactionDateTime": "2015-05-06T06:00:58.872Z",
50
      "CollectionDateTime": "2015-05-06T06:00:58.872Z",
51
      "Specimen": {
52
        "Source": null,
53
        "BodySite": null,
54
        "ID": null
55
      },
56
      "Procedure": {
57
        "Code": "49086-2",
58
        "Codeset": null,
59
        "Description": "First trimester maternal screen with nuchal translucency panel"
60
      },
61
      "Provider": {
62
        "NPI": null,
63
        "ID": null,
64
        "IDType": null,
65
        "FirstName": null,
66
        "LastName": null,
67
        "Credentials": [],
68
        "Address": {
69
          "StreetAddress": null,
70
          "City": null,
71
          "State": null,
72
          "ZIP": null,
73
          "County": null,
74
          "Country": null
75
        },
76
        "EmailAddresses": [],
77
        "PhoneNumber": {
78
          "Office": null
79
        },
80
        "Location": {
81
          "Type": null,
82
          "Facility": null,
83
          "FacilityIdentifiers": [],
84
          "Department": null,
85
          "DepartmentIdentifiers": [],
86
          "Room": null
87
        }
88
      },
89
      "ResultCopyProviders": [],
90
      "OrderingFacility": {
91
        "Name": null,
92
        "Address": {
93
          "StreetAddress": null,
94
          "City": null,
95
          "State": null,
96
          "ZIP": null,
97
          "County": null,
98
          "Country": null
99
        },
100
        "PhoneNumber": null
101
      },
102
      "Priority": "Stat",
103
      "Comments": null,
104
      "Notes": [],
105
      "Diagnoses": [
106
        {
107
          "Code": "Z31.41",
108
          "Codeset": "ICD-10",
109
          "Name": "Encounter for fertility testing",
110
          "Type": null,
111
          "DocumentedDateTime": null
112
        }
113
      ],
114
      "ClinicalInfo": [
115
        {
116
          "Code": "QUESTION001",
117
          "Codeset": null,
118
          "Description": "Estimated Due Date",
119
          "Value": "2015-10-05",
120
          "Units": null,
121
          "Abbreviation": null,
122
          "Notes": []
123
        },
124
        {
125
          "Code": "QUESTION002",
126
          "Codeset": null,
127
          "Description": "Ethnicity",
128
          "Value": "White",
129
          "Units": null,
130
          "Abbreviation": "W",
131
          "Notes": []
132
        },
133
        {
134
          "Code": "QUESTION010",
135
          "Codeset": null,
136
          "Description": "Is this a twin pregnancy?",
137
          "Value": "Singleton",
138
          "Units": null,
139
          "Abbreviation": "sng",
140
          "Notes": []
141
        },
142
        {
143
          "Code": "QUESTION011",
144
          "Codeset": null,
145
          "Description": "Dating Method",
146
          "Value": "LMP",
147
          "Units": null,
148
          "Abbreviation": "lmp",
149
          "Notes": []
150
        }
151
      ]
152
    }
153
  ]
154
}