Skip to content
Tidepool API/Clinics API/
/
Sync EHR Data

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

Refresh Patient Count

Request

An internal endpoint to refresh the patient count for the specified clinic.

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

Responses

OK

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

Find Patients

Request

Returns all patients to which the clinician has access to

Security
sessionToken
Query
mrnstring
birthDatestring
workspaceIdstring

The identifier of the workspace

workspaceIdTypestring

The type of the workspace identifier

Enum"clinicId""ehrSourceId"
offsetinteger>= 0
limitinteger>= 1
Default 10
curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/patients?mrn=string&birthDate=string&workspaceId=string&workspaceIdType=clinicId&offset=0&limit=10' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
patientobject(Patient)required
patient.​idstring(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

patient.​emailstring(email)
patient.​fullNamestringnon-emptyrequired

The full name of the patient

patient.​birthDatestring(date)required
Example: "2012-08-30"
patient.​mrnstringnon-empty

The medical record number of the patient

patient.​tagsArray of strings or null(Patient Tag ID List)unique
patient.​targetDevicesArray of strings
patient.​permissionsobject(Patient Permissions)
patient.​createdTimestring(date-time)read-onlyrequired
patient.​updatedTimestring(date-time)read-onlyrequired
patient.​attestationSubmittedboolean
patient.​dataSourcesArray of objects or null(Patient data source)
patient.​lastUploadReminderTimestring(date-time)read-only
patient.​summaryobject(patientsummary.v1)

A summary of a patients recent data

patient.​reviewsArray of objects or null(patientreview.v1)
patient.​connectionRequestsobject(providerconnectionrequests.v1)read-onlyrequired
patient.​connectionRequests.​twiistArray of objects(Provider Connection Request)required
patient.​connectionRequests.​twiist[].​createdTimestring(date-time)required
patient.​connectionRequests.​twiist[].​providerNamestring(Third-Party Data Providers)required
Enum"dexcom""twiist""abbott"
patient.​connectionRequests.​dexcomArray of objects(Provider Connection Request)required
patient.​connectionRequests.​dexcom[].​createdTimestring(date-time)required
patient.​connectionRequests.​dexcom[].​providerNamestring(Third-Party Data Providers)required
Enum"dexcom""twiist""abbott"
patient.​connectionRequests.​abbottArray of objects(Provider Connection Request)required
patient.​connectionRequests.​abbott[].​createdTimestring(date-time)required
patient.​connectionRequests.​abbott[].​providerNamestring(Third-Party Data Providers)required
Enum"dexcom""twiist""abbott"
patient.​sitesArray of objects(Site)
patient.​glycemicRangesobject(glycemicRanges.v1)
patient.​diagnosisTypestring(Diagnosis Type)
Enum"type1""type2""type3c""gestational""prediabetes""lada""mody""other""notApplicable"""
Example: "type1"
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
[
  {
    "patient": { … },
    "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