Home
API reference
Redox Data Models
Results
QueryResponse

Results

This data model allows you to exchange discrete clinical data—usually as a result of an order—with an EHR system.

Results data can be written as discrete data (e.g., lab values), text (e.g., pathology report), or other complex formats (e.g., PDF, JPEG, Word) to the EHR system, depending on their respective capability. If you're writing back a file, see tips for sending files.

This data model has event types that allow you to:

  • receive a notification when new results are added; or
  • query for and receive result data.

QueryResponse

Receive result details based on the query parameters defined in Result.Query.

Beta
Data on Demand Enabled

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      Results

    • 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

    • LastUpdated
      string, null
      Probable

      The last time the order was updated. This timestamp is not clinically relevant but indicates when the order was last updated in the database.
      ISO 8601 Format

    • ID
      string, null
      Reliable

      Contains the unique identifier of the order request, which is assigned by the system that placed the order.

    • ApplicationOrderID
      string, null
      Possible

      Contains the identifier of the order request, which is assigned by the system fulfilling the order.

    • TransactionDateTime
      string, null
      Reliable

      Displays the timestamp (in ISO 8601 format) for when the order was updated with results.
      Not supported with data on demand.

    • CollectionDateTime
      string, null
      Reliable

      Displays the timestamp for when the specimen was collected.
      ISO 8601 Format

    • CompletionDateTime
      string, null
      Probable

      Date and time the results were composed into a report and released.
      ISO 8601 Format

    • Notes
      Array of string

      Contains any order-level notes.
      Not supported with data on demand.

    • ResultsStatus
      string, null
      Reliable
      Value Set

      Specifies the current overall status of the order.

    • Procedure
      object

      Displays the procedure associated with the results.

      • 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

      Contains the providers that should be copied on the results.
      Not supported with data on demand.

      • 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

    • Status
      string, null
      Reliable
      Value Set

      Displays the current status of the order. The default value is Resulted.
      Not supported with data on demand.

    • ResponseFlag
      string, null
      Probable

      Specifies the response type that the receiving system requests. Derived from HL7 Table 0121. The default value is D, which includes associated segments.
      Not supported with data on demand.

    • Priority
      string, null
      Reliable
      Value Set

      Indicates the priority of the order.
      Not supported with data on demand.

    • Results
      Array of object

      Contains a list of result components and their values.

      • Code
        string, null
        Probable

        Code for the result component

      • Codeset
        string, null
        Probable

        Code set used to identify the result component

      • Description
        string, null
        Probable

        Description of the result component

      • RelatedGroupID
        string, null
        Probable

        Contains the identifier to group separate result components.

      • 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

      • Value
        string, null
        Reliable

        Displays the value of the result component. If the value type is Encapsulated Data, this field includes the base64 encoded string for the file. Learn more about sending a file.

      • ValueType
        string, null
        Reliable
        Value Set

        Specifies the data type of the result value.
        Not supported with data on demand.

      • CompletionDateTime
        string, null
        Possible

        Displays the timestamp for when the individual results were composed into a report and released.

      • FileType
        string, null
        Reliable

        Identifies the format of the file (e.g., PDF, JPG). If the ValueType is Encapsulated Data, this field is required.

      • Units
        string, null
        Probable

        Defines the units of measurement for the result.

      • Notes
        Array of string

        Includes notes about the result component/observation.
        Not supported with data on demand.

      • AbnormalFlag
        string, null
        Probable
        Value Set

        Indicates whether the result is abnormal.

      • Status
        string, null
        Reliable
        Value Set

        Displays the current status of the result.

      • PrimaryResultsInterpreter
        object
        • NPI
          string, null
          Possible

          NPI of the Primary Results Interpreter

        • ID
          string, null
          Possible

          ID of the Primary Results Interpreter.
          This ID is often required for Inpatient Visits.

        • IDType
          string, null
          Possible

          ID type of the ID for the Primary Results Interpreter

        • FirstName
          string, null
          Possible

          First name of the Primary Results Interpreter

        • LastName
          string, null
          Possible

          Last name of the Primary Results Interpreter

        • Credentials
          Array of string

          List of credentials for the Primary Results Interpreter.
          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

      • Producer
        object
        • ID
          string, null
          Possible

          Contains the identifier of the entity that produced the result. This is typically the lab that fulfilled the order.

        • Name
          string, null
          Possible

          Displays the name of the entity (typically the lab) that produced the results.

        • IDType
          string, null
          Possible

          Defines the type of identifier used for the corresponding ID of the entity that produced the results.

        • Address
          object

          Result producer'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

      • Performer
        object
        • ID
          string, null
          Possible

          ID of the performer.
          This ID is often required for Inpatient Visits.

        • IDType
          string, null
          Possible

          ID type of the ID for the performer

        • FirstName
          string, null
          Possible

          First name of the performer

        • LastName
          string, null
          Possible

          Last name of the performer

        • Credentials
          Array of string

          List of credentials for the performer.
          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

      • ReferenceRange
        object

        Defines the clinical range for a given result. Numeric results use low and high values to indicate a normal result. Non-numeric results populate the normal value in the text field.

        • Low
          number, null
          Possible

          Specifies the lower bound for a normal result.

        • High
          number, null
          Possible

          Specifies the upper bound for a normal result.

        • Text
          string, null
          Possible

          Contains the normal value for non-numeric results.

      • ObservationMethod
        object

        Indicates the method used to obtain the observation. This field is used when an observation may be obtained by different methods and the sending system wishes to indicate which method was used.

        • Code
          string, null
          Possible

          Code for the observation method

        • Codeset
          string, null
          Possible

          Code set used to identify the observation method

        • Description
          string, null
          Possible

          Description of the observation method

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "Results",
4
    "EventType": "QueryResponse",
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
  "Orders": [
26
    {
27
      "Patient": {
28
        "Identifiers": [
29
          {
30
            "ID": "000000001",
31
            "IDType": "MRN"
32
          }
33
        ]
34
      },
35
      "Visit": {
36
        "VisitNumber": 1234567
37
      },
38
      "LastUpdated": null,
39
      "ID": "157968300",
40
      "ApplicationOrderID": null,
41
      "TransactionDateTime": "2015-05-06T06:00:58.872Z",
42
      "CollectionDateTime": "2015-05-06T06:00:58.872Z",
43
      "CompletionDateTime": "2015-05-06T06:00:58.872Z",
44
      "Notes": [],
45
      "ResultsStatus": "Final",
46
      "Procedure": {
47
        "Code": "49086-2",
48
        "Codeset": null,
49
        "Description": "First trimester maternal screen with nuchal translucency panel"
50
      },
51
      "Provider": {
52
        "NPI": "4356789876",
53
        "ID": null,
54
        "IDType": null,
55
        "FirstName": "Pat",
56
        "LastName": "Granite",
57
        "Credentials": [],
58
        "Address": {
59
          "StreetAddress": null,
60
          "City": null,
61
          "State": null,
62
          "ZIP": null,
63
          "County": null,
64
          "Country": null
65
        },
66
        "EmailAddresses": [],
67
        "PhoneNumber": {
68
          "Office": null
69
        },
70
        "Location": {
71
          "Type": null,
72
          "Facility": null,
73
          "FacilityIdentifiers": [],
74
          "Department": null,
75
          "DepartmentIdentifiers": [],
76
          "Room": null
77
        }
78
      },
79
      "ResultCopyProviders": [],
80
      "Status": "Resulted",
81
      "ResponseFlag": "Associated Segments",
82
      "Priority": "Stat",
83
      "Results": [
84
        {
85
          "Code": "TEST0001",
86
          "Codeset": null,
87
          "Description": "Cystic Fibrosis",
88
          "RelatedGroupID": null,
89
          "Specimen": {
90
            "Source": null,
91
            "BodySite": null,
92
            "ID": null
93
          },
94
          "Value": "Positive Result",
95
          "ValueType": "String",
96
          "CompletionDateTime": null,
97
          "FileType": null,
98
          "Units": null,
99
          "Notes": [
100
            "This individual is a carrier for Cystic Fibrosis."
101
          ],
102
          "AbnormalFlag": "Very Abnormal",
103
          "Status": "Final",
104
          "PrimaryResultsInterpreter": {
105
            "NPI": null,
106
            "ID": null,
107
            "IDType": null,
108
            "FirstName": null,
109
            "LastName": null,
110
            "Credentials": [],
111
            "Address": {
112
              "StreetAddress": null,
113
              "City": null,
114
              "State": null,
115
              "ZIP": null,
116
              "County": null,
117
              "Country": null
118
            },
119
            "EmailAddresses": [],
120
            "PhoneNumber": {
121
              "Office": null
122
            },
123
            "Location": {
124
              "Type": null,
125
              "Facility": null,
126
              "FacilityIdentifiers": [],
127
              "Department": null,
128
              "DepartmentIdentifiers": [],
129
              "Room": null
130
            }
131
          },
132
          "Producer": {
133
            "ID": "RL001",
134
            "Name": "Redox Lab WI",
135
            "IDType": null,
136
            "Address": {
137
              "StreetAddress": "111 W. Fairchild",
138
              "City": "Madison",
139
              "State": "WI",
140
              "ZIP": "53703",
141
              "County": "Dane",
142
              "Country": "USA"
143
            }
144
          },
145
          "Performer": {
146
            "ID": null,
147
            "IDType": null,
148
            "FirstName": "Bob",
149
            "LastName": "Smith",
150
            "Credentials": [
151
              "MD"
152
            ],
153
            "Address": {
154
              "StreetAddress": null,
155
              "City": null,
156
              "State": null,
157
              "ZIP": null,
158
              "County": null,
159
              "Country": null
160
            },
161
            "EmailAddresses": [],
162
            "PhoneNumber": {
163
              "Office": null
164
            },
165
            "Location": {
166
              "Type": null,
167
              "Facility": null,
168
              "FacilityIdentifiers": [],
169
              "Department": null,
170
              "DepartmentIdentifiers": [],
171
              "Room": null
172
            }
173
          },
174
          "ReferenceRange": {
175
            "Low": null,
176
            "High": null,
177
            "Text": null
178
          },
179
          "ObservationMethod": {
180
            "Code": null,
181
            "Codeset": null,
182
            "Description": null
183
          }
184
        },
185
        {
186
          "Code": "TEST0004",
187
          "Codeset": null,
188
          "Description": "Primary Carnitine Deficiency",
189
          "RelatedGroupID": null,
190
          "Specimen": {
191
            "Source": null,
192
            "BodySite": null,
193
            "ID": null
194
          },
195
          "Value": "Negative Result",
196
          "ValueType": "String",
197
          "CompletionDateTime": null,
198
          "FileType": null,
199
          "Units": null,
200
          "Notes": [],
201
          "AbnormalFlag": "Normal",
202
          "Status": "Final",
203
          "PrimaryResultsInterpreter": {
204
            "NPI": null,
205
            "ID": null,
206
            "IDType": null,
207
            "FirstName": null,
208
            "LastName": null,
209
            "Credentials": [],
210
            "Address": {
211
              "StreetAddress": null,
212
              "City": null,
213
              "State": null,
214
              "ZIP": null,
215
              "County": null,
216
              "Country": null
217
            },
218
            "EmailAddresses": [],
219
            "PhoneNumber": {
220
              "Office": null
221
            },
222
            "Location": {
223
              "Type": null,
224
              "Facility": null,
225
              "FacilityIdentifiers": [],
226
              "Department": null,
227
              "DepartmentIdentifiers": [],
228
              "Room": null
229
            }
230
          },
231
          "Producer": {
232
            "ID": "RL001",
233
            "Name": "Redox Lab WI",
234
            "IDType": null,
235
            "Address": {
236
              "StreetAddress": "111 W. Fairchild",
237
              "City": "Madison",
238
              "State": "WI",
239
              "ZIP": "53703",
240
              "County": "Dane",
241
              "Country": "USA"
242
            }
243
          },
244
          "Performer": {
245
            "ID": null,
246
            "IDType": null,
247
            "FirstName": "Bob",
248
            "LastName": "Smith",
249
            "Credentials": [
250
              "MD"
251
            ],
252
            "Address": {
253
              "StreetAddress": null,
254
              "City": null,
255
              "State": null,
256
              "ZIP": null,
257
              "County": null,
258
              "Country": null
259
            },
260
            "EmailAddresses": [],
261
            "PhoneNumber": {
262
              "Office": null
263
            },
264
            "Location": {
265
              "Type": null,
266
              "Facility": null,
267
              "FacilityIdentifiers": [],
268
              "Department": null,
269
              "DepartmentIdentifiers": [],
270
              "Room": null
271
            }
272
          },
273
          "ReferenceRange": {
274
            "Low": null,
275
            "High": null,
276
            "Text": null
277
          },
278
          "ObservationMethod": {
279
            "Code": null,
280
            "Codeset": null,
281
            "Description": null
282
          }
283
        }
284
      ]
285
    }
286
  ]
287
}