Skip to content
Documentation
/
/
/
Prime (`prime`)
Last updated

Prime (prime)

Quick Summary

One of:

A cannula prime event.

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"deviceEvent""alert""basal""bloodKetone""bolus""cbg""cgmSettings""controllerSettings""controllerStatus""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"
subTypestring(Device Event Sub Type)required
Enum"prime""alarm""calibration""pumpSettingsOverride""reservoirChange""sensorEvent""settingsChange""status""timeChange""transmitterEvent"
primeTargetstringrequired
Value"cannula"
volumenumber(float)[ 0 .. 10 ]required
guidstringDeprecated

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

Sub-Type (subType)

The prime sub-type of device event represents a user's "priming" of either an insulin infusion line (used with traditional insulin pumps) or an insulin delivery cannula (used in tubeless patch pumps and some traditional pumps).

To "prime" an infusion line or cannula is to fill it with insulin either:

  • While disconnected from the user
  • Or, in preparation for a site or reservior change

The priming process removes any air from the tubing or cannula to ensure seamless insulin delivery.

Prime Target (primeTarget)

The prime target field identifies the object of the priming action — "tubing" for an infusion line prime or "cannula" for a cannula prime.

Most commonly, tubing and cannula prime events will occur as a pair separated only by seconds or minutes. However, many combinations of prime events are possible. For example, no priming events appear in an OmniPod's data, as the device primes automatically without notifying the user.

Among traditional pump users, priming behavior varies considerably. Those who use steel cannulas must prime the cannula and tubing simultaneously, as the steel cannula and infusion line are inseparable. In this case, only tubing primes will appear in the data. Other insulin pump users can change the infusion site independently (without changing the insulin reservoir), causing a cannula prime to appear without a tubing prime.

Volume (volume)

Where available in the data, the volume of a priming event should be included to measure insulin expended from the priming action.

Examples

Example (client)
{
    "type": "deviceEvent",
    "subType": "prime",
    "primeTarget": "cannula",
    "volume": "0.5",
    "clockDriftOffset": 0,
    "conversionOffset": 0,
    "deviceId": "DevId0987654321",
    "deviceTime": "2018-05-14T18:17:08",
    "guid": "7637c7b9-6286-4f93-8953-d619e42cb1a5",
    "id": "bfc3e597e16c436a94a03d7fd095a774",
    "time": "2018-05-14T08:17:08.276Z",
    "timezoneOffset": 600,
    "uploadId": "SampleUploadId"
}
Example (ingestion)
{
    "type": "deviceEvent",
    "subType": "prime",
    "primeTarget": "tubing",
    "volume": 12,
    "clockDriftOffset": 0,
    "conversionOffset": 0,
    "deviceId": "DevId0987654321",
    "deviceTime": "2018-05-14T18:17:08",
    "time": "2018-05-14T08:17:08.276Z",
    "timezoneOffset": 600,
    "uploadId": "SampleUploadId"
}
Example (storage)
{
    "type": "deviceEvent",
    "subType": "prime",
    "primeTarget": "tubing",
    "volume": 15.3,
    "_active": true,
    "_groupId": "abcdef",
    "_schemaVersion": 0,
    "_version": 0,
    "clockDriftOffset": 0,
    "conversionOffset": 0,
    "createdTime": "2018-05-14T08:17:13.276Z",
    "deviceId": "DevId0987654321",
    "deviceTime": "2018-05-14T18:17:08",
    "guid": "a6f76c8d-38e5-4c60-96d9-8df53b0fb9e8",
    "id": "94e1776ca9384280bd347691e105b02f",
    "time": "2018-05-14T08:17:08.276Z",
    "timezoneOffset": 600,
    "uploadId": "SampleUploadId"
}

Keep Reading

Previous page
Next page