Skip to content
Documentation
/
Diabetes Device Data Mode...
/
/
Pump Status (`pumpStatus`...
Last updated

Pump Status (pumpStatus)

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"pumpStatus""alert""basal""bloodKetone""bolus""cbg""cgmSettings""controllerSettings""controllerStatus""deviceEvent"
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"
basalDeliveryobject
batteryobject
bolusDeliveryobject
deliveryIndeterminantboolean
Example: false
reservoirobject
guidstringDeprecated

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

Overview

This is the Tidepool data type representing the status of a pump.

Type (type)

This is the Tidepool data type to represent the pump status at a given point in time.

Basal Delivery (basalDelivery)

The basal delivery status of the pump, if known. The basal delivery status contains the following fields:

  • State
  • Time
  • Dose

State (state) (Basal Delivery)

The state of the basal delivery status. One of cancelingTemporary, initiatingTemporary, resuming, scheduled, suspended, suspending, or temporary.

Time (time) (Basal Delivery)

The time of the scheduled or suspended basal delivery status. Only specify if state is scheduled or suspended.

Dose (dose) (Basal Delivery)

The dose of the temporary basal delivery status. Only specify if state is temporary. Includes the following fields:

Start Time (startTime) (Basal Delivery Dose)

The start time of the temporary basal dose.

End Time (endTime) (Basal Delivery Dose)

The end time of the temporary basal dose.

Rate (rate) (Basal Delivery Dose)

The rate of the temporary basal dose.

Amount Delivered (amountDelivered) (Basal Delivery Dose)

The current amount delivered of the temporary basal dose.

Battery (battery)

The battery status of the pump, if known. The battery status contains the following fields:

  • Time
  • State
  • Remaining
  • Units

Time (time) (Battery)

The time of the battery status, if known.

State (state) (Battery)

The state of the battery status, if known. One of charging, full, or unplugged.

Remaining (remaining) (Battery)

The remaining amount of battery. For units of percent, can be in range of 0.0 (empty) to 1.0 (full).

Units (units) (Battery)

The units for the remaining amount of battery, if known. One of percent.

Bolus Delivery (bolusDelivery)

The bolus delivery status of the pump, if known. The bolus delivery status contains the following fields:

  • State
  • Dose

State (state) (Bolus Delivery)

The state of the bolus delivery status. One of canceling, delivering, initiating, or none.

Dose (dose) (Bolus Delivery)

The dose of the delivering bolus delivery status. Only specify if state is delivering. Includes the following fields:

Start Time (startTime) (Bolus Delivery Dose)

The start time of the delivering bolus dose.

Amount (amount) (Bolus Delivery Dose)

The intended amount of the delivering bolus dose.

Amount Delivered (amountDelivered) (Bolus Delivery Dose)

The current amount delivered of the delivering bolus dose.

Reservoir (reservoir)

The reservoir status of the pump, if known. The reservoir status contains the following fields:

  • Time
  • Remaining
  • Units

Time (time) (Reservoir)

The time of the reservoir status, if known.

Remaining (remaining) (Reservoir)

The remaining amount of insulin in the reservoir.

Units (units) (Reservoir)

The units for the remaining amount of insulin in the reservoir. One of Units.

Example Pump Status
{
    "id": "02ccebd2affc472d9b296d4f1f800dfd",
    "time": "2018-05-14T08:17:07.560Z",
    "type": "pumpStatus",
    "basalDelivery": {
      "state": "temporary",
      "dose": {
        "startTime": "2018-05-14T08:12:02.154Z",
        "endTime": "2018-05-14T08:12:32.154Z",
        "rate": 1.25,
        "amountDelivered": 0.35
      }
    },
    "battery": {
      "time": "2018-05-14T08:17:05.421Z",
      "state": "charging",
      "remaining": 0.75,
      "units": "percent"
    },
    "bolusDelivery": {
      "state": "delivering",
      "dose": {
        "startTime": "2018-05-14T08:17:01.482Z",
        "amount": 4.55,
        "amountDelivered": 1.65
      }
    },
    "reservoir": {
      "time": "2018-05-14T08:17:03.689Z",
      "remaining": 156,
      "units": "Units"
    },
    "uploadId": "0d92d5c1c22117a18f3620b9e24d3c06"
}

Keep Reading

Previous page
Next page