Table of Contents

Data model reference

Data models are the base for exchanging data with the Redox Data Model API. Learn more about the Data Model API.

Data models describe the categories of data that can be exchanged with your connection, and they can be combined to perform API actions. In the Meta section of a message, you or your connection must specify the data model that’s being exchanged.

These data model reference pages contain the schemas, fields, and values for each data model. But first, here are some tips for understanding these reference pages.

Field tags

We use tags on some fields in the data model schemas to convey what to expect for a given field.

Required

When a field is required, we use a required tag so that you know when a field must be included when exchanging data. You can use the Required toggle button at the top of the schema if you only want to see required fields.

Reliability ratings

We can only pass data that we have access to. Depending on the healthcare organization or EHR system, some fields may or may not be available to us. We do our best to get as much data as possible from each EHR system, but there may be some differences. During the testing process, we identify which fields you can expect based on the given healthcare organization and EHR system.

We use tags with reliability ratings for given fields to show whether a field is reliable, probable, or possible. Learn about our reliability rating definitions.

Valuesets

We also use tags when a field only allows a particular valueset, or allowable values. If this is the case, there's a drop-down on the field with the supported values. You can use the Translation toggle button at the top of the schema if you only want to see fields with specific valuesets.

Redox API endpoint

Whenever you send a data model, you must direct it to the Redox API endpoint. Whenever you receive a data model, you can configure your endpoint in the Redox dashboard.

Authentication

Before sending or receiving a data model, you must authenticate your system. Learn how to authenticate with Redox.