Skip to content
Documentation
/
Diabetes Device Data Mode...
/
/
Alert (`alert`)
Last updated

Alert (alert)

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"
namestring[ 1 .. 100 ] charactersrequired
prioritystring
Enum"critical""normal""timeSensitive"
triggerstring
Enum"delayed""immediate""repeating"
triggerDelayinteger(int32)[ 0 .. 86400 ]
soundstring
Enum"name""silence""vibrate"
soundNamestring[ 1 .. 100 ] characters
issuedTimestring(date-time)(Date/Time)required
Example: "2017-02-06T02:37:46Z"
acknowledgedTimestring(date-time)(Date/Time)
Example: "2017-02-06T02:37:46Z"
retractedTimestring(date-time)(Date/Time)
Example: "2017-02-06T02:37:46Z"
guidstringDeprecated

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

Overview

This is the Tidepool data type representing an alert presented to the user from a device or controller.

Type (type)

This is the Tidepool data type to represent ab alert presented to the user from a device or controller.

Name (name)

The name of the alert, not necessarily human readable. This is not a unique identifier for the alert, but rather a name of the class of alert presented to the user. For example, "CGM.lowGlucose".

Priority (priority)

The priority of the alert. One of critical, normal, or timeSensitive.

Trigger (trigger)

The trigger that causes the alert to be presented. One of delayed, immediate, or repeating.

Trigger Delay (triggerDelay)

For a delayed or repeating trigger alert, the delay, in seconds, before the alert is presented after it is initially issued and, for repeating trigger alerts, the delay before re-presenting it after it was previously presented.

Sound (sound)

The sound associated with the alert. One of name, silence, or vibrate.

Sound Name (soundName)

For a name sound, then name of the sound played when the alert is presented.

Issued Time (issuedTime)

The time the alert was issued (aka created).

Acknowledged Time (acknowledgedTime)

The time the alert was first acknowledged by the user after it was presented.

Retracted Time (retractedTime)

The time the alert was retracted after it was presented.

Example Low Glucose Alert
{
    "id": "02ccebd2affc472d9b296d4f1f800dfd",
    "time": "2018-05-14T08:17:07.560Z",
    "type": "alert",
    "name": "CGM.lowGlucose",
    "priority": "timeSensitive",
    "trigger": "delayed",
    "triggerDelay": 900,
    "sound": "name",
    "soundName": "Gong",
    "issuedTime": "2018-05-14T08:17:07.560Z",
    "acknowledgedTime": "2018-05-14T08:33:03.254Z",
    "retractedTime": "2018-05-14T08:35:12.884Z",
    "uploadId": "0d92d5c1c22117a18f3620b9e24d3c06"
}

Keep Reading

Previous page
Next page