Introduction to the Redox Data Model API

Last updated: May 8, 2025

IMPLEMENTATION

PRODUCT OWNER

HEALTH TECH VENDOR

One of the most popular options for exchanging data is the Redox Data Model API. This modern, standardized API handles all your data mapping, translation, and connectivity needs.

The Data Model API relies on standardized data models, which describe the categories of data that you can exchange with your connection. Data exchange happens via an encrypted communication method, typically HTTPS.

You can combine data models to perform a given action to accomplish your unique workflow. 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 configure and verify an endpoint to process requests.

Explore the Redox Data Model API

Review our supported data models to see which types of requests you can send and receive with the Data Model API. Or, you can download the JSON schema v4 files or download the TypeScript type definitions to explore our current data models for yourself.

Many ways to greatness

There are many ways to connect with Redox—our Data Model API is only one. It offers a single interface to manage integrations with a variety of different communication methods, data formats, authentication, or other connectivity requirements. But you can also check out our other integration methods.

Push vs. pull methods

There are two possible methods for exchanging data using our Data Model API:

Push: This is an event-based method where user actions within your connection's system trigger a notification. Your connection then pushes the notification to a webhook that you've established. For example, when a new appointment is scheduled or a new patient is registered in the EHR system.
Pull: This is a query-based or polling method where you request clinical data and receive the data from your connection's system on demand. For example, you search for a patient using their demographic data and the EHR system returns the relevant results.

Available data fields

We can only pass data we have access to. Depending on your connection, some data may or may not be available. We do our best to pass all the available data, but there may be differences in what you receive from different connections.

During the testing process, we help you identify which data points you can rely on, based on the given healthcare organization and EHR system you’re integrating with.

Each data model has supported event types with a corresponding push or pull method. These event types consist of JSON fields and values. We note for you in each data model which fields are required. If a field has a required tag, you must include this field for Redox to successfully process your request.

We can help you determine which data models fit your needs best.

Data on demand

Depending on your system, we may recommend sending and receiving data via polling or data on demand. We can help you decide what may suit your system the best based on your unique integrations. Learn more about data on demand.

Supported data models

Data model schemas

Before onboarding, it’s important to have a clear understanding of what data your connection will or won't provide. Our Implementation team works with you to document the data integration needs or plan for any customization. Browse through our data models to see what you can expect. Also, check out tips for reviewing our schemas.

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.