{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["partial","json-schema"]},"type":"markdown"},"seo":{"title":"Scheduled Basals ( scheduled )","llmstxt":{"hide":true}},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"scheduled-basals--scheduled-","__idx":0},"children":["Scheduled Basals (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["scheduled"]},")"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"delivery-type--deliverytype-","__idx":1},"children":["Delivery Type (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deliveryType"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The string ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["scheduled"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"duration--duration-","__idx":2},"children":["Duration (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["duration"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An integer value representing a duration of time in milliseconds."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"expected-duration--expectedduration-","__idx":3},"children":["Expected Duration (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expectedDuration"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An integer value representing an original programmed duration of time in milliseconds, copied from the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["duration"]}," field on ingestion when a following event has resulted in truncation of the original programmed duration."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Many insulin pumps provide information on the expected duration of basals in addition to the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"basal-rate--rate-","__idx":4},"children":["Basal Rate (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rate"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A floating point number >= 0 representing the amount of insulin delivered in units per hour."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"schedule-name--schedulename-","__idx":5},"children":["Schedule Name (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["scheduleName"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A string: the name of the basal schedule."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"quick-summary","__idx":6},"children":["Quick Summary"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../../../reference/data/models/basal/basal-scheduled.v1.yaml"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/basal-scheduled.v1"},"code.v1":{"title":"Annotation Code","description":"Annotation codes that appear in Tidepool diabetes data records.\nThe annotation codes are primarily intended for machine processing, but they are usually readable enough to make sense.\nThese are by convention structured as series of strings separated by slashes (`/`), in order from more general to more specific.\nFor example:\n\n  * `wrong-device-time` or `time-change`, generic annotations.\n  * `basal/unknown-duration` or `bg/out-of-range`, generic annotations around a particular theme.\n  * `medtronic/basal/flat-rate`, a manufacturer-specific annotation.\n  * `medtronic600/smbg/user-rejected-remote-bg`, a device-specific annotation.","type":"string","minLength":1,"pattern":"^[0-9a-z\\-_]+(/[0-9a-z\\-_]+(/[0-9a-z\\-_]+)?)?$","enum":["animas/basal/flat-rate","animas/basal/marked-suspended-from-alarm","animas/bolus/extended-equal-split","animas/bolus/unknown-duration","animas/out-of-sequence","animas/status/fabricated-from-alarm","basal/auto","basal/intersects-incomplete-suspend","basal/mismatched-series","basal/unknown-duration","bg/out-of-range","carelink/basal/fabricated-from-schedule","carelink/basal/fabricated-from-suppressed","carelink/basal/off-schedule-rate","carelink/bolus/missing-square-component","carelink/wizard/long-search","final-basal/fabricated-from-schedule","insulet/basal/fabricated-from-schedule","insulet/bolus/split-extended","medtronic/basal/fabricated-from-schedule","medtronic/basal/flat-rate","medtronic/basal/one-second-gap","medtronic/basal/time-change","medtronic/status/fabricated-from-device-event","medtronic/wizard/carb-to-exchange-ratio-deconverted","medtronic600/smbg/bg-reading-received","medtronic600/smbg/bg-sent-for-calib","medtronic600/smbg/bg-si-fail-result-recd-frm-gst","medtronic600/smbg/bg-si-pass-result-recd-frm-gst","medtronic600/smbg/entered-as-bg-marker","medtronic600/smbg/entered-in-bg-entry","medtronic600/smbg/entered-in-bolus-wizard","medtronic600/smbg/entered-in-meal-wizard","medtronic600/smbg/entered-in-sensor-calib","medtronic600/smbg/remote-bg-acceptance-screen-timeout","medtronic600/smbg/user-accepted-remote-bg","medtronic600/smbg/user-rejected-remote-bg","medtronic600/smbg/user-rejected-sensor-calib","spring-forward","stats-how-calculated","stats-how-calculated-average-cbg","stats-how-calculated-average-smbg","stats-how-calculated-range-cbg","stats-how-calculated-range-smbg","stats-how-calculated-ratio","stats-insufficient-data","status/incomplete-tuple","tandem/basal/fabricated-from-new-day","tandem/basal/temp-without-rate-change","tandem/pumpSettingsOverride/estimated-duration","tandem/pumpSettingsOverride/fabricated-from-new-day","time-change","uncertain-timestamp","wizard/target-automated","wrong-device-time"],"example":"wrong-device-time"},"bgoutofrange.v1":{"title":"Blood Glucose Out of Range","type":"object","properties":{"code":{"type":"string","enum":["bg/out-of-range"],"example":"bg/out-of-range"},"value":{"type":"string","enum":["low","high"],"example":"low"},"threshold":{"type":"number","example":40}},"required":["code","value","threshold"]},"annotation.v1":{"title":"Annotation","description":"Annotation attached to the diabetes data record to provide additional information. Annotation is at minimum a `code` (string) that describes the annotation. It may also include additional properties that further describe the annotation. The maximum size is 4K bytes.","type":"object","allOf":[{"type":"object","properties":{"code":{"$ref":"#/components/schemas/code.v1"}},"required":["code"]},{"oneOf":[{"type":"object","properties":{"code":{"$ref":"#/components/schemas/code.v1"}},"required":["code"]},{"$ref":"#/components/schemas/bgoutofrange.v1"}]}]},"annotationarray.v1":{"title":"Annotation Array","description":"An array of annotations.","type":"array","uniqueItems":true,"minItems":0,"maxItems":100,"items":{"$ref":"#/components/schemas/annotation.v1"}},"datetime.v1":{"title":"Date/Time","description":"[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) / [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp _with_ timezone information","type":"string","format":"date-time","example":"2017-02-06T02:37:46Z","x-go-type":"string"},"datasetid.v1":{"title":"Data Set ID","type":"string","pattern":"^(upid_[0-9a-f]{12}|upid_[0-9a-f]{32}|[0-9a-f]{32})$","minLength":17,"maxLength":37,"example":"ce8cc5f7595575945f91fc6710db6fef","x-tags":["Data"]},"association-type.v1":{"title":"Association Type","description":"The type of the association. If type is `blob`, `datum`, or `image`, then `id` must also be specified. If type is `url`, then url must also be specified.","type":"string","enum":["blob","datum","image","url"],"example":"blob","x-go-type":"string"},"reason.v1":{"title":"Association Reason","description":"The reason for the association.","type":"string","minLength":1,"maxLength":1000},"association-id.v1":{"title":"Association ID","description":"The ID of the associated Tidepool resource if type is blob, datum, or image.","type":"string"},"url.v1":{"title":"URL","description":"URL","type":"string","format":"uri"},"blob.v1":{"title":"Association (blob)","type":"object","properties":{"type":{"$ref":"#/components/schemas/association-type.v1"},"reason":{"$ref":"#/components/schemas/reason.v1"},"id":{"$ref":"#/components/schemas/association-id.v1"},"url":{"$ref":"#/components/schemas/url.v1"}},"required":["type","id"]},"datum.v1":{"title":"Association (datum)","type":"object","properties":{"type":{"$ref":"#/components/schemas/association-type.v1"},"reason":{"$ref":"#/components/schemas/reason.v1"},"id":{"$ref":"#/components/schemas/association-id.v1"},"url":{"$ref":"#/components/schemas/url.v1"}},"required":["type","id"]},"image.v1":{"title":"Association (image)","type":"object","properties":{"type":{"$ref":"#/components/schemas/association-type.v1"},"reason":{"$ref":"#/components/schemas/reason.v1"},"id":{"$ref":"#/components/schemas/association-id.v1"},"url":{"$ref":"#/components/schemas/url.v1"}},"required":["type","id"]},"url-association.v1":{"title":"Association (url)","type":"object","properties":{"type":{"$ref":"#/components/schemas/association-type.v1"},"reason":{"$ref":"#/components/schemas/reason.v1"},"id":{"$ref":"#/components/schemas/association-id.v1"},"url":{"$ref":"#/components/schemas/url.v1"}},"required":["type","id","url"]},"association.v1":{"title":"Association","description":"Associate this resource with another Tidepool resource ID.","type":"object","oneOf":[{"$ref":"#/components/schemas/blob.v1"},{"$ref":"#/components/schemas/datum.v1"},{"$ref":"#/components/schemas/image.v1"},{"$ref":"#/components/schemas/url-association.v1"}]},"associationarray.v1":{"title":"Association Array","description":"An array of associations for the resource.","type":"array","items":{"$ref":"#/components/schemas/association.v1"}},"clockdriftoffset.v1":{"title":"Clock Drift Offset","description":"Clock drift offset, expressed as milliseconds.","type":"integer","format":"int64","minimum":-86400000,"maximum":86400000,"example":0,"x-tags":["Data"]},"conversionoffset.v1":{"title":"Conversion Offset","description":"Conversion offset, expressed as milliseconds.","type":"integer","format":"int64","example":0,"x-tags":["Data"]},"tidepooluserid":{"type":"string","title":"Tidepool User ID","pattern":"^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","description":"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](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random))","readOnly":true,"x-go-type":"string"},"semanticversion.v1":{"title":"Semantic Version Number","description":"[Semantic Version Number 2.0.0](http://semver.org/). Regex from their [site](https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string).","type":"string","minLength":5,"pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$","example":"2.36.1"},"reversedomainname.v1":{"title":"Reverse Domain Name","description":"Name in the [reverse domain name notation](https://en.wikipedia.org/wiki/Reverse_domain_name_notation).","type":"string","pattern":"^[a-zA-Z0-9](|[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])(\\.[a-zA-Z0-9](|[a-zA-Z0-9-]{0,61}[a-zA-Z0-9]))+$","example":"org.tidepool.uploader"},"deduplicatordescriptor.v1":{"title":"Deduplicator Descriptor","type":"object","properties":{"hash":{"type":"string","minLength":1},"version":{"$ref":"#/components/schemas/semanticversion.v1"},"name":{"$ref":"#/components/schemas/reversedomainname.v1"}},"required":["name","version"],"x-tags":["Data"]},"deviceid.v1":{"title":"Device ID","description":"Globally unique to device and repeatable with each upload, e.g. device make and model with serial number","type":"string","minLength":1,"example":"MMT-1711:12345678","x-tags":["Data"]},"datetimenotz.v1":{"title":"Date/Time without Timezone","description":"[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) / [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp _without_ timezone information","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","example":"2017-02-06T02:37:46","x-go-type":"string"},"jsonpatch.v1":{"title":"JSONPatch","oneOf":[{"properties":{"op":{"type":"string","description":"The operation to perform.","enum":["add","replace","test"]},"path":{"type":"string","description":"A JSON Pointer path."},"value":{"description":"The value to add, replace or test."}},"required":["op","path","value"]},{"properties":{"op":{"type":"string","description":"The operation to perform.","enum":["remove"]},"path":{"type":"string","description":"A JSON Pointer path."}},"required":["op","path"]},{"properties":{"op":{"type":"string","description":"The operation to perform.","enum":["move","copy"]},"from":{"description":"A JSON Pointer path pointing to the location to move/copy from.","type":"string"},"path":{"type":"string","description":"A JSON Pointer path."}},"required":["op","from","path"]}],"type":"object","description":"Only have this here because Stoplight doesn't seem to like using the JSONSchema directly as a ref from http://json.schemastore.org/json-patch"},"eventhistory.v1":{"title":"Event History [Proposed]","description":"Revision history of the event","type":"array","items":{"type":"object","properties":{"time":{"$ref":"#/components/schemas/datetime.v1"},"changes":{"$ref":"#/components/schemas/jsonpatch.v1"}},"required":["time","changes"]},"x-tags":["Data"]},"origin-id.v1":{"title":"Origin ID","description":"Any external identifier uniquely identifying the resource at the origin source.","type":"string","minLength":1,"maxLength":100},"name.v1":{"title":"Origin Name","description":"A human-readable name for the origin source.","type":"string","minLength":1,"maxLength":100},"payload.v1":{"title":"Payload","description":"Grab bag field for data that isn't yet part of the data model. The maximum size is 4K bytes.","type":"object","additionalProperties":true},"origin-type.v1":{"title":"Origin Type","description":"The type of the origin source.","type":"string","enum":["application","device","manual","service"],"example":"device"},"version.v1":{"title":"Origin Version","description":"The version of the origin source at the time the resources was obtained.","type":"string","minLength":1,"maxLength":100},"origin.v1":{"title":"Origin","description":"External origin information for the source of the resource.","type":"object","properties":{"id":{"$ref":"#/components/schemas/origin-id.v1"},"name":{"$ref":"#/components/schemas/name.v1"},"payload":{"$ref":"#/components/schemas/payload.v1"},"time":{"$ref":"#/components/schemas/datetime.v1"},"type":{"$ref":"#/components/schemas/origin-type.v1"},"version":{"$ref":"#/components/schemas/version.v1"}},"required":["id","name","time","type","version"]},"longitude.v1":{"title":"Longitude","description":"The prime meridian, which passes near the Royal Observatory, Greenwich, England, is defined as 0° longitude by convention. Positive longitudes are east of the prime meridian, and negative ones are west.","type":"object","properties":{"units":{"type":"string","enum":["degrees"],"example":"degrees"},"value":{"type":"number","format":"double","minimum":-180,"maximum":180,"example":-122.1625595}},"required":["units","value"]},"latitude.v1":{"title":"Latitude","description":"Latitude is an angle which ranges from -90° at the South pole to 0° at the Equator to 90° at the North pole.","type":"object","properties":{"units":{"type":"string","enum":["degrees"],"example":"degrees"},"value":{"type":"number","format":"double","minimum":-90,"maximum":90,"example":37.4454404}},"required":["units","value"]},"meters.v1":{"title":"Accuracy (meters)","description":"Accuracy of a measurement, expressed as meters.","type":"object","properties":{"value":{"type":"number","format":"double","minimum":0,"maximum":1000,"example":42},"units":{"type":"string","enum":["meters"],"example":"meters"}},"required":["units"]},"accuracy-feet.v1":{"title":"Accuracy (feet)","description":"Accuracy of a measurement, expressed in `feet`.","type":"object","properties":{"value":{"type":"number","format":"double","minimum":0,"maximum":3280,"example":42},"units":{"type":"string","enum":["feet"],"example":"feet"}},"required":["units"]},"accuracy.v1":{"title":"Accuracy","description":"Accuracy of a measurement","type":"object","oneOf":[{"$ref":"#/components/schemas/meters.v1"},{"$ref":"#/components/schemas/accuracy-feet.v1"}]},"floor.v1":{"title":"Floor","type":"integer","format":"int32","minimum":-1000,"maximum":1000},"elevation-meters.v1":{"title":"Elevation (meters)","type":"object","properties":{"units":{"type":"string","enum":["meters"],"example":"meters"},"value":{"type":"number","format":"double","minimum":0,"maximum":10000,"example":42}},"required":["units","value"]},"elevation-feet.v1":{"title":"Elevation (feet)","type":"object","properties":{"units":{"type":"string","enum":["feet"],"example":"feet"},"value":{"type":"number","format":"double","minimum":0,"maximum":32808,"example":42}},"required":["units","value"]},"elevation.v1":{"title":"Elevation","description":"Elevation, expressed as `meters` or `feet`.","type":"object","oneOf":[{"$ref":"#/components/schemas/elevation-meters.v1"},{"$ref":"#/components/schemas/elevation-feet.v1"}]},"gps.v1":{"title":"GPS","description":"GPS coordinates and related information.","type":"object","properties":{"origin":{"$ref":"#/components/schemas/origin.v1"},"longitude":{"$ref":"#/components/schemas/longitude.v1"},"latitude":{"$ref":"#/components/schemas/latitude.v1"},"horizontalAccuracy":{"$ref":"#/components/schemas/accuracy.v1"},"verticalAccuracy":{"$ref":"#/components/schemas/accuracy.v1"},"floor":{"$ref":"#/components/schemas/floor.v1"},"elevation":{"$ref":"#/components/schemas/elevation.v1"}},"required":["longitude","latitude"]},"location.v1":{"title":"Location","type":"object","description":"Location information associated with the resource. One or both of `name` and `gps` must be specified.","properties":{"name":{"type":"string","description":"A name for the location.","minLength":1,"maxLength":100},"gps":{"$ref":"#/components/schemas/gps.v1"}}},"note.v1":{"title":"Note","description":"A note associated with the resource.","type":"string","minLength":1,"maxLength":1000},"notearray.v1":{"title":"Note Array","description":"An array of 1 to 100 notes.","type":"array","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/note.v1"}},"tag.v1":{"title":"Tag","description":"A tag associated with the resource.","type":"string","minLength":1,"maxLength":100},"tagarray.v1":{"title":"Tag Array","description":"An array of tags.","type":"array","items":{"$ref":"#/components/schemas/tag.v1"}},"timezonename.v1":{"title":"Time Zone","description":"A string timezone name from the [IANA timezone database](https://www.iana.org/time-zones)","type":"string","example":"Europe/London","x-tags":["Data"]},"timezoneoffset.v1":{"title":"Time Zone offset","description":"Time zone offset, expressed as positive or negative number of minutes from UTC.","type":"integer","format":"int32","minimum":-10080,"maximum":10080,"example":-420,"x-tags":["Data"]},"datatype.v1":{"title":"Tidepool Data Type","description":"Data type","type":"string","enum":["alert","basal","bloodKetone","bolus","cbg","cgmSettings","controllerSettings","controllerStatus","deviceEvent","deviceStatus","dosingDecision","food","insulin","physicalActivity","pumpSettings","pumpStatus","reportedState","smbg","upload","water","wizard"],"example":"upload","x-tags":["Data"]},"uploadid.v1":{"title":"Upload ID","description":"An upload identifier; this field should be the uploadId of the corresponding upload record","type":"string","pattern":"^([0-9a-f]{32}|upid_[0-9a-f]{12})$","minLength":17,"maxLength":32,"example":"0d92d5c1c22117a18f3620b9e24d3c06","x-tags":["Data"]},"base.v1":{"title":"Base","description":"An abstract base data type for all Tidepool diabetes data objects.","type":"object","properties":{"annotations":{"$ref":"#/components/schemas/annotationarray.v1"},"archivedTime":{"allOf":[{"$ref":"#/components/schemas/datetime.v1"}],"readOnly":true},"archivedDatasetId":{"$ref":"#/components/schemas/datasetid.v1"},"associations":{"$ref":"#/components/schemas/associationarray.v1"},"clockDriftOffset":{"$ref":"#/components/schemas/clockdriftoffset.v1"},"conversionOffset":{"$ref":"#/components/schemas/conversionoffset.v1"},"createdTime":{"$ref":"#/components/schemas/datetime.v1"},"createdUserId":{"$ref":"#/components/schemas/tidepooluserid"},"deduplicator":{"$ref":"#/components/schemas/deduplicatordescriptor.v1"},"deletedTime":{"$ref":"#/components/schemas/datetime.v1"},"deletedUserId":{"$ref":"#/components/schemas/tidepooluserid"},"deviceId":{"$ref":"#/components/schemas/deviceid.v1"},"deviceTime":{"$ref":"#/components/schemas/datetimenotz.v1"},"guid":{"type":"string","description":"A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.","deprecated":true},"history":{"$ref":"#/components/schemas/eventhistory.v1"},"id":{"$ref":"#/components/schemas/datasetid.v1"},"location":{"$ref":"#/components/schemas/location.v1"},"modifiedTime":{"$ref":"#/components/schemas/datetime.v1"},"modifiedUserId":{"$ref":"#/components/schemas/tidepooluserid"},"notes":{"$ref":"#/components/schemas/notearray.v1"},"origin":{"$ref":"#/components/schemas/origin.v1"},"payload":{"$ref":"#/components/schemas/payload.v1"},"source":{"type":"string","enum":["carelink"]},"tags":{"$ref":"#/components/schemas/tagarray.v1"},"time":{"$ref":"#/components/schemas/datetime.v1"},"timezone":{"$ref":"#/components/schemas/timezonename.v1"},"timezoneOffset":{"$ref":"#/components/schemas/timezoneoffset.v1"},"type":{"$ref":"#/components/schemas/datatype.v1"},"uploadId":{"$ref":"#/components/schemas/uploadid.v1"}},"required":["id","type","time"],"x-tags":["Data"]},"deliverytype.v1":{"title":"Delivery Type","description":"This defines the basal delivery type, used to differentiate between automated, scheduled, suspended and temporary basal types.","type":"string","enum":["automated","scheduled","suspend","temp"],"x-tags":["Data"]},"duration.v1":{"title":"Insulin Delivery Duration","description":"An integer value representing a duration of time in milliseconds.","type":"integer","format":"int64","minimum":0,"maximum":604800000},"expectedduration.v1":{"title":"Expected Insulin Delivery Duration","description":"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.\n\n`expectedDuration` cannot be less than the value of `duration`","type":"integer","format":"int64","minimum":0,"maximum":604800000},"compound.v1":{"title":"Insulin Compound","type":"object","properties":{"amount":{"type":"number","format":"double","minimum":0}},"required":["amount"],"x-tags":["Data"]},"compoundarray.v1":{"title":"Insulin Compound Array","type":"array","items":{"$ref":"#/components/schemas/compound.v1"},"maxItems":100,"minItems":1,"x-tags":["Data"]},"concentration.v1":{"title":"Insulin Concentration","type":"object","properties":{"value":{"type":"number","format":"double","minimum":0,"maximum":10000},"units":{"type":"string","enum":["Units/mL"]}},"required":["units","value"],"x-tags":["Data"]},"simple.v1":{"title":"Insulin Simple","type":"object","required":["actingType"],"properties":{"actingType":{"type":"string","enum":["intermediate","long","rapid","short"]},"brand":{"type":"string","minLength":1,"maxLength":100},"concentration":{"$ref":"#/components/schemas/concentration.v1"}},"x-tags":["Data"]},"formulation.v1":{"title":"Insulin Formulation","type":"object","oneOf":[{"properties":{"compounds":{"$ref":"#/components/schemas/compoundarray.v1"},"name":{"type":"string","minLength":1,"maxLength":100}}},{"properties":{"simple":{"$ref":"#/components/schemas/simple.v1"},"name":{"type":"string","minLength":1,"maxLength":100}}}],"x-tags":["Data"]},"deliveryrate.v1":{"title":"Insulin Delivery Rate","description":"A floating point number >= 0 representing the amount of insulin delivered in units per hour.","type":"number","format":"double","minimum":0,"maximum":100},"schedulename.v1":{"title":"Insulin Delivery Schedule Name","description":"The name of the basal schedule.","type":"string","minLength":1,"maxLength":1000},"basal-scheduled.v1":{"title":"Basal Scheduled","description":"A scheduled basal delivery event.","allOf":[{"$ref":"#/components/schemas/base.v1"},{"type":"object","properties":{"deliveryType":{"$ref":"#/components/schemas/deliverytype.v1"}}},{"type":"object","properties":{"type":{"type":"string","enum":["basal"]},"deliveryType":{"type":"string","enum":["scheduled"]},"duration":{"$ref":"#/components/schemas/duration.v1"},"expectedDuration":{"$ref":"#/components/schemas/expectedduration.v1"},"insulinFormulation":{"$ref":"#/components/schemas/formulation.v1"},"rate":{"$ref":"#/components/schemas/deliveryrate.v1"},"scheduleName":{"$ref":"#/components/schemas/schedulename.v1"}}}],"x-tags":["Data"]}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"examples","__idx":7},"children":["Examples"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"Example (client)","header":{"title":"Example (client)","controls":{"copy":{}}},"source":"{\n    \"type\": \"basal\",\n    \"deliveryType\": \"scheduled\",\n    \"duration\": 84600000,\n    \"rate\": 1.45,\n    \"scheduleName\": \"Very Active\",\n    \"clockDriftOffset\": 0,\n    \"conversionOffset\": 0,\n    \"deviceId\": \"DevId0987654321\",\n    \"deviceTime\": \"2018-05-14T18:00:00\",\n    \"guid\": \"9d161801-2607-4cb6-b4f8-457159c7786c\",\n    \"id\": \"30f76219248d474fa7025b12f0e4b136\",\n    \"time\": \"2018-05-14T08:00:00.000Z\",\n    \"timezoneOffset\": 600,\n    \"uploadId\": \"SampleUploadId\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"Example (ingestion)","header":{"title":"Example (ingestion)","controls":{"copy":{}}},"source":"{\n    \"type\": \"basal\",\n    \"deliveryType\": \"scheduled\",\n    \"duration\": 82800000,\n    \"rate\": 0.025,\n    \"scheduleName\": \"Weekend\",\n    \"clockDriftOffset\": 0,\n    \"conversionOffset\": 0,\n    \"deviceId\": \"DevId0987654321\",\n    \"deviceTime\": \"2018-05-14T18:00:00\",\n    \"time\": \"2018-05-14T08:00:00.000Z\",\n    \"timezoneOffset\": 600,\n    \"uploadId\": \"SampleUploadId\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"Example (storage)","header":{"title":"Example (storage)","controls":{"copy":{}}},"source":"{\n    \"type\": \"basal\",\n    \"deliveryType\": \"scheduled\",\n    \"duration\": 79200000,\n    \"rate\": 1.175,\n    \"scheduleName\": \"Vacation\",\n    \"_active\": true,\n    \"_groupId\": \"abcdef\",\n    \"_schemaVersion\": 0,\n    \"_version\": 0,\n    \"clockDriftOffset\": 0,\n    \"conversionOffset\": 0,\n    \"createdTime\": \"2018-05-14T08:00:05.000Z\",\n    \"deviceId\": \"DevId0987654321\",\n    \"deviceTime\": \"2018-05-14T18:00:00\",\n    \"guid\": \"05d3bdbd-3ad3-4762-9a7b-2e8e27a601c3\",\n    \"id\": \"33f00679ddf440ec95055114162d4821\",\n    \"time\": \"2018-05-14T08:00:00.000Z\",\n    \"timezoneOffset\": 600,\n    \"uploadId\": \"SampleUploadId\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"keep-reading","__idx":8},"children":["Keep Reading"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/device-data/data-types/basal"},"children":["Basal"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/device-data/common-fields"},"children":["Common Fields"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/device-data/data-types/pump-settings"},"children":["Pump Settings"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/device-data/data-types/basal/automated"},"children":["Automated Basals"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/device-data/data-types/basal/suppressed"},"children":["Suppressed Basals"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/device-data/data-types/basal/suspend"},"children":["Suspend Basals"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/device-data/data-types/basal/temp"},"children":["Temporary Basals"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/device-data/units"},"children":["Units"]}]}]}]},"headings":[{"value":"Scheduled Basals ( scheduled )","id":"scheduled-basals--scheduled-","depth":1},{"value":"Delivery Type ( deliveryType )","id":"delivery-type--deliverytype-","depth":2},{"value":"Duration ( duration )","id":"duration--duration-","depth":2},{"value":"Expected Duration ( expectedDuration )","id":"expected-duration--expectedduration-","depth":2},{"value":"Basal Rate ( rate )","id":"basal-rate--rate-","depth":2},{"value":"Schedule Name ( scheduleName )","id":"schedule-name--schedulename-","depth":2},{"value":"Quick Summary","id":"quick-summary","depth":2},{"value":"Examples","id":"examples","depth":2},{"value":"Keep Reading","id":"keep-reading","depth":2}],"frontmatter":{"seo":{"title":"Scheduled Basals ( scheduled )"}},"lastModified":"2026-05-29T03:19:52.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/device-data/data-types/basal/scheduled","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}