Skip to main content

Create Order

POST 
/v1/orders

Overview​

Use this endpoint to create an order for an at-home diagnostic test via our fulfilment service.

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

Reference​

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

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

Result emitting​

You can override your organisation result emitting settings using the emitOn property.

This supports two different modes:

  • Emit when a result has been generated for the study - complete
  • Emit when a clinician has reviewed the study in our diagnosis app - reviewed

Omitting this value will make the system fall back to using your organisation settings for emitting results - as agreed upon during your onboarding.

Shipping Address​

We require an accurate and up to date shipping address for the patient when creating an order. We require the following:

  • Atleast 1 address line - lines
  • The city/town - city
  • The county - county
  • The postcode - postcode

Note: If you are shipping to a city which does not have a county (such as London) then enter the value London in both the city and county fields.

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 the patient requires a smartphone in their shipment - requiresPhone

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

We monitor the usage of the smartphone flag and will raise an alert to your account manager if we find there is abuse of this flag. You must ensure that you ask patients if they have a smartphone (Android or iOS) before you send their details through this service.

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.

Organisation​

During your onboarding process you will be assigned 1 or more organsiations within your account. Each of these organisations has:

  • A specific diagnostic product
  • A clinician

You must provide both the name and reference for the organisation you are creating the study within. If you do not provide a valid value then you will receive a 404 Not Found response.

Request​

Responses​

Created

Response Headers
    Location

    URI of newly created resource