You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
An integer value representing a duration of time in milliseconds.
4
+
5
+
Note that for some insulin pumps, even for a scheduled basal not interrupted by another event like a suspend or temp, the duration may not be the nice round numbers of milliseconds that might be expected given the schedule in the pumpSettings, for example, 3600000 for a basal event lasting an hour. This is because of how some pumps schedule the small pulses of insulin delivery fulfilling the scheduled rate; depending on how the pulses are scheduled, the actual duration of the basal may be a bit over or under the scheduled duration.
6
+
7
+
This value is expected to be >= 0 and <= 432000000 (the number of milliseconds in five days), as we assume that any single basal interval, even for a user running a flat-rate basal schedule, is broken up by a suspension of delivery in order to change the infusion site and/or insulin reservoir at least every five days.
8
+
9
+
10
+
## Expected Duration (`expectedDuration`)
11
+
12
+
An integer value representing an original programmed duration of time in milliseconds, copied from the `duration` field on ingestion when a following event has resulted in truncation of the original programmed duration.
13
+
14
+
Many insulin pumps provide information on the expected duration of basals in addition to the *actual* duration of basals. (These values may differ in the case of a basal being suspended or canceled.) Where this is true, Platform will provide the same information. If you do not know what the expected duration is, do not include this information as it is an optional field.
A floating point number >= 0 representing the amount of insulin delivered in units per hour.
4
+
5
+
Different insulin pump manufacturers offer the ability to program basal rates with different levels of precision in terms of significant digits on the rate. We endeavor to represent each rate as accurately as possible for each insulin pump; occasionally when values are stored to a falsely large number of floating point digits this means rounding the raw rate value found in a record from a pump in order to match the significant digits of precision advertised by the manufacturer. It is the burden of the uploading client to handle this rounding since the number of significant digits for rates varies according to the pump manufacturer.
5.[Schedule Name (`scheduleName`)](#schedule-name-schedulename)
12
-
6.[Keep Reading](#keep-reading)
13
-
14
4
---
15
5
16
-
## Overview
17
-
18
6
This is the Tidepool data type for background insulin dosing — the “constant drip” of insulin programmable in all insulin pumps. Different insulin pump manufacturers use different terminology for this insulin dosing, so we have standardized calling one set of rates covering a 24-hour period a basal “schedule.”
19
7
20
8
The data model for basal schedules is part of the Tidepool [pump settings type](./pump-settings.md), however, basal data types represent actual intervals of basal insulin delivery and may or may not match the programmed basal schedule.
@@ -32,41 +20,6 @@ This page documents the fields shared by various basal delivery types. The four
32
20
33
21
---
34
22
35
-
## Duration (`duration`)
36
-
37
-
In Platform, the duration field is required on all basals. We define duration as the period of time that a basal runs or, in the case of suspend basals, the period of time a suspension of insulin occurs.
38
-
39
-
Depending on how some pumps' insulin pulses are scheduled, the actual duration of the basal may
40
-
differ slightly from the scheduled duration. This explains why some pumps' duration results in odd numbers of milliseconds (e.g. 3600001 for a basal event lasting an hour).
41
-
42
-
Platform expects the duration value of basals to be >= 0 and <= 604800000 milliseconds (seven days).
43
-
44
-
---
45
-
46
-
## Expected Duration (`expectedDuration`)
47
-
48
-
Many insulin pumps provide information on the expected duration of basals in addition to the *actual* duration of basals. (These values may differ in the case of a basal being suspended or canceled.) Where this is true, Platform will provide the same information. If you do not know what the expected duration is, do not include this information as it is an optional field.
49
-
50
-
---
51
-
52
-
## Rate (`rate`)
53
-
54
-
Different insulin pump manufacturers offer the ability to program basal rates with different levels of precision in terms of significant digits on the rate.
55
-
56
-
Tidepool endeavors to represent each rate accurately, so occasionally when values are stored to a falsely large number, Platform will round the raw rate value to match the significant digits of precision advertised by the manufacturer.
57
-
58
-
Many insulin pump manufacturers do not allow a basal rate higher than 10.0 or 15.0 units per hour; Platform will reject any value higher than 100.0 units per hour.
59
-
60
-
---
61
-
62
-
## Schedule Name (`scheduleName`)
63
-
64
-
Tidepool would love to surface the basal schedule names for every pump manufacturer. Unfortunately, most manufacturers do not provide this information or record pump setting changes. In some cases, we can find this information ourselves by looking up the active pump settings at the time of a particular basal event.
65
-
66
-
Schedule name is an optional field and should only be added to basal data when directly available from an insulin pump's raw data, or if it can be inferred with high confidence via lookup against a complete pump settings history.
Copy file name to clipboardExpand all lines: docs/device-data/data-types/basal/automated.md
+8-12Lines changed: 8 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,15 @@
1
1
<!-- omit in toc -->
2
2
# Automated Basals (`automated`)
3
3
4
-
<!-- omit in toc -->
5
-
## Table of Contents
4
+
## Delivery Type (`deliveryType`)
5
+
6
+
The string `automated`.
7
+
8
+
This is the sub-type of basal event representing intervals of basal insulin delivery triggered by the pump itself (rather than manual user entry) according to a closed loop algorithm.
2.[Delivery Type (`deliveryType`)](#delivery-type-deliverytype)
9
-
3.[Examples](#examples)
10
-
4.[Keep Reading](#keep-reading)
12
+
{% partial file="/_partials/basal_rate.md" /%}
11
13
12
14
---
13
15
@@ -21,12 +23,6 @@
21
23
22
24
---
23
25
24
-
## Delivery Type (`deliveryType`)
25
-
26
-
This is the sub-type of basal event representing intervals of basal insulin delivery triggered by the pump itself (rather than manual user entry) according to a closed loop algorithm.
Copy file name to clipboardExpand all lines: docs/device-data/data-types/basal/scheduled.md
+16-12Lines changed: 16 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,23 @@
1
1
<!-- omit in toc -->
2
2
# Scheduled Basals (`scheduled`)
3
3
4
-
<!-- omit in toc -->
5
-
## Table of Contents
4
+
## Delivery Type (`deliveryType`)
5
+
6
+
The string `scheduled`.
7
+
8
+
This is the sub-type of basal event that represents intervals of basal insulin delivery triggered by the pump itself according to the active basal schedule programmed by the user (or clinician).
2.[Delivery Type (`deliveryType`)](#delivery-type-deliverytype)
9
-
3.[Examples](#examples)
10
-
4.[Keep Reading](#keep-reading)
16
+
A string: the name of the basal schedule.
17
+
18
+
Tidepool would love to surface the basal schedule names for every pump manufacturer. Unfortunately, most manufacturers do not provide this information or record pump setting changes. In some cases, we can find this information ourselves by looking up the active pump settings at the time of a particular basal event.
19
+
20
+
Schedule name is an optional field and should only be added to basal data when directly available from an insulin pump's raw data, or if it can be inferred with high confidence via lookup against a complete pump settings history.
11
21
12
22
---
13
23
@@ -21,12 +31,6 @@
21
31
22
32
---
23
33
24
-
## Delivery Type (`deliveryType`)
25
-
26
-
This is the sub-type of basal event that represents intervals of basal insulin delivery triggered by the pump itself according to the active basal schedule programmed by the user (or clinician).
A suppressed basal is a way to essentially replace one basal with another basal. For example, if a PwD's blood glucose is falling, they may program a temp basal to try and prevent hypoglycemia. By programming a temp basal, they are suppressing a scheduled basal, which was previously in effect. A suppressed can apply to all basal types except a suspend — [see here](#suppressed-suspend-basals).
@@ -345,6 +300,38 @@ A suspend basal can embed a scheduled, automatic or temporary suppressed basal,
Copy file name to clipboardExpand all lines: docs/device-data/data-types/basal/suspend.md
+12-14Lines changed: 12 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,19 @@
1
1
<!-- omit in toc -->
2
2
# Suspend Basals (`suspend`)
3
3
4
-
<!-- omit in toc -->
5
-
## Table of Contents
4
+
## Delivery Type (`deliveryType`)
5
+
6
+
The string `suspend`.
7
+
8
+
This is the sub-type of basal event representing the total suspension of insulin delivery on a pump within the stream of basal events — which should be without gaps or overlaps. The user's inputs to suspend (and later resume) insulin delivery are part of Tidepool's [device event](../device-event.md) data type. We represent suspend intervals as a suspend basal to maintain a continuous stream of basal data, making the calculation of statistics (e.g. total basal dose per day) easier.
9
+
10
+
No rate field appears on suspend basal events. The rate is always zero, so this is redundant information.
2.[Delivery Type (`deliveryType`)](#delivery-type-deliverytype)
9
-
3.[Examples](#examples)
10
-
4.[Keep Reading](#keep-reading)
16
+
An object representing another `basal` event - namely, the event that is currently [suppressed](./suppressed.md) (inactive) because this suspended basal is in effect.
11
17
12
18
---
13
19
@@ -21,14 +27,6 @@
21
27
22
28
---
23
29
24
-
## Delivery Type (`deliveryType`)
25
-
26
-
This is the sub-type of basal event representing the total suspension of insulin delivery on a pump within the stream of basal events — which should be without gaps or overlaps. The user's inputs to suspend (and later resume) insulin delivery are part of Tidepool's [device event](../device-event.md) data type. We represent suspend intervals as a suspend basal to maintain a continuous stream of basal data, making the calculation of statistics (e.g. total basal dose per day) easier.
27
-
28
-
No rate field appears on suspend basal events. The rate is always zero, so this is redundant information.
This is the sub-type of basal event that represents temporary intervals of basal insulin delivery requested by the user. Insulin pumps allow a temporary basal insulin rate for a duration of up to 24 hours. Depending on the pump, the user will be able to program a temp basal rate by percentage, manual specification or both.
Tidepool's data model has standardized on a floating point representation of the second strategy. The value 0.0 represents a temp basal at 0% of the current active rate, 0.5 at 50%, 1.0 at 100%, 1.5 at 150%, and so on.
41
22
23
+
{% partial file="/_partials/basal_rate.md" /%}
24
+
25
+
## Suppressed (`suppressed`)
26
+
27
+
An object representing another `basal` event - namely, the event that is currently [suppressed](./suppressed.md) (inactive) because this temp basal is in effect.
0 commit comments