IHD LabFlow (2.29.1)

An API for managing orders with Innovative Health Diagnostics.

Introduction

The LabFlow API offers diagnostics-as-a-service features to its partners.

Partner Workflows

There are many different varieties of workflows that are enabled by the LabFlow API, which are customized based on the specific needs of the partner.

In scenarios where IHDLab will be handling the process of fulfilling patient kit orders, the partner's workflow will begin with a Kit Order.
In scenarios where the partner will provide the kit to the patient through other means, the partner's workflow will begin with a Lab Order.

Authentication

The LabFlow API offers a single authentication mechanism: API keys. API keys are generated on a per-organization basis and are used to authenticate requests to the API. API keys are passed in the x-api-key header.

Active partners will be provided with an admin portal to manage its own keys. Contact daas.support@ihdlab.com to request access to the portal or require a staging key for testing.

Code Samples

IHD provides a sample application to illustrate common interactions with the API later.

• LabFlow Example in React/JavaScript

Common Questions

Q: How do I get my API key?

A: As part of partner onboarding, you will be provided with a One-Time Token URL, that can be consumed via a webbrowser or an API platform built for calling REST APIs. The response payload will contain the API key that can be used for your calls. Once the token is consumed, it will no longer be available and subsequent calls will receive a 404 error.

If you are using a browser with plugins, the URL may be consumed by one of the plugins, returning a 404 error, therefore we recommend using a neutral browser profile or a tool like Postman/Insomnia.

Q: Why do the mocked results look different than I'd expect?

A: Every partner's panel configuration is different, so there will be differences with the results and rejections returned. We can provide a customized mock after the original kit is configured by the lab, but until then, a more generic mock will be returned that demonstrates the keys and sample values in the payload.

Q: Why do the mocked results look different than I'd expect?

A: Every partner's panel configuration is different, so there will be differences with the results and rejections returned. We can provide a customized mock after the original kit is configured by the lab, but until then, a more generic mock will be returned that demonstrates the keys and sample values in the payload.