Bolus subType: normal

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

• type
• subType
• normal
• expectedNormal

NB: All fields are required unless otherwise noted.

Jump to example JSON:

• client example
• ingestion example
• storage example

type

[ingestion, storage, client] The string bolus.

QUICK SUMMARY
Required:
    jellyfish: yes
    platform: yes

subType

[ingestion, storage, client] The string normal.

QUICK SUMMARY
Required:
    jellyfish: yes
    platform: yes

This is the sub-type of bolus event that represents a bolus insulin dose delivered more-or-less immediately (within a matter of seconds or a small number of minutes, depending on the insulin pump and the user's settings). At Tidepool we follow the common convention of representing normal boluses as point-in-time events since their durations are short enough to be negligible.

normal

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

QUICK SUMMARY
Required:
    jellyfish: yes
    platform: yes
Numerical type: Floating point value rounded to the appropriate significant figures for the device's precision.
Range:
    min: >= 0.0
    max: 100.0

The normal field encodes the numerical value of the dose of insulin delivered by an insulin pump. To avoid noise in the data (especially as some insulin pumps make it very easy to deliver "doses" of 0 units when no additional dose is recommended given the PWD's current blood glucose and insulin on board), we have chosen in most cases not to allow the upload of boluses with a total delivered dose of 0 units; the value must be greater than 0.

The only exception to this is when a user programs a bolus of greater than 0 units of insulin but cancels the delivery of this bolus before any of the insulin has been successfully delivered, resulting in a normal of 0 units but an expectedNormal reflecting the value of the original programmed dose. In other words: a bolus of with a normal of 0 units may only be uploaded through the new platform APIs if the expectedNormal field is also present with a value greater than 0.

Most, if not all, insulin pumps include a maximum bolus setting that a PWD can customize to his or her typical dosing in order to prevent accidental delivery of very large doses of insulin. However, we could not find any indication that insulin pumps typically set a default maximum dose; hence we have chosen 100 units as an arbitrarily large maximum dose that we can imagine someone with type 1 diabetes programming.

expectedNormal

This field is optional.

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

QUICK SUMMARY
Required:
    jellyfish: no (optional)
    platform: no (optional)
Numerical type: Floating point value rounded to the appropriate significant figures for the device's precision.
Range:
    min: > `normal`
    max: 100.0

When a bolus is interrupted (for example, by an occlusion or pump malfunction) or canceled by the user, the expectedNormal field is used to store the original value of the dose of insulin that the user programmed, while normal represents the value of the dose that was actually delivered.

The minimum value of expectedNormal is any value greater than that encoded under normal since any other value (i.e., less than or equal to normal) cannot obtain from interruption or cancellation of a bolus. See above in normal for discussion of the maximum value for this field.

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": "bolus",
    "subType": "normal",
    "normal": 7.75,
    "expectedNormal": 9.3,
    "clockDriftOffset": 0,
    "conversionOffset": 0,
    "deviceId": "DevId0987654321",
    "deviceTime": "2018-05-14T18:17:06",
    "guid": "3645b635-e97a-410b-b866-5ccc8cb98cbf",
    "id": "622cc9f88a61475f8a1290909ec56e5c",
    "time": "2018-05-14T08:17:06.676Z",
    "timezoneOffset": 600,
    "uploadId": "SampleUploadId"
}

example (ingestion)

{
    "type": "bolus",
    "subType": "normal",
    "normal": 4.5,
    "expectedNormal": 5.4,
    "clockDriftOffset": 0,
    "conversionOffset": 0,
    "deviceId": "DevId0987654321",
    "deviceTime": "2018-05-14T18:17:06",
    "time": "2018-05-14T08:17:06.676Z",
    "timezoneOffset": 600,
    "uploadId": "SampleUploadId"
}

example (storage)

{
    "type": "bolus",
    "subType": "normal",
    "normal": 8.25,
    "expectedNormal": 9.9,
    "_active": true,
    "_groupId": "abcdef",
    "_schemaVersion": 0,
    "_version": 0,
    "clockDriftOffset": 0,
    "conversionOffset": 0,
    "createdTime": "2018-05-14T08:17:11.676Z",
    "deviceId": "DevId0987654321",
    "deviceTime": "2018-05-14T18:17:06",
    "guid": "5f7a9c48-ec16-449c-9597-2cef1f679096",
    "id": "8480f23a08484c91a7436475ee40c0c6",
    "time": "2018-05-14T08:17:06.676Z",
    "timezoneOffset": 600,
    "uploadId": "SampleUploadId"
}