Skip to content
Documentation
/
/
Common Fields
Last updated

Common Fields

Quick summary

annotationsArray of Annotation (object) or Blood Glucose Out of Range (object)(Annotation Array)[ 0 .. 100 ] itemsunique

An array of annotations.

archivedTimestring(date-time)(Date/Time)read-only
Example: "2017-02-06T02:37:46Z"
archivedDatasetIdstring(Data Set ID)[ 17 .. 37 ] characters^(upid_[0-9a-f]{12}|upid_[0-9a-f]{32}|[0-9a-f...
Example: "ce8cc5f7595575945f91fc6710db6fef"
associationsArray of Association (blob) (object) or Association (datum) (object) or Association (image) (object) or Association (url) (object)(Association Array)

An array of associations for the resource.

clockDriftOffsetinteger(int64)(Clock Drift Offset)[ -86400000 .. 86400000 ]

Clock drift offset, expressed as milliseconds.

Example: 0
conversionOffsetinteger(int64)(Conversion Offset)

Conversion offset, expressed as milliseconds.

Example: 0
createdTimestring(date-time)(Date/Time)
Example: "2017-02-06T02:37:46Z"
createdUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

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

deduplicatorobject(Deduplicator Descriptor)
deletedTimestring(date-time)(Date/Time)
Example: "2017-02-06T02:37:46Z"
deletedUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

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

deviceIdstring(Device ID)non-empty

Globally unique to device and repeatable with each upload, e.g. device make and model with serial number

Example: "MMT-1711:12345678"
deviceTimestring(Date/Time without Timezone)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$
Example: "2017-02-06T02:37:46"
historyArray of objects(Event History [Proposed])

Revision history of the event

idstring(Data Set ID)[ 17 .. 37 ] characters^(upid_[0-9a-f]{12}|upid_[0-9a-f]{32}|[0-9a-f...required
Example: "ce8cc5f7595575945f91fc6710db6fef"
locationobject(Location)

Location information associated with the resource. One or both of name and gps must be specified.

modifiedTimestring(date-time)(Date/Time)
Example: "2017-02-06T02:37:46Z"
modifiedUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

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

notesArray of strings(Note Array)[ 1 .. 100 ] items

An array of 1 to 100 notes.

originobject(Origin)

External origin information for the source of the resource.

payloadobject(Payload)

Grab bag field for data that isn't yet part of the data model. The maximum size is 4K bytes.

sourcestring
Value"carelink"
tagsArray of strings(Tag Array)

An array of tags.

timestring(date-time)(Date/Time)required
Example: "2017-02-06T02:37:46Z"
timezonestring(Time Zone)
Example: "Europe/London"
timezoneOffsetinteger(int32)(Time Zone offset)[ -10080 .. 10080 ]

Time zone offset, expressed as positive or negative number of minutes from UTC.

Example: -420
typestring(Tidepool Data Type)required

Data type

Enum"alert""basal""bloodKetone""bolus""cbg""cgmSettings""controllerSettings""controllerStatus""deviceEvent""deviceStatus"
Example: "upload"
uploadIdstring(Upload ID)[ 17 .. 32 ] characters^([0-9a-f]{32}|upid_[0-9a-f]{12})$

An upload identifier; this field should be the uploadId of the corresponding upload record

Example: "0d92d5c1c22117a18f3620b9e24d3c06"
guidstringDeprecated

A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.

Clock Drift Offset (clockDriftOffset)

This field is Platform's best effort to convert the device's local display time to UTC. This optional field records the offset from UTC (in milliseconds) resulting from small adjustments a user may make to a device's display time due to "clock drift." See the technical documentation describing "Bootstrapping to UTC" for more information.

Conversion Offset (conversionOffset)

This field is Platform's best effort to convert the device's local display time to UTC. This field records the offset from UTC resulting from very large adjustments a user may make due to realizing the device was set to the wrong day, month, or year. See the technical documentation describing "Bootstrapping to UTC" for more information.

Created Time (createdTime)

Created time is the machine-time when the event was first ingested into Platform. This is represented as an ISO 8601-formatted UTC timestamp with a final Z for "Zulu" time.

Example:

  • 2015-11-09T03:58:44.584Z

Device ID (deviceId)

A string encoding the device that generated the datum. This should be globally unique to this device and repeatable with each upload. A device make and model with a shortened serial number is a good value to include here.

Examples:

  • InsOmn-240243671 (Insulet OmniPod with serial number 240243671)
  • DexG4RecwitShaSM62228608 (Dexcom G4 receiver with Share, serial number SM62228608)

Device Time (deviceTime)

No currently available diabetes device (that Tidepool knows of) stores data in UTC or UTC-anchored time via a timezone offset. This means all diabetes devices currently store the device's display time at the time the event occurred. Platform makes a best effort to convert this device time to UTC, but the raw device time is also stored for data-auditing purposes. It is stored in the ISO 8601 format, but without any timezone offset information.

Example:

  • 2015-11-08T17:06:53

GUID (guid)

An RFC 4122 version 4 UUID (universally unique identifier), generated using the node-uuid library in Tidepool Uploader or, if the data is being ingested through Platform, added upon ingestion by the service itself.

See here for Tidepool Uploader implementation and app/uuid.go for Platform ingestion implementation.

Example:

  • 6380d89e-1894-49de-bdaf-cb1e8c163dec

ID (id)

The IDs generated for each event by Platform are simply RFC 4122 version 4 UUIDs with the - characters deleted. This provides a backwards compatibility with the format of the earlier jellyfish-generated IDs, which were alphanumeric.

Example:

  • c4c31493417b4c6d968b72f08e6b3712

IDs are not deterministically generated from the content of events and are therefore not useful for deduplication.

Time (time)

An ISO 8601-formatted timestamp including either a timezone offset from UTC or converted to UTC and formatted with a final Z for "Zulu" time.

This field is Platform's best effort to convert the device's local display time to UTC. See "Bootstrapping to UTC" for more information.

Examples:

  • 2015-11-08T17:06:53-08:00 (timezone offset from UTC)
  • 2015-11-09T01:06:53.555Z ("Zulu" time formatting)

Timezone Offset (timezoneOffset)

This field is Platform's best effort to convert the device's local display time to UTC. Timezone offset encodes the offest (in minutes from UTC) to convert the UTC timestamp back to local display time. See "Bootstrapping to UTC" for more information.

Examples:

  • 0 (timezone offset for UTC)
  • -480 (timezone offset for Pacific Standard Time in the U.S.)
  • 60 (timezone offset for British Summer Time)

Upload ID (uploadId)

An upload identifier. This field should be the upload ID of the corresponding upload record. Currently, upload IDs are generated in Tidepool Uploader as a hash of various pieces of upload session metadata.

Upload ID does not figure in the calculations of an event record's ID. This ID is used to prevent storage of multiple copies of the same event. This means that multiple attempts to upload the same event record will nevertheless result in the same ID.

Example of All Possible Fields
{
    "_active": true,
    "_groupId": "abcdef",
    "_schemaVersion": 0,
    "_version": 0,
    "clockDriftOffset": 0,
    "conversionOffset": 0,
    "createdTime": "2018-05-14T08:17:12.734Z",
    "deviceId": "DevId0987654321",
    "deviceTime": "2018-05-14T18:17:07",
    "guid": "33b8f139-50e4-49d6-b9eb-44d70cc05abc",
    "id": "47a2c4c1435a41bc83aba48797ed5cb3",
    "time": "2018-05-14T08:17:07.734Z",
    "timezoneOffset": 600,
    "uploadId": "SampleUploadId"
}
Previous page
Next page