Skip to main content

Create Study

POST 
/v1/studies

Overview​

Use this endpoint to create an in-house study.

For in-house studies you must ensure that the patient is handed an Acurable diagnosis kit with the relevant sensors included.

Reference​

When creating your study you must provide a unique reference for it.

We will use this reference for deduplicating requests. If we receive 2 requests to create a study 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
  • 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.

Activation Codes​

When the study is created the response will include an activation code value.

This value needs to be provided to the patient so they can activate the study.

The mobile app supports the scanning of QR codes so we recommend rendering this as a QR code for the patient, otherwise they will need to type it into the app in order to activate their study.

Request​

Responses​

Created

Response Headers
    Location

    URI of newly created resource