Skip to content
Tidepool API/Clinics API/
/
Update Migration

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

Get Migration

Request

Get a migration by user id

Security
sessionToken
Path
clinicIdstring(Clinic ID)= 24 characters^[a-f0-9]{24}$read-onlyrequired

Clinic ID

Example: 2fe2488217ee43e1b2e83c2f
userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit UUID v4

curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/2fe2488217ee43e1b2e83c2f/migrations/{userId}' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
userIdstringnon-emptyrequired

The user id of the legacy clinician account that needs to be migrated.

statusstring(Migration Status)

The current status of the migration

Enum"PENDING""RUNNING""COMPLETED"
createdTimestring(date-time)read-onlyrequired
updatedTimestring(date-time)read-onlyrequired
attestationTimestring(date-time)read-only
Response
application/json
{
  "userId": "string",
  "status": "PENDING",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "attestationTime": "2019-08-24T14:15:22Z"
}

Update Migration

Request

Internal endpoint to update the status of a migration

Security
sessionToken
Path
clinicIdstring(Clinic ID)= 24 characters^[a-f0-9]{24}$read-onlyrequired

Clinic ID

Example: 2fe2488217ee43e1b2e83c2f
userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit UUID v4

Bodyapplication/json
statusstring(Migration Status)required

The current status of the migration

Enum"PENDING""RUNNING""COMPLETED"
curl -i -X PATCH \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/2fe2488217ee43e1b2e83c2f/migrations/{userId}' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{
    "status": "PENDING"
  }'

Responses

OK

Bodyapplication/json
userIdstringnon-emptyrequired

The user id of the legacy clinician account that needs to be migrated.

statusstring(Migration Status)

The current status of the migration

Enum"PENDING""RUNNING""COMPLETED"
createdTimestring(date-time)read-onlyrequired
updatedTimestring(date-time)read-onlyrequired
attestationTimestring(date-time)read-only
Response
application/json
{
  "userId": "string",
  "status": "PENDING",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "attestationTime": "2019-08-24T14:15:22Z"
}

Remove User from Clinics

Request

Internal endpoint that deletes any user associations with clinics they are a patient or a member of.

If the user is a patient of a clinic the service will delete the patient-clinic relationship.

If the user is one of many admins of any clinic the service will delete the clinician-clinic relationship.

If the user is the only admin of a clinic the service will:

  • delete the clinician record, leaving the clinic without an admin
  • delete all non-custodial patient relationships of the clinic
  • keep all custodian relationships, allowing users to claim custodial accounts with an email
  • keep all custodian accounts and data even if they can’t be claimed when there isn’t an email address associated with the account
Security
sessionToken
Path
userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit UUID v4

curl -i -X DELETE \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/users/{userId}/clinics' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Confirmations

Manage confirmations for account creation, sharing invites, etc.

Operations

Internal

APIs intended for internal use by Tidepool.

Operations

Redox

Public endpoints invoked by Redox.

Operations