Device event subType: prime

Jump to...(notable fields on this type)

• type
• subType
• primeTarget
• volume

NB: All fields are required unless otherwise noted.

Jump to example JSON:

• client example
• ingestion example
• storage example

type

[ingestion, storage, client] The string deviceEvent.

QUICK SUMMARY
Required:
    jellyfish: yes
    platform: yes

subType

[ingestion, storage, client] The string prime.

QUICK SUMMARY
Required:
    jellyfish: yes
    platform: yes

The prime sub-type of deviceEvent represents a user's priming of either an insulin infusion line/tubing used with a traditional insulin pump or the priming of an insulin delivery cannula used in all insulin delivery devices (i.e., both traditional insulin pumps and tubeless patch pumps like the Insulet OmniPod insulin delivery system). To "prime" and infusion line or cannula is to fill it with insulin either while disconnected from the user or in preparation for insertion in order to ready the device to delivery programmed doses of insulin.

primeTarget

[ingestion, storage, client] String encoding the target of the priming action.

QUICK SUMMARY
Required:
    jellyfish: yes
    platform: yes
Range: Must be one of:
    `cannula`
    `tubing`

The primeTarget field identifies the object of the priming action - either 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 be seconds or minutes. Note, however, that many combinations of prime events may occur in a real user's data "in the wild." For example, no priming events will appear in the data of an Insulet OmniPod user, as the device's automatic cannula prime prior to pod activation is not logged. And among traditional insulin pump users, priming behavior varies considerably. Those who use steel cannulas must prime the cannula along with the tubing, as the steel cannula is not separable from the infusion line, and so only tubing primes will appear in the data. Other insulin pump users may change the infusion site without changing out the insulin reservoir and infusion line at the same time, in which case a cannula prime may appear independently of a tubing prime.

volume

This field is optional.

[ingestion, storage, client] A floating point value representing units of insulin.

QUICK SUMMARY
Required:
    jellyfish: no (optional)
    platform: no (optional)
Range:
    cannula:
        min: 0.0
        max: 10.0
    tubing:
        min: 0.0
        max: 100.0

Where available in the data, the volume of a priming event should be included as a value in insulin of expended in the course of the priming action.

clockDriftOffset

See common fields.

conversionOffset

See common fields.

deviceId

See common fields.

deviceTime

See common fields.

time

See common fields.

timezoneOffset

See common fields.

uploadId

See common fields.

_active

See common fields.

_groupId

See common fields.

_schemaVersion

See common fields.

_version

See common fields.

createdTime

See common fields.

guid

See common fields.

id

See common fields.

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"
}