Skip to content
Tidepool API/Clinics API/
/
Accept Patient Invitation

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

Get Patient Invites

Request

Retrieve the list of all pending invites from users who would like to share their accounts with the clinic and become patients.

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

Responses

OK

Accept Patient Invitation

Request

Accept a pending invite from a user who would like to share their account with the clinic and become a patient.

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
inviteIdstringnon-emptyrequired
Bodyapplication/json
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 PUT \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/invites/patients/{inviteId}' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{
    "fullName": "string",
    "birthDate": "2012-08-30",
    "mrn": "string",
    "tags": [
      "stringstringstringstring"
    ],
    "sites": [
      {
        "name": "string"
      }
    ]
  }'

Responses

OK

Update Patient Reviews

Request

Update the patient's last reviewed date and clinician 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 PUT \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/patients/{patientId}/reviews' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
clinicianIdstringrequired
timestring(date-time)required
]
Response
application/json
[
  {
    "clinicianId": "string",
    "time": "2019-08-24T14:15:22Z"
  }
]

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