Redox Data Model API

The Redox Data Model API is a popular, modern API method to exchange your healthcare data. This standardized API handles all your data mapping, translation, and connectivity needs. Data exchange happens via an encrypted communication method, typically HTTPS.

With the Data Model API, you can use Redox data models—standardized JSON schemas for organizing data—to exchange data with your connection(s). You can combine data models to perform a given action to accomplish your unique workflow.

We have data models to support notifications from your connection, querying your connection, and writing data back to your connection. Learn more about data exchange with Redox.

All outgoing messages via the Data Model API should be sent to https://api.redoxengine.com/endpoint. Learn how to authenticate your system so you can initiate requests, then learn how to set up destinations to process incoming messages.

Depending on your needs and your connection's capabilities, we might recommend using polling (learn about polling) or data on demand (learn more about data on demand) for accessing data you'd normally get through notifications or queries.

With data on demand, we support using these Redox data models:

• ClinicalSummary
• PatientQuery
• VisitQuery
• DocumentQuery
• DocumentGet
• Media
• Notes
• Orders
• PatientSearch
• Provider
• Results
• Scheduling
• Booked

Before onboarding, it’s important to have a clear understanding of what data your connection will or won't provide. Our Managed Services team works with you to document the data integration needs or plan for any customization.

Explore the Redox Data Model API

Review all available Redox data models you can use to send and receive healthcare data. Alternatively, you can download JSON schema v4 files or TypeScript type definitions in the Redox dashboard under Developer > Test tools > Dev tool downloads.

Check out tips for reviewing our schemas.