A connection is a partner organization that agrees to exchange healthcare data with you via Redox. A single connection may include one or more subscriptions (i.e., integrations) between your system and your partner’s system.
Connections are important because they:
Represent a business relationship between you and another organization.
Enable data flow between different systems.
Simplify integration since you can build multiple subscriptions for one connection.
We help you establish connections with your preferred partner organization(s). You can view them on the Connections page of the Redox dashboard.
Connections must have subscriptions
For a connection to appear in the dashboard, it must have at least one subscription. If you don’t see the connection you expect, talk to a Redoxer to make sure a subscription has been created for it.
Your Redox connections
When you set up your Redox organization, there are two default connections to Redox Engine and Redox Health System. These connections are available so that you can configure and test your system with Redox. Learn how to request a new connection.
Default connections
What are subscriptions?
A connection must have at least one subscription, but likely has multiple. A subscription is the bridge of data exchange between two systems. It links a source, destination, and data model to define how and what data is exchanged between two organizations.
One-party subscriptions
Closed beta feature
This is a closed beta feature for a limited pilot group by invitation only. We’re not currently accepting additional participants, but we’ll let you know when it’s available to everyone.
Typically, a subscription is the bridge of data exchange between two parties (or two systems). However, you can choose to have a subscription with yourself, meaning your organization owns both the source and destination.
To populate a cloud repository, you can create a cloud destination within your Redox organization, then set up a subscription from a source you own. Learn how to create a destination.
View your Redox subscriptions
On the Connections page of the Redox dashboard, you can view either:
One connection’s subscriptions at a time in a visual flow on the Connected orgs tab.
All your subscriptions at once in a table on the All subscriptions tab.
By default, the Connected orgs tab opens with tiles for each of your connections. To view subscriptions for one connection at a time, click the connectiontile you want to review. The Subscriptions tab opens with a visual of the sources and destinations used, the type of data exchanged, and the direction of traffic.
Connected orgs tab: View one connection’s subscriptions
Subscriptions show the “what” and “how” of each implementation (i.e., integration) with your Redox connections.
Your subscriptions
Description
1
Your Redox organization. This list shows the source or destination in each subscription that you own.
2
The name and ID of the source or destination. Click the name to open the settings or the copy icon to copy the ID.
If any of these use a VPN, a status icon with a color code shows the current VPN status. Learn more about VPN statuses.
You can also navigate to the Developer page to view all your sources and destinations independent of their subscriptions.
3
Your connection’s organization. This list shows the source or destination in each subscription that your connection owns.
4
The name and ID of your connection’s source or destination. Click the name to open the settings in a read-only view. Or click the copy icon to copy the ID.
If any of these use a VPN, a status icon with a color code shows the current VPN status. Learn more about VPN statuses.
There might be duplicate IDs if your connection has one source or destination for asynchronous and synchronous traffic. It might look like your connection has extra sources or destinations, but it’s only splitting them out by traffic type.
5
The type and direction of traffic.
The type is the Redox data model or FHIR® resource that’s being exchanged.
The direction of the arrow for asynchronous traffic goes from the source to the destination. This represents one-way traffic that’s delivered without waiting for a response.
The direction of the arrow for synchronous traffic shows traffic going from the destination to the source. This represents two-way traffic: The source sends a query and the destination responds with results.
The number of arrows matches the number of subscriptions you have.
To see another view of how data travels from source to destination, learn about logs.
To view all existing subscriptions at once, click the All subscriptions tab. A table opens with an active subscription in each row. Subscriptions are grouped by connection (i.e., connected org), then source, then destination. For beta one-party users, learn how to create a subscription.
All subscriptions tab
To narrow down the list of subscriptions, enter any value into the Search keyword field. For example, to search for active subscriptions, enter “Active” in the Search keyword field. The table filters to only subscriptions with an Active queue status.
All subscriptions table
Review the details in the columns of each displayed subscription:
Connected org: The organization name of the connection. Click the sort icon to sort the subscriptions by connection alphabetically in ascending or descending order.
Source: The name, owner, VPN status (if applicable), and directionality of the source associated with the subscription.
Hover over the copy icon to view or copy the source ID. Or, click the source name to open the Details page to view its configured settings and VPN details.
If your organization owns the source, users assigned to an engineer role can click the Edit button to open the source wizard or click the Delete button to delete the source from the Details page. Learn more about roles.
If your organization doesn’t own the source, you can view the name and basic details, including VPN ports (if applicable).
Subscription: The name of the subscription.
Click the subscription name to open the Details page with the source, destination, data model, go-live (i.e., activation) date, and queue information.
If a user in your organization created the subscription and is assigned to an engineer role, click the pencil icon to edit the subscription name.
If you own the destination in the subscription, you can view and manage filters from the Details page. Learn how to define filters.
For beta users, you can delete the subscription from the Details page, too.
Data model: The Redox FHIR® or Redox data model that determines the shape of the data being exchanged.
Click the View logs link to see the subscription’s related logs. The Logs page automatically opens with the source, destination, and data model filters already populated.
Queue: The current status of the subscription queue. Subscriptions with async traffic could have any of these three statuses:
Ready: The queue is ready for traffic, but nothing is flowing. Once traffic starts to flow after go-live, this changes to Active.
Active: The queue is running and traffic is flowing through the subscription queue. The queue depth (i.e., the number of async messages waiting to be processed in the subscription queue) appears beneath the status. Learn more about queues and handling async notifications.
Paused: A Redoxer has manually paused the queue. The queue depth still appears beneath the status. Talk to your Technical Account Manager for more details.
Queue depth
Most active, healthy async subscriptions have a queue depth close to 0. Queue depth might be higher if:
Destination: The name, owner, VPN status (if applicable), and directionality of the destination associated with the subscription.
Hover over the copy icon to view or copy the destination ID.
Users assigned to an engineer role can click the destination name to open the destination wizard and edit any destination settings. Learn more about roles.
What are sources and destinations?
A subscription must have one source and one destination. Sources and destinations are the building blocks of data exchange:
A source represents where a messages starts (i.e., SEND, REQUEST). Think of a source like the address in the “From” line of an email header, which specifies where the message originates.
A destination represents where a message is delivered (i.e., RECEIVE, RESPOND). Think of a destination like the address in the “To” line of an email header, which specifies where the message should go.
You can view and manage sources and destinations on the Developer page of the Redox dashboard.
Your sources and destinations
One of the main benefits of Redox is that you can typically use the same API source and destination to exchange data with all of your connections. However, you might want to use unique sources and destinations for each communication method. Learn more about data exchange.
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®.
