Skip to content
Tidepool API/Clinics API/
/
Update User Details

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

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

Update User Details

Request

Internal endpoint to update clinician details. In the future it may be extended to support patient updates.

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

Bodyapplication/json
emailstring(email)non-empty
curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/users/{userId}/clinics' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{
    "email": "user@example.com"
  }'

Responses

No Content

List All Clinicians

Request

Returns list of all clinician/clinic relationships in the system. Internal endpoint used for reporting purposes.

Security
sessionToken
Query
offsetinteger>= 0
limitinteger>= 1
Default 10
createdTimeStartstring(date-time)

Return records created after the given date (inclusive)

createdTimeEndstring(date-time)

Return records created before the given date (exclusive)

curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinicians?offset=0&limit=10&createdTimeStart=2019-08-24T14%3A15%3A22Z&createdTimeEnd=2019-08-24T14%3A15%3A22Z' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
clinicianobject(Clinician)required

The id may be empty if the clinician invite has not been accepted.

clinician.​idstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

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

clinician.​inviteIdstring

The id of the invite if it hasn't been accepted

clinician.​emailstring(email)required
clinician.​namestringnon-empty

The name of the clinician

clinician.​rolesArray of strings(Clinician Permissions)non-emptyuniquerequired
Items Enum"CLINIC_ADMIN""CLINIC_MEMBER""PRESCRIBER"
clinician.​createdTimestring(date-time)read-onlyrequired
clinician.​updatedTimestring(date-time)read-onlyrequired
clinicobject(Clinic)required

Clinic

clinic.​idstring(Clinic ID)= 24 characters^[a-f0-9]{24}$read-onlyrequired

Clinic identifier.

Example: "2fe2488217ee43e1b2e83c2f"
clinic.​addressstring(Street Address)non-empty

Street address.

clinic.​citystring(City)non-empty

City name.

Example: "Palo Alto"
clinic.​postalCodestring(Postal Code)non-empty

Postal code. In the U.S., typically the zip code such as 94301 or 94301-1704.

Example: "94301"
clinic.​statestring(State)non-empty

State or province. In the U.S., typically something like CA or California.

Example: "CA"
clinic.​countrystring(Country)non-empty

Country name.

Example: "USA"
clinic.​patientTagsArray of objects(Patient Tag)
clinic.​sitesArray of objects(Site)
clinic.​lastDeletedPatientTagobject(Patient Tag)
clinic.​phoneNumbersArray of objects(Phone phoneNumbers)non-emptyunique

An array of phone numbers.

Example: [{"type":"main","number":"+1 (555) 555-1212"}]
clinic.​clinicTypestringnon-empty
Enum"provider_practice""healthcare_system""veterinary_clinic""other""researcher"
clinic.​clinicSizestring
Enum"0-249""250-499""500-999""1000+"
clinic.​namestring(Clinic Name)non-emptyrequired

Name of the clinic.

clinic.​shareCodestring(Clinic Share Code)^[ABCDEFGHJKLMNPQRSTUVWXYZ23456789]{4}-[ABCDE...read-onlyrequired

Globally unique share code for a clinic. The share code is 3 groups of 4 uppercase alphanumeric characters in each group. Ambiguous characters such as I and 1, or O and 0 are excluded.

clinic.​canMigratebooleanread-onlyrequired
clinic.​websitestring(uri)
clinic.​createdTimestring(date-time)read-onlyrequired
clinic.​updatedTimestring(date-time)read-onlyrequired
clinic.​tierDescriptionstringnon-emptyread-onlyrequired
Example: "Free"
clinic.​tierstringnon-emptyread-onlyrequired
Example: "tier0100"
clinic.​preferredBgUnitsstringrequired
Enum"mg/dL""mmol/L"
clinic.​suppressedNotificationsobject(Suppressed Notifications)
clinic.​timezonestring(Clinic Timezone)
Enum"Africa/Abidjan""Africa/Accra""Africa/Addis_Ababa""Africa/Algiers""Africa/Asmara""Africa/Asmera""Africa/Bamako""Africa/Bangui""Africa/Banjul""Africa/Bissau"
]
Response
application/json
[
  {
    "clinician": { … },
    "clinic": { … }
  }
]

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