# Order Query

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

> **Required query parameters and populated response**
>
> The required elements and populated response vary depending on the EHR system you're integrating with. Work with your connection to understand which query parameters they require and what to expect in the response during implementation testing.

> **Data on demand enabled**
>
> This event type is available with data on demand. [Learn more about data on demand.](https://docs.redoxengine.com/permalink/4TD76U5kQESdKsZvzDHfx5)

Status: Beta, Data on demand

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `Meta` | object | Yes |  |
| `Meta.DataModel` | string | Yes | Order |
| `Meta.EventType` | string | Yes | Query |
| `Meta.EventDateTime` | string or null | No | Displays the UTC date and time that an outgoing request is delivered or an incoming request is received. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Meta.Test` | boolean or null | No | Indicates whether the request is a test or not. |
| `Meta.Source` | object | No | Contains the information for the system initiating the message, including the source ID and name. *Included in messages from Redox* |
| `Meta.Source.ID` | string or null | No | 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* |
| `Meta.Source.Name` | string or null | No | Displays the name of the system initiating the message. |
| `Meta.Destinations` | Array of object | No | 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.* |
| `Meta.Destinations[].ID` | string or null | No | Identifies the endpoint that the request is directed to. *UUID* |
| `Meta.Destinations[].Name` | string or null | No | Displays the name of the endpoint that the request is directed to. |
| `Meta.Logs` | Array of object | No | Contains the log identifier(s) for the request. |
| `Meta.Logs[].ID` | string or null | No | 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* |
| `Meta.Logs[].AttemptID` | string or null | No | Identifies the request log attempt value, which is useful when retries are possible. *UUID* |
| `Meta.FacilityCode` | string or null | No | 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 | No | Array of patients to find orders for. *If multiple patients are provided, all orders associated with any of the patients will be returned.* |
| `Patients[].Identifiers` | Array of object | No | List of IDs and ID types that identify the patient. *If multiple identifiers are provided, only patients with all identifiers will be considered.* |
| `Patients[].Identifiers[].ID` | string or null | No | ID for the patient. |
| `Patients[].Identifiers[].IDType` | string or null | No | Type of ID. *E.g. MRN, EPI* |
| `VisitNumbers` | Array of string | No | 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 or null | No | Start of the time range to search for orders. This is based on the Order.TransactionDateTime. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `EndDateTime` | string or null | No | End of the time range to search for orders. This is based on the Order.TransactionDateTime. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `OrderIDs` | Array of string | No | 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 | No | Procedures to search/filter by. *All orders associated with any of the procedure codes provided will be returned.* |
| `Procedures[].Code` | string or null | No | Code for the procedure |
| `Procedures[].Codeset` | string or null | No | Code set used to identify the procedure. *If no code set is specified, a health system specific identifier is being used.* Value set b442f8b8-b0b5-4af5-83a6-0cbd4c87204a: NPI, LOINC, ICD-10, NDC, CVX, SSN, SNOMED CT, RxNorm, CPT-4, ICD-9, HCPCS, Unknown, ICD-10-CA |

## Example

```json
{
  "Meta": {
    "DataModel": "Order",
    "EventType": "Query",
    "EventDateTime": "2026-11-18T19:05:05.809Z",
    "Test": true,
    "Source": {
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
      "Name": "Redox Dev Tools"
    },
    "Destinations": [
      {
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
        "Name": "Redox EMR"
      }
    ],
    "Logs": [
      {
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
      }
    ],
    "FacilityCode": null
  },
  "Patients": [
    {
      "Identifiers": [
        {
          "ID": "0000000001",
          "IDType": "MR"
        },
        {
          "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
          "IDType": "EHRID"
        },
        {
          "ID": "a1d4ee8aba494ca",
          "IDType": "NIST"
        }
      ]
    }
  ],
  "VisitNumbers": [],
  "StartDateTime": "2020-05-05T06:00:00.000Z",
  "EndDateTime": "2020-05-05T07:00:00.000Z",
  "OrderIDs": [
    "157968300"
  ],
  "Procedures": [
    {
      "Code": "49086-2",
      "Codeset": null
    }
  ]
}
```
