What are Redox connections?

A connection is a partner organization that you can exchange data with via Redox. A single connection may include one or more technical integrations between your system and your partner's system. Check out the organizations we already work with to explore potential connections.

We help you establish connections with your preferred healthcare organization(s). Then, you can view all of your connections on the Connections page of the Redox dashboard.

The Connections page
The Connections page

When you first set up your organization on Redox, you have two default connections to Redox Engine and Redox Health System. These connections are available so that you can configure your system with Redox using any of the available data models.

Default connections
Default connections

Learn how to request a new connection.

API keys and endpoints

Before viewing your connections, though, you must create at least one API key and one endpoint. API keys and endpoints facilitate data exchange, whether via SEND, RECEIVE, REQUEST, or RESPOND. You can view and manage API keys and endpoints on the Developer page of the Redox dashboard.

The Developer page
The Developer page

The beauty of Redox is that you can typically use the same configuration (i.e., API keys and endpoints) to integrate with multiple connections. There are cases for having more than one configuration with Redox; for example, you may want a unique configuration for each communication method you establish. But most often, you can use the same configuration for a given API action to exchange data with all of your connections. 

Learn more about data exchange.

After you configure your system, we help establish the business agreement with your connection. Then, we help configure the nitty gritty details of the exchange, including specific data types, notifications, and filters (if applicable). After that, you get to see the visual picture of your configuration and connections on the Connections page of the dashboard.

Subscriptions

Once your Redox configuration is set up, the Connections page displays a list of your connections. You can open a connection's details by clicking on any of the tiles. The Subscriptions tab opens, which displays the respective subscription for that connection.

Select a connection to view subscriptions
Select a connection to view subscriptions

Subscriptions are a visualization of your data exchange with your connection. They show the type of data exchanged, the direction of the data, and your connection's endpoints. In other words, subscriptions visually convey all the nitty gritty details that we helped you configure. Subscriptions were previously known as data flows.

Subscriptions
Subscriptions

The left side of a subscription represents your system. Since you must have at least one destination (or endpoint) to receive data, the destination GUID of your system displays on the left. You can copy this GUID by clicking the copy icon next to it. You can also view and manage the endpoint by clicking on the URL for the endpoint, which opens the endpoint's Settings page. Or, you can navigate to the Developer page to view all your endpoints. If you have a VPN endpoint, you can also see a status icon with a color code to display the current VPN status. Learn more about VPN statuses.

The right side of a subscription displays a list of your connection’s endpoints, but some may have duplicate IDs. There may be duplicates if your connection uses one endpoint for multiple event types (e.g., one endpoint for both RECEIVE and RESPOND transactions). For the sake of simplicity, we show the endpoints for those transactions separately in the dashboard. So the list on the right may look like it has extra endpoints, but some simply display twice. 

You can copy your connection endpoint's GUID or view the endpoint's settings by clicking the URL, just like you can with your endpoints. The difference is that you can't edit your connection's endpoint details.

In between your system and your connection's system, an arrow indicates the direction of the data. The arrow's label shows the data model or FHIR® resource that's used, too. The number of arrows matches the number of data models or FHIR® resources you plan to exchange (SEND, RECEIVE, REQUEST, or RESPOND) with your connection.