Skip to content
Tidepool API/Clinics API/
/
Create or update a data s...

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

DeletePatientSummary

Request

Internal endpoint which deletes the summary in all patient records which match the summary id.

Security
sessionToken
Path
summaryIdstring(Summary ID)[ 0 .. 24 ] characters^[a-f0-9]{0,24}$required

Summary Unique Identifier

Example: 2fe2488217ee43e1b2e83c2f
curl -i -X DELETE \
  https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/summaries/2fe2488217ee43e1b2e83c2f/clinics \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Create or update a data source for a patient

Request

Internal endpoint to upsert patient data source provider details in all their associated clinic records.

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/jsonArray [
statestring(Data source connection state)required
Enum"pending""pendingReconnect""connected""disconnected""error"
Example: "connected"
providerNamestring(Provider Name)[ 1 .. 100 ] charactersrequired
Example: "dexcom"
modifiedTimestring(date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
expirationTimestring(date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
]
curl -i -X PUT \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/patients/{userId}/data_sources' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '[
    {
      "state": "connected",
      "providerName": "dexcom",
      "modifiedTime": "2017-02-06T02:37:46Z",
      "expirationTime": "2017-02-06T02:37:46Z"
    }
  ]'

Responses

OK

Update Tier

Request

Internal endpoint to update clinic service tier

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
Bodyapplication/json
tierstring(Clinic Service Tier)required
Enum"tier0100""tier0200""tier0300""tier0400"
Example: "tier0100"
curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/tier' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{
    "tier": "tier0100"
  }'

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