Get Patient Count

Request

Get Patient Count

Security

sessionToken

Path

clinicIdstring^[a-f0-9]{24}$required

curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/patient_count' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

totalinteger, >= 0required

The count of all patients associated with the clinic, regardless of classification.

demointeger, >= 0required

The count of patients associated with the clinic that are classified as demo and do not apply towards the plan-based patient count limit. Currently this is limited to 0 or 1, but allows for future expansion with multiple demo patients if needed.

planinteger, >= 0required

The count of patients associated with the clinic classified as applying towards the plan-based patient count limit. This excludes patients classified as demo as well as any other classifications that do not apply towards the plan-based patient count limit for various business reasons.

providersobject

The count of patients associated with the clinic by provider. As each patient may be associated with multiple providers, the sum of all provider counts may exceed the total patient count.

Response

{
  "total": 0,
  "demo": 0,
  "plan": 0,
  "providers": {
    "property1": { … },
    "property2": { … }
  }
}