Skip to content
Tidepool API/Clinics API/
/
Create a Site

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

Create Patient Tag

Request

Create a new patient tag

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
Bodyapplication/json
namestring[ 1 .. 20 ] characters^[\p{L}\p{N}_+><-]{1}[\p{L}\p{N}\s_+><-]*$required

The tag display name

numPatientsinteger
curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/patient_tags' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "numPatients": 0
  }'

Responses

The newly-created patient tag

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

String representation of a resource id

namestring[ 1 .. 20 ] characters^[\p{L}\p{N}_+><-]{1}[\p{L}\p{N}\s_+><-]*$required

The tag display name

numPatientsinteger
Response
application/json
{
  "id": "stringstringstringstring",
  "name": "string",
  "numPatients": 0
}

Create a Site

Request

Create a Site

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
Bodyapplication/json
namestring(siteName.v1)[ 1 .. 200 ] characters^[[:graph:]\p{L}\p{N}][[:graph:]\p{L}\p{N} ]*...required

The site's name.

curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/sites' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string"
  }'

Responses

The newly-created clinic site

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

String representation of a resource id

namestring(siteName.v1)[ 1 .. 200 ] characters^[[:graph:]\p{L}\p{N}][[:graph:]\p{L}\p{N} ]*...required

The site's name.

numPatientsinteger
Response
application/json
{
  "id": "string",
  "name": "string",
  "numPatients": 0
}

Update a Site

Request

Update a Site

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
siteIdstring(Object Id)= 24 characters^[a-f0-9]{24}$required

String representation of a resource id

Bodyapplication/json
namestring(siteName.v1)[ 1 .. 200 ] characters^[[:graph:]\p{L}\p{N}][[:graph:]\p{L}\p{N} ]*...required

The site's name.

numPatientsinteger
curl -i -X PUT \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/sites/{siteId}' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "numPatients": 0
  }'

Responses

The updated clinic site

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

String representation of a resource id

namestring(siteName.v1)[ 1 .. 200 ] characters^[[:graph:]\p{L}\p{N}][[:graph:]\p{L}\p{N} ]*...required

The site's name.

numPatientsinteger
Response
application/json
{
  "id": "string",
  "name": "string",
  "numPatients": 0
}

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