Set up sources

Last updated: Apr 8, 2025

IMPLEMENTATION

HEALTH TECH VENDOR

HCO

You must set up sources to send data to Redox. Learn more about sources.

Only for engineer roles

Any user in a given environment may view connectivity settings, including sources, destinations, API keys, and authentication credentials. However, you must be assigned to an engineer role to manage them (i.e., create, verify, edit, or delete). Learn about roles.

This how-to is only for users with an engineer role.

Platform API endpoints

This article contains instructions for managing sources in the Redox dashboard. If you’d like to create and manage destinations via API instead, use these Platform API endpoints:

Create a source

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 API keys. To create a source, click the New source button.
A modal opens for the source name. Enter the source name then click the Add button.
The source is created and its Settings page opens. You can edit the source name, copy the legacy API key value, or generate a new secret value for the legacy API key. If you do any of these things, click the Save button when finished. Otherwise, click the back arrow to return to the Sources tab.
Legacy API keys
A legacy API key is automatically created with every new source. We call them legacy API keys because they’re no longer our recommendation authentication method. You can still use legacy API keys, but our preferred authentication method is OAuth API keys. Learn how to use OAuth API keys.
Even when you use OAuth API keys, you’ll still see a legacy API key in any source’s settings. This doesn’t change anything about your authentication process, so you can ignore the legacy API key value and secret.

Create a new source
Next, 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
user-level API key (for Redox Platform API requests)

Edit a source

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 API keys. Find the source you want to modify and click the Edit button next to it.
The Settings page displays the source name, legacy API key value, and secret details. Edit the source name.
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 Save button.
Edit the source name

Delete a source

Can’t delete production sources

You can only delete sources in staging or development environments.

Log in to the Redox dashboard.
From the navigation menu, click the Developer page.
By default, the Sources tab opens and displays any configured sources and API keys. Find the source you want to delete and click the Edit button next to it.
The Settings page opens. Scroll down and click the Delete button.
Disabled delete option
The delete option may be disabled if:
You don’t have the right role assignment. Learn about user roles.
Your organization has already migrated to production. Talk to your Technical Account Manager to delete production-level assets.
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®.