Skip to content
Documentation
/
/
/
Pump Settings Override (`...
Last updated

Pump Settings Override (pumpSettingsOverride)

A pump settings override is used to temporarily override certain current pump settings for a temporary event.

The physicalActivity override would typically be used before, during, and/or after physical exercise to account for blood glucose level changes during exercise. For example, raising the blood glucose target for running.

The preprandial override would typically be used before eating and might decrease the blood glucose target range prior to eating.

The preset override indicates that this override can be found in the overridePresets of the related pumpSettings. In this case, the overridePreset field should match one of the keys in the overridePresets map of the related pump settings. The remainder of the fields should match those of the matching override preset.

The sleep override would typically be used while sleeping. This override might increase the blood glucose target range while sleeping to reduce risk of hypoglycemia overnight.

Finally the custom override is one that does not match any of the other override types.

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"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"pumpSettingsOverride""alarm""calibration""prime""reservoirChange""sensorEvent""settingsChange""status""timeChange""transmitterEvent"
overrideTypestringrequired
Enum"custom""physicalActivity""preprandial""preset""sleep"
Example: "preset"
overridePresetstring[ 1 .. 100 ] characters
Example: "Running"
methodstring
Enum"automatic""manual"
Example: "manual"
durationnumber(float)[ 0 .. 604800000 ]
Example: 2700000
expectedDurationnumber(float)[ 0 .. 604800000 ]
Example: 7200000
bgTargetBlood Glucose Target Value (mg/dL) (object) or Blood Glucose Target Value (mmol/L) (object)(Blood Glucose Target)
One of:

Blood glucose target values, in mg/dL

basalRateScaleFactornumber(float)[ 0.1 .. 10 ]
Example: 0.8
carbRatioScaleFactornumber(float)[ 0.1 .. 10 ]
Example: 1.25
insulinSensitivityScaleFactornumber(float)[ 0.1 .. 10 ]
Example: 1.25
unitsobject
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 pumpSettingsOverride sub-type of device event represents a user temporarily overriding certain insulin pump settings. This might be temporarily adjusting the blood glucose target range before a meal or during exercise.

Override Type (overrideType)

The pump settings override can be one of several types: physicalActivity, preprandial, preset, sleep, and custom.

Override Preset (overridePreset)

The override matches one found in the override presets map of the related pump settings. The value of this field must match one of the keys in the overridePresets map in the related pumpSettings. The overrideType must be preset.

Method (method)

The method indicates how the preset was enabled, if known. It can be one of automatic or manual. An automatic method indicates that some automated system (typically non-human) enabled the preset while a manual method indicates the preset was enabled manually (typically human).

--

Duration (duration)

The duration the override is enabled for. When the override is first enabled the duration field can indicate how long the override is expected to be enabled for. Once the override is disabled the duration field should be updated to indicate the actual duration is was enable for. In this case, if the duration is less than what was expected, the expectedDuration field should be specified. If the override is enable indefinitely (meaning that there is no planned time to disable) then the duration field should not be specified until after the override is disabled. The duration is milliseconds.

Expected Duration (expectedDuration)

Once the override is disabled, if the actual duration is less than the initial expected duration, then the expectedDuration field should be specified and the duration field updated to the actual duration. The expectedDuration is milliseconds.

Blood Glucose Target (bgTarget)

The blood glucose target range in effect while the override is enabled. Not specified means no change.

Basal Rate Scale Factor (basalRateScaleFactor)

The basal rate scale factor in effect while the override is enabled. This is a percentage of the active basal rate found in the basal rate schedule of the related pumpSettings. A value of 1.0 means 100% (i.e. unchanged). Not specified means no change.

Carbohydrate Ratio Scale Factor (carbRatioScaleFactor)

The carbohydrate ratio scale factor in effect while the override is enabled. This is a percentage of the active carbohydrate ratio found in the carbohydrate ratio schedule of the related pumpSettings. A value of 1.0 means 100% (i.e. unchanged). Not specified means no change.

Insulin Sensitivity Scale Factor (insulinSensitivityScaleFactor)

The insulin sensitivity scale factor in effect while the override is enabled. This is a percentage of the active insulin sensitivity found in the insulin sensitivity schedule of the related pumpSettings. A value of 1.0 means 100% (i.e. unchanged). Not specified means no change.

Example
{
  "id": "bfc3e597e16c436a94a03d7fd095a774",
  "time": "2017-02-06T02:37:46Z",
  "type": "deviceEvent",
  "subType": "pumpSettingsOverride",
  "overrideType": "preset",
  "overridePreset": "Running",
  "method": "manual",
  "duration": 2700000,
  "expectedDuration": 7200000,
  "bgTarget": {
    "high": 160,
    "low": 150
  },
  "basalRateScaleFactor": 0.8,
  "carbRatioScaleFactor": 1.25,
  "insulinSensitivityScaleFactor": 1.25,
  "units": {
    "bg": "mg/dL"
  },
  "uploadId": "0d92d5c1c22117a18f3620b9e24d3c06"
}

Keep Reading

Previous page
Next page