Skip to content
Tidepool API/Clinics API/
/
Redox EHR Endpoint

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

Confirmations

Manage confirmations for account creation, sharing invites, etc.

Operations

Internal

APIs intended for internal use by Tidepool.

Operations

Update Membership Restrictions

Request

An internal endpoint to update clinic membership restrictions

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
Bodyapplication/json
restrictionsArray of objects(Membership Restriction)
curl -i -X PUT \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/membership_restrictions' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{
    "restrictions": [
      {
        "emailDomain": "example.com",
        "requiredIdp": "string"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
restrictionsArray of objects(Membership Restriction)
Response
application/json
{
  "restrictions": [
    { … }
  ]
}

Redox EHR Endpoint

Request

An endpoint for incoming Redox messages

Security
sessionToken
Bodyapplication/json
object
curl -i -X POST \
  https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/redox \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{}'

Responses

OK

Redox Verify Endpoint

Request

Internal endpoint for Redox challenge verification

Security
sessionToken
curl -i -X POST \
  https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/redox/verify \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Redox

Public endpoints invoked by Redox.

Operations