An array of annotations.
An array of associations for the resource.
Clock drift offset, expressed as milliseconds.
Conversion offset, expressed as milliseconds.
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
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
Globally unique to device and repeatable with each upload, e.g. device make and model with serial number
Revision history of the event
Location information associated with the resource. One or both of name and gps must be specified.
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
An array of 1 to 100 notes.
External origin information for the source of the resource.
Grab bag field for data that isn't yet part of the data model. The maximum size is 4K bytes.
An array of tags.
A string timezone name from the IANA timezone database
Time zone offset, expressed as positive or negative number of minutes from UTC.
Data type
An upload identifier; this field should be the uploadId of the corresponding upload record
An array of string tags indicating the manufacturer(s) of the device.
In order to avoid confusion resulting from referring to a single manufacturer with more than one name—for example, using both 'Minimed' and 'Medtronic' interchangeably—we restrict the set of strings used to refer to manufacturers to the set listed above and enforce exact string matches (including casing).
deviceManufacturers is an array of one or more string "tags" because there are devices resulting from a collaboration between more than one manufacturer, such as the Tandem G4 insulin pump with CGM integration (a collaboration between Tandem and Dexcom).
A string identifying the model of the device.
The deviceModel is a non-empty string that encodes the model of device. We endeavor to match each manufacturer's standard for how they represent model name in terms of casing, whether parts of the name are represented as one word or two, etc.
A string encoding the device's serial number.
The deviceSerialNumber is a string that encodes the serial number of the device. Note that even if a manufacturer only uses digits in its serial numbers, the SN should be stored as a string regardless.
Uniquely of string fields in the Tidepool device data models, deviceSerialNumber may be an empty string. This is essentially a compromise: having the device serial number is extremely important (especially for e.g., clinical studies) but in 2016 we came across our first case where we cannot recover the serial number of the device that generated the data: Dexcom G5 data uploaded to Tidepool through Apple iOS's HealthKit integration.
An array of string tags indicating the function(s) of the device.
The deviceTags array should be fairly self-explanatory as an array of tags indicating the function(s) of a particular device. For example, the Insulet OmniPod insulin delivery system has the tags bgm and insulin-pump since the PDM is both an insulin pump controller and includes a built-in blood glucose monitor.
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
The client software that provided diabetes data.
An ISO 8601 formatted timestamp without any timezone offset information.
The computerTime field encodes the local time at upload with no timezone offset information since we are storing timezone separately. We store this field in order to be able to audit and/or detect the correspondence between the user's browser time and the timezone they selected at the time of upload. If the user selected the timezone that was actually in effect for their browser at the time of upload, then applying the stored timezone to the UTC Zulu time field will match computerTime. If, on the other hand, the user selected a different timezone from that effective in their browser at the time of upload, applying the timezone to time will not match computerTime.
There are some use cases when it is perfectly justified to select a timezone that does not reflect the browser's current timezone. For example, some insulin pump users do not change the time on their devices when traveling for short periods of time across many timezones, but when uploading a device a user should always choose the timezone that aligns with the most recent data on the device and thus that will not match the local browser timezone.
A string indicating what variety of processing was used to create the time and related fields such as timezoneOffset on data in this upload.
For data auditing purposes, we store a string encoding the type of algorithm used to generate the time, timezoneOffset, and other related fields from the local deviceTime. At present, there are only three options for this value:
nonefor data sources that already include a UTC-anchoredtimevalue. At present, the only data source for which this is true is Dexcom G5 or Dexcom G6 data coming through Apple's iOS HealthKit integration.across-the-board-timezonefor devices (all BGMs, for example) that cannot have theirdeviceTimevalues "bootstrapped" to a UTCtimevalue; in such cases, we apply a single user-selected timezone to everydeviceTime"across the board" to generate thetimevalue.utc-bootstrappingfor devices (most insulin pumps and CGMs) where we use a combination of the user-selected timezone at time of upload, the most recent timestamp on device, and the history of display time changes on the device to infer the correcttimevalue for each record.
Semantic Version Number 2.0.0. Regex from their site.
A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
This is the Tidepool data type most distinct from all others: instead of encoding diabetes device data, the upload type encodes metadata — about uploads of diabetes device data — to Platform.
The fields under this type are:
- Quick Summary
- Type (
type) - By User (
byUser) - Computer Time (
computerTime) - Device Manufacturers (
deviceManufacturers) - Device Model (
deviceModel) - Device Serial Number (
deviceSerialNumber) - Device Tags (
deviceTags) - Time Processing (
timeProcessing) - Timezone (
timezone) - Upload ID (
uploadId) - Version (
version) - Examples
- Keep Reading
The by user field is provided for data auditing purposes. Since Tidepool provides functionality to share data and data permissions between users — for example, between a clinician and a patient — the user that logged in and performed the device upload may not be the PwD whose data is being uploaded.
The computer time field encodes the local time at upload with no timezone offset information (Tidepool stores timezone separately). We store this field to audit and/or detect the correspondence between the user's browser time and the timezone they selected at the time of upload. If the user selected the correct timezone for their browser, then the timezone will be converted to UTC Zulu time and then again to computer time (which should match the selected timezone). If, however, the user selected a different timezone from that effective in their browser, the computer time and timezone will not match.
There are some cases where it is perfectly justified to select a timezone that does not reflect the browser's current timezone. For example, some insulin pump users do not change the time on their devices when traveling for short periods of time across many timezones. When uploading a device, a user should always choose the timezone that aligns with the most recent data on the device and therefore (in the previous example) will not match the local browser timezone.
To avoid confusion resulting from referring to a single manufacturer with more than one name — for example, using both "Minimed" and "Medtronic" interchangeably — Tidepool restricts device manufacturer string "tags" to those detailed in the quick summary above and enforces exact string matches (including casing).
Device manufacturers is an array of one or more string tags because some devices are the result of manufacturer collaboration, such as the Tandem G4 insulin pump with CGM integration (a collaboration between Tandem and Dexcom).
The device model is a non-empty string that encodes the model of device. We endeavor to match each manufacturer's standard for how they represent model name in terms of casing, whether parts of the name are represented as one word or two, etc.
The device serial number is a string that encodes the serial number of the device.
Even if a manufacturer only uses digits in its serial numbers, the serial number should be stored as a string regardless.
Having the device serial number is extremely important (especially for clinical studies) and should be included whenever possible. However, if the device serial number is unknown, the device serial number may be an empty string.
The device tags array should be fairly self-explanatory as an array of tags indicating the function/s of a particular device. For example, the Insulet OmniPod insulin delivery system has the tags "bgm" and "insulin-pump" since the PDM (personal diabetes monitor) is both an insulin pump controller and includes a built-in blood glucose monitor.
For data auditing purposes, Tidepool stores a string encoding the type of algorithm used to generate the time, timezone offset, and other related fields from the local device time. At present, there are only three options for this value:
- Across-the-board-timezone for devices (all BGMs, for example) that cannot have their device time values "bootstrapped" to a UTC time value. In such cases, we apply a single user-selected timezone to every device time "across the board" to generate the time value.
- UTC-bootstrapping for devices (most insulin pumps and CGMs) where we use a combination of the user-selected timezone (at time of upload), the most recent timestamp on the device, and the history of display time changes on the device to infer the correct time value for each record.
- None for data sources that already include a UTC-anchored time value. Currently, the only data source for which this is true is Dexcom G5 data coming through Apple's iOS HealthKit integration.
The timezone is the timezone selected by the user manually in the Chrome uploader at the time of upload, or (in the case of Dexcom G5 data from HealthKit), the timezone reported by the mobile device at the time of upload.
Tidepool uses the Moment Timezone library for the implementation of both UTC-bootstrapping (in Tidepool Uploader) and in Tidepool Web. Moment Timezone includes a copy of the IANA timezone database and is updated frequently, but as Tidepool does not always reguarly update dependencies, the possible values of this field are limited to the string timezone names recognized by the IANA timezone database (included in Tidepool's current version of Moment Timezone).
The upload ID is generated and returned by Platform when opening an upload session. The upload ID should be used as part of the URI when adding new data.
Upload ID should not be used in any POST bodies when uploading to Platform.
A string identifying the software version of the uploading client. For Tidepool Uploader, this will be a semver (e.g. 1.25.2). For other uploading clients such as Tidepool iOS applications, the format includes the namespace and semver of the app (e.g. org.tidepool.blipnotes:1.25:2).
{
"type": "upload",
"byUser": "154bb78230",
"computerTime": "2016-06-27T18:09:55",
"deviceManufacturers": "Tandems",
"deviceModel": "Devicey McDeviceface",
"deviceSerialNumber": "11359410",
"deviceTags": [
"bgm",
"cgm"
],
"timeProcessing": "across-the-board-timezone",
"timezone": "Europe/London",
"uploadId": "SampleUploadId",
"version": "0.100.0",
"clockDriftOffset": 0,
"conversionOffset": 0,
"deviceId": "DevId0987654321",
"deviceTime": "2016-06-27T18:09:55",
"guid": "e46ceaf2-e6af-4eb2-9583-3b6095f44474",
"id": "eed794bbf9ec4b118f5e4c158216d45d",
"time": "2016-06-28T01:09:55.131Z",
"timezoneOffset": -420
}{
"type": "upload",
"byUser": "eda1e15c6a",
"computerTime": "2016-06-27T18:09:55",
"deviceManufacturers": "Tandems",
"deviceModel": "Devicey McDeviceface",
"deviceSerialNumber": "B97B6D59",
"deviceTags": [
"bgm",
"cgm"
],
"timeProcessing": "utc-bootstrapping",
"timezone": "Europe/London",
"uploadId": "SampleUploadId",
"version": "0.100.0",
"clockDriftOffset": 0,
"conversionOffset": 0,
"deviceId": "DevId0987654321",
"deviceTime": "2016-06-27T18:09:55",
"time": "2016-06-28T01:09:55.132Z",
"timezoneOffset": -420
}{
"type": "upload",
"byUser": "e9c6044f37",
"computerTime": "2016-06-27T18:09:55",
"deviceManufacturers": "Tandems",
"deviceModel": "Devicey McDeviceface",
"deviceSerialNumber": "59579660",
"deviceTags": [
"bgm",
"cgm"
],
"timeProcessing": "utc-bootstrapping",
"timezone": "Europe/London",
"uploadId": "SampleUploadId",
"version": "0.100.0",
"_active": true,
"_groupId": "abcdef",
"_schemaVersion": 0,
"_version": 0,
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2016-06-28T01:10:00.132Z",
"deviceId": "DevId0987654321",
"deviceTime": "2016-06-27T18:09:55",
"guid": "42b5f8b1-699a-4c15-ab62-33934791ea7b",
"id": "451beb9d69b64bc2a60a1696559f94d1",
"time": "2016-06-28T01:09:55.132Z",
"timezoneOffset": -420
}