Extensions for data models

Redox data models don't contain absolutely every possible piece of data to exchange. You may find that there's data you want to exchange that isn't included in the data standards. Keep in mind that the data standards contain what's generally available in the industry, but doesn't cover all possible contingencies.

Take something like confirmation status of an appointment, as an example. It may be useful for one customer's workflow, but not widely used across the board. This is where extensions come in. Instead of adding all data to every data model, we can instead use extensions to add the relevant fields that are critical to exchange for your workflow.

That said, if we do have an extension for your workflow, it isn't guaranteed that your connection can support it. Before adding any extensions, we go through a review process to ensure that all other avenues have been explored and that the data is critical and can be supported.

If supported, it's possible for a data model to have multiple extensions, and an extension container may have one or more extensions within it.

Extension availability

For our Basic plan customers, extensions aren't available.

For our Standard plan customers, you may use existing extensions (i.e., extensions that we already developed for other customers). Check out our extension library.

For our Premium plan customers, you can request new extensions that are customized to your workflow. But remember, we go through a review process to add new extensions, so it isn't guaranteed that we create an extension for every request.

Representing diversity with Redox

Most healthcare standards don't account for representations of gender identity, sexual orientation, ethnicity, and disability.

Here at Redox, we value belonging and it's important to us that when available, we support that exchange of information for you. As a result, we have extensions available on every data model to support this information related to diversity. If your connection can send or receive this data, then you can do so with Redox, without needing to upgrade to a higher platform tier.

What an extension looks like

An extension applies to a specified data model, event type, and field. The extension container lives at the field path in the extension description, and the extension object contains field/value pairs based on the extension identified with the URL.

Let's look at a specific example. We offer an Additional Phone Numbers extension for these data models:

PatientAdmin
Scheduling
Event types
Available for all event types.
Fields
Patient.Demographics.PhoneNumber
Patient.Guarantor.PhoneNumber
Patient.Contacts[].PhoneNumber
Event types
Available for all event types.
Fields
Patient.Demographics.PhoneNumber
Visit.Location

When used for any of these fields, the Additional Phone Numbers extension contains values for extra home, office, or mobile phone numbers for the patient or location.

The top-level field has the name for the extension. The value for that top-level field has the URL for the extension. In the example below, you can see the top-level additional-Phones field with the relevant URL: https://api.redoxengine.com/extensions/additional-phones. You can also see the extra phone numbers for this particular location.

On this Page