Test a destination

Testing a destination, or endpoint, in your organization is useful to make sure you're receiving data as expected data from Redox. This kind of testing is especially useful during onboarding to Redox or implementing with a new connection before go-live.

There are two Redox dashboard tools for testing your destinations:

• Notifications Explorer: Send test Redox data model or FHIR® messages to your configured destination(s). This simulates the Redox-to-destination part of your integration.
• Dataset Tester: Send test datasets to your configured destination(s). This simulates the entire source-to-destination flow.

We currently support sending test messages that are already in a Redox data model or Redox FHIR® format. This means simulating an individual message coming from Redox to one of your destinations.

1. Log in to the dashboard.
2. From the navigation menu, click the Developer page.
3. By default, the API Keys tab opens. Click the Test Tools tab.
4. The Notifications Explorer opens. The API toggle allows you to choose whether to test receiving a Redox data model, FHIR® notification, or FHIR® message. Select Data Model API for data model messages or FHIR® API for FHIR® notifications or messages.

   Reference links

   For data model specs, review our data model reference.

   For FHIR® message or notification specs, review our FHIR® notification reference.

5. From the Destination drop-down, select the configured destination you want to test. You must have already created the destination in the Destinations tab (for API destinations) or Other tab (for non-API destinations) for it to appear in the drop-down menu.
6. The Send with credentials option allows the test message to be verified by the destination with either auth credentials or verification tokens. Learn about authenticating incoming data. To use an auth credential, toggle to ON. Then select the auth credential from the drop-down menu that appears. To use a verification token, toggle to OFF.

   

   Sending without credentials

   Sending a test message without credentials to a destination configured to use an auth credential will result in an error.

   Manage auth credentials in the Redox dashboard. Or, manage auth credentials or update destinations via the Redox Platform API.

7. Depending on which API you selected, a drop-down for the set of data models or FHIR® messages and notifications displays. Select the type of test message to send.
8. Another drop-down may appear with examples. If there's more than one example available, select the example you want to use.
9. The example payload displays. Make any modifications you want to the payload. Once you're finished reviewing or making changes, click the Send button.
10. A success or failed notification displays. The notification contains a link to the related log ID so you can view the details.

    

    Log inspector not available

    Log inspector isn't available for test messages sent through Notifications Explorer.

11. (Optional) You can also send test messages to make sure your system can send the data your connection is expecting.

We currently support sending test messages that are in the raw format used by your connection's source. This means simulating data coming from a source being processed by Redox then delivered to one of your destinations.

This allows you to see the full breadth of how your subscription will work, since you'll see how data will change from source to destination. This may help you make any necessary configuration changes before go-live.

Follow these instructions to run Dataset Tester in the Redox dashboard. You can also run Dataset Tester via the Redox Platform API.

1. Log in to the dashboard.
2. From the navigation menu, click the Developer page.
3. By default, the API Keys tab opens. Click the Test Tools tab.
4. The Notifications Explorer opens. Click the Dataset Tester button.

   Staging or dev environments only

   You can't use Dataset Tester in a production environment. You'll see a warning asking you to switch to a non-production environment if you've selected Dataset Tester while in a production environment.

5. From the Dataset drop-down, select the relevant dataset type.

   Dataset support

   We currently support sending these dataset types to one of your configured destinations.

   • HL7v2 ADT
   • C-CDA

6. From the Destination drop-down, select the destination you want to test.
7. Click the Send button.

   Error due to lower rate limit

   Remember that with any of our test tools, the rate limit is five API requests per every five minutes. This means you can send up to five test datasets within a five-minute window. If you exceed this limit, you'll get an error message.

8. A success or failed notification displays. To view the logs, click the View logs link.
9. The Logs page opens with the appropriate filters applied so you can see all the logs that resulted from the full dataset.

   Error notifications

   If a test dataset fails, the resulting error is either from Redox or your system, which owns the destination. This should give you the opportunity to see what might fail and how your system handles those errors.

   If you want to dig into the errors, run log inspector and review the error details in the Deliveries tab.

10. Review the outcome of the message in the log. Run log inspector to dig into any errors or unexpected mappings. Then, make any necessary adjustments to your configuration(s).