Skip to content
Tidepool API/Clinics API/
/
List Patients

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

View TIDE Report

Request

Retrieve a report of patients with tags by TIDE categories

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
Query
periodstring^(1d|7d|14d|30d)$

Time Period to display

Example: period=7d
tagsArray of strings(^[a-f0-9]{24}$)

Comma-separated list of patient tag IDs

lastDataCutoffstring(date-time)

Inclusive

curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/tide_report?period=7d&tags=string&lastDataCutoff=2019-08-24T14%3A15%3A22Z' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
configobject(tideconfig.v1)required
config.​schemaVersionnumberrequired

TIDE schema version

config.​clinicIdstring(Clinic ID)= 24 characters^[a-f0-9]{24}$read-onlyrequired

Clinic identifier.

Example: "2fe2488217ee43e1b2e83c2f"
config.​periodstring^(1d|7d|14d|30d)$required
Example: "7d"
config.​lastDataCutoffstring(date-time)required
config.​highGlucoseThresholdnumberrequired

Threshold used for determining if a value is high

config.​veryHighGlucoseThresholdnumberrequired

Threshold used for determining if a value is very high

config.​lowGlucoseThresholdnumberrequired

Threshold used for determining if a value is low

config.​veryLowGlucoseThresholdnumberrequired

Threshold used for determining if a value is very low

config.​tagsArray of strings or null(Patient Tag ID List)uniquerequired
config.​filtersobject(tidefilters.v1)required
config.​filters.​timeInVeryLowPercentstring^(>=|>|<=|<)\d\.\d\d?$required
Example: ">0.5"
config.​filters.​timeInAnyLowPercentstring^(>=|>|<=|<)\d\.\d\d?$required
Example: ">0.5"
config.​filters.​dropInTimeInTargetPercentstring^(>=|>|<=|<)\d\.\d\d?$required
Example: ">0.5"
config.​filters.​timeInTargetPercentstring^(>=|>|<=|<)\d\.\d\d?$required
Example: ">0.5"
config.​filters.​timeCGMUsePercentstring^(>=|>|<=|<)\d\.\d\d?$required
Example: ">0.5"
resultsobject(tideresults.v1)required
results.​property name*Array of objects(tideresultpatient.v1)additional property
Response
application/json
{
  "config": {
    "schemaVersion": 0,
    "clinicId": "2fe2488217ee43e1b2e83c2f",
    "period": "7d",
    "lastDataCutoff": "2019-08-24T14:15:22Z",
    "highGlucoseThreshold": 0,
    "veryHighGlucoseThreshold": 0,
    "lowGlucoseThreshold": 0,
    "veryLowGlucoseThreshold": 0,
    "tags": [ … ],
    "filters": { … }
  },
  "results": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

List Patients

Request

Retrieve a list of patients of a clinic

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
Query
searchstring

Full text search query

offsetinteger>= 0
limitinteger>= 1
Default 10
sortstring(?:-|\+)(?:[a-zA-Z]|_)+

Sort order and attribute (e.g. +name or -name)

sortTypestring^(cgm|bgm)$

Summary type to sort by

Example: sortType=cgm
periodstring^(1d|7d|14d|30d)$

Time Period to display, filter, and sort

Example: period=7d
lastReviewedstring(date-time)

Inclusive

cgm.maxstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Max glucose value in mmol/L

Example: cgm.max=>=5.5
cgm.minstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Min glucose value in mmol/L

Example: cgm.min=>=5.5
cgm.averageGlucoseMmolstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Average glucose value of records in mmol/L

Example: cgm.averageGlucoseMmol=>=5.5
cgm.glucoseManagementIndicatorstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Glucose management Indicator of records

Example: cgm.glucoseManagementIndicator=>=5.5
cgm.timeCGMUsePercentstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Percentage of time [0.0-1.0] of CGM use

Example: cgm.timeCGMUsePercent=>=5.5
cgm.timeInVeryLowPercentstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Percentage of time [0.0-1.0] below 54 mg/dL

Example: cgm.timeInVeryLowPercent=>=5.5
cgm.timeInAnyLowPercentstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Percentage of time [0.0-1.0] below 70 mg/dL

Example: cgm.timeInAnyLowPercent=>=5.5
cgm.timeInLowPercentstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Percentage of time [0.0-1.0] in range 54-70 mg/dL

Example: cgm.timeInLowPercent=>=5.5
cgm.timeInTargetPercentstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Percentage of time [0.0-1.0] in range 70-180 mg/dL

Example: cgm.timeInTargetPercent=>=5.5
cgm.timeInHighPercentstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Percentage of time [0.0-1.0] in range 180-250 mg/dL

Example: cgm.timeInHighPercent=>=5.5
cgm.timeInVeryHighPercentstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Percentage of time [0.0-1.0] above 250 mg/dL

Example: cgm.timeInVeryHighPercent=>=5.5
cgm.timeInExtremeHighPercentstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Percentage of time [0.0-1.0] above 350 mg/dL

Example: cgm.timeInExtremeHighPercent=>=5.5
cgm.timeInAnyHighPercentstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Percentage of time [0.0-1.0] above 180 mg/dL

Example: cgm.timeInAnyHighPercent=>=5.5
cgm.timeCGMUseMinutesstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Minutes of CGM use

Example: cgm.timeCGMUseMinutes=>=7
cgm.timeInVeryLowMinutesstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Minutes below 54 mg/dL

Example: cgm.timeInVeryLowMinutes=>=7
cgm.timeInAnyLowMinutesstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Minutes below 70 mg/dL

Example: cgm.timeInAnyLowMinutes=>=7
cgm.timeInLowMinutesstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Minutes in range 54-70 mg/dL

Example: cgm.timeInLowMinutes=>=7
cgm.timeInTargetMinutesstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Minutes in range 70-180 mg/dL

Example: cgm.timeInTargetMinutes=>=7
cgm.timeInHighMinutesstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Minutes in range 180-250 mg/dL

Example: cgm.timeInHighMinutes=>=7
cgm.timeInVeryHighMinutesstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Minutes above 250 mg/dL

Example: cgm.timeInVeryHighMinutes=>=7
cgm.timeInExtremeHighMinutesstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Minutes above 350 mg/dL

Example: cgm.timeInExtremeHighMinutes=>=7
cgm.timeInAnyHighMinutesstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Minutes above 180 mg/dL

Example: cgm.timeInAnyHighMinutes=>=7
cgm.timeCGMUseRecordsstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Records of CGM use

Example: cgm.timeCGMUseRecords=>=7
cgm.timeInVeryLowRecordsstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Records below 54 mg/dL

Example: cgm.timeInVeryLowRecords=>=7
cgm.timeInAnyLowRecordsstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Records below 70 mg/dL

Example: cgm.timeInAnyLowRecords=>=7
cgm.timeInLowRecordsstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Records in range 54-70 mg/dL

Example: cgm.timeInLowRecords=>=7
cgm.timeInTargetRecordsstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Records in range 70-180 mg/dL

Example: cgm.timeInTargetRecords=>=7
cgm.timeInHighRecordsstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Records in range 180-250 mg/dL

Example: cgm.timeInHighRecords=>=7
cgm.timeInVeryHighRecordsstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Records above 250 mg/dL

Example: cgm.timeInVeryHighRecords=>=7
cgm.timeInAnyHighRecordsstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Records above 180 mg/dL

Example: cgm.timeInAnyHighRecords=>=7
cgm.averageDailyRecordsstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Average records per day

Example: cgm.averageDailyRecords=>=5.5
cgm.totalRecordsstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Total records in period

Example: cgm.totalRecords=>=7
cgm.hoursWithDatastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Total hours with data in period

Example: cgm.hoursWithData=>=7
cgm.daysWithDatastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Total days with data in period

Example: cgm.daysWithData=>=7
cgm.standardDeviationstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Standard deviation of glucose values in mmol/L

Example: cgm.standardDeviation=>=5.5
cgm.coefficientOfVariationstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Coefficient Of Variation of glucose values in mmol/L

Example: cgm.coefficientOfVariation=>=5.5
bgm.maxstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Max glucose value in mmol/L

Example: bgm.max=>=5.5
bgm.minstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Min glucose value in mmol/L

Example: bgm.min=>=5.5
bgm.averageGlucoseMmolstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Average glucose value of records in mmol/L

Example: bgm.averageGlucoseMmol=>=5.5
bgm.timeInVeryLowPercentstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Percentage of time [0.0-1.0] below 54 mg/dL

Example: bgm.timeInVeryLowPercent=>=5.5
bgm.timeInAnyLowPercentstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Percentage of time [0.0-1.0] below 70 mg/dL

Example: bgm.timeInAnyLowPercent=>=5.5
bgm.timeInLowPercentstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Percentage of time [0.0-1.0] in range 54-70 mg/dL

Example: bgm.timeInLowPercent=>=5.5
bgm.timeInTargetPercentstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Percentage of time [0.0-1.0] in range 70-180 mg/dL

Example: bgm.timeInTargetPercent=>=5.5
bgm.timeInHighPercentstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Percentage of time [0.0-1.0] in range 180-250 mg/dL

Example: bgm.timeInHighPercent=>=5.5
bgm.timeInVeryHighPercentstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Percentage of time [0.0-1.0] above 250 mg/dL

Example: bgm.timeInVeryHighPercent=>=5.5
bgm.timeInExtremeHighPercentstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Percentage of time [0.0-1.0] above 350 mg/dL

Example: bgm.timeInExtremeHighPercent=>=5.5
bgm.timeInAnyHighPercentstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Percentage of time [0.0-1.0] above 180 mg/dL

Example: bgm.timeInAnyHighPercent=>=5.5
bgm.timeInVeryLowRecordsstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Records below 54 mg/dL

Example: bgm.timeInVeryLowRecords=>=7
bgm.timeInAnyLowRecordsstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Records below 70 mg/dL

Example: bgm.timeInAnyLowRecords=>=7
bgm.timeInLowRecordsstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Records in range 54-70 mg/dL

Example: bgm.timeInLowRecords=>=7
bgm.timeInTargetRecordsstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Records in range 70-180 mg/dL

Example: bgm.timeInTargetRecords=>=7
bgm.timeInHighRecordsstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Records in range 180-250 mg/dL

Example: bgm.timeInHighRecords=>=7
bgm.timeInVeryHighRecordsstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Records above 250 mg/dL

Example: bgm.timeInVeryHighRecords=>=7
bgm.timeInAnyHighRecordsstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Records above 180 mg/dL

Example: bgm.timeInAnyHighRecords=>=7
bgm.averageDailyRecordsstring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Average records per day

Example: bgm.averageDailyRecords=>=5.5
bgm.totalRecordsstring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Total records in period

Example: bgm.totalRecords=>=7
cgm.maxDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of Max glucose value in mmol/L

Example: cgm.maxDelta=>=5.5
cgm.minDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of Min glucose value in mmol/L

Example: cgm.minDelta=>=5.5
cgm.averageGlucoseMmolDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of average glucose value in mmol/L

Example: cgm.averageGlucoseMmolDelta=>=5.5
cgm.glucoseManagementIndicatorDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Glucose management Indicator of records

Example: cgm.glucoseManagementIndicatorDelta=>=5.5
cgm.timeCGMUsePercentDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of time of CGM use

Example: cgm.timeCGMUsePercentDelta=>=5.5
cgm.timeInVeryLowPercentDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of time below 54 mg/dL

Example: cgm.timeInVeryLowPercentDelta=>=5.5
cgm.timeInAnyLowPercentDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of time below 70 mg/dL

Example: cgm.timeInAnyLowPercentDelta=>=5.5
cgm.timeInLowPercentDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of time in range 54-70 mg/dL

Example: cgm.timeInLowPercentDelta=>=5.5
cgm.timeInTargetPercentDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of time in range 70-180 mg/dL

Example: cgm.timeInTargetPercentDelta=>=5.5
cgm.timeInHighPercentDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of time in range 180-250 mg/dL

Example: cgm.timeInHighPercentDelta=>=5.5
cgm.timeInVeryHighPercentDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of time above 250 mg/dL

Example: cgm.timeInVeryHighPercentDelta=>=5.5
cgm.timeInExtremeHighPercentDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of time above 350 mg/dL

Example: cgm.timeInExtremeHighPercentDelta=>=5.5
cgm.timeInAnyHighPercentDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of time above 180 mg/dL

Example: cgm.timeInAnyHighPercentDelta=>=5.5
cgm.timeCGMUseMinutesDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of minutes of CGM use

Example: cgm.timeCGMUseMinutesDelta=>=7
cgm.timeInVeryLowMinutesDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of minutes below 54 mg/dL

Example: cgm.timeInVeryLowMinutesDelta=>=7
cgm.timeInAnyLowMinutesDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of minutes below 70 mg/dL

Example: cgm.timeInAnyLowMinutesDelta=>=7
cgm.timeInLowMinutesDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of minutes in range 54-70 mg/dL

Example: cgm.timeInLowMinutesDelta=>=7
cgm.timeInTargetMinutesDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of minutes in range 70-180 mg/dL

Example: cgm.timeInTargetMinutesDelta=>=7
cgm.timeInHighMinutesDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of minutes in range 180-250 mg/dL

Example: cgm.timeInHighMinutesDelta=>=7
cgm.timeInVeryHighMinutesDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of minutes above 250 mg/dL

Example: cgm.timeInVeryHighMinutesDelta=>=7
cgm.timeInExtremeHighMinutesDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of minutes above 350 mg/dL

Example: cgm.timeInExtremeHighMinutesDelta=>=7
cgm.timeInAnyHighMinutesDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of minutes above 180 mg/dL

Example: cgm.timeInAnyHighMinutesDelta=>=7
cgm.timeCGMUseRecordsDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of records count

Example: cgm.timeCGMUseRecordsDelta=>=7
cgm.timeInVeryLowRecordsDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of records below 54 mg/dL

Example: cgm.timeInVeryLowRecordsDelta=>=7
cgm.timeInAnyLowRecordsDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of records below 70 mg/dL

Example: cgm.timeInAnyLowRecordsDelta=>=7
cgm.timeInLowRecordsDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of records in range 54-70 mg/dL

Example: cgm.timeInLowRecordsDelta=>=7
cgm.timeInTargetRecordsDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of records in range 70-180 mg/dL

Example: cgm.timeInTargetRecordsDelta=>=7
cgm.timeInHighRecordsDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of records in range 180-250 mg/dL

Example: cgm.timeInHighRecordsDelta=>=7
cgm.timeInVeryHighRecordsDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of records above 250 mg/dL

Example: cgm.timeInVeryHighRecordsDelta=>=7
cgm.timeInAnyHighRecordsDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of records above 180 mg/dL

Example: cgm.timeInAnyHighRecordsDelta=>=7
cgm.averageDailyRecordsDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of average records per day

Example: cgm.averageDailyRecordsDelta=>=5.5
cgm.totalRecordsDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of total records

Example: cgm.totalRecordsDelta=>=7
cgm.hoursWithDataDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of total hours with data

Example: cgm.hoursWithDataDelta=>=7
cgm.daysWithDataDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of total days with data

Example: cgm.daysWithDataDelta=>=7
cgm.standardDeviationDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of the standard deviation of glucose values in mmol/L

Example: cgm.standardDeviationDelta=>=5.5
cgm.coefficientOfVariationDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of the coefficient of glucose values in mmol/L

Example: cgm.coefficientOfVariationDelta=>=5.5
cgm.lastDataFromstring(date-time)

Inclusive

cgm.lastDataTostring(date-time)

Exclusive

bgm.maxDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of Max glucose value in mmol/L

Example: bgm.maxDelta=>=5.5
bgm.minDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of Min glucose value in mmol/L

Example: bgm.minDelta=>=5.5
bgm.averageGlucoseMmolDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of the average glucose values in mmol/L

Example: bgm.averageGlucoseMmolDelta=>=5.5
bgm.timeInVeryLowPercentDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of time below 54 mg/dL

Example: bgm.timeInVeryLowPercentDelta=>=5.5
bgm.timeInAnyLowPercentDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of time below 70 mg/dL

Example: bgm.timeInAnyLowPercentDelta=>=5.5
bgm.timeInLowPercentDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of time in range 54-70 mg/dL

Example: bgm.timeInLowPercentDelta=>=5.5
bgm.timeInTargetPercentDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of time in range 70-180 mg/dL

Example: bgm.timeInTargetPercentDelta=>=5.5
bgm.timeInHighPercentDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of time in range 180-250 mg/dL

Example: bgm.timeInHighPercentDelta=>=5.5
bgm.timeInVeryHighPercentDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of time above 250 mg/dL

Example: bgm.timeInVeryHighPercentDelta=>=5.5
bgm.timeInExtremeHighPercentDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of time above 350 mg/dL

Example: bgm.timeInExtremeHighPercentDelta=>=5.5
bgm.timeInAnyHighPercentDeltastring(FloatFilter)^(>=|>|<=|<)[+-]?((\d+(\.\d*)?)|(\.\d+))$

Delta of time above 180 mg/dL

Example: bgm.timeInAnyHighPercentDelta=>=5.5
bgm.timeInVeryLowRecordsDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of records below 54 mg/dL

Example: bgm.timeInVeryLowRecordsDelta=>=7
bgm.timeInAnyLowRecordsDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of records below 70 mg/dL

Example: bgm.timeInAnyLowRecordsDelta=>=7
bgm.timeInLowRecordsDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of records in range 54-70 mg/dL

Example: bgm.timeInLowRecordsDelta=>=7
bgm.timeInTargetRecordsDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of records in range 70-180 mg/dL

Example: bgm.timeInTargetRecordsDelta=>=7
bgm.timeInHighRecordsDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of records in range 180-250 mg/dL

Example: bgm.timeInHighRecordsDelta=>=7
bgm.timeInVeryHighRecordsDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of records above 250 mg/dL

Example: bgm.timeInVeryHighRecordsDelta=>=7
bgm.timeInAnyHighRecordsDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of records above 180 mg/dL

Example: bgm.timeInAnyHighRecordsDelta=>=7
bgm.averageDailyRecordsDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of average records per day

Example: bgm.averageDailyRecordsDelta=>=7
bgm.totalRecordsDeltastring(IntFilter)^(>=|>|<=|<)[+-]?\d+$

Delta of total record count

Example: bgm.totalRecordsDelta=>=7
bgm.lastDataFromstring(date-time)

Inclusive

bgm.lastDataTostring(date-time)

Exclusive

tagsArray of strings(^[a-f0-9]{24}$)

Comma-separated list of patient tag IDs

sitesArray of strings(^[a-f0-9]{24}$)

Comma-separated list of clinic site IDs

curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/patients?search=string&offset=0&limit=10&sort=string&sortType=cgm&period=7d&lastReviewed=2019-08-24T14%3A15%3A22Z&cgm.max=%3E%3D5.5&cgm.min=%3E%3D5.5&cgm.averageGlucoseMmol=%3E%3D5.5&cgm.glucoseManagementIndicator=%3E%3D5.5&cgm.timeCGMUsePercent=%3E%3D5.5&cgm.timeInVeryLowPercent=%3E%3D5.5&cgm.timeInAnyLowPercent=%3E%3D5.5&cgm.timeInLowPercent=%3E%3D5.5&cgm.timeInTargetPercent=%3E%3D5.5&cgm.timeInHighPercent=%3E%3D5.5&cgm.timeInVeryHighPercent=%3E%3D5.5&cgm.timeInExtremeHighPercent=%3E%3D5.5&cgm.timeInAnyHighPercent=%3E%3D5.5&cgm.timeCGMUseMinutes=%3E%3D7&cgm.timeInVeryLowMinutes=%3E%3D7&cgm.timeInAnyLowMinutes=%3E%3D7&cgm.timeInLowMinutes=%3E%3D7&cgm.timeInTargetMinutes=%3E%3D7&cgm.timeInHighMinutes=%3E%3D7&cgm.timeInVeryHighMinutes=%3E%3D7&cgm.timeInExtremeHighMinutes=%3E%3D7&cgm.timeInAnyHighMinutes=%3E%3D7&cgm.timeCGMUseRecords=%3E%3D7&cgm.timeInVeryLowRecords=%3E%3D7&cgm.timeInAnyLowRecords=%3E%3D7&cgm.timeInLowRecords=%3E%3D7&cgm.timeInTargetRecords=%3E%3D7&cgm.timeInHighRecords=%3E%3D7&cgm.timeInVeryHighRecords=%3E%3D7&cgm.timeInAnyHighRecords=%3E%3D7&cgm.averageDailyRecords=%3E%3D5.5&cgm.totalRecords=%3E%3D7&cgm.hoursWithData=%3E%3D7&cgm.daysWithData=%3E%3D7&cgm.standardDeviation=%3E%3D5.5&cgm.coefficientOfVariation=%3E%3D5.5&bgm.max=%3E%3D5.5&bgm.min=%3E%3D5.5&bgm.averageGlucoseMmol=%3E%3D5.5&bgm.timeInVeryLowPercent=%3E%3D5.5&bgm.timeInAnyLowPercent=%3E%3D5.5&bgm.timeInLowPercent=%3E%3D5.5&bgm.timeInTargetPercent=%3E%3D5.5&bgm.timeInHighPercent=%3E%3D5.5&bgm.timeInVeryHighPercent=%3E%3D5.5&bgm.timeInExtremeHighPercent=%3E%3D5.5&bgm.timeInAnyHighPercent=%3E%3D5.5&bgm.timeInVeryLowRecords=%3E%3D7&bgm.timeInAnyLowRecords=%3E%3D7&bgm.timeInLowRecords=%3E%3D7&bgm.timeInTargetRecords=%3E%3D7&bgm.timeInHighRecords=%3E%3D7&bgm.timeInVeryHighRecords=%3E%3D7&bgm.timeInAnyHighRecords=%3E%3D7&bgm.averageDailyRecords=%3E%3D5.5&bgm.totalRecords=%3E%3D7&cgm.maxDelta=%3E%3D5.5&cgm.minDelta=%3E%3D5.5&cgm.averageGlucoseMmolDelta=%3E%3D5.5&cgm.glucoseManagementIndicatorDelta=%3E%3D5.5&cgm.timeCGMUsePercentDelta=%3E%3D5.5&cgm.timeInVeryLowPercentDelta=%3E%3D5.5&cgm.timeInAnyLowPercentDelta=%3E%3D5.5&cgm.timeInLowPercentDelta=%3E%3D5.5&cgm.timeInTargetPercentDelta=%3E%3D5.5&cgm.timeInHighPercentDelta=%3E%3D5.5&cgm.timeInVeryHighPercentDelta=%3E%3D5.5&cgm.timeInExtremeHighPercentDelta=%3E%3D5.5&cgm.timeInAnyHighPercentDelta=%3E%3D5.5&cgm.timeCGMUseMinutesDelta=%3E%3D7&cgm.timeInVeryLowMinutesDelta=%3E%3D7&cgm.timeInAnyLowMinutesDelta=%3E%3D7&cgm.timeInLowMinutesDelta=%3E%3D7&cgm.timeInTargetMinutesDelta=%3E%3D7&cgm.timeInHighMinutesDelta=%3E%3D7&cgm.timeInVeryHighMinutesDelta=%3E%3D7&cgm.timeInExtremeHighMinutesDelta=%3E%3D7&cgm.timeInAnyHighMinutesDelta=%3E%3D7&cgm.timeCGMUseRecordsDelta=%3E%3D7&cgm.timeInVeryLowRecordsDelta=%3E%3D7&cgm.timeInAnyLowRecordsDelta=%3E%3D7&cgm.timeInLowRecordsDelta=%3E%3D7&cgm.timeInTargetRecordsDelta=%3E%3D7&cgm.timeInHighRecordsDelta=%3E%3D7&cgm.timeInVeryHighRecordsDelta=%3E%3D7&cgm.timeInAnyHighRecordsDelta=%3E%3D7&cgm.averageDailyRecordsDelta=%3E%3D5.5&cgm.totalRecordsDelta=%3E%3D7&cgm.hoursWithDataDelta=%3E%3D7&cgm.daysWithDataDelta=%3E%3D7&cgm.standardDeviationDelta=%3E%3D5.5&cgm.coefficientOfVariationDelta=%3E%3D5.5&cgm.lastDataFrom=2019-08-24T14%3A15%3A22Z&cgm.lastDataTo=2019-08-24T14%3A15%3A22Z&bgm.maxDelta=%3E%3D5.5&bgm.minDelta=%3E%3D5.5&bgm.averageGlucoseMmolDelta=%3E%3D5.5&bgm.timeInVeryLowPercentDelta=%3E%3D5.5&bgm.timeInAnyLowPercentDelta=%3E%3D5.5&bgm.timeInLowPercentDelta=%3E%3D5.5&bgm.timeInTargetPercentDelta=%3E%3D5.5&bgm.timeInHighPercentDelta=%3E%3D5.5&bgm.timeInVeryHighPercentDelta=%3E%3D5.5&bgm.timeInExtremeHighPercentDelta=%3E%3D5.5&bgm.timeInAnyHighPercentDelta=%3E%3D5.5&bgm.timeInVeryLowRecordsDelta=%3E%3D7&bgm.timeInAnyLowRecordsDelta=%3E%3D7&bgm.timeInLowRecordsDelta=%3E%3D7&bgm.timeInTargetRecordsDelta=%3E%3D7&bgm.timeInHighRecordsDelta=%3E%3D7&bgm.timeInVeryHighRecordsDelta=%3E%3D7&bgm.timeInAnyHighRecordsDelta=%3E%3D7&bgm.averageDailyRecordsDelta=%3E%3D7&bgm.totalRecordsDelta=%3E%3D7&bgm.lastDataFrom=2019-08-24T14%3A15%3A22Z&bgm.lastDataTo=2019-08-24T14%3A15%3A22Z&tags=string&sites=string' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
dataArray of objects(patients.v1)
metaobject(Meta)
Response
application/json
{
  "data": [
    { … }
  ],
  "meta": {
    "count": 0,
    "totalCount": 0
  }
}

Create Patient Account

Request

Create a custodial account for a patient

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
Bodyapplication/json
emailstring(email)
fullNamestringnon-emptyrequired

The full name of the patient

birthDatestring(date)required
Example: "2012-08-30"
mrnstringnon-empty

The medical record number of the patient

tagsArray of strings or null(Patient Tag ID List)unique
targetDevicesArray of strings
permissionsobject(Patient Permissions)
attestationSubmittedboolean
dataSourcesArray of objects or null(Patient data source)
summaryobject(patientsummary.v1)

A summary of a patients recent data

reviewsArray of objects or null(patientreview.v1)
sitesArray of objects(Site)
curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/patients' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{
    "email": "user@example.com",
    "fullName": "string",
    "birthDate": "2012-08-30",
    "mrn": "string",
    "tags": [
      "stringstringstringstring"
    ],
    "targetDevices": [
      "string"
    ],
    "permissions": {
      "custodian": {},
      "view": {},
      "note": {},
      "upload": {}
    },
    "attestationSubmitted": true,
    "dataSources": [
      {
        "state": "connected",
        "providerName": "dexcom",
        "modifiedTime": "2017-02-06T02:37:46Z",
        "expirationTime": "2017-02-06T02:37:46Z"
      }
    ],
    "summary": {
      "cgmStats": {
        "id": "2fe2488217ee43e1b2e83c2f",
        "config": {
          "schemaVersion": 0,
          "highGlucoseThreshold": 0,
          "veryHighGlucoseThreshold": 0,
          "lowGlucoseThreshold": 0,
          "veryLowGlucoseThreshold": 0
        },
        "dates": {
          "lastUpdatedDate": "2019-08-24T14:15:22Z",
          "lastUpdatedReason": [
            "string"
          ],
          "hasFirstData": true,
          "firstData": "2019-08-24T14:15:22Z",
          "hasLastData": true,
          "lastData": "2019-08-24T14:15:22Z",
          "hasLastUploadDate": true,
          "lastUploadDate": "2019-08-24T14:15:22Z",
          "hasOutdatedSince": true,
          "outdatedSince": "2019-08-24T14:15:22Z",
          "outdatedSinceLimit": "2019-08-24T14:15:22Z",
          "outdatedReason": [
            "string"
          ]
        },
        "periods": {
          "property1": {
            "min": 3,
            "minDelta": 3,
            "max": 8,
            "maxDelta": 8,
            "hasAverageGlucoseMmol": true,
            "averageGlucoseMmol": 5.5,
            "averageGlucoseMmolDelta": 2.5,
            "hasGlucoseManagementIndicator": true,
            "glucoseManagementIndicator": 7.5,
            "glucoseManagementIndicatorDelta": 7.5,
            "hasTimeInTargetPercent": true,
            "timeInTargetPercent": 0.35,
            "timeInTargetPercentDelta": 0.2,
            "hasTimeInTargetMinutes": true,
            "timeInTargetMinutes": 200,
            "timeInTargetMinutesDelta": 20,
            "hasTimeInTargetRecords": true,
            "timeInTargetRecords": 10,
            "timeInTargetRecordsDelta": 5,
            "hasTimeInHighPercent": true,
            "timeInHighPercent": 0.35,
            "timeInHighPercentDelta": 0.2,
            "hasTimeInHighMinutes": true,
            "timeInHighMinutes": 200,
            "timeInHighMinutesDelta": 20,
            "hasTimeInHighRecords": true,
            "timeInHighRecords": 10,
            "timeInHighRecordsDelta": 5,
            "hasTimeInVeryHighPercent": true,
            "timeInVeryHighPercent": 0.35,
            "timeInVeryHighPercentDelta": 0.2,
            "hasTimeInVeryHighMinutes": true,
            "timeInVeryHighMinutes": 200,
            "timeInVeryHighMinutesDelta": 5,
            "hasTimeInVeryHighRecords": true,
            "timeInVeryHighRecords": 10,
            "timeInVeryHighRecordsDelta": 5,
            "hasTimeInExtremeHighPercent": true,
            "timeInExtremeHighPercent": 0.35,
            "timeInExtremeHighPercentDelta": 0.2,
            "hasTimeInExtremeHighMinutes": true,
            "timeInExtremeHighMinutes": 200,
            "timeInExtremeHighMinutesDelta": 5,
            "hasTimeInExtremeHighRecords": true,
            "timeInExtremeHighRecords": 10,
            "timeInExtremeHighRecordsDelta": 5,
            "hasTimeInAnyHighPercent": true,
            "timeInAnyHighPercent": 0.35,
            "timeInAnyHighPercentDelta": 0.2,
            "hasTimeInAnyHighMinutes": true,
            "timeInAnyHighMinutes": 200,
            "timeInAnyHighMinutesDelta": 5,
            "hasTimeInAnyHighRecords": true,
            "timeInAnyHighRecords": 10,
            "timeInAnyHighRecordsDelta": 5,
            "hasTimeInLowPercent": true,
            "timeInLowPercent": 0.35,
            "timeInLowPercentDelta": 0.2,
            "hasTimeInLowMinutes": true,
            "timeInLowMinutes": 200,
            "timeInLowMinutesDelta": 5,
            "hasTimeInLowRecords": true,
            "timeInLowRecords": 10,
            "timeInLowRecordsDelta": 5,
            "hasTimeInVeryLowPercent": true,
            "timeInVeryLowPercent": 0.35,
            "timeInVeryLowPercentDelta": 0.2,
            "hasTimeInVeryLowMinutes": true,
            "timeInVeryLowMinutes": 200,
            "timeInVeryLowMinutesDelta": 5,
            "hasTimeInVeryLowRecords": true,
            "timeInVeryLowRecords": 10,
            "timeInVeryLowRecordsDelta": 5,
            "hasTimeInAnyLowPercent": true,
            "timeInAnyLowPercent": 0.35,
            "timeInAnyLowPercentDelta": 0.2,
            "hasTimeInAnyLowMinutes": true,
            "timeInAnyLowMinutes": 200,
            "timeInAnyLowMinutesDelta": 5,
            "hasTimeInAnyLowRecords": true,
            "timeInAnyLowRecords": 10,
            "timeInAnyLowRecordsDelta": 5,
            "hasTimeCGMUsePercent": true,
            "timeCGMUsePercent": 0.35,
            "timeCGMUsePercentDelta": 0.2,
            "hasTimeCGMUseMinutes": true,
            "timeCGMUseMinutes": 200,
            "timeCGMUseMinutesDelta": 5,
            "hasTimeCGMUseRecords": true,
            "timeCGMUseRecords": 10,
            "timeCGMUseRecordsDelta": 5,
            "hasTotalRecords": true,
            "totalRecords": 10,
            "totalRecordsDelta": 10,
            "hasAverageDailyRecords": true,
            "averageDailyRecords": 3.5,
            "averageDailyRecordsDelta": 2.5,
            "standardDeviation": 2.5,
            "standardDeviationDelta": 2.5,
            "coefficientOfVariation": 2.5,
            "coefficientOfVariationDelta": 2.5,
            "hoursWithData": 2,
            "hoursWithDataDelta": 2,
            "daysWithData": 2,
            "daysWithDataDelta": 2
          },
          "property2": {
            "min": 3,
            "minDelta": 3,
            "max": 8,
            "maxDelta": 8,
            "hasAverageGlucoseMmol": true,
            "averageGlucoseMmol": 5.5,
            "averageGlucoseMmolDelta": 2.5,
            "hasGlucoseManagementIndicator": true,
            "glucoseManagementIndicator": 7.5,
            "glucoseManagementIndicatorDelta": 7.5,
            "hasTimeInTargetPercent": true,
            "timeInTargetPercent": 0.35,
            "timeInTargetPercentDelta": 0.2,
            "hasTimeInTargetMinutes": true,
            "timeInTargetMinutes": 200,
            "timeInTargetMinutesDelta": 20,
            "hasTimeInTargetRecords": true,
            "timeInTargetRecords": 10,
            "timeInTargetRecordsDelta": 5,
            "hasTimeInHighPercent": true,
            "timeInHighPercent": 0.35,
            "timeInHighPercentDelta": 0.2,
            "hasTimeInHighMinutes": true,
            "timeInHighMinutes": 200,
            "timeInHighMinutesDelta": 20,
            "hasTimeInHighRecords": true,
            "timeInHighRecords": 10,
            "timeInHighRecordsDelta": 5,
            "hasTimeInVeryHighPercent": true,
            "timeInVeryHighPercent": 0.35,
            "timeInVeryHighPercentDelta": 0.2,
            "hasTimeInVeryHighMinutes": true,
            "timeInVeryHighMinutes": 200,
            "timeInVeryHighMinutesDelta": 5,
            "hasTimeInVeryHighRecords": true,
            "timeInVeryHighRecords": 10,
            "timeInVeryHighRecordsDelta": 5,
            "hasTimeInExtremeHighPercent": true,
            "timeInExtremeHighPercent": 0.35,
            "timeInExtremeHighPercentDelta": 0.2,
            "hasTimeInExtremeHighMinutes": true,
            "timeInExtremeHighMinutes": 200,
            "timeInExtremeHighMinutesDelta": 5,
            "hasTimeInExtremeHighRecords": true,
            "timeInExtremeHighRecords": 10,
            "timeInExtremeHighRecordsDelta": 5,
            "hasTimeInAnyHighPercent": true,
            "timeInAnyHighPercent": 0.35,
            "timeInAnyHighPercentDelta": 0.2,
            "hasTimeInAnyHighMinutes": true,
            "timeInAnyHighMinutes": 200,
            "timeInAnyHighMinutesDelta": 5,
            "hasTimeInAnyHighRecords": true,
            "timeInAnyHighRecords": 10,
            "timeInAnyHighRecordsDelta": 5,
            "hasTimeInLowPercent": true,
            "timeInLowPercent": 0.35,
            "timeInLowPercentDelta": 0.2,
            "hasTimeInLowMinutes": true,
            "timeInLowMinutes": 200,
            "timeInLowMinutesDelta": 5,
            "hasTimeInLowRecords": true,
            "timeInLowRecords": 10,
            "timeInLowRecordsDelta": 5,
            "hasTimeInVeryLowPercent": true,
            "timeInVeryLowPercent": 0.35,
            "timeInVeryLowPercentDelta": 0.2,
            "hasTimeInVeryLowMinutes": true,
            "timeInVeryLowMinutes": 200,
            "timeInVeryLowMinutesDelta": 5,
            "hasTimeInVeryLowRecords": true,
            "timeInVeryLowRecords": 10,
            "timeInVeryLowRecordsDelta": 5,
            "hasTimeInAnyLowPercent": true,
            "timeInAnyLowPercent": 0.35,
            "timeInAnyLowPercentDelta": 0.2,
            "hasTimeInAnyLowMinutes": true,
            "timeInAnyLowMinutes": 200,
            "timeInAnyLowMinutesDelta": 5,
            "hasTimeInAnyLowRecords": true,
            "timeInAnyLowRecords": 10,
            "timeInAnyLowRecordsDelta": 5,
            "hasTimeCGMUsePercent": true,
            "timeCGMUsePercent": 0.35,
            "timeCGMUsePercentDelta": 0.2,
            "hasTimeCGMUseMinutes": true,
            "timeCGMUseMinutes": 200,
            "timeCGMUseMinutesDelta": 5,
            "hasTimeCGMUseRecords": true,
            "timeCGMUseRecords": 10,
            "timeCGMUseRecordsDelta": 5,
            "hasTotalRecords": true,
            "totalRecords": 10,
            "totalRecordsDelta": 10,
            "hasAverageDailyRecords": true,
            "averageDailyRecords": 3.5,
            "averageDailyRecordsDelta": 2.5,
            "standardDeviation": 2.5,
            "standardDeviationDelta": 2.5,
            "coefficientOfVariation": 2.5,
            "coefficientOfVariationDelta": 2.5,
            "hoursWithData": 2,
            "hoursWithDataDelta": 2,
            "daysWithData": 2,
            "daysWithDataDelta": 2
          }
        }
      },
      "bgmStats": {
        "id": "2fe2488217ee43e1b2e83c2f",
        "config": {
          "schemaVersion": 0,
          "highGlucoseThreshold": 0,
          "veryHighGlucoseThreshold": 0,
          "lowGlucoseThreshold": 0,
          "veryLowGlucoseThreshold": 0
        },
        "dates": {
          "lastUpdatedDate": "2019-08-24T14:15:22Z",
          "lastUpdatedReason": [
            "string"
          ],
          "hasFirstData": true,
          "firstData": "2019-08-24T14:15:22Z",
          "hasLastData": true,
          "lastData": "2019-08-24T14:15:22Z",
          "hasLastUploadDate": true,
          "lastUploadDate": "2019-08-24T14:15:22Z",
          "hasOutdatedSince": true,
          "outdatedSince": "2019-08-24T14:15:22Z",
          "outdatedSinceLimit": "2019-08-24T14:15:22Z",
          "outdatedReason": [
            "string"
          ]
        },
        "periods": {
          "property1": {
            "min": 3,
            "minDelta": 3,
            "max": 8,
            "maxDelta": 8,
            "hasAverageGlucoseMmol": true,
            "averageGlucoseMmol": 5.5,
            "averageGlucoseMmolDelta": 2.5,
            "hasTimeInTargetPercent": true,
            "timeInTargetPercent": 0.35,
            "timeInTargetPercentDelta": 0.2,
            "hasTimeInTargetRecords": true,
            "timeInTargetRecords": 10,
            "timeInTargetRecordsDelta": 5,
            "hasTimeInHighPercent": true,
            "timeInHighPercent": 0.35,
            "timeInHighPercentDelta": 0.2,
            "hasTimeInHighRecords": true,
            "timeInHighRecords": 10,
            "timeInHighRecordsDelta": 5,
            "hasTimeInVeryHighPercent": true,
            "timeInVeryHighPercent": 0.35,
            "timeInVeryHighPercentDelta": 0.2,
            "hasTimeInVeryHighRecords": true,
            "timeInVeryHighRecords": 10,
            "timeInVeryHighRecordsDelta": 5,
            "hasTimeInExtremeHighPercent": true,
            "timeInExtremeHighPercent": 0.35,
            "timeInExtremeHighPercentDelta": 0.2,
            "hasTimeInExtremeHighRecords": true,
            "timeInExtremeHighRecords": 10,
            "timeInExtremeHighRecordsDelta": 5,
            "hasTimeInAnyHighPercent": true,
            "timeInAnyHighPercent": 0.35,
            "timeInAnyHighPercentDelta": 0.2,
            "hasTimeInAnyHighRecords": true,
            "timeInAnyHighRecords": 10,
            "timeInAnyHighRecordsDelta": 5,
            "hasTimeInLowPercent": true,
            "timeInLowPercent": 0.35,
            "timeInLowPercentDelta": 0.2,
            "hasTimeInLowRecords": true,
            "timeInLowRecords": 10,
            "timeInLowRecordsDelta": 5,
            "hasTimeInVeryLowPercent": true,
            "timeInVeryLowPercent": 0.35,
            "timeInVeryLowPercentDelta": 0.2,
            "hasTimeInVeryLowRecords": true,
            "timeInVeryLowRecords": 10,
            "timeInVeryLowRecordsDelta": 5,
            "hasTimeInAnyLowPercent": true,
            "timeInAnyLowPercent": 0.35,
            "timeInAnyLowPercentDelta": 0.2,
            "hasTimeInAnyLowRecords": true,
            "timeInAnyLowRecords": 10,
            "timeInAnyLowRecordsDelta": 5,
            "hasTotalRecords": true,
            "totalRecords": 10,
            "totalRecordsDelta": 10,
            "hasAverageDailyRecords": true,
            "averageDailyRecords": 3.5,
            "averageDailyRecordsDelta": 2.5,
            "standardDeviation": 2.5,
            "standardDeviationDelta": 2.5,
            "coefficientOfVariation": 2.5,
            "coefficientOfVariationDelta": 2.5,
            "daysWithData": 2,
            "daysWithDataDelta": 2
          },
          "property2": {
            "min": 3,
            "minDelta": 3,
            "max": 8,
            "maxDelta": 8,
            "hasAverageGlucoseMmol": true,
            "averageGlucoseMmol": 5.5,
            "averageGlucoseMmolDelta": 2.5,
            "hasTimeInTargetPercent": true,
            "timeInTargetPercent": 0.35,
            "timeInTargetPercentDelta": 0.2,
            "hasTimeInTargetRecords": true,
            "timeInTargetRecords": 10,
            "timeInTargetRecordsDelta": 5,
            "hasTimeInHighPercent": true,
            "timeInHighPercent": 0.35,
            "timeInHighPercentDelta": 0.2,
            "hasTimeInHighRecords": true,
            "timeInHighRecords": 10,
            "timeInHighRecordsDelta": 5,
            "hasTimeInVeryHighPercent": true,
            "timeInVeryHighPercent": 0.35,
            "timeInVeryHighPercentDelta": 0.2,
            "hasTimeInVeryHighRecords": true,
            "timeInVeryHighRecords": 10,
            "timeInVeryHighRecordsDelta": 5,
            "hasTimeInExtremeHighPercent": true,
            "timeInExtremeHighPercent": 0.35,
            "timeInExtremeHighPercentDelta": 0.2,
            "hasTimeInExtremeHighRecords": true,
            "timeInExtremeHighRecords": 10,
            "timeInExtremeHighRecordsDelta": 5,
            "hasTimeInAnyHighPercent": true,
            "timeInAnyHighPercent": 0.35,
            "timeInAnyHighPercentDelta": 0.2,
            "hasTimeInAnyHighRecords": true,
            "timeInAnyHighRecords": 10,
            "timeInAnyHighRecordsDelta": 5,
            "hasTimeInLowPercent": true,
            "timeInLowPercent": 0.35,
            "timeInLowPercentDelta": 0.2,
            "hasTimeInLowRecords": true,
            "timeInLowRecords": 10,
            "timeInLowRecordsDelta": 5,
            "hasTimeInVeryLowPercent": true,
            "timeInVeryLowPercent": 0.35,
            "timeInVeryLowPercentDelta": 0.2,
            "hasTimeInVeryLowRecords": true,
            "timeInVeryLowRecords": 10,
            "timeInVeryLowRecordsDelta": 5,
            "hasTimeInAnyLowPercent": true,
            "timeInAnyLowPercent": 0.35,
            "timeInAnyLowPercentDelta": 0.2,
            "hasTimeInAnyLowRecords": true,
            "timeInAnyLowRecords": 10,
            "timeInAnyLowRecordsDelta": 5,
            "hasTotalRecords": true,
            "totalRecords": 10,
            "totalRecordsDelta": 10,
            "hasAverageDailyRecords": true,
            "averageDailyRecords": 3.5,
            "averageDailyRecordsDelta": 2.5,
            "standardDeviation": 2.5,
            "standardDeviationDelta": 2.5,
            "coefficientOfVariation": 2.5,
            "coefficientOfVariationDelta": 2.5,
            "daysWithData": 2,
            "daysWithDataDelta": 2
          }
        }
      }
    },
    "reviews": [
      {
        "clinicianId": "string",
        "time": "2019-08-24T14:15:22Z"
      }
    ],
    "sites": [
      {
        "name": "string"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
idstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit UUID v4

emailstring(email)
fullNamestringnon-emptyrequired

The full name of the patient

birthDatestring(date)required
Example: "2012-08-30"
mrnstringnon-empty

The medical record number of the patient

tagsArray of strings or null(Patient Tag ID List)unique
targetDevicesArray of strings
permissionsobject(Patient Permissions)
createdTimestring(date-time)read-onlyrequired
updatedTimestring(date-time)read-onlyrequired
attestationSubmittedboolean
dataSourcesArray of objects or null(Patient data source)
lastUploadReminderTimestring(date-time)read-only
summaryobject(patientsummary.v1)

A summary of a patients recent data

reviewsArray of objects or null(patientreview.v1)
connectionRequestsobject(providerconnectionrequests.v1)read-onlyrequired
connectionRequests.​twiistArray of objects(Provider Connection Request)required
connectionRequests.​twiist[].​createdTimestring(date-time)required
connectionRequests.​twiist[].​providerNamestring(Third-Party Data Providers)required
Enum"dexcom""twiist""abbott"
connectionRequests.​dexcomArray of objects(Provider Connection Request)required
connectionRequests.​dexcom[].​createdTimestring(date-time)required
connectionRequests.​dexcom[].​providerNamestring(Third-Party Data Providers)required
Enum"dexcom""twiist""abbott"
connectionRequests.​abbottArray of objects(Provider Connection Request)required
connectionRequests.​abbott[].​createdTimestring(date-time)required
connectionRequests.​abbott[].​providerNamestring(Third-Party Data Providers)required
Enum"dexcom""twiist""abbott"
sitesArray of objects(Site)
Response
application/json
{
  "id": "string",
  "email": "user@example.com",
  "fullName": "string",
  "birthDate": "2012-08-30",
  "mrn": "string",
  "tags": [
    "stringstringstringstring"
  ],
  "targetDevices": [
    "string"
  ],
  "permissions": {
    "custodian": {},
    "view": {},
    "note": {},
    "upload": {}
  },
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "attestationSubmitted": true,
  "dataSources": [
    { … }
  ],
  "lastUploadReminderTime": "2019-08-24T14:15:22Z",
  "summary": {
    "cgmStats": { … },
    "bgmStats": { … }
  },
  "reviews": [
    { … }
  ],
  "connectionRequests": {
    "twiist": [ … ],
    "dexcom": [ … ],
    "abbott": [ … ]
  },
  "sites": [
    { … }
  ]
}

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