Skip to content
Tidepool API/Clinics API/
/
Preorder Form Webhook

Clinics API (1.0)

Web service that stores information about clinics, clinicians and their patients

Download OpenAPI description
clinic.v1.json
clinic.v1.yaml
Overview
URL

https://www.tidepool.org

Tidepool

support@tidepool.org

License

BSD-2-Clause

Languages
Servers
Mock server

https://tidepool.redocly.app/_mock/reference/clinic.v1/

integration

https://external.integration.tidepool.org/

production

https://api.tidepool.org/

dev1

https://dev1.dev.tidepool.org/

qa1

https://qa1.development.tidepool.org/

qa2

https://qa2.development.tidepool.org/

Clinics

Manage clinics, clinians and patients.

Operations

Confirmations

Manage confirmations for account creation, sharing invites, etc.

Operations

Internal

APIs intended for internal use by Tidepool.

Operations

Sync EHR Data

Request

An internal endpoint which will push the latest patient summary statistics and PDF reports for all patients who have an active subscription. The actual data is pushed asynchronously. A successful response means that an asynchronous task has been scheduled for each patient of the clinic with an active subscription.

Will return 404 Not Found if the clinic does not have an active EHR connection.

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/ehr/sync' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

Accepted

Preorder Form Webhook

Request

The Preorder endpoint can be invoked when a care provider attempts to place an order manually within the EHR. Subscribers can use Preorder Forms to present additional information to, or receive input from, a care provider before an order can be placed. Preorder Forms can also be implemented so as to prevent an order from being placed entirely.

https://sandbox.xealth.io/app/api-docs#tag/Digital-Care/paths/preorder/post

Security
sessionToken
curl -i -X POST \
  https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/xealth/preorder \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Get Programs

Request

Security
sessionToken
curl -i -X PUT \
  https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/xealth/programs \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Redox

Public endpoints invoked by Redox.

Operations