Skip to content
Tidepool API/Clinics API/
/
Enable Clinics

Enable Clinics

Request

Internal only endpoint to enable new clinic experience for a legacy clinician account. Patients won't be migrated until the clinic details are populated and migration is explicitly kicked-off by blip.

Security
sessionToken
Path
userIdstringrequired
curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinicians/{userId}/migrate' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring, = 24 characters(Clinic ID)^[a-f0-9]{24}$read-onlyrequired

Clinic identifier.

Example:"2fe2488217ee43e1b2e83c2f"
addressstring, non-empty(Street Address)

Street address.

citystring, non-empty(City)

City name.

Example:"Palo Alto"
postalCodestring, non-empty(Postal Code)

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

Example:"94301"
statestring, non-empty(State)

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

Example:"CA"
countrystring, non-empty(Country)

Country name.

Example:"USA"
patientTagsArray of objects(Patient Tag)
sitesArray of objects(Site)
lastDeletedPatientTagobject(Patient Tag)
phoneNumbersArray of objects, non-empty, unique(Phone phoneNumbers)

An array of phone numbers.

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

Name of the 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.

canMigratebooleanread-onlyrequired
websitestring, (uri)
createdTimestring, (date-time)read-onlyrequired
updatedTimestring, (date-time)read-onlyrequired
tierDescriptionstring, non-emptyread-onlyrequired
Example:"Free"
tierstring, non-emptyread-onlyrequired
Example:"tier0100"
preferredBgUnitsstringrequired
Enum:"mg/dL""mmol/L"
suppressedNotificationsobject(Suppressed Notifications)
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
{
  "id": "2fe2488217ee43e1b2e83c2f",
  "address": "string",
  "city": "Palo Alto",
  "postalCode": "94301",
  "state": "CA",
  "country": "USA",
  "patientTags": [
    { … }
  ],
  "sites": [
    { … }
  ],
  "lastDeletedPatientTag": {
    "id": "stringstringstringstring",
    "name": "string",
    "numPatients": 0
  },
  "phoneNumbers": [
    { … }
  ],
  "clinicType": "provider_practice",
  "clinicSize": "0-249",
  "name": "string",
  "shareCode": "string",
  "canMigrate": true,
  "website": "http://example.com",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "tierDescription": "Free",
  "tier": "tier0100",
  "preferredBgUnits": "mg/dL",
  "suppressedNotifications": {
    "patientClinicInvitation": true
  },
  "timezone": "Africa/Abidjan"
}