Set up sources

Last updated: Jan 6, 2026

IMPLEMENTATION

HEALTH TECH VENDOR

HCO

You can self-serve to set up API sources (i.e., JSON via HTTPS) to send data to Redox. Learn more about sources.

To create non-API sources, talk to your Technical Account Manager.

Platform API endpoints

This article describes how to manage sources in the Redox dashboard. To manage destinations via API, use these Redox Platform API endpoints instead:

Prerequisites

A user must be assigned to an engineer role to manage sources. Learn about user roles.
You must be part of the closed beta with Redox to create non-API sources (i.e., SFTP, MLLP). Talk to your Technical Account Manager if you have questions.
To delete a source, you must be logged into a development or staging environment. Production sources can’t be deleted without a Redoxer.

View sources

Follow these steps to view any existing sources.

Log in to the Redox dashboard.
From the navigation menu, click the Developer page.
By default, the Sources tab opens with any configured sources and OAuth API keys. To view a specific source’s configuration details, click the Edit button on its tile.
VPN status for MLLP sources
If you have any MLLP sources, you can view its VPN status at a glance. Learn how to check a VPN status.

Create a source

On the Sources tab, click the New source button to open the source wizard. The instructions below take you through each step of the source wizard.

The New Source button is on the top right of the Sources tab.

Create a new source

Step 1: Select source type

Click the checkbox to acknowledge that you’re creating a source for your own Redox organization, not your connection. This is a legal requirement, so you can’t proceed without this acknowledgement.
Enter a human-readable name for the source. This will be the display name on the Sources tab.
Source names
There aren’t any restrictions around source names. That means you could end up with duplicate names.
We recommend creating unique, descriptive names so you can more easily distinguish between sources.
(For multi-region users only) From the Region drop-down field, select the Redox service region.
From the Data format drop-down field, select the format of the data and how it will be sent (i.e., source type). Currently, you can send JSON via HTTPS (i.e., API sources only).
Beta users
Beta users can create API, SFTP, or MLLP sources. You can select any of these data format options:
JSON via HTTPS
HL7v2 via SFTP
HL7v2 via MLLP
(Optional) From the Sending system type drop-down field, select the EHR system this source will pull data from. Begin typing the EHR name to filter the list or enter a free text name if you can’t find the one you’re looking for.
Click the Next button. You can also click the Exit button to discard the new source configuration.
Step 1: Select source type

Step 2: Configure source

Enter the configuration details based on the source type.

Save progress option

You can exit the source wizard at any time. If you’ve already started entering source settings, click the Save progress option to save what you’ve done so far and exit the wizard. The new source appears on the Sources tab with a status of in progress. Edit the source to complete setup at any time.

Keep in mind that the save progress option is disabled when editing sources after completing setup.

Option 1: Configure an API source

Option 2: Configure an SFTP source (beta)

Closed beta feature

This is a closed beta feature for a limited pilot group. We’re not currently accepting additional participants, but we’ll let you know when it’s available to everyone.

Set the following configuration details for SFTP sources:

SFTP username: Use this username to authenticate data you’re pushing to Redox. This is assigned by the SFTP server.
SFTP password: Click the Reset password button to generate one from the SFTP server. Store this value and use it to authenticate data you’re pushing to Redox.
Copy your password first
Your new SFTP password only displays once, so be sure to copy the value before you leave this page.
(Optional) Sending system time zone: Select the time zone for any timestamps in data payloads you’re sending from your system. This is the time zone we’ll use to normalize timestamps in your outbound messages if the time zone isn’t specified in the payload.
Add at least one config link to define the Redox data model and Redox base config to apply to data you’re sending.
One source, multiple destinations
One source can send multiple message types (e.g., PatientAdmin or Scheduling) to a destination or the same message type to multiple destinations.
You’ll need one config link for each message type, and one subscription for each destination.
1. Select the Redox FHIR® data model that data will be normalized to before sending to your connection.
  Data model(s) are required to pass validation
  Unless you want to pass data through exactly as-is, you must select a data model. Otherwise, your message will fail validation checks.
2. Select the related Redox base config to apply, which contains customized instructions for normalizing data from your source. Learn about base configs.
  You need a base config link for each type of HL7v2 message you’re normalizing to FHIR® from this source. Base configs are named for the type of HL7v2 message you’re sending and the FHIR® notification to normalize your data to (see our FHIR® notifications).
  Choose one of these available base configs for sources:
  MDM to FHIR®
  ORM RDE to FHIR®
  ORM to FHIR®
  RDE to FHIR®
  ADT to FHIR®
  ORU to FHIR®
  SIU to FHIR®
  DFT to FHIR®
  Just remember you’ll need a subscription for every base config link you add. Learn how to create a subscription.
3. To add another base config, click the Add config link button and repeat the previous two steps. Otherwise, click the Next button to continue.

A user completes the SFTP source configuration in Step 2 of the source wizard.

Step 2: Configure an SFTP source

A user adds multiple config links to the SFTP source.

Add multiple config links

Option 3: Configure an MLLP source (beta)

Closed beta feature

This is a closed beta feature for a limited pilot group. We’re not currently accepting additional participants, but we’ll let you know when it’s available to everyone.

Set the following configuration details for MLLP sources:

VPN: Select the VPN configuration to use to secure traffic coming from this source.
No VPNs configured
Only a Redoxer can set up a VPN for you. Talk to your Technical Account Manager if you don’t see one available.
Sending system IP addresses: Enter the IP address(es) that the source sends data from to Redox. These addresses must be within the noted configured encryption domain(s) for the VPN.
Redox receiving IP address: This field is pre-populated with the Redox IP address, which can't be edited.
Redox receiving port: Select an available port to direct your outgoing traffic to Redox.
Ports reserved by Redox
A Redoxer reserves one or more ports for you. A port is reserved for a single source. Talk to your Technical Account Manager if you don’t see any ports available.
For traffic to be routed appropriately, data must be sent from one of the sending system IP addresses you listed to the Redox receiving IP address and a configured Redox receiving port.
(Optional) Sending system time zone: Select the time zone for any timestamps in data payloads you’re sending from your system. This is the time zone we'll use to normalize timestamps in your outbound messages if the time zone isn't specified in the payload.
Add at least one config link to define the Redox data model and Redox base config to apply to data you’re sending.
One source, multiple destinations
One source can send multiple message types (e.g., PatientAdmin or Scheduling) to a destination or the same message type to multiple destinations.
You’ll need one config link for each message type, and one subscription for each destination.
1. Select the Redox FHIR® data model that your data will be normalized to. This is the schema format that your data will be normalized to before Redox processes or sends to your connection.
  Data model(s) are required to pass validation
  Unless you want to pass data through exactly as-is, you must select a data model. Otherwise, your message will fail validation checks.
2. Select the related Redox base config to apply, which contains customized instructions for normalizing data from your source. Learn more about base configs.
  You need a base config link for each type of HL7v2 message you’re normalizing to FHIR® from this source. Base configs are named for the type of HL7v2 message you’re sending and the FHIR® notification to normalize your data to (see our FHIR® notifications).
  Choose one of these available base configs for sources:
  MDM to FHIR®
  ORM RDE to FHIR®
  ORM to FHIR®
  RDE to FHIR®
  ADT to FHIR®
  ORU to FHIR®
  SIU to FHIR®
  DFT to FHIR®
  Just remember you’ll need a subscription for every base config link you add. Learn how to create a subscription.
3. To add another base config, click the Add config link button and repeat the previous two steps. Otherwise, click the Next button to continue.

A user completes the MLLP source configuration in Step 2 of the source wizard.

Step 2: Configure an MLLP source

Step 3: Confirmation

The Confirmation tab opens with a summary of the settings you’ve configured. When you’re finished reviewing, click the Confirm setup button. Or, click the Back button to change any settings before confirming.
The source is created and its confirmed settings display. To test sending data with this source, click the View dev tools button. Otherwise, click the Exit button to return to the Sources tab.
Step 3: Confirmation

Next steps

For SFTP or MLLP sources, create a subscription for each config link you added.

For API sources, authenticate an API key to start sending data.

Authentication how-tos

Learn how to authenticate API keys:

OAuth API key (recommended method)
legacy API key

Edit a source name

Follow the steps to view sources.
Find the source you want to rename, then click the Edit button.
The source wizard opens. You can view the source’s configuration details or edit the source name.
Sources you didn’t create
You can edit any source name in your organization, whether a user in your organization or a Redoxer created the source. Your editing options are the same (i.e., only source name is editable) for both API and non-API sources.
Click the Next button to navigate through the rest of the wizard steps.
If using OAuth API keys
If using legacy API keys, you can’t edit the legacy API key value, but you can generate a new secret value for it.
If using our recommended OAuth API keys, you can ignore the legacy API key settings.
When you’re finished, click the Confirm setup button.
Edit a source name

Delete a source

Can’t delete production source

You can’t delete a production source without a Redoxer’s help. Talk to your Technical Account Manager if you need to delete a source in a production environment.

Follow the steps to view sources.
Find the source you want to delete and click the Delete button.
A modal appears asking you to confirm the deletion. Click the Delete button to confirm—or the Cancel button if you changed your mind.
Delete a source

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®.