Basic Test Flow

This will guide you through how a basic testing flow works in the most simple form, from ordering the test to getting results.

10551055

1) Ordering

In order to start a test flow, you must first place an order using the Orders API to ship the kit to the end user. This requires you to know what type of kit you want to order and basic details of the customer such as name and shipping address.

Once the order is successfully placed, the kit will ship from the Chronomics warehouse direct to the end user. If you are in the US, the customer should be the same person as the patient.

998998

Example of the information required by the Orders API.

2) Registering

Once the end user receives the physical kit they must first register it before returning to the lab. Use the Registration widget to allow the user to complete the registration. Note: the registration is a complex process that differs per test type and region and includes instructions to complete the test hence is not available to complete via the API currently.

Once the registration is complete the end user ships the kit back to our lab with the pre-paid shipping method (instructions included in the kit and during the registration process).

393393

The SDK contains pre built registration flows.

3) Results

Once results are ready, you can call the Bio Tests API to receive them.

392392

Example of what the information from the results API can be used to display

πŸ“˜

Note about fetching results

When looking closely at the API reference, you will see that you need more than the order id to retrieve them. We use the following concepts:

  • the order id is assigned upon order creation, and returned in the response of the Order API endpoint. It is also included in all webhook events.
  • the kit id corresponds to the physical kit received by the end user. You can get this id from the webhook event TEST.REGISTERED. It is also included in all subsequent webhook events.
  • the test id corresponds to the test on the lab side. You can get this id from the webhook event TEST.LAB_ACCESSIONED. It is also included in all subsequent webhook events.
    Depending on the endpoint you target in the BioTest API, you might need to refer either the kit id or the test id. For more information on the webhook events and their payloads, see the dedicated page.

What’s Next