Skip to content
Tidepool API/Clinics API/
/
Get Patient

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

Delete Clinician

Request

Removes a clinician from a clinic

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
clinicianIdstring^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...required
curl -i -X DELETE \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/clinicians/{clinicianId}' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Get Patient

Request

Retrieve a patient of clinic given their user id

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
patientIdstring^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...required
curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/patients/{patientId}' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
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

emailstring(email)
fullNamestringnon-emptyrequired

The full name of the patient

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

The medical record number of the patient

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

A summary of a patients recent data

reviewsArray of objects or null(patientreview.v1)
connectionRequestsobject(providerconnectionrequests.v1)read-onlyrequired
connectionRequests.​twiistArray of objects(Provider Connection Request)required
connectionRequests.​twiist[].​createdTimestring(date-time)required
connectionRequests.​twiist[].​providerNamestring(Third-Party Data Providers)required
Enum"dexcom""twiist""abbott"
connectionRequests.​dexcomArray of objects(Provider Connection Request)required
connectionRequests.​dexcom[].​createdTimestring(date-time)required
connectionRequests.​dexcom[].​providerNamestring(Third-Party Data Providers)required
Enum"dexcom""twiist""abbott"
connectionRequests.​abbottArray of objects(Provider Connection Request)required
connectionRequests.​abbott[].​createdTimestring(date-time)required
connectionRequests.​abbott[].​providerNamestring(Third-Party Data Providers)required
Enum"dexcom""twiist""abbott"
sitesArray of objects(Site)
Response
application/json
{
  "id": "string",
  "email": "user@example.com",
  "fullName": "string",
  "birthDate": "2012-08-30",
  "mrn": "string",
  "tags": [
    "stringstringstringstring"
  ],
  "targetDevices": [
    "string"
  ],
  "permissions": {
    "custodian": {},
    "view": {},
    "note": {},
    "upload": {}
  },
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "attestationSubmitted": true,
  "dataSources": [
    { … }
  ],
  "lastUploadReminderTime": "2019-08-24T14:15:22Z",
  "summary": {
    "cgmStats": { … },
    "bgmStats": { … }
  },
  "reviews": [
    { … }
  ],
  "connectionRequests": {
    "twiist": [ … ],
    "dexcom": [ … ],
    "abbott": [ … ]
  },
  "sites": [
    { … }
  ]
}

Create Patient from Existing User

Request

Internal endpoint for creating a patient from an existing user

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
patientIdstring^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...required
Bodyapplication/json
permissionsobject(Patient Permissions)
isMigratedboolean
attestationSubmittedboolean
fullNamestringnon-empty

The full name of the patient

birthDatestring(date)
Example: "2012-08-30"
mrnstringnon-empty

The medical record number of the patient

tagsArray of strings or null(Patient Tag ID List)unique
sitesArray of objects(Site)
curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/patients/{patientId}' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{
    "permissions": {
      "custodian": {},
      "view": {},
      "note": {},
      "upload": {}
    },
    "isMigrated": true,
    "attestationSubmitted": true,
    "fullName": "string",
    "birthDate": "2012-08-30",
    "mrn": "string",
    "tags": [
      "stringstringstringstring"
    ],
    "sites": [
      {
        "name": "string"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
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

emailstring(email)
fullNamestringnon-emptyrequired

The full name of the patient

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

The medical record number of the patient

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

A summary of a patients recent data

reviewsArray of objects or null(patientreview.v1)
connectionRequestsobject(providerconnectionrequests.v1)read-onlyrequired
connectionRequests.​twiistArray of objects(Provider Connection Request)required
connectionRequests.​twiist[].​createdTimestring(date-time)required
connectionRequests.​twiist[].​providerNamestring(Third-Party Data Providers)required
Enum"dexcom""twiist""abbott"
connectionRequests.​dexcomArray of objects(Provider Connection Request)required
connectionRequests.​dexcom[].​createdTimestring(date-time)required
connectionRequests.​dexcom[].​providerNamestring(Third-Party Data Providers)required
Enum"dexcom""twiist""abbott"
connectionRequests.​abbottArray of objects(Provider Connection Request)required
connectionRequests.​abbott[].​createdTimestring(date-time)required
connectionRequests.​abbott[].​providerNamestring(Third-Party Data Providers)required
Enum"dexcom""twiist""abbott"
sitesArray of objects(Site)
Response
application/json
{
  "id": "string",
  "email": "user@example.com",
  "fullName": "string",
  "birthDate": "2012-08-30",
  "mrn": "string",
  "tags": [
    "stringstringstringstring"
  ],
  "targetDevices": [
    "string"
  ],
  "permissions": {
    "custodian": {},
    "view": {},
    "note": {},
    "upload": {}
  },
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "attestationSubmitted": true,
  "dataSources": [
    { … }
  ],
  "lastUploadReminderTime": "2019-08-24T14:15:22Z",
  "summary": {
    "cgmStats": { … },
    "bgmStats": { … }
  },
  "reviews": [
    { … }
  ],
  "connectionRequests": {
    "twiist": [ … ],
    "dexcom": [ … ],
    "abbott": [ … ]
  },
  "sites": [
    { … }
  ]
}

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