The Redox API makes healthcare data useful by providing a modern, standardized API that can be used to communicate with a vast array of EHRs, medical devices, applications, and other healthcare data systems.
As such, the Redox API is the preferred means of connecting your system to Redox. Details on how to integrate with the API depend on what you need to do via Redox:
- Initiating Requests (Source) –
SENDorREQUESTdata - Processing Requests (Destination) –
RECEIVEData orRESPONDto Requests
There are many other ways of connecting to Redox. Most Redox customers choose Redox so that they can utilize the Redox API as a single interface to communicate with external systems that have a variety of different communication methods, data formats, authentication or other connectivity requirements.
For reference on these other means of connectivity, see: Other Integration Methods
The API works with all Redox data models: https://developer.redoxengine.com/data-models/
Some data model properties can only contain a limited set of values, called a ValueSet.
Whether you are initiating or processing Redox API requests, you should expect or utilize only the listed “Supported Values” for these properties.
Redox data models have been built to support a wide range of data elements. However, depending on the source of the data, a given field may not always be populated.
To help illustrate this, our data model documentation has an estimated reliability rating for each field:
| Field Rating | Estimated Reliability | Description |
|---|---|---|
Reliable | > 90% | Expect this field to be present for nearly every request |
Probable | > 50% | Expect this field to be present for most requests |
Possible | < 50% | Expect this field to be present for some requests |
All Date and DateTime values sent from over the Redox API will be formatted in ISO 8601 format.
| Type | Format | Example |
|---|---|---|
| Date | YYYY-MM-DD | 2021-09-22 |
| DateTime | YYYY-MM-DDThh:mm:ss.sssZ | 2021-09-22T10:20:30.000Z |
Redox API always uses UTC timestamps
Redox always converts timestamps within a request to UTC±00:00.
This means that, regardless of the original timezone, all timezones will be UTC±00:00 in payloads sent by Redox when:
-
your system RECEIVEs a request from Redox
-
your system REQUESTs data via Redox and is returned a result
In order to protect our customers, we employ rate limiting across our APIs. You can make up to 7,500 requests every five minutes per user as determined by IP address.
If your IP address exceeds this limit, until the five minute window has elapsed, we respond to requests in the following way:
- We send an HTTP 429 status code response.
- We add an X-RateLimit-Limit HTTP response header with the current limit (7500).
This limit should be sufficient for any nominal operation, but may cause issues during backloads. We expect you to throttle your API requests to stay within this limit. If this is not possible, reach out to your assigned support personnel to examine alternative options.