Skip to content
Tidepool API/Clinics API/
/
Update MRN Settings

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

Get MRN Settings

Request

Retrieve MRN settings

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

Responses

OK

Bodyapplication/json
requiredbooleanrequired

Require MRN when creating or updating patients

uniquebooleanrequired

Enforce MRN uniqueness constraint

Response
application/json
{
  "required": true,
  "unique": true
}

Update MRN Settings

Request

Update MRN Settings

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
Bodyapplication/json
requiredbooleanrequired

Require MRN when creating or updating patients

uniquebooleanrequired

Enforce MRN uniqueness constraint

curl -i -X PUT \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/settings/mrn' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{
    "required": true,
    "unique": true
  }'

Responses

OK

Update Patient Count Settings

Request

Update Patient Count Settings

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
Bodyapplication/json
hardLimitobject(Patient Count Limit)
softLimitobject(Patient Count Limit)
curl -i -X PUT \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/settings/patient_count' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{
    "hardLimit": {
      "patientCount": 0,
      "startDate": "2017-02-06T02:37:46Z",
      "endDate": "2017-02-06T02:37:46Z"
    },
    "softLimit": {
      "patientCount": 0,
      "startDate": "2017-02-06T02:37:46Z",
      "endDate": "2017-02-06T02:37:46Z"
    }
  }'

Responses

OK

Redox

Public endpoints invoked by Redox.

Operations