API Reference

Platform overview

Workflow Health is a software platform that coordinates services for healthcare companies.

API Functionality

Companies can use the Workflow Health API to manage patient data, perform a variety of healthcare services, and easily exchange data with other companies using the Workflow Health platform.

Lab API

This documentation is focused on clinical diagnostics and laboratory-specific services including COVID-19 testing.

1408

Step 1 - Create your account

If you are interested in using the Workflow Health API, please schedule a call with us here.

Once your company is in our system, we will provide your team with API keys for access.

You will receive a production/sandbox key pair that looks like the following:

Production KeySandbox Key
live:XXXXXXXXXXXXXXXXXXXXXXXXtest:XXXXXXXXXXXXXXXXXXXXXXXX

Step 2 - Familiarize yourself with the API

This documentation represents the current state of the Workflow Health API. These docs are subject to change over the course of development. We will let you know about any major changes in advance via email.

The documentation is primarily organized by resources. Most endpoints support basic actions like create, read, and update. POST requests are not idempotent. If you submit information (test order/patient/etc.) and are unsure if it has been received, first check if the resource exists by listing the respective resource in your account.

Testing code

To test your code, you can either copy the requests and paste them into your terminal (assuming your machine supports cURL). Otherwise, if you have the Postman app, you can copy a code example and import it into your Postman editor.

Support

If you need help, feel free to contact us anytime at [email protected] for assistance.