How can we help?

The purpose of this tool is to provide a straightforward way to test API connections. Rather than diagnosing configuration problems manually, implementation teams can use the tool to quickly verify whether a connection is set up correctly. When a connection succeeds, the tool confirms it is properly configured. When it fails, the tool goes a step further by indicating the likely cause of the issue, helping teams resolve problems faster and with less guesswork.

Note: This tool is currently only available for Epic integrations, and only supports a limited set of use cases (see below). More use cases will be added as new APIs are built.

• Available Use Cases
• Creating a Scenario
• Running a Test
• Managing Scenarios
  • Downloading a Scenario
  • Adding a Pre-Created Scenario

Available Use Cases

The tool currently supports testing the following Epic use cases:

Patient Lookup

• Using the MRN
• Using Phone Number + Date of Birth

Screen Pop

• Using the Patient ID
• Using the Phone Number
• Using the Phone Number + Date of Birth

Get Future Appointment (includes Patient Lookup and Get Future Appointments)

Schedule Appointment – Open Scheduling / Direct Scheduling (includes Patient Lookup, Get Available Slots, Schedule Appointment)

Reschedule Appointment – Open Scheduling (includes Patient Lookup, Get Future Appointment, Get Available Slots, Schedule Appointment, and Cancel Previous Appointment)

Reschedule Appointment – Direct Scheduling (includes Patient Lookup, Get Future Appointment, Get Available Slots, Reschedule Appointment)

Patient Billing (includes Patient Lookup and Get Patient Billing Details)

Tip: New use cases are added whenever a new API is built, so check back periodically for updates.

Creating a Scenario

Follow these steps to create and run a test scenario.

1. Log in to your account and open the Integrations Validator app
2. Navigate to the Scenarios tab.
3. Click Add Scenario.
4. Choose whether to add the scenario manually or import it from an XLS file.

To add a scenario manually:

5. Enter a name in the Scenario Name field.
6. Click Add Manually — a list of available use cases will appear.
7. Select the use case(s) you want to test.
   • Optional Substep: Within each use case, unselect/select individual steps of the flow you want to test.
8. Fill in the required testing data fields that appear at the bottom of the page.
   • Note: If multiple use cases are selected, the fields for all of them will appear together.
9. Click Add Scenario at the bottom of the page.

You can run multiple scenarios at once — for example, testing a patient with future appointments alongside one with none — to cover different conditions in a single pass.

Running a Test

1. Once created, the scenario will appear in the Scenarios list.
2. Click Run Scenarios.
3. Review the results in the Execution Results section, which shows full details of what succeeded and what failed, including likely causes for any failures.

• Note: Scenarios and Execution Results are not saved permanently — they disappear once you leave the app.

Managing Scenarios

You can save and reuse scenarios across sessions by downloading and re-importing them.

Downloading a Scenario

1. In the Scenarios tab, click Edit on the scenario you want to download.
2. Click Download at the bottom of the scenario's page.

Adding a Pre-Created Scenario

1. Click Add Scenario.
2. Click Import from XLS.
3. Choose the file you want to import and confirm.