Extensions for data models

Redox data models contain the most common, industry-standard data fields, but they don’t cover every possible use case. When your workflow requires specific data that isn’t in the standard—for example, an appointment’s confirmation status—we offer extensions to add those fields.

When supported, a data model might have multiple extensions. Also, an extension container can have one or more extensions within it.

We review whether the data is critical and can be supported before adding an extension. Keep in mind that some of your connections may not support extensions.

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

At Redox, we value belonging. It’s important to us to support this diversity data when it’s available from your connection. We offer extensions on every data model to support diversity-related information. If your connection can send or receive diversity data, you can exchange it through Redox without needing to upgrade to a higher platform tier.

An extension applies to a specified data model, event type, and field. The Extensions container holds extension objects. The key of the object (e.g., additional-phones) identifies the extension, and the value contains the extension’s data. You can also include an optional url field for reference.

We offer an Additional Phone Numbers extension for these data models.

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

Some notes about the code example below:

• The top-level key has the name of the extension. The value for that top-level key can include the extension URL.
• Any event type (*) is allowed.
• Visit.Location is one available field for this extension.
• The url is optional. Use the actual key name to find the extension.
• The actual value additionalPhones is required.

1
{
2
  "Meta": {
3
    "DataModel": "Scheduling",
4
    "EventType": "New"
5
  },
6
  "Visit": {
7
    "Location": {
8
      "Extensions": {
9
        "additional-phones": {
10
          "url": "https://api.redoxengine.com/extensions/additional-phones",
11
          "additionalPhones": {
12
            "home": [
13
              "+16088675309",
14
              "+16088675308"
15
            ],
16
            "office": [
17
              "+16088675309"
18
            ],
19
            "mobile": [
20
              "+16088675307",
21
              "+16088675306"
22
            ]
23
          }
24
        }
25
      },
26
      {{Other Location fields}}
27
    },
28
    {{Other Visit fields}}
29
  },
30
  {{Other top-level fields}}
31
}