Skip to content
Tidepool API/Clinics API/
/
Add Service Account

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

View PDF Report

Request

View PDF report for a given patient of a clinic

Security
sessionToken
Query
clinicIdstringrequired
patientIdstringrequired
restricted_tokenstringrequired
curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/xealth/report/web/viewer.html?clinicId=string&patientId=string&restricted_token=string' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Add Service Account

Request

Adds authentication client's service account as a new clinician member.

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
Bodyapplication/json
namestringnon-emptyrequired
client_idstringnon-emptyrequired
client_secretstringnon-emptyrequired
curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/service_accounts' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "client_id": "string",
    "client_secret": "string"
  }'

Responses

OK

Sync EHR Data for Patient

Request

An internal endpoint which will push the latest patient summary statistics and PDF reports to all EHR enabled clinics for which the patient has an active subscription. The actual data is pushed asynchronously. A successful response means that an asynchronous task has been scheduled.

A 404 response will be returned if no active subscriptions can be found for given patient.

Security
sessionToken
Path
patientIdstring^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...required
curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/patients/{patientId}/ehr/sync' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

Accepted

Redox

Public endpoints invoked by Redox.

Operations