Skip to main content

Create Referral

POST 
/v1/referrals

Overview​

Use this endpoint to create a referral for an at-home diagnostic test via our referrals & fulfilment service.

Our referrals service handles the verification of patient details before fulfilment occurs.

Our fulfilment service handles the shipping and return of the re-usable kit to the patients home address.

Referrals cannot be modified once created.

Reference​

When create your referral you must provide a unique reference for it.

We will use this reference for deduplicating requests. If we receive 2 requests to create an referral with the same reference then we will respond with a 409 Conflict response.

Study​

You can specify the following requirements for your study:

  • Number of nights - nights
  • Sensors to be used by the patient - neck_sensor and (optionally) oximeter

If you specify sensors that your account is not configured to use then you will receive a 400 Bad Request response.

Patient​

You must provide the following information about the patient:

  • Date of birth - dob
  • Name - name
  • Email - email
  • Mobile Telephone - mobileTelephone
  • Reference - reference

This reference should be different from your study reference and should uniquely identify the patient within your system.

Request​

Responses​

Created

Response Headers
    Location

    URI of newly created resource