General API (1.0)

Download OpenAPI specification:Download

API Support: support@tidepool.org URL: https://support.tidepool.org/ License: BSD-2-Clause Terms of Service

The Tidepool API is an HTTP REST API used by Tidepool clients use to communicate with the Tidepool Platform.

For more information, see the Getting Started section.

General

General utility APIs.

Users

List and manage users.

Get Current User

Returns user account information for the logger-in user.

Authorizations:

sessionToken

Responses

Response samples

Content type

application/json

{"emailVerified": true,
"emails": ["example@tidepool.org"
],
"termsAccepted": "2017-02-06T02:37:46Z",
"userid": "string",
"username": "example@tidepool.org",
"roles": ["clinic"
],
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string"
}

Update Current User Account

Updates user account details of the logged-in user.

Authorizations:

sessionToken

Request Body schema: application/json

Updated user details

emailVerified required	boolean (User Email Verification Status) `true` if the user has verified their email address. `false` or not present if the user has not verified their email address.
emails	Array of strings <email> (User Email Addresses) non-empty unique [ items <email > >= 6 characters ]
termsAccepted	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
username	string <email> (Email Address) >= 6 characters An email address, as specified by RFC 5322.
roles	Array of strings (User Roles) >= 0 items unique Items Value: "clinic"
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information

Responses

Request samples

Payload

Content type

application/json

{"emailVerified": true,
"emails": ["example@tidepool.org"
],
"termsAccepted": "2017-02-06T02:37:46Z",
"username": "example@tidepool.org",
"roles": ["clinic"
],
"createdTime": "2017-02-06T02:37:46Z",
"modifiedTime": "2017-02-06T02:37:46Z",
"deletedTime": "2017-02-06T02:37:46Z"
}

Response samples

Content type

application/json

{"emailVerified": true,
"emails": ["example@tidepool.org"
],
"termsAccepted": "2017-02-06T02:37:46Z",
"userid": "string",
"username": "example@tidepool.org",
"roles": ["clinic"
],
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string"
}

Get User

Get information for the user identified by userId.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

Responses

Response samples

Content type

application/json

{"emailVerified": true,
"emails": ["example@tidepool.org"
],
"termsAccepted": "2017-02-06T02:37:46Z",
"userid": "string",
"username": "example@tidepool.org",
"roles": ["clinic"
],
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string"
}

Update User

Updates the user identified by userId.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

Request Body schema: application/json

Updated user details

emailVerified required	boolean (User Email Verification Status) `true` if the user has verified their email address. `false` or not present if the user has not verified their email address.
emails	Array of strings <email> (User Email Addresses) non-empty unique [ items <email > >= 6 characters ]
termsAccepted	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
username	string <email> (Email Address) >= 6 characters An email address, as specified by RFC 5322.
roles	Array of strings (User Roles) >= 0 items unique Items Value: "clinic"
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information

Responses

Request samples

Payload

Content type

application/json

{"emailVerified": true,
"emails": ["example@tidepool.org"
],
"termsAccepted": "2017-02-06T02:37:46Z",
"username": "example@tidepool.org",
"roles": ["clinic"
],
"createdTime": "2017-02-06T02:37:46Z",
"modifiedTime": "2017-02-06T02:37:46Z",
"deletedTime": "2017-02-06T02:37:46Z"
}

Response samples

Content type

application/json

{"emailVerified": true,
"emails": ["example@tidepool.org"
],
"termsAccepted": "2017-02-06T02:37:46Z",
"userid": "string",
"username": "example@tidepool.org",
"roles": ["clinic"
],
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string"
}

Delete User

Deletes the user identified by userId. The request body must provide the current password of the account to be deleted, unless the session token is a server token, or the account being deleted is a custodial account managed by the authenticated user.

Authorizations:

sessionTokenserverToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

Request Body schema: application/json

password

string <password> (Password) [ 8 .. 72 ] characters ^\S{8,72}$

Password

Responses

Request samples

Payload

Content type

application/json

{"password": "correctbatteryhorsestaple"
}

Response samples

Content type

application/json

{"code": 401,
"reason": "No user matched the given details",
"error": 0
}

Create Custodial User

Creates a custodial user, that is, a user that has no independent login (no username, no password). The user identified by userId will be the custodian of this new custodial account. It will be granted the custodial permission on the new custodial user account.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

Request Body schema: application/json

username	string <email> (Email Address) >= 6 characters An email address, as specified by RFC 5322.
emails	Array of strings <email> (User Email Addresses) non-empty unique [ items <email > >= 6 characters ]

Responses

Request samples

Payload

Content type

application/json

{"username": "example@tidepool.org",
"emails": ["example@tidepool.org"
]
}

Response samples

Content type

application/json

{"emailVerified": true,
"emails": ["example@tidepool.org"
],
"termsAccepted": "2017-02-06T02:37:46Z",
"userid": "string",
"username": "example@tidepool.org",
"roles": ["clinic"
],
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string"
}

Authentication

An OpenID Connect and OAuth2 compliant authentication API.

The authentication endpoints have a required realm realm parameter. The following is the list of all available realms and the servers they are available on:

Realm	Server
dev1	Development
qa1	QA
qa2	QA
qa3	QA
qa4	QA
qa5	QA
integration	External
tidepool	Production

Obtain Token

Obtain an access, id and refresh token(s) by presenting an authorization grant or a valid refresh token.

If the access token request is valid and authorized, the authorization server issues an access token and optional refresh token. If the request client authentication failed or is invalid, the authorization server returns an error response.

Password Credentials Grant

This capability is not available to the general public - Tidepool's recommendation is to use the "Authorization Code" flow, which will authenticate the user in a browser session. When this is not feasible (e.g. for programmatic access) it is possible to use the "Password Credentials" grant which allows obtaining access and refresh tokens by providing a valid username and password to the /token endpoint. This functionality is enabled only for trusted partners.

client_id=cgm-monitor
client_secret=c50e6502-131c-47f0-b439-a43acb3b83d0
grant_type=password
password=qwertyuiop1234
username=user@example.com

Refresh Token

Access tokens are short-lived and are valid for up to 10 minutes. You should use the refresh token obtained previously and exchange it for a new access and refresh token pair. Always use the most recently obtained refresh token when making the request.

client_id=cgm-monitor
client_secret=c50e6502-131c-47f0-b439-a43acb3b83d0
grant_type=refresh_token
refresh_token=eyJhbGciOiJ...

Token Exchange Flow

Trusted partners can use the token exchange flow to provision new users in Tidepool using an access or an ID token. The token exchange flow requires grant_type to be set to urn:ietf:params:oauth:grant-type:token-exchange.

The email address of the newly registered user will be obtained from the subject_token parameter. If an account with a duplicate email already exists the endpoint will return an error with "error_description": "User already exists" in the response body.

An already existing user can be linked to the external identity provider by going through the standard authorization code flow by redirecting the user in a browser to the authorization endpoint. The external identity provider can be pre-selected by setting kc_idp_hint query parameter of the authorization request.

A fresh access and/or refresh token can be issued for users which have an existing link to the external identity provider or were provisioned by this flow.

client_id=cgm-monitor
client_secret=c50e6502-131c-47f0-b439-a43acb3b83d0
grant_type=urn:ietf:params:oauth:grant-type:token-exchange
requested_token_type=urn:ietf:params:oauth:token-type:access_token
subject_issuer=acme-clinic
subject_token=eyJhbGciOiJ...
subject_token_type=urn:ietf:params:oauth:token-type:access_token

path Parameters

realm

required

string

Enum: "dev1" "qa1" "qa2" "qa3" "qa4" "qa5" "integration" "tidepool"

The authentication realm.

Request Body schema: application/x-www-form-urlencoded

code	string An authorization code obtained from authorization flow. Required if `grant_type` is `authorization_code`.
code_verifier	string
grant_type required	string Enum: "authorization_code" "refresh_token" "password" "urn:ietf:params:oauth:grant-type:token-exchange" The mechanism used for authorizing requests for obtaining tokens. `authorization_code` - used in the authorization code flow `refresh_token` - used for refreshing expired access tokens with an active refresh token `urn:ietf:params:oauth:grant-type:token-exchange` - used in the token exchange flow
client_id required	string The client ID
client_secret	string The client secret if the client is confidential or it was issued credentials.
subject_token	string The subject token used in the token exchange flow. `REQUIRED` when `grant_type` is `urn:ietf:params:oauth:grant-type:token-exchange`
subject_token_type	string Enum: "urn:ietf:params:oauth:token-type:access_token" "urn:ietf:params:oauth:token-type:jwt" The type of the subject token. If the type is `urn:ietf:params:oauth:token-type:access_token` you must specify the `subject_issuer` parameter and it must be the alias of the configured identity provider. If the type is `urn:ietf:params:oauth:token-type:jwt`, the provider will be matched via the issuer claim within the JWT which must be the alias of the provider, or a registered issuer within the providers configuration. For validation, if the token is an access token, the provider’s user info service will be invoked to validate the token. A successful call will mean that the access token is valid. If the subject token is a JWT and if the provider has signature validation enabled, that will be attempted, otherwise, it will default to also invoking on the user info service to validate the token.
requested_token_type	string Enum: "urn:ietf:params:oauth:token-type:access_token" "urn:ietf:params:oauth:token-type:refresh_token" The type of token that will be issued in the token exhange flow.
subject_issuer	string The issuer of `subject_token`. It must be a registered identity provider. `REQUIRED` when `subject_token_type` is `urn:ietf:params:oauth:token-type:access_token`
username	string The username of the end-user being authenticated when using the Password Credentials Grant
password	string The password of the end-user being authenticated when using the Password Credentials Grant

Responses

Request samples

Payload

Content type

application/x-www-form-urlencoded

Example

Password Credentials Grant

client_id=cgm-monitor&client_secret=c50e6502-131c-47f0-b439-a43acb3b83d0&grant_type=password&password=qwertyuiop1234&username=user%40example.com

Response samples

Content type

application/json

{"access_token": "ODBkOTY5NWUtN2I0Mi00ODQwLWI0ZTEtZDdmYjcwMjhhZWIyCg==",
"expires_in": 60,
"refresh_expires_in": 7200,
"refresh_token": "ZWM0MGZjYzctMWExZC00NmM4LTlhOTgtOTVjOTYyNGFiNWZhCg==",
"scope": "openid email",
"id_token": "MDY3YzJmMjctOTliMi00N2ZjLWFkMGUtMzY3NzliMmJiNGI1Cg=="
}

Authorize

The starting point for browser-based OpenID Connect flows. This endpoint authenticates the user and returns an authorization grant or an access token to callback endpoint at the specified redirect_uri.

path Parameters

realm

required

string

Enum: "dev1" "qa1" "qa2" "qa3" "qa4" "qa5" "integration" "tidepool"

The authentication realm.

query Parameters

client_id required	string Client Identifier valid at the Authorization Server
scope required	Array of strings Items Enum: "openid" "email" OpenID Connect requests MUST contain the `openid` scope value
response_type required	string Value: "code" Response Type value that determines the authorization processing flow to be used, including what parameters are returned from the endpoints used. When using the Authorization Code Flow, this value is `code`.
redirect_uri required	string Redirection URI to which the response will be sent. This URI MUST exactly match one of the Redirection URI values for the Client pre-registered at the OpenID Provider
login_hint	string Hint to the Authorization Server about the login identifier the End-User might use to log in
kc_idp_hint	string OIDC applications can bypass the login page by hinting at the identity provider they want to use
prompt	string Enum: "none" "login" Specifies whether the Authorization Server prompts the End-User for reauthentication and consent

Responses

Authorization

List, create and manage authorizations that grant access to another user's diabetes data.

Get Groups for User

Retrieve all groups accessible to the user userId.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

Responses

Response samples

Content type

application/json

{"d4206d26a6": {"root": { }
},
"305cabe660": {"note": { },
"view": { }
},
"7575613eca": {"view": { },
"note": { },
"upload": { }
},
"975ac5cc92": {"note": { },
"view": { }
}
}

Get Users in Group

Retrieve all users that have access to group sharerId.

Authorizations:

sessionToken

path Parameters

sharerId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID of user who granted access

Responses

Response samples

Content type

application/json

{"d4206d26a6": {"root": { }
},
"305cabe660": {"note": { },
"view": { }
},
"7575613eca": {"view": { },
"note": { },
"upload": { }
},
"975ac5cc92": {"note": { },
"view": { }
}
}

Get User Permissions in Group

Retrieve permissions of individual user userId in group sharerId.

Authorizations:

sessionToken

path Parameters

sharerId required	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... Tidepool User ID of user who granted access
userId required	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... Tidepool User ID

Responses

Response samples

Content type

application/json

Example

Owner

{"root": { }
}

Update Permissions for User in Group

Update permissions of individual user userId in group sharerId. The permissions provided in the request body replace all existing permissions for that user. Therefore to delete a permission, submit the request body without that permission.

Authorizations:

sessionToken

path Parameters

sharerId required	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... Tidepool User ID of user who granted access
userId required	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... Tidepool User ID

Request Body schema: application/json

[ 1 .. 3 ] properties

Any of

[ 1 .. 3 ] properties

view	object (Permission) The presence of this object indicates that the user has been granted the named permission.

Responses

Request samples

Payload

Content type

application/json

Example

View

{"view": { }
}

Response samples

Content type

application/json

Example

Owner

{"root": { }
}

Blobs

List, create, and manage binary blobs. The content format may be anything, because the blobs are treated as opaque data by the service. Each blob has a status. If a blob is created without content, then its status is created. If the blob is created with content or has been updated to include content then its status is available.

List Binary Blobs

List previously uploaded binary blobs in the user's account. The list can be filtered with mediaType and status query parameters.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

query Parameters

mediaType	string (MediaType) ^\w+/[-+.\w]+(;.+)?$ Example: mediaType=application/octet-stream Blob Media Type
status	string (Blob status) Enum: "created" "available" Example: status=created Blob Status

Responses

Response samples

Content type

application/json

[{"id": "97a9fae8a19b4da58bb48dc90c9562c9",
"userId": "string",
"digestMD5": "HUXZLQLMuI/KZ5KDcJPcOA==",
"mediaType": "application/octet-stream",
"size": 1024,
"status": "created",
"createdTime": "2017-02-06T02:37:46Z",
"modifiedTime": "2017-02-06T02:37:46Z",
"deletedTime": "2017-02-06T02:37:46Z",
"revision": 42
}
]

Create New Binary Blob

Creates a new binary blob in the user's account. The Content-Type and the Digest headers must represent the media type and MD5 hash of the binary blob content, respectively.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

header Parameters

Content-Type required	string (MediaType) ^\w+/[-+.\w]+(;.+)?$ Examples: application/octet-stream - text/plain - text/plain; charset=utf-8 - text/html - application/json - application/xml - text/xml - image/jpeg - image/png - video/mp4 - application/pdf - application/zip - Content type of the resource
Digest required	string = 28 characters ^md5=(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}... Example: md5=HUXZLQLMuI/KZ5KDcJPcOA== Base64-encoded MD5 hash of the resource, per RFC 3230

Request Body schema: /
required

Binary blob

string <binary> (Blob content)

Binary data.

Responses

Response samples

Content type

application/json

{"id": "97a9fae8a19b4da58bb48dc90c9562c9",
"userId": "string",
"digestMD5": "HUXZLQLMuI/KZ5KDcJPcOA==",
"mediaType": "application/octet-stream",
"size": 1024,
"status": "created",
"createdTime": "2017-02-06T02:37:46Z",
"modifiedTime": "2017-02-06T02:37:46Z",
"deletedTime": "2017-02-06T02:37:46Z",
"revision": 42
}

Delete All Binary Blobs

Deletes all previously uploaded binary blobs in the user's account.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

Responses

Get Binary Blob Metadata

Get a previously uploaded binary blob in the user's account.

Authorizations:

sessionToken

path Parameters

blobId

required

string (Blob ID) ^[0-9a-z]{32}$

Example: 97a9fae8a19b4da58bb48dc90c9562c9

Blob ID

Responses

Response samples

Content type

application/json

{"id": "97a9fae8a19b4da58bb48dc90c9562c9",
"userId": "string",
"digestMD5": "HUXZLQLMuI/KZ5KDcJPcOA==",
"mediaType": "application/octet-stream",
"size": 1024,
"status": "created",
"createdTime": "2017-02-06T02:37:46Z",
"modifiedTime": "2017-02-06T02:37:46Z",
"deletedTime": "2017-02-06T02:37:46Z",
"revision": 42
}

Delete Binary Blob

Deletes a previously uploaded binary blob in the user's account. This operation fails if the blobId does not match the ID of an existing blob.

Authorizations:

sessionToken

path Parameters

blobId

required

string (Blob ID) ^[0-9a-z]{32}$

Example: 97a9fae8a19b4da58bb48dc90c9562c9

Blob ID

Responses

Get Binary Blob Content

Retrieves the content of a binary blob in the user's account.

Authorizations:

sessionToken

path Parameters

blobId

required

string (Blob ID) ^[0-9a-z]{32}$

Example: 97a9fae8a19b4da58bb48dc90c9562c9

Blob ID

Responses

Device Logs

Create and list device logs.

Upload new device logs as json

Uploads new device logs to the user's account. The Digest header must represent the MD5 hash of the data.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

header Parameters

Digest required	string = 28 characters ^md5=(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}... Example: md5=HUXZLQLMuI/KZ5KDcJPcOA== Base64-encoded MD5 hash of the resource, per RFC 3230
X-Logs-Start-At-Time required	string <date-time> (Date/Time) Example: 2017-02-06T02:37:46Z Starting time of device logs inside the uploaded json log
X-Logs-End-At-Time required	string <date-time> (Date/Time) Example: 2017-02-06T02:37:46Z End time of device logs inside the uploaded json log

Request Body schema:
application/json
required

array of JSON data

Array (>= 0 items)

type required	string Enum: "send" "receive" "error" "delegate" "delegateResponse" "connection"
managerIdentifier required	string (Device Model Name) non-empty A string identifying the model of the device. The `deviceModel` is a non-empty string that encodes the model of device. We endeavor to match each manufacturer's standard for how they represent model name in terms of casing, whether parts of the name are represented as one word or two, etc.
deviceIdentifier required	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
timestamp required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
message required	string non-empty

Responses

Request samples

Payload

Content type

application/json

[{"type": "send",
"managerIdentifier": "Devicey McDeviceface",
"deviceIdentifier": "MMT-1711:12345678",
"timestamp": "2017-02-06T02:37:46Z",
"message": "sent something ..."
},
{"type": "connection",
"managerIdentifier": "Devicey McDeviceface",
"deviceIdentifier": "MMT-1711:12345678",
"timestamp": "2017-02-06T02:36:50Z",
"message": "establishing connection ..."
}
]

Response samples

Content type

application/json

{"id": "97a9fae8a19b4da58bb48dc90c9562c9",
"userId": "4d94a5fb-642e-48f1-89b9-c6a3e6145342",
"digestMD5": "HUXZLQLMuI/KZ5KDcJPcOA==",
"mediaType": "application/json",
"size": 1024,
"createdTime": "2017-02-06T02:35:46Z",
"startAt": "2017-02-06T02:35:46Z",
"endAt": "2017-02-06T02:36:46Z"
}

List device logs metadata

List previously uploaded device logs json data in the user's account. The list must be filtered with startAt and endAt parameters

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

query Parameters

startAtTime	string <date-time> (Date/Time) Example: startAtTime=2017-02-06T02:37:46Z Start At Datetime
endAtTime	string <date-time> (Date/Time) Example: endAtTime=2017-02-06T02:37:46Z End At Datetime
page	integer <int32> (Page Number) >= 0 Default: 0 Example: page=0 Page number for pagination
size	integer <int32> (Page Size) [ 1 .. 1000 ] Default: 100 Example: size=42 Page size for pagination

Responses

Response samples

Content type

application/json

[{"id": "97a9fae8a19b4da58bb48dc90c9562c9",
"userId": "4d94a5fb-642e-48f1-89b9-c6a3e6145342",
"digestMD5": "HUXZLQLMuI/KZ5KDcJPcOA==",
"mediaType": "application/json",
"size": 1024,
"createdTime": "2017-02-06T02:35:46Z",
"startAt": "2017-02-06T02:35:46Z",
"endAt": "2017-02-06T02:36:46Z"
}
]

Get the content of a device log.

Retrieves the content, the actual data, of a device log.

Authorizations:

sessionToken

path Parameters

deviceLogId

required

string (Blob ID) ^[0-9a-z]{32}$

Example: 97a9fae8a19b4da58bb48dc90c9562c9

DeviceLog ID

Responses

Response samples

Content type

application/json

[{"type": "send",
"managerIdentifier": "Devicey McDeviceface",
"deviceIdentifier": "MMT-1711:12345678",
"timestamp": "2017-02-06T02:37:46Z",
"message": "sent something ..."
},
{"type": "connection",
"managerIdentifier": "Devicey McDeviceface",
"deviceIdentifier": "MMT-1711:12345678",
"timestamp": "2017-02-06T02:36:50Z",
"message": "establishing connection ..."
}
]

Clinics

Manage clinics, clinians and patients.

List Clinics

Retrieve the list of clinics

Authorizations:

sessionToken

query Parameters

limit	integer >= 1 Default: 10
offset	integer >= 0
shareCode	string
createdTimeStart	string <date-time> Return records created after the given date (inclusive)
createdTimeEnd	string <date-time> Return records created before the given date (exclusive)
ehrEnabled	boolean Retrieve clinics with enabled EHR integration

Responses

Response samples

Content type

application/json

[{"id": "2fe2488217ee43e1b2e83c2f",
"address": "string",
"city": "Palo Alto",
"postalCode": "94301",
"state": "CA",
"country": "USA",
"patientTags": [{"id": "stringstringstringstring",
"name": "string"
}
],
"lastDeletedPatientTag": {"id": "stringstringstringstring",
"name": "string"
},
"phoneNumbers": [{"type": "main",
"number": "+1 (555) 555-1212"
}
],
"clinicType": "provider_practice",
"clinicSize": "0-249",
"name": "string",
"shareCode": "string",
"canMigrate": true,
"website": "http://example.com",
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"tierDescription": "Free",
"tier": "tier0100",
"preferredBgUnits": "mg/dL",
"suppressedNotifications": {"patientClinicInvitation": true
},
"timezone": "Africa/Abidjan"
}
]

Create Clinic

Create a new clinic

Authorizations:

sessionToken

Request Body schema: application/json

address	string (Street Address) non-empty Street address.
city	string (City) non-empty City name.
postalCode	string (Postal Code) non-empty Postal code. In the U.S., typically the zip code such as `94301` or `94301-1704`.
state	string (State) non-empty State or province. In the U.S., typically something like `CA` or `California`.
country	string (Country) non-empty Country name.
	Array of objects (Patient Tag)
	object (Patient Tag)
	Array of objects (Phone phoneNumbers) non-empty unique An array of phone numbers.
clinicType	string non-empty Enum: "provider_practice" "healthcare_system" "veterinary_clinic" "other" "researcher"
clinicSize	string Enum: "0-249" "250-499" "500-999" "1000+"
name required	string (Clinic Name) non-empty Name of the clinic.
website	string <uri>
preferredBgUnits required	string Enum: "mg/dL" "mmol/L"
	object (Suppressed Notifications)
timezone	string (Clinic Timezone) Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Asmera" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Timbuktu" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/ComodRivadavia" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Atka" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Buenos_Aires" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Catamarca" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Coral_Harbour" "America/Cordoba" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Ensenada" "America/Fort_Nelson" "America/Fort_Wayne" "America/Fortaleza" "America/Glace_Bay" "America/Godthab" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Indianapolis" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Jujuy" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Knox_IN" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Louisville" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Mendoza" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Acre" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Rosario" "America/Santa_Isabel" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Virgin" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/South_Pole" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Ashkhabad" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Calcutta" "Asia/Chita" "Asia/Choibalsan" "Asia/Chongqing" "Asia/Chungking" "Asia/Colombo" "Asia/Dacca" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Istanbul" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Katmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macao" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Rangoon" "Asia/Riyadh" "Asia/Saigon" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tel_Aviv" "Asia/Thimbu" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ujung_Pandang" "Asia/Ulaanbaatar" "Asia/Ulan_Bator" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faeroe" "Atlantic/Faroe" "Atlantic/Jan_Mayen" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/ACT" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Canberra" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/LHI" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/NSW" "Australia/North" "Australia/Perth" "Australia/Queensland" "Australia/South" "Australia/Sydney" "Australia/Tasmania" "Australia/Victoria" "Australia/West" "Australia/Yancowinna" "Brazil/Acre" "Brazil/DeNoronha" "Brazil/East" "Brazil/West" "CET" "CST6CDT" "Canada/Atlantic" "Canada/Central" "Canada/Eastern" "Canada/Mountain" "Canada/Newfoundland" "Canada/Pacific" "Canada/Saskatchewan" "Canada/Yukon" "Chile/Continental" "Chile/EasterIsland" "Cuba" "EET" "EST" "EST5EDT" "Egypt" "Eire" "Etc/GMT" "Etc/GMT+0" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-0" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/GMT0" "Etc/Greenwich" "Etc/UCT" "Etc/UTC" "Etc/Universal" "Etc/Zulu" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belfast" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Nicosia" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Tiraspol" "Europe/Ulyanovsk" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "GB" "GB-Eire" "GMT" "GMT+0" "GMT-0" "GMT0" "Greenwich" "HST" "Hongkong" "Iceland" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Iran" "Israel" "Jamaica" "Japan" "Kwajalein" "Libya" "MET" "MST" "MST7MDT" "Mexico/BajaNorte" "Mexico/BajaSur" "Mexico/General" "NZ" "NZ-CHAT" "Navajo" "PRC" "PST8PDT" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Ponape" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Samoa" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Truk" "Pacific/Wake" "Pacific/Wallis" "Pacific/Yap" "Poland" "Portugal" "ROC" "ROK" "Singapore" "Turkey" "UCT" "US/Alaska" "US/Aleutian" "US/Arizona" "US/Central" "US/East-Indiana" "US/Eastern" "US/Hawaii" "US/Indiana-Starke" "US/Michigan" "US/Mountain" "US/Pacific" "US/Samoa" "UTC" "Universal" "W-SU" "WET" "Zulu"

Responses

Request samples

Payload

Content type

application/json

{"address": "string",
"city": "Palo Alto",
"postalCode": "94301",
"state": "CA",
"country": "USA",
"patientTags": [{"name": "string"
}
],
"lastDeletedPatientTag": {"name": "string"
},
"phoneNumbers": [{"type": "main",
"number": "+1 (555) 555-1212"
}
],
"clinicType": "provider_practice",
"clinicSize": "0-249",
"name": "string",
"website": "http://example.com",
"preferredBgUnits": "mg/dL",
"suppressedNotifications": {"patientClinicInvitation": true
},
"timezone": "Africa/Abidjan"
}

Response samples

Content type

application/json

{"id": "2fe2488217ee43e1b2e83c2f",
"address": "string",
"city": "Palo Alto",
"postalCode": "94301",
"state": "CA",
"country": "USA",
"patientTags": [{"id": "stringstringstringstring",
"name": "string"
}
],
"lastDeletedPatientTag": {"id": "stringstringstringstring",
"name": "string"
},
"phoneNumbers": [{"type": "main",
"number": "+1 (555) 555-1212"
}
],
"clinicType": "provider_practice",
"clinicSize": "0-249",
"name": "string",
"shareCode": "string",
"canMigrate": true,
"website": "http://example.com",
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"tierDescription": "Free",
"tier": "tier0100",
"preferredBgUnits": "mg/dL",
"suppressedNotifications": {"patientClinicInvitation": true
},
"timezone": "Africa/Abidjan"
}

Get Clinic by Share Code

Retrieve a clinic object with a share code

Authorizations:

sessionToken

path Parameters

shareCode

required

string non-empty

Responses

Response samples

Content type

application/json

{"id": "2fe2488217ee43e1b2e83c2f",
"address": "string",
"city": "Palo Alto",
"postalCode": "94301",
"state": "CA",
"country": "USA",
"patientTags": [{"id": "stringstringstringstring",
"name": "string"
}
],
"lastDeletedPatientTag": {"id": "stringstringstringstring",
"name": "string"
},
"phoneNumbers": [{"type": "main",
"number": "+1 (555) 555-1212"
}
],
"clinicType": "provider_practice",
"clinicSize": "0-249",
"name": "string",
"shareCode": "string",
"canMigrate": true,
"website": "http://example.com",
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"tierDescription": "Free",
"tier": "tier0100",
"preferredBgUnits": "mg/dL",
"suppressedNotifications": {"patientClinicInvitation": true
},
"timezone": "Africa/Abidjan"
}

Get Clinic

Retrieve a clinic by id

Authorizations:

sessionToken

path Parameters

clinicId

required

string^[a-f0-9]{24}$

Responses

Response samples

Content type

application/json

{"id": "2fe2488217ee43e1b2e83c2f",
"address": "string",
"city": "Palo Alto",
"postalCode": "94301",
"state": "CA",
"country": "USA",
"patientTags": [{"id": "stringstringstringstring",
"name": "string"
}
],
"lastDeletedPatientTag": {"id": "stringstringstringstring",
"name": "string"
},
"phoneNumbers": [{"type": "main",
"number": "+1 (555) 555-1212"
}
],
"clinicType": "provider_practice",
"clinicSize": "0-249",
"name": "string",
"shareCode": "string",
"canMigrate": true,
"website": "http://example.com",
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"tierDescription": "Free",
"tier": "tier0100",
"preferredBgUnits": "mg/dL",
"suppressedNotifications": {"patientClinicInvitation": true
},
"timezone": "Africa/Abidjan"
}

Update Clinic

Update an existing clinic

Authorizations:

sessionToken

path Parameters

clinicId

required

string^[a-f0-9]{24}$

Request Body schema:
application/json

address	string (Street Address) non-empty Street address.
city	string (City) non-empty City name.
postalCode	string (Postal Code) non-empty Postal code. In the U.S., typically the zip code such as `94301` or `94301-1704`.
state	string (State) non-empty State or province. In the U.S., typically something like `CA` or `California`.
country	string (Country) non-empty Country name.
	Array of objects (Patient Tag)
	object (Patient Tag)
	Array of objects (Phone phoneNumbers) non-empty unique An array of phone numbers.
clinicType	string non-empty Enum: "provider_practice" "healthcare_system" "veterinary_clinic" "other" "researcher"
clinicSize	string Enum: "0-249" "250-499" "500-999" "1000+"
name required	string (Clinic Name) non-empty Name of the clinic.
website	string <uri>
preferredBgUnits required	string Enum: "mg/dL" "mmol/L"
	object (Suppressed Notifications)
timezone	string (Clinic Timezone) Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Asmera" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Timbuktu" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/ComodRivadavia" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Atka" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Buenos_Aires" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Catamarca" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Coral_Harbour" "America/Cordoba" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Ensenada" "America/Fort_Nelson" "America/Fort_Wayne" "America/Fortaleza" "America/Glace_Bay" "America/Godthab" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Indianapolis" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Jujuy" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Knox_IN" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Louisville" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Mendoza" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Acre" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Rosario" "America/Santa_Isabel" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Virgin" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/South_Pole" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Ashkhabad" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Calcutta" "Asia/Chita" "Asia/Choibalsan" "Asia/Chongqing" "Asia/Chungking" "Asia/Colombo" "Asia/Dacca" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Istanbul" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Katmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macao" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Rangoon" "Asia/Riyadh" "Asia/Saigon" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tel_Aviv" "Asia/Thimbu" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ujung_Pandang" "Asia/Ulaanbaatar" "Asia/Ulan_Bator" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faeroe" "Atlantic/Faroe" "Atlantic/Jan_Mayen" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/ACT" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Canberra" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/LHI" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/NSW" "Australia/North" "Australia/Perth" "Australia/Queensland" "Australia/South" "Australia/Sydney" "Australia/Tasmania" "Australia/Victoria" "Australia/West" "Australia/Yancowinna" "Brazil/Acre" "Brazil/DeNoronha" "Brazil/East" "Brazil/West" "CET" "CST6CDT" "Canada/Atlantic" "Canada/Central" "Canada/Eastern" "Canada/Mountain" "Canada/Newfoundland" "Canada/Pacific" "Canada/Saskatchewan" "Canada/Yukon" "Chile/Continental" "Chile/EasterIsland" "Cuba" "EET" "EST" "EST5EDT" "Egypt" "Eire" "Etc/GMT" "Etc/GMT+0" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-0" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/GMT0" "Etc/Greenwich" "Etc/UCT" "Etc/UTC" "Etc/Universal" "Etc/Zulu" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belfast" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Nicosia" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Tiraspol" "Europe/Ulyanovsk" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "GB" "GB-Eire" "GMT" "GMT+0" "GMT-0" "GMT0" "Greenwich" "HST" "Hongkong" "Iceland" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Iran" "Israel" "Jamaica" "Japan" "Kwajalein" "Libya" "MET" "MST" "MST7MDT" "Mexico/BajaNorte" "Mexico/BajaSur" "Mexico/General" "NZ" "NZ-CHAT" "Navajo" "PRC" "PST8PDT" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Ponape" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Samoa" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Truk" "Pacific/Wake" "Pacific/Wallis" "Pacific/Yap" "Poland" "Portugal" "ROC" "ROK" "Singapore" "Turkey" "UCT" "US/Alaska" "US/Aleutian" "US/Arizona" "US/Central" "US/East-Indiana" "US/Eastern" "US/Hawaii" "US/Indiana-Starke" "US/Michigan" "US/Mountain" "US/Pacific" "US/Samoa" "UTC" "Universal" "W-SU" "WET" "Zulu"

Responses

Request samples

Payload

Content type

application/json

{"address": "string",
"city": "Palo Alto",
"postalCode": "94301",
"state": "CA",
"country": "USA",
"patientTags": [{"name": "string"
}
],
"lastDeletedPatientTag": {"name": "string"
},
"phoneNumbers": [{"type": "main",
"number": "+1 (555) 555-1212"
}
],
"clinicType": "provider_practice",
"clinicSize": "0-249",
"name": "string",
"website": "http://example.com",
"preferredBgUnits": "mg/dL",
"suppressedNotifications": {"patientClinicInvitation": true
},
"timezone": "Africa/Abidjan"
}

Response samples

Content type

application/json

{"id": "2fe2488217ee43e1b2e83c2f",
"address": "string",
"city": "Palo Alto",
"postalCode": "94301",
"state": "CA",
"country": "USA",
"patientTags": [{"id": "stringstringstringstring",
"name": "string"
}
],
"lastDeletedPatientTag": {"id": "stringstringstringstring",
"name": "string"
},
"phoneNumbers": [{"type": "main",
"number": "+1 (555) 555-1212"
}
],
"clinicType": "provider_practice",
"clinicSize": "0-249",
"name": "string",
"shareCode": "string",
"canMigrate": true,
"website": "http://example.com",
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"tierDescription": "Free",
"tier": "tier0100",
"preferredBgUnits": "mg/dL",
"suppressedNotifications": {"patientClinicInvitation": true
},
"timezone": "Africa/Abidjan"
}

Delete Clinic

Deletes a clinic if there are no connected patient accounts (besides demo accounts).

Authorizations:

sessionToken

path Parameters

clinicId

required

string^[a-f0-9]{24}$

Responses

List Clinicians

Retrieve the list of clinic members.

Authorizations:

sessionToken

path Parameters

clinicId

required

string^[a-f0-9]{24}$

query Parameters

search	string Full text search query
offset	integer >= 0
limit	integer >= 1 Default: 10
email	string <email>
role	string

Responses

Response samples

Content type

application/json

[{"id": "string",
"inviteId": "string",
"email": "user@example.com",
"name": "string",
"roles": ["CLINIC_ADMIN"
],
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z"
}
]

Create Clinician

Internal endpoint to create a new clinician

Authorizations:

sessionToken

path Parameters

clinicId

required

string^[a-f0-9]{24}$

Request Body schema: application/json

inviteId	string The id of the invite if it hasn't been accepted
email required	string <email>
name	string non-empty The name of the clinician
roles required	Array of strings (Clinician Permissions) non-empty unique Items Enum: "CLINIC_ADMIN" "CLINIC_MEMBER" "PRESCRIBER"

Responses

Request samples

Payload

Content type

application/json

{"inviteId": "string",
"email": "user@example.com",
"name": "string",
"roles": ["CLINIC_ADMIN"
]
}

View TIDE Report

Retrieve a report of patients with tags by TIDE categories

Authorizations:

sessionToken

path Parameters

clinicId

required

string^[a-f0-9]{24}$

query Parameters

period	string^(1d\|7d\|14d\|30d)$ Example: period=7d Time Period to display
tags	Array of strings <^[a-f0-9]{24}$> [ items <^[a-f0-9]{24}$ > ] Comma-separated list of patient tag IDs
cgm.lastUploadDateFrom	string <date-time> Inclusive
cgm.lastUploadDateTo	string <date-time> Exclusive

Responses

Response samples

Content type

application/json

{"config": {"schemaVersion": 0,
"clinicId": "2fe2488217ee43e1b2e83c2f",
"period": "7d",
"lastUploadDateFrom": "2019-08-24T14:15:22Z",
"lastUploadDateTo": "2019-08-24T14:15:22Z",
"highGlucoseThreshold": 0,
"veryHighGlucoseThreshold": 0,
"lowGlucoseThreshold": 0,
"veryLowGlucoseThreshold": 0,
"tags": ["stringstringstringstring"
],
"filters": {"timeInVeryLowPercent": ">0.5",
"timeInAnyLowPercent": ">0.5",
"dropInTimeInTargetPercent": ">0.5",
"timeInTargetPercent": ">0.5",
"timeCGMUsePercent": ">0.5"
}
},
"results": {"property1": [{"averageGlucoseMmol": 5.5,
"glucoseManagementIndicator": 7.5,
"timeInVeryLowPercent": 0.35,
"timeInAnyLowPercent": 0.35,
"timeInLowPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"timeInHighPercent": 0.35,
"timeInVeryHighPercent": 0.35,
"timeInAnyHighPercent": 0.35,
"timeInTargetPercent": 0.35,
"timeCGMUsePercent": 0.35,
"timeCGMUseMinutes": 200,
"patient": {"id": "string",
"email": "user@example.com",
"fullName": "string",
"tags": ["stringstringstringstring"
],
"reviews": [{"clinicianId": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
}
],
"property2": [{"averageGlucoseMmol": 5.5,
"glucoseManagementIndicator": 7.5,
"timeInVeryLowPercent": 0.35,
"timeInAnyLowPercent": 0.35,
"timeInLowPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"timeInHighPercent": 0.35,
"timeInVeryHighPercent": 0.35,
"timeInAnyHighPercent": 0.35,
"timeInTargetPercent": 0.35,
"timeCGMUsePercent": 0.35,
"timeCGMUseMinutes": 200,
"patient": {"id": "string",
"email": "user@example.com",
"fullName": "string",
"tags": ["stringstringstringstring"
],
"reviews": [{"clinicianId": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
}
]
}
}

List Patients

Retrieve a list of patients of a clinic

Authorizations:

sessionToken

path Parameters

clinicId

required

string^[a-f0-9]{24}$

query Parameters

search	string Full text search query
offset	integer >= 0
limit	integer >= 1 Default: 10
sort	string(?:-\|\+)(?:[a-zA-Z]\|_)+ Sort order and attribute (e.g. +name or -name)
sortType	string^(cgm\|bgm)$ Example: sortType=cgm Summary type to sort by
period	string^(1d\|7d\|14d\|30d)$ Example: period=7d Time Period to display, filter, and sort
offsetPeriods	boolean If we should display, filter, and sort based on the offset periods or default periods
lastReviewed	string <date-time> Inclusive
cgm.averageGlucoseMmol	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.averageGlucoseMmol=>=5.5 Average glucose value of records in Mmol/L
cgm.glucoseManagementIndicator	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.glucoseManagementIndicator=>=5.5 Glucose management Indicator of records
cgm.timeCGMUsePercent	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.timeCGMUsePercent=>=5.5 Percentage of time [0.0-1.0] of CGM use
cgm.timeInVeryLowPercent	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.timeInVeryLowPercent=>=5.5 Percentage of time [0.0-1.0] below 54 mg/dL
cgm.timeInAnyLowPercent	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.timeInAnyLowPercent=>=5.5 Percentage of time [0.0-1.0] below 70 mg/dL
cgm.timeInLowPercent	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.timeInLowPercent=>=5.5 Percentage of time [0.0-1.0] in range 54-70 mg/dL
cgm.timeInTargetPercent	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.timeInTargetPercent=>=5.5 Percentage of time [0.0-1.0] in range 70-180 mg/dL
cgm.timeInHighPercent	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.timeInHighPercent=>=5.5 Percentage of time [0.0-1.0] in range 180-250 mg/dL
cgm.timeInVeryHighPercent	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.timeInVeryHighPercent=>=5.5 Percentage of time [0.0-1.0] above 250 mg/dL
cgm.timeInExtremeHighPercent	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.timeInExtremeHighPercent=>=5.5 Percentage of time [0.0-1.0] above 350 mg/dL
cgm.timeInAnyHighPercent	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.timeInAnyHighPercent=>=5.5 Percentage of time [0.0-1.0] above 180 mg/dL
cgm.timeCGMUseMinutes	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeCGMUseMinutes=>=7 Minutes of CGM use
cgm.timeInVeryLowMinutes	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInVeryLowMinutes=>=7 Minutes below 54 mg/dL
cgm.timeInAnyLowMinutes	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInAnyLowMinutes=>=7 Minutes below 70 mg/dL
cgm.timeInLowMinutes	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInLowMinutes=>=7 Minutes in range 54-70 mg/dL
cgm.timeInTargetMinutes	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInTargetMinutes=>=7 Minutes in range 70-180 mg/dL
cgm.timeInHighMinutes	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInHighMinutes=>=7 Minutes in range 180-250 mg/dL
cgm.timeInVeryHighMinutes	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInVeryHighMinutes=>=7 Minutes above 250 mg/dL
cgm.timeInExtremeHighMinutes	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInExtremeHighMinutes=>=7 Minutes above 350 mg/dL
cgm.timeInAnyHighMinutes	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInAnyHighMinutes=>=7 Minutes above 180 mg/dL
cgm.timeCGMUseRecords	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeCGMUseRecords=>=7 Records of CGM use
cgm.timeInVeryLowRecords	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInVeryLowRecords=>=7 Records below 54 mg/dL
cgm.timeInAnyLowRecords	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInAnyLowRecords=>=7 Records below 70 mg/dL
cgm.timeInLowRecords	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInLowRecords=>=7 Records in range 54-70 mg/dL
cgm.timeInTargetRecords	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInTargetRecords=>=7 Records in range 70-180 mg/dL
cgm.timeInHighRecords	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInHighRecords=>=7 Records in range 180-250 mg/dL
cgm.timeInVeryHighRecords	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInVeryHighRecords=>=7 Records above 250 mg/dL
cgm.timeInAnyHighRecords	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInAnyHighRecords=>=7 Records above 180 mg/dL
cgm.averageDailyRecords	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.averageDailyRecords=>=5.5 Average records per day
cgm.totalRecords	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.totalRecords=>=7 Total records in period
cgm.hoursWithData	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.hoursWithData=>=7 Total hours with data in period
cgm.daysWithData	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.daysWithData=>=7 Total days with data in period
cgm.standardDeviation	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.standardDeviation=>=5.5 Standard deviation of glucose values in Mmol/L
cgm.coefficientOfVariation	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.coefficientOfVariation=>=5.5 Coefficient Of Variation of glucose values in Mmol/L
bgm.averageGlucoseMmol	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: bgm.averageGlucoseMmol=>=5.5 Average glucose value of records in Mmol/L
bgm.timeInVeryLowPercent	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: bgm.timeInVeryLowPercent=>=5.5 Percentage of time [0.0-1.0] below 54 mg/dL
bgm.timeInAnyLowPercent	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: bgm.timeInAnyLowPercent=>=5.5 Percentage of time [0.0-1.0] below 70 mg/dL
bgm.timeInLowPercent	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: bgm.timeInLowPercent=>=5.5 Percentage of time [0.0-1.0] in range 54-70 mg/dL
bgm.timeInTargetPercent	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: bgm.timeInTargetPercent=>=5.5 Percentage of time [0.0-1.0] in range 70-180 mg/dL
bgm.timeInHighPercent	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: bgm.timeInHighPercent=>=5.5 Percentage of time [0.0-1.0] in range 180-250 mg/dL
bgm.timeInVeryHighPercent	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: bgm.timeInVeryHighPercent=>=5.5 Percentage of time [0.0-1.0] above 250 mg/dL
bgm.timeInExtremeHighPercent	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: bgm.timeInExtremeHighPercent=>=5.5 Percentage of time [0.0-1.0] above 350 mg/dL
bgm.timeInAnyHighPercent	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: bgm.timeInAnyHighPercent=>=5.5 Percentage of time [0.0-1.0] above 180 mg/dL
bgm.timeInVeryLowRecords	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: bgm.timeInVeryLowRecords=>=7 Records below 54 mg/dL
bgm.timeInAnyLowRecords	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: bgm.timeInAnyLowRecords=>=7 Records below 70 mg/dL
bgm.timeInLowRecords	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: bgm.timeInLowRecords=>=7 Records in range 54-70 mg/dL
bgm.timeInTargetRecords	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: bgm.timeInTargetRecords=>=7 Records in range 70-180 mg/dL
bgm.timeInHighRecords	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: bgm.timeInHighRecords=>=7 Records in range 180-250 mg/dL
bgm.timeInVeryHighRecords	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: bgm.timeInVeryHighRecords=>=7 Records above 250 mg/dL
bgm.timeInAnyHighRecords	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: bgm.timeInAnyHighRecords=>=7 Records above 180 mg/dL
bgm.averageDailyRecords	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: bgm.averageDailyRecords=>=5.5 Average records per day
bgm.totalRecords	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: bgm.totalRecords=>=7 Total records in period
cgm.averageGlucoseMmolDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.averageGlucoseMmolDelta=>=5.5 Delta of average glucose value in Mmol/L
cgm.glucoseManagementIndicatorDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.glucoseManagementIndicatorDelta=>=5.5 Glucose management Indicator of records
cgm.timeCGMUsePercentDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.timeCGMUsePercentDelta=>=5.5 Delta of time of CGM use
cgm.timeInVeryLowPercentDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.timeInVeryLowPercentDelta=>=5.5 Delta of time below 54 mg/dL
cgm.timeInAnyLowPercentDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.timeInAnyLowPercentDelta=>=5.5 Delta of time below 70 mg/dL
cgm.timeInLowPercentDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.timeInLowPercentDelta=>=5.5 Delta of time in range 54-70 mg/dL
cgm.timeInTargetPercentDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.timeInTargetPercentDelta=>=5.5 Delta of time in range 70-180 mg/dL
cgm.timeInHighPercentDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.timeInHighPercentDelta=>=5.5 Delta of time in range 180-250 mg/dL
cgm.timeInVeryHighPercentDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.timeInVeryHighPercentDelta=>=5.5 Delta of time above 250 mg/dL
cgm.timeInExtremeHighPercentDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.timeInExtremeHighPercentDelta=>=5.5 Delta of time above 350 mg/dL
cgm.timeInAnyHighPercentDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.timeInAnyHighPercentDelta=>=5.5 Delta of time above 180 mg/dL
cgm.timeCGMUseMinutesDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeCGMUseMinutesDelta=>=7 Delta of minutes of CGM use
cgm.timeInVeryLowMinutesDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInVeryLowMinutesDelta=>=7 Delta of minutes below 54 mg/dL
cgm.timeInAnyLowMinutesDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInAnyLowMinutesDelta=>=7 Delta of minutes below 70 mg/dL
cgm.timeInLowMinutesDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInLowMinutesDelta=>=7 Delta of minutes in range 54-70 mg/dL
cgm.timeInTargetMinutesDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInTargetMinutesDelta=>=7 Delta of minutes in range 70-180 mg/dL
cgm.timeInHighMinutesDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInHighMinutesDelta=>=7 Delta of minutes in range 180-250 mg/dL
cgm.timeInVeryHighMinutesDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInVeryHighMinutesDelta=>=7 Delta of minutes above 250 mg/dL
cgm.timeInExtremeHighMinutesDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInExtremeHighMinutesDelta=>=7 Delta of minutes above 350 mg/dL
cgm.timeInAnyHighMinutesDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInAnyHighMinutesDelta=>=7 Delta of minutes above 180 mg/dL
cgm.timeCGMUseRecordsDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeCGMUseRecordsDelta=>=7 Delta of records count
cgm.timeInVeryLowRecordsDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInVeryLowRecordsDelta=>=7 Delta of records below 54 mg/dL
cgm.timeInAnyLowRecordsDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInAnyLowRecordsDelta=>=7 Delta of records below 70 mg/dL
cgm.timeInLowRecordsDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInLowRecordsDelta=>=7 Delta of records in range 54-70 mg/dL
cgm.timeInTargetRecordsDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInTargetRecordsDelta=>=7 Delta of records in range 70-180 mg/dL
cgm.timeInHighRecordsDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInHighRecordsDelta=>=7 Delta of records in range 180-250 mg/dL
cgm.timeInVeryHighRecordsDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInVeryHighRecordsDelta=>=7 Delta of records above 250 mg/dL
cgm.timeInAnyHighRecordsDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.timeInAnyHighRecordsDelta=>=7 Delta of records above 180 mg/dL
cgm.averageDailyRecordsDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.averageDailyRecordsDelta=>=5.5 Delta of average records per day
cgm.totalRecordsDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.totalRecordsDelta=>=7 Delta of total records
cgm.hoursWithDataDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.hoursWithDataDelta=>=7 Delta of total hours with data
cgm.daysWithDataDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: cgm.daysWithDataDelta=>=7 Delta of total days with data
cgm.standardDeviationDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.standardDeviationDelta=>=5.5 Delta of the standard deviation of glucose values in Mmol/L
cgm.coefficientOfVariationDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: cgm.coefficientOfVariationDelta=>=5.5 Delta of the coefficient of glucose values in Mmol/L
cgm.lastUploadDateFrom	string <date-time> Inclusive
cgm.lastUploadDateTo	string <date-time> Exclusive
bgm.averageGlucoseMmolDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: bgm.averageGlucoseMmolDelta=>=5.5 Delta of the average glucose values in Mmol/L
bgm.timeInVeryLowPercentDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: bgm.timeInVeryLowPercentDelta=>=5.5 Delta of time below 54 mg/dL
bgm.timeInAnyLowPercentDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: bgm.timeInAnyLowPercentDelta=>=5.5 Delta of time below 70 mg/dL
bgm.timeInLowPercentDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: bgm.timeInLowPercentDelta=>=5.5 Delta of time in range 54-70 mg/dL
bgm.timeInTargetPercentDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: bgm.timeInTargetPercentDelta=>=5.5 Delta of time in range 70-180 mg/dL
bgm.timeInHighPercentDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: bgm.timeInHighPercentDelta=>=5.5 Delta of time in range 180-250 mg/dL
bgm.timeInVeryHighPercentDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: bgm.timeInVeryHighPercentDelta=>=5.5 Delta of time above 250 mg/dL
bgm.timeInExtremeHighPercentDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: bgm.timeInExtremeHighPercentDelta=>=5.5 Delta of time above 350 mg/dL
bgm.timeInAnyHighPercentDelta	string (FloatFilter) ^(>=\|>\|<=\|<)[+-]?((\d+(\.\d*)?)\|(\.\d+))$ Example: bgm.timeInAnyHighPercentDelta=>=5.5 Delta of time above 180 mg/dL
bgm.timeInVeryLowRecordsDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: bgm.timeInVeryLowRecordsDelta=>=7 Delta of records below 54 mg/dL
bgm.timeInAnyLowRecordsDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: bgm.timeInAnyLowRecordsDelta=>=7 Delta of records below 70 mg/dL
bgm.timeInLowRecordsDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: bgm.timeInLowRecordsDelta=>=7 Delta of records in range 54-70 mg/dL
bgm.timeInTargetRecordsDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: bgm.timeInTargetRecordsDelta=>=7 Delta of records in range 70-180 mg/dL
bgm.timeInHighRecordsDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: bgm.timeInHighRecordsDelta=>=7 Delta of records in range 180-250 mg/dL
bgm.timeInVeryHighRecordsDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: bgm.timeInVeryHighRecordsDelta=>=7 Delta of records above 250 mg/dL
bgm.timeInAnyHighRecordsDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: bgm.timeInAnyHighRecordsDelta=>=7 Delta of records above 180 mg/dL
bgm.averageDailyRecordsDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: bgm.averageDailyRecordsDelta=>=7 Delta of average records per day
bgm.totalRecordsDelta	string (IntFilter) ^(>=\|>\|<=\|<)[+-]?\d+$ Example: bgm.totalRecordsDelta=>=7 Delta of total record count
bgm.lastUploadDateFrom	string <date-time> Inclusive
bgm.lastUploadDateTo	string <date-time> Exclusive
tags	Array of strings <^[a-f0-9]{24}$> [ items <^[a-f0-9]{24}$ > ] Comma-separated list of patient tag IDs

Responses

Response samples

Content type

application/json

{"data": [{"id": "string",
"email": "user@example.com",
"fullName": "string",
"birthDate": "2012-08-30",
"mrn": "string",
"tags": ["stringstringstringstring"
],
"targetDevices": ["string"
],
"permissions": {"custodian": { },
"view": { },
"note": { },
"upload": { }
},
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"attestationSubmitted": true,
"dataSources": [{"state": "connected",
"providerName": "dexcom",
"dataSourceId": "stringstringstringstring",
"modifiedTime": "2017-02-06T02:37:46Z",
"expirationTime": "2017-02-06T02:37:46Z"
}
],
"lastRequestedDexcomConnectTime": "2019-08-24T14:15:22Z",
"lastUploadReminderTime": "2019-08-24T14:15:22Z",
"summary": {"cgmStats": {"config": {"schemaVersion": 0,
"highGlucoseThreshold": 0,
"veryHighGlucoseThreshold": 0,
"lowGlucoseThreshold": 0,
"veryLowGlucoseThreshold": 0
},
"dates": {"lastUpdatedDate": "2019-08-24T14:15:22Z",
"lastUpdatedReason": ["string"
],
"hasFirstData": true,
"firstData": "2019-08-24T14:15:22Z",
"hasLastData": true,
"lastData": "2019-08-24T14:15:22Z",
"hasLastUploadDate": true,
"lastUploadDate": "2019-08-24T14:15:22Z",
"hasOutdatedSince": true,
"outdatedSince": "2019-08-24T14:15:22Z",
"outdatedSinceLimit": "2019-08-24T14:15:22Z",
"outdatedReason": ["string"
]
},
"totalHours": 0,
"periods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
}
},
"offsetPeriods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
}
}
},
"bgmStats": {"config": {"schemaVersion": 0,
"highGlucoseThreshold": 0,
"veryHighGlucoseThreshold": 0,
"lowGlucoseThreshold": 0,
"veryLowGlucoseThreshold": 0
},
"dates": {"lastUpdatedDate": "2019-08-24T14:15:22Z",
"lastUpdatedReason": ["string"
],
"hasFirstData": true,
"firstData": "2019-08-24T14:15:22Z",
"hasLastData": true,
"lastData": "2019-08-24T14:15:22Z",
"hasLastUploadDate": true,
"lastUploadDate": "2019-08-24T14:15:22Z",
"hasOutdatedSince": true,
"outdatedSince": "2019-08-24T14:15:22Z",
"outdatedSinceLimit": "2019-08-24T14:15:22Z",
"outdatedReason": ["string"
]
},
"totalHours": 0,
"periods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
}
},
"offsetPeriods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
}
}
}
},
"reviews": [{"clinicianId": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"meta": {"count": 0
}
}

Create Patient Account

Create a custodial account for a patient

Authorizations:

sessionToken

path Parameters

clinicId

required

string^[a-f0-9]{24}$

Request Body schema: application/json

email	string <email>
fullName required	string non-empty The full name of the patient
birthDate required	string <date>
mrn	string non-empty The medical record number of the patient
tags	Array of strings or null (Patient Tag ID List) unique
targetDevices	Array of strings
	object (Patient Permissions)
attestationSubmitted	boolean
	Array of objects or null (Patient data source)
	object (patientsummary.v1) A summary of a patients recent data
	Array of objects or null (patientreview.v1)

Responses

Request samples

Payload

Content type

application/json

{"email": "user@example.com",
"fullName": "string",
"birthDate": "2012-08-30",
"mrn": "string",
"tags": ["stringstringstringstring"
],
"targetDevices": ["string"
],
"permissions": {"custodian": { },
"view": { },
"note": { },
"upload": { }
},
"attestationSubmitted": true,
"dataSources": [{"state": "connected",
"providerName": "dexcom",
"modifiedTime": "2017-02-06T02:37:46Z",
"expirationTime": "2017-02-06T02:37:46Z"
}
],
"summary": {"cgmStats": {"config": {"schemaVersion": 0,
"highGlucoseThreshold": 0,
"veryHighGlucoseThreshold": 0,
"lowGlucoseThreshold": 0,
"veryLowGlucoseThreshold": 0
},
"dates": {"lastUpdatedDate": "2019-08-24T14:15:22Z",
"lastUpdatedReason": ["string"
],
"hasFirstData": true,
"firstData": "2019-08-24T14:15:22Z",
"hasLastData": true,
"lastData": "2019-08-24T14:15:22Z",
"hasLastUploadDate": true,
"lastUploadDate": "2019-08-24T14:15:22Z",
"hasOutdatedSince": true,
"outdatedSince": "2019-08-24T14:15:22Z",
"outdatedSinceLimit": "2019-08-24T14:15:22Z",
"outdatedReason": ["string"
]
},
"totalHours": 0,
"periods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
}
},
"offsetPeriods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
}
}
},
"bgmStats": {"config": {"schemaVersion": 0,
"highGlucoseThreshold": 0,
"veryHighGlucoseThreshold": 0,
"lowGlucoseThreshold": 0,
"veryLowGlucoseThreshold": 0
},
"dates": {"lastUpdatedDate": "2019-08-24T14:15:22Z",
"lastUpdatedReason": ["string"
],
"hasFirstData": true,
"firstData": "2019-08-24T14:15:22Z",
"hasLastData": true,
"lastData": "2019-08-24T14:15:22Z",
"hasLastUploadDate": true,
"lastUploadDate": "2019-08-24T14:15:22Z",
"hasOutdatedSince": true,
"outdatedSince": "2019-08-24T14:15:22Z",
"outdatedSinceLimit": "2019-08-24T14:15:22Z",
"outdatedReason": ["string"
]
},
"totalHours": 0,
"periods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
}
},
"offsetPeriods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
}
}
}
},
"reviews": [{"clinicianId": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}

Response samples

Content type

application/json

{"id": "string",
"email": "user@example.com",
"fullName": "string",
"birthDate": "2012-08-30",
"mrn": "string",
"tags": ["stringstringstringstring"
],
"targetDevices": ["string"
],
"permissions": {"custodian": { },
"view": { },
"note": { },
"upload": { }
},
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"attestationSubmitted": true,
"dataSources": [{"state": "connected",
"providerName": "dexcom",
"dataSourceId": "stringstringstringstring",
"modifiedTime": "2017-02-06T02:37:46Z",
"expirationTime": "2017-02-06T02:37:46Z"
}
],
"lastRequestedDexcomConnectTime": "2019-08-24T14:15:22Z",
"lastUploadReminderTime": "2019-08-24T14:15:22Z",
"summary": {"cgmStats": {"config": {"schemaVersion": 0,
"highGlucoseThreshold": 0,
"veryHighGlucoseThreshold": 0,
"lowGlucoseThreshold": 0,
"veryLowGlucoseThreshold": 0
},
"dates": {"lastUpdatedDate": "2019-08-24T14:15:22Z",
"lastUpdatedReason": ["string"
],
"hasFirstData": true,
"firstData": "2019-08-24T14:15:22Z",
"hasLastData": true,
"lastData": "2019-08-24T14:15:22Z",
"hasLastUploadDate": true,
"lastUploadDate": "2019-08-24T14:15:22Z",
"hasOutdatedSince": true,
"outdatedSince": "2019-08-24T14:15:22Z",
"outdatedSinceLimit": "2019-08-24T14:15:22Z",
"outdatedReason": ["string"
]
},
"totalHours": 0,
"periods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
}
},
"offsetPeriods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
}
}
},
"bgmStats": {"config": {"schemaVersion": 0,
"highGlucoseThreshold": 0,
"veryHighGlucoseThreshold": 0,
"lowGlucoseThreshold": 0,
"veryLowGlucoseThreshold": 0
},
"dates": {"lastUpdatedDate": "2019-08-24T14:15:22Z",
"lastUpdatedReason": ["string"
],
"hasFirstData": true,
"firstData": "2019-08-24T14:15:22Z",
"hasLastData": true,
"lastData": "2019-08-24T14:15:22Z",
"hasLastUploadDate": true,
"lastUploadDate": "2019-08-24T14:15:22Z",
"hasOutdatedSince": true,
"outdatedSince": "2019-08-24T14:15:22Z",
"outdatedSinceLimit": "2019-08-24T14:15:22Z",
"outdatedReason": ["string"
]
},
"totalHours": 0,
"periods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
}
},
"offsetPeriods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
}
}
}
},
"reviews": [{"clinicianId": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}

Create Patient Tag

Create a new patient tag

Authorizations:

sessionToken

path Parameters

clinicId

required

string^[a-f0-9]{24}$

Request Body schema: application/json

name

required

string [ 1 .. 20 ] characters ^[\p{L}\p{N}_+><-]{1}[\p{L}\p{N}\s_+><-]*$

The tag display name

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Get Clinician

Retrieve a member of clinic given their user id

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
clinicianId required	string^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/clinicians/{clinicianId}

production

https://api.tidepool.org/v1/clinics/{clinicId}/clinicians/{clinicianId}

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/clinicians/{clinicianId}

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/clinicians/{clinicianId}

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/clinicians/{clinicianId}

Response samples

Content type

application/json

{"id": "string",
"inviteId": "string",
"email": "user@example.com",
"name": "string",
"roles": ["CLINIC_ADMIN"
],
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z"
}

Update Clinician

Update existing clinician

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
clinicianId required	string^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Request Body schema: application/json

inviteId	string The id of the invite if it hasn't been accepted
email required	string <email>
name	string non-empty The name of the clinician
roles required	Array of strings (Clinician Permissions) non-empty unique Items Enum: "CLINIC_ADMIN" "CLINIC_MEMBER" "PRESCRIBER"

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/clinicians/{clinicianId}

production

https://api.tidepool.org/v1/clinics/{clinicId}/clinicians/{clinicianId}

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/clinicians/{clinicianId}

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/clinicians/{clinicianId}

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/clinicians/{clinicianId}

Request samples

Payload

Content type

application/json

{"inviteId": "string",
"email": "user@example.com",
"name": "string",
"roles": ["CLINIC_ADMIN"
]
}

Delete Clinician

Removes a clinician from a clinic

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
clinicianId required	string^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/clinicians/{clinicianId}

production

https://api.tidepool.org/v1/clinics/{clinicId}/clinicians/{clinicianId}

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/clinicians/{clinicianId}

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/clinicians/{clinicianId}

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/clinicians/{clinicianId}

Get Patient

Retrieve a patient of clinic given their user id

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
patientId required	string^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}

production

https://api.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}

Response samples

Content type

application/json

{"id": "string",
"email": "user@example.com",
"fullName": "string",
"birthDate": "2012-08-30",
"mrn": "string",
"tags": ["stringstringstringstring"
],
"targetDevices": ["string"
],
"permissions": {"custodian": { },
"view": { },
"note": { },
"upload": { }
},
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"attestationSubmitted": true,
"dataSources": [{"state": "connected",
"providerName": "dexcom",
"dataSourceId": "stringstringstringstring",
"modifiedTime": "2017-02-06T02:37:46Z",
"expirationTime": "2017-02-06T02:37:46Z"
}
],
"lastRequestedDexcomConnectTime": "2019-08-24T14:15:22Z",
"lastUploadReminderTime": "2019-08-24T14:15:22Z",
"summary": {"cgmStats": {"config": {"schemaVersion": 0,
"highGlucoseThreshold": 0,
"veryHighGlucoseThreshold": 0,
"lowGlucoseThreshold": 0,
"veryLowGlucoseThreshold": 0
},
"dates": {"lastUpdatedDate": "2019-08-24T14:15:22Z",
"lastUpdatedReason": ["string"
],
"hasFirstData": true,
"firstData": "2019-08-24T14:15:22Z",
"hasLastData": true,
"lastData": "2019-08-24T14:15:22Z",
"hasLastUploadDate": true,
"lastUploadDate": "2019-08-24T14:15:22Z",
"hasOutdatedSince": true,
"outdatedSince": "2019-08-24T14:15:22Z",
"outdatedSinceLimit": "2019-08-24T14:15:22Z",
"outdatedReason": ["string"
]
},
"totalHours": 0,
"periods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
}
},
"offsetPeriods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
}
}
},
"bgmStats": {"config": {"schemaVersion": 0,
"highGlucoseThreshold": 0,
"veryHighGlucoseThreshold": 0,
"lowGlucoseThreshold": 0,
"veryLowGlucoseThreshold": 0
},
"dates": {"lastUpdatedDate": "2019-08-24T14:15:22Z",
"lastUpdatedReason": ["string"
],
"hasFirstData": true,
"firstData": "2019-08-24T14:15:22Z",
"hasLastData": true,
"lastData": "2019-08-24T14:15:22Z",
"hasLastUploadDate": true,
"lastUploadDate": "2019-08-24T14:15:22Z",
"hasOutdatedSince": true,
"outdatedSince": "2019-08-24T14:15:22Z",
"outdatedSinceLimit": "2019-08-24T14:15:22Z",
"outdatedReason": ["string"
]
},
"totalHours": 0,
"periods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
}
},
"offsetPeriods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
}
}
}
},
"reviews": [{"clinicianId": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}

Create Patient from Existing User

Internal endpoint for creating a patient from an existing user

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
patientId required	string^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Request Body schema: application/json

	object (Patient Permissions)
isMigrated	boolean
attestationSubmitted	boolean
fullName	string non-empty The full name of the patient
birthDate	string <date>
mrn	string non-empty The medical record number of the patient
tags	Array of strings or null (Patient Tag ID List) unique

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}

production

https://api.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}

Request samples

Payload

Content type

application/json

{"permissions": {"custodian": { },
"view": { },
"note": { },
"upload": { }
},
"isMigrated": true,
"attestationSubmitted": true,
"fullName": "string",
"birthDate": "2012-08-30",
"mrn": "string",
"tags": ["stringstringstringstring"
]
}

Response samples

Content type

application/json

{"id": "string",
"email": "user@example.com",
"fullName": "string",
"birthDate": "2012-08-30",
"mrn": "string",
"tags": ["stringstringstringstring"
],
"targetDevices": ["string"
],
"permissions": {"custodian": { },
"view": { },
"note": { },
"upload": { }
},
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"attestationSubmitted": true,
"dataSources": [{"state": "connected",
"providerName": "dexcom",
"dataSourceId": "stringstringstringstring",
"modifiedTime": "2017-02-06T02:37:46Z",
"expirationTime": "2017-02-06T02:37:46Z"
}
],
"lastRequestedDexcomConnectTime": "2019-08-24T14:15:22Z",
"lastUploadReminderTime": "2019-08-24T14:15:22Z",
"summary": {"cgmStats": {"config": {"schemaVersion": 0,
"highGlucoseThreshold": 0,
"veryHighGlucoseThreshold": 0,
"lowGlucoseThreshold": 0,
"veryLowGlucoseThreshold": 0
},
"dates": {"lastUpdatedDate": "2019-08-24T14:15:22Z",
"lastUpdatedReason": ["string"
],
"hasFirstData": true,
"firstData": "2019-08-24T14:15:22Z",
"hasLastData": true,
"lastData": "2019-08-24T14:15:22Z",
"hasLastUploadDate": true,
"lastUploadDate": "2019-08-24T14:15:22Z",
"hasOutdatedSince": true,
"outdatedSince": "2019-08-24T14:15:22Z",
"outdatedSinceLimit": "2019-08-24T14:15:22Z",
"outdatedReason": ["string"
]
},
"totalHours": 0,
"periods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
}
},
"offsetPeriods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
}
}
},
"bgmStats": {"config": {"schemaVersion": 0,
"highGlucoseThreshold": 0,
"veryHighGlucoseThreshold": 0,
"lowGlucoseThreshold": 0,
"veryLowGlucoseThreshold": 0
},
"dates": {"lastUpdatedDate": "2019-08-24T14:15:22Z",
"lastUpdatedReason": ["string"
],
"hasFirstData": true,
"firstData": "2019-08-24T14:15:22Z",
"hasLastData": true,
"lastData": "2019-08-24T14:15:22Z",
"hasLastUploadDate": true,
"lastUploadDate": "2019-08-24T14:15:22Z",
"hasOutdatedSince": true,
"outdatedSince": "2019-08-24T14:15:22Z",
"outdatedSinceLimit": "2019-08-24T14:15:22Z",
"outdatedReason": ["string"
]
},
"totalHours": 0,
"periods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
}
},
"offsetPeriods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
}
}
}
},
"reviews": [{"clinicianId": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}

Update Patient

Update existing patient of a clinic

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
patientId required	string^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Request Body schema: application/json

email	string <email>
fullName required	string non-empty The full name of the patient
birthDate required	string <date>
mrn	string non-empty The medical record number of the patient
tags	Array of strings or null (Patient Tag ID List) unique
targetDevices	Array of strings
	object (Patient Permissions)
attestationSubmitted	boolean
	Array of objects or null (Patient data source)
	object (patientsummary.v1) A summary of a patients recent data
	Array of objects or null (patientreview.v1)

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}

production

https://api.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}

Request samples

Payload

Content type

application/json

{"email": "user@example.com",
"fullName": "string",
"birthDate": "2012-08-30",
"mrn": "string",
"tags": ["stringstringstringstring"
],
"targetDevices": ["string"
],
"permissions": {"custodian": { },
"view": { },
"note": { },
"upload": { }
},
"attestationSubmitted": true,
"dataSources": [{"state": "connected",
"providerName": "dexcom",
"modifiedTime": "2017-02-06T02:37:46Z",
"expirationTime": "2017-02-06T02:37:46Z"
}
],
"summary": {"cgmStats": {"config": {"schemaVersion": 0,
"highGlucoseThreshold": 0,
"veryHighGlucoseThreshold": 0,
"lowGlucoseThreshold": 0,
"veryLowGlucoseThreshold": 0
},
"dates": {"lastUpdatedDate": "2019-08-24T14:15:22Z",
"lastUpdatedReason": ["string"
],
"hasFirstData": true,
"firstData": "2019-08-24T14:15:22Z",
"hasLastData": true,
"lastData": "2019-08-24T14:15:22Z",
"hasLastUploadDate": true,
"lastUploadDate": "2019-08-24T14:15:22Z",
"hasOutdatedSince": true,
"outdatedSince": "2019-08-24T14:15:22Z",
"outdatedSinceLimit": "2019-08-24T14:15:22Z",
"outdatedReason": ["string"
]
},
"totalHours": 0,
"periods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
}
},
"offsetPeriods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
}
}
},
"bgmStats": {"config": {"schemaVersion": 0,
"highGlucoseThreshold": 0,
"veryHighGlucoseThreshold": 0,
"lowGlucoseThreshold": 0,
"veryLowGlucoseThreshold": 0
},
"dates": {"lastUpdatedDate": "2019-08-24T14:15:22Z",
"lastUpdatedReason": ["string"
],
"hasFirstData": true,
"firstData": "2019-08-24T14:15:22Z",
"hasLastData": true,
"lastData": "2019-08-24T14:15:22Z",
"hasLastUploadDate": true,
"lastUploadDate": "2019-08-24T14:15:22Z",
"hasOutdatedSince": true,
"outdatedSince": "2019-08-24T14:15:22Z",
"outdatedSinceLimit": "2019-08-24T14:15:22Z",
"outdatedReason": ["string"
]
},
"totalHours": 0,
"periods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
}
},
"offsetPeriods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
}
}
}
},
"reviews": [{"clinicianId": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}

Response samples

Content type

application/json

{"id": "string",
"email": "user@example.com",
"fullName": "string",
"birthDate": "2012-08-30",
"mrn": "string",
"tags": ["stringstringstringstring"
],
"targetDevices": ["string"
],
"permissions": {"custodian": { },
"view": { },
"note": { },
"upload": { }
},
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"attestationSubmitted": true,
"dataSources": [{"state": "connected",
"providerName": "dexcom",
"dataSourceId": "stringstringstringstring",
"modifiedTime": "2017-02-06T02:37:46Z",
"expirationTime": "2017-02-06T02:37:46Z"
}
],
"lastRequestedDexcomConnectTime": "2019-08-24T14:15:22Z",
"lastUploadReminderTime": "2019-08-24T14:15:22Z",
"summary": {"cgmStats": {"config": {"schemaVersion": 0,
"highGlucoseThreshold": 0,
"veryHighGlucoseThreshold": 0,
"lowGlucoseThreshold": 0,
"veryLowGlucoseThreshold": 0
},
"dates": {"lastUpdatedDate": "2019-08-24T14:15:22Z",
"lastUpdatedReason": ["string"
],
"hasFirstData": true,
"firstData": "2019-08-24T14:15:22Z",
"hasLastData": true,
"lastData": "2019-08-24T14:15:22Z",
"hasLastUploadDate": true,
"lastUploadDate": "2019-08-24T14:15:22Z",
"hasOutdatedSince": true,
"outdatedSince": "2019-08-24T14:15:22Z",
"outdatedSinceLimit": "2019-08-24T14:15:22Z",
"outdatedReason": ["string"
]
},
"totalHours": 0,
"periods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
}
},
"offsetPeriods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
}
}
},
"bgmStats": {"config": {"schemaVersion": 0,
"highGlucoseThreshold": 0,
"veryHighGlucoseThreshold": 0,
"lowGlucoseThreshold": 0,
"veryLowGlucoseThreshold": 0
},
"dates": {"lastUpdatedDate": "2019-08-24T14:15:22Z",
"lastUpdatedReason": ["string"
],
"hasFirstData": true,
"firstData": "2019-08-24T14:15:22Z",
"hasLastData": true,
"lastData": "2019-08-24T14:15:22Z",
"hasLastUploadDate": true,
"lastUploadDate": "2019-08-24T14:15:22Z",
"hasOutdatedSince": true,
"outdatedSince": "2019-08-24T14:15:22Z",
"outdatedSinceLimit": "2019-08-24T14:15:22Z",
"outdatedReason": ["string"
]
},
"totalHours": 0,
"periods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
}
},
"offsetPeriods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
}
}
}
},
"reviews": [{"clinicianId": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}

Delete Patient

Deletes patient from a clinic. Requires the request to be made by a clinic admin or the currently authenticated user id to match the patient id.

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
patientId required	string^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}

production

https://api.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}

Update Patient Tag

Update existing patient tag

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
patientTagId required	string^[a-f0-9]{24}$

Request Body schema: application/json

name

required

string [ 1 .. 20 ] characters ^[\p{L}\p{N}_+><-]{1}[\p{L}\p{N}\s_+><-]*$

The tag display name

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/patient_tags/{patientTagId}

production

https://api.tidepool.org/v1/clinics/{clinicId}/patient_tags/{patientTagId}

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/patient_tags/{patientTagId}

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/patient_tags/{patientTagId}

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/patient_tags/{patientTagId}

Request samples

Payload

Content type

application/json

{"name": "string"
}

Delete Patient Tag

Removes a patient tag from a clinic and tagged patients

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
patientTagId required	string^[a-f0-9]{24}$

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/patient_tags/{patientTagId}

production

https://api.tidepool.org/v1/clinics/{clinicId}/patient_tags/{patientTagId}

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/patient_tags/{patientTagId}

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/patient_tags/{patientTagId}

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/patient_tags/{patientTagId}

Invite Clinician

Send an invite to clinician's email address to join a clinic.

Authorizations:

sessionToken

path Parameters

clinicId

required

string^[a-f0-9]{24}$

Request Body schema: application/json

email required	string <email> (Email Address) >= 6 characters An email address, as specified by RFC 5322.
roles required	Array of strings (Clinician Permissions) non-empty unique Items Enum: "CLINIC_ADMIN" "CLINIC_MEMBER" "PRESCRIBER"

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/invites/clinicians

production

https://api.tidepool.org/v1/clinics/{clinicId}/invites/clinicians

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/invites/clinicians

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/invites/clinicians

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/invites/clinicians

Request samples

Payload

Content type

application/json

{"email": "example@tidepool.org",
"roles": ["CLINIC_ADMIN"
]
}

Response samples

Content type

application/json

{"id": "string",
"inviteId": "string",
"email": "user@example.com",
"name": "string",
"roles": ["CLINIC_ADMIN"
],
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z"
}

Resend Clinician Invite

Resend invite to the email address of the clinician.

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
inviteId required	string non-empty

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

production

https://api.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

Response samples

Content type

application/json

{"key": "Sds2PHMALZrmt++JyD5mIjLkZruJldiM",
"type": "password_reset",
"status": "pending",
"email": "example@tidepool.org",
"creatorId": "string",
"created": "2017-02-06T02:37:46Z",
"modified": "2017-02-06T02:37:46Z",
"creator": {"userid": "string",
"profile": {"fullName": "string",
"patient": {"birthday": "2012-08-30",
"diagnosisDate": "2013-05-09",
"isOtherPerson": false,
"fullName": "James Jellyfish"
}
}
},
"context": "string",
"restrictions": {"canAccept": true,
"requiredIdp": "string"
},
"expiresAt": "2024-01-30T08:11:00Z"
}

Delete Invite

Deletes unaccepted invite

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
inviteId required	string non-empty

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

production

https://api.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

Associate Clinician to User

Internal endpoint to associate a clinician to a user.

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
inviteId required	string non-empty

Request Body schema: application/json

userId

required

string

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician

production

https://api.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician

Request samples

Payload

Content type

application/json

{"userId": "string"
}

Response samples

Content type

application/json

{"id": "string",
"inviteId": "string",
"email": "user@example.com",
"name": "string",
"roles": ["CLINIC_ADMIN"
],
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z"
}

Delete Invited Clinician

Internal endpoint to delete an invited clinician object

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
inviteId required	string non-empty

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician

production

https://api.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician

Get Invited Clinician

Internal endpoint to retrieve invited clinician.

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
inviteId required	string non-empty

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician

production

https://api.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician

Response samples

Content type

application/json

{"id": "string",
"inviteId": "string",
"email": "user@example.com",
"name": "string",
"roles": ["CLINIC_ADMIN"
],
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z"
}

Get Patient Invites

Retrieve the list of all pending invites from users who would like to share their accounts with the clinic and become patients.

Authorizations:

sessionToken

path Parameters

clinicId

required

string^[a-f0-9]{24}$

Responses

Accept Patient Invitation

Accept a pending invite from a user who would like to share their account with the clinic and become a patient.

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
inviteId required	string non-empty

Request Body schema: application/json

fullName	string non-empty The full name of the patient
birthDate	string <date>
mrn	string non-empty The medical record number of the patient
tags	Array of strings or null (Patient Tag ID List) unique

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/invites/patients/{inviteId}

production

https://api.tidepool.org/v1/clinics/{clinicId}/invites/patients/{inviteId}

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/invites/patients/{inviteId}

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/invites/patients/{inviteId}

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/invites/patients/{inviteId}

Request samples

Payload

Content type

application/json

{"fullName": "string",
"birthDate": "2012-08-30",
"mrn": "string",
"tags": ["stringstringstringstring"
]
}

Update Patient Reviews

Update the patient's last reviewed date and clinician ID

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
patientId required	string^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/reviews

production

https://api.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/reviews

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/reviews

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/reviews

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/reviews

Response samples

Content type

application/json

[{"clinicianId": "string",
"time": "2019-08-24T14:15:22Z"
}
]

Delete Patient Reviews

Revert the patient's last reviewed date to the previous set

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
patientId required	string^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/reviews

production

https://api.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/reviews

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/reviews

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/reviews

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/reviews

Response samples

Content type

application/json

[{"clinicianId": "string",
"time": "2019-08-24T14:15:22Z"
}
]

Update Patient Permissions

Update permissions that a clinic has over a patient account. If all permissions are revoked as a result of the update, the patient profile will be removed from the clinic.

Only patients can change the permissions.

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
patientId required	string^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Request Body schema: application/json

custodian	object
view	object
note	object
upload	object

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/permissions

production

https://api.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/permissions

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/permissions

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/permissions

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/permissions

Request samples

Payload

Content type

application/json

{"custodian": { },
"view": { },
"note": { },
"upload": { }
}

Response samples

Content type

application/json

[{"clinicianId": "string",
"time": "2019-08-24T14:15:22Z"
}
]

Delete Patient Permission

Remove a single permission that a clinic has over a patient account. If all permissions are revoked as a result of the update, the patient profile will be removed from the clinic.

Only patients can change the permissions.

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
patientId required	string^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...
permission required	string Enum: "custodian" "view" "upload" "note"

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/permissions/{permission}

production

https://api.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/permissions/{permission}

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/permissions/{permission}

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/permissions/{permission}

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/permissions/{permission}

List Clinics for Patient

Get all clinics a user is a patient of

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

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

query Parameters

offset	integer >= 0
limit	integer >= 1 Default: 10

Responses

Response samples

Content type

application/json

[{"patient": {"id": "string",
"email": "user@example.com",
"fullName": "string",
"birthDate": "2012-08-30",
"mrn": "string",
"tags": ["stringstringstringstring"
],
"targetDevices": ["string"
],
"permissions": {"custodian": { },
"view": { },
"note": { },
"upload": { }
},
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"attestationSubmitted": true,
"dataSources": [{"state": "connected",
"providerName": "dexcom",
"dataSourceId": "stringstringstringstring",
"modifiedTime": "2017-02-06T02:37:46Z",
"expirationTime": "2017-02-06T02:37:46Z"
}
],
"lastRequestedDexcomConnectTime": "2019-08-24T14:15:22Z",
"lastUploadReminderTime": "2019-08-24T14:15:22Z",
"summary": {"cgmStats": {"config": {"schemaVersion": 0,
"highGlucoseThreshold": 0,
"veryHighGlucoseThreshold": 0,
"lowGlucoseThreshold": 0,
"veryLowGlucoseThreshold": 0
},
"dates": {"lastUpdatedDate": "2019-08-24T14:15:22Z",
"lastUpdatedReason": ["string"
],
"hasFirstData": true,
"firstData": "2019-08-24T14:15:22Z",
"hasLastData": true,
"lastData": "2019-08-24T14:15:22Z",
"hasLastUploadDate": true,
"lastUploadDate": "2019-08-24T14:15:22Z",
"hasOutdatedSince": true,
"outdatedSince": "2019-08-24T14:15:22Z",
"outdatedSinceLimit": "2019-08-24T14:15:22Z",
"outdatedReason": ["string"
]
},
"totalHours": 0,
"periods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
}
},
"offsetPeriods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
}
}
},
"bgmStats": {"config": {"schemaVersion": 0,
"highGlucoseThreshold": 0,
"veryHighGlucoseThreshold": 0,
"lowGlucoseThreshold": 0,
"veryLowGlucoseThreshold": 0
},
"dates": {"lastUpdatedDate": "2019-08-24T14:15:22Z",
"lastUpdatedReason": ["string"
],
"hasFirstData": true,
"firstData": "2019-08-24T14:15:22Z",
"hasLastData": true,
"lastData": "2019-08-24T14:15:22Z",
"hasLastUploadDate": true,
"lastUploadDate": "2019-08-24T14:15:22Z",
"hasOutdatedSince": true,
"outdatedSince": "2019-08-24T14:15:22Z",
"outdatedSinceLimit": "2019-08-24T14:15:22Z",
"outdatedReason": ["string"
]
},
"totalHours": 0,
"periods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
}
},
"offsetPeriods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
}
}
}
},
"reviews": [{"clinicianId": "string",
"time": "2019-08-24T14:15:22Z"
}
]
},
"clinic": {"id": "2fe2488217ee43e1b2e83c2f",
"address": "string",
"city": "Palo Alto",
"postalCode": "94301",
"state": "CA",
"country": "USA",
"patientTags": [{"id": "stringstringstringstring",
"name": "string"
}
],
"lastDeletedPatientTag": {"id": "stringstringstringstring",
"name": "string"
},
"phoneNumbers": [{"type": "main",
"number": "+1 (555) 555-1212"
}
],
"clinicType": "provider_practice",
"clinicSize": "0-249",
"name": "string",
"shareCode": "string",
"canMigrate": true,
"website": "http://example.com",
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"tierDescription": "Free",
"tier": "tier0100",
"preferredBgUnits": "mg/dL",
"suppressedNotifications": {"patientClinicInvitation": true
},
"timezone": "Africa/Abidjan"
}
}
]

List Clinician Invites

Retrieve a list of the outstanding invites to join a clinic

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

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

Responses

Dismiss Clinician Invite

Dismisses an invite sent from a clinic to clinician

Authorizations:

sessionToken

path Parameters

userId required	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
inviteId required	string non-empty

Responses

integration

https://external.integration.tidepool.org/v1/clinicians/{userId}/invites/{inviteId}

production

https://api.tidepool.org/v1/clinicians/{userId}/invites/{inviteId}

dev1

https://dev1.dev.tidepool.org/v1/clinicians/{userId}/invites/{inviteId}

qa1

https://qa1.development.tidepool.org/v1/clinicians/{userId}/invites/{inviteId}

qa2

https://qa2.development.tidepool.org/v1/clinicians/{userId}/invites/{inviteId}

Accept Clinician Invite

Accept an invite to join a clinic as clinician. The clinician will be associated to the currently authenticated user if the email in their profile matches the email of the invite.

Authorizations:

sessionToken

path Parameters

userId required	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
inviteId required	string non-empty

Responses

integration

https://external.integration.tidepool.org/v1/clinicians/{userId}/invites/{inviteId}

production

https://api.tidepool.org/v1/clinicians/{userId}/invites/{inviteId}

dev1

https://dev1.dev.tidepool.org/v1/clinicians/{userId}/invites/{inviteId}

qa1

https://qa1.development.tidepool.org/v1/clinicians/{userId}/invites/{inviteId}

qa2

https://qa2.development.tidepool.org/v1/clinicians/{userId}/invites/{inviteId}

Response samples

Content type

application/json

{"id": "string",
"inviteId": "string",
"email": "user@example.com",
"name": "string",
"roles": ["CLINIC_ADMIN"
],
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z"
}

List Clinics for Clinician

Returns a list of all clinics a clinician is a member of

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

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

query Parameters

offset	integer >= 0
limit	integer >= 1 Default: 10

Responses

Response samples

Content type

application/json

[{"clinician": {"id": "string",
"inviteId": "string",
"email": "user@example.com",
"name": "string",
"roles": ["CLINIC_ADMIN"
],
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z"
},
"clinic": {"id": "2fe2488217ee43e1b2e83c2f",
"address": "string",
"city": "Palo Alto",
"postalCode": "94301",
"state": "CA",
"country": "USA",
"patientTags": [{"id": "stringstringstringstring",
"name": "string"
}
],
"lastDeletedPatientTag": {"id": "stringstringstringstring",
"name": "string"
},
"phoneNumbers": [{"type": "main",
"number": "+1 (555) 555-1212"
}
],
"clinicType": "provider_practice",
"clinicSize": "0-249",
"name": "string",
"shareCode": "string",
"canMigrate": true,
"website": "http://example.com",
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"tierDescription": "Free",
"tier": "tier0100",
"preferredBgUnits": "mg/dL",
"suppressedNotifications": {"patientClinicInvitation": true
},
"timezone": "Africa/Abidjan"
}
}
]

Update Suppressed Notifications

Endpoint to update clinic suppressed notifications

Authorizations:

sessionToken

path Parameters

clinicId

required

string^[a-f0-9]{24}$

Request Body schema: application/json

required

object (Suppressed Notifications)

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/suppressed_notifications

production

https://api.tidepool.org/v1/clinics/{clinicId}/suppressed_notifications

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/suppressed_notifications

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/suppressed_notifications

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/suppressed_notifications

Request samples

Payload

Content type

application/json

{"suppressedNotifications": {"patientClinicInvitation": true
}
}

Send Upload Reminder

Sends upload reminder to the patient

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
patientId required	string^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/upload_reminder

production

https://api.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/upload_reminder

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/upload_reminder

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/upload_reminder

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/upload_reminder

Resend Dexcom connect request email

Resend Dexcom connect request to the email address of the patient

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
patientId required	string^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/send_dexcom_connect_request

production

https://api.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/send_dexcom_connect_request

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/send_dexcom_connect_request

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/send_dexcom_connect_request

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/patients/{patientId}/send_dexcom_connect_request

Response samples

Content type

application/json

{"id": "string",
"email": "user@example.com",
"fullName": "string",
"birthDate": "2012-08-30",
"mrn": "string",
"tags": ["stringstringstringstring"
],
"targetDevices": ["string"
],
"permissions": {"custodian": { },
"view": { },
"note": { },
"upload": { }
},
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"attestationSubmitted": true,
"dataSources": [{"state": "connected",
"providerName": "dexcom",
"dataSourceId": "stringstringstringstring",
"modifiedTime": "2017-02-06T02:37:46Z",
"expirationTime": "2017-02-06T02:37:46Z"
}
],
"lastRequestedDexcomConnectTime": "2019-08-24T14:15:22Z",
"lastUploadReminderTime": "2019-08-24T14:15:22Z",
"summary": {"cgmStats": {"config": {"schemaVersion": 0,
"highGlucoseThreshold": 0,
"veryHighGlucoseThreshold": 0,
"lowGlucoseThreshold": 0,
"veryLowGlucoseThreshold": 0
},
"dates": {"lastUpdatedDate": "2019-08-24T14:15:22Z",
"lastUpdatedReason": ["string"
],
"hasFirstData": true,
"firstData": "2019-08-24T14:15:22Z",
"hasLastData": true,
"lastData": "2019-08-24T14:15:22Z",
"hasLastUploadDate": true,
"lastUploadDate": "2019-08-24T14:15:22Z",
"hasOutdatedSince": true,
"outdatedSince": "2019-08-24T14:15:22Z",
"outdatedSinceLimit": "2019-08-24T14:15:22Z",
"outdatedReason": ["string"
]
},
"totalHours": 0,
"periods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
}
},
"offsetPeriods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
}
}
},
"bgmStats": {"config": {"schemaVersion": 0,
"highGlucoseThreshold": 0,
"veryHighGlucoseThreshold": 0,
"lowGlucoseThreshold": 0,
"veryLowGlucoseThreshold": 0
},
"dates": {"lastUpdatedDate": "2019-08-24T14:15:22Z",
"lastUpdatedReason": ["string"
],
"hasFirstData": true,
"firstData": "2019-08-24T14:15:22Z",
"hasLastData": true,
"lastData": "2019-08-24T14:15:22Z",
"hasLastUploadDate": true,
"lastUploadDate": "2019-08-24T14:15:22Z",
"hasOutdatedSince": true,
"outdatedSince": "2019-08-24T14:15:22Z",
"outdatedSinceLimit": "2019-08-24T14:15:22Z",
"outdatedReason": ["string"
]
},
"totalHours": 0,
"periods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
}
},
"offsetPeriods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
}
}
}
},
"reviews": [{"clinicianId": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}

List Membership Restrictions

Returns a list of the membership restrictions that will be evaluated when a user joins a clinic.

Only clinic admins can access this endpoint.

Authorizations:

sessionToken

path Parameters

clinicId

required

string^[a-f0-9]{24}$

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/membership_restrictions

production

https://api.tidepool.org/v1/clinics/{clinicId}/membership_restrictions

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/membership_restrictions

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/membership_restrictions

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/membership_restrictions

Response samples

Content type

application/json

{"restrictions": [{"emailDomain": "example.com",
"requiredIdp": "string"
}
]
}

Get Patient Count Settings

Get Patient Count settings

Authorizations:

sessionToken

path Parameters

clinicId

required

string^[a-f0-9]{24}$

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/settings/patient_count

production

https://api.tidepool.org/v1/clinics/{clinicId}/settings/patient_count

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/settings/patient_count

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/settings/patient_count

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/settings/patient_count

Response samples

Content type

application/json

{"hardLimit": {"patientCount": 0,
"startDate": "2017-02-06T02:37:46Z",
"endDate": "2017-02-06T02:37:46Z"
},
"softLimit": {"patientCount": 0,
"startDate": "2017-02-06T02:37:46Z",
"endDate": "2017-02-06T02:37:46Z"
}
}

Get Patient Count

Authorizations:

sessionToken

path Parameters

clinicId

required

string^[a-f0-9]{24}$

Responses

Response samples

Content type

application/json

{"patientCount": 0
}

Find Patients

Returns all patients to which the clinician has access to

Authorizations:

sessionToken

query Parameters

mrn	string
birthDate	string
workspaceId	string The identifier of the workspace
workspaceIdType	string Enum: "clinicId" "ehrSourceId" The type of the workspace identifier
offset	integer >= 0
limit	integer >= 1 Default: 10

Responses

Response samples

Content type

application/json

[{"patient": {"id": "string",
"email": "user@example.com",
"fullName": "string",
"birthDate": "2012-08-30",
"mrn": "string",
"tags": ["stringstringstringstring"
],
"targetDevices": ["string"
],
"permissions": {"custodian": { },
"view": { },
"note": { },
"upload": { }
},
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"attestationSubmitted": true,
"dataSources": [{"state": "connected",
"providerName": "dexcom",
"dataSourceId": "stringstringstringstring",
"modifiedTime": "2017-02-06T02:37:46Z",
"expirationTime": "2017-02-06T02:37:46Z"
}
],
"lastRequestedDexcomConnectTime": "2019-08-24T14:15:22Z",
"lastUploadReminderTime": "2019-08-24T14:15:22Z",
"summary": {"cgmStats": {"config": {"schemaVersion": 0,
"highGlucoseThreshold": 0,
"veryHighGlucoseThreshold": 0,
"lowGlucoseThreshold": 0,
"veryLowGlucoseThreshold": 0
},
"dates": {"lastUpdatedDate": "2019-08-24T14:15:22Z",
"lastUpdatedReason": ["string"
],
"hasFirstData": true,
"firstData": "2019-08-24T14:15:22Z",
"hasLastData": true,
"lastData": "2019-08-24T14:15:22Z",
"hasLastUploadDate": true,
"lastUploadDate": "2019-08-24T14:15:22Z",
"hasOutdatedSince": true,
"outdatedSince": "2019-08-24T14:15:22Z",
"outdatedSinceLimit": "2019-08-24T14:15:22Z",
"outdatedReason": ["string"
]
},
"totalHours": 0,
"periods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
}
},
"offsetPeriods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasGlucoseManagementIndicator": true,
"glucoseManagementIndicator": 7.5,
"glucoseManagementIndicatorDelta": 7.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetMinutes": true,
"timeInTargetMinutes": 200,
"timeInTargetMinutesDelta": 20,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighMinutes": true,
"timeInHighMinutes": 200,
"timeInHighMinutesDelta": 20,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighMinutes": true,
"timeInVeryHighMinutes": 200,
"timeInVeryHighMinutesDelta": 5,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighMinutes": true,
"timeInExtremeHighMinutes": 200,
"timeInExtremeHighMinutesDelta": 5,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighMinutes": true,
"timeInAnyHighMinutes": 200,
"timeInAnyHighMinutesDelta": 5,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowMinutes": true,
"timeInLowMinutes": 200,
"timeInLowMinutesDelta": 5,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowMinutes": true,
"timeInVeryLowMinutes": 200,
"timeInVeryLowMinutesDelta": 5,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowMinutes": true,
"timeInAnyLowMinutes": 200,
"timeInAnyLowMinutesDelta": 5,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTimeCGMUsePercent": true,
"timeCGMUsePercent": 0.35,
"timeCGMUsePercentDelta": 0.2,
"hasTimeCGMUseMinutes": true,
"timeCGMUseMinutes": 200,
"timeCGMUseMinutesDelta": 5,
"hasTimeCGMUseRecords": true,
"timeCGMUseRecords": 10,
"timeCGMUseRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5,
"standardDeviation": 2.5,
"standardDeviationDelta": 2.5,
"coefficientOfVariation": 2.5,
"coefficientOfVariationDelta": 2.5,
"hoursWithData": 2,
"hoursWithDataDelta": 2,
"daysWithData": 2,
"daysWithDataDelta": 2
}
}
},
"bgmStats": {"config": {"schemaVersion": 0,
"highGlucoseThreshold": 0,
"veryHighGlucoseThreshold": 0,
"lowGlucoseThreshold": 0,
"veryLowGlucoseThreshold": 0
},
"dates": {"lastUpdatedDate": "2019-08-24T14:15:22Z",
"lastUpdatedReason": ["string"
],
"hasFirstData": true,
"firstData": "2019-08-24T14:15:22Z",
"hasLastData": true,
"lastData": "2019-08-24T14:15:22Z",
"hasLastUploadDate": true,
"lastUploadDate": "2019-08-24T14:15:22Z",
"hasOutdatedSince": true,
"outdatedSince": "2019-08-24T14:15:22Z",
"outdatedSinceLimit": "2019-08-24T14:15:22Z",
"outdatedReason": ["string"
]
},
"totalHours": 0,
"periods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
}
},
"offsetPeriods": {"property1": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
},
"property2": {"hasAverageGlucoseMmol": true,
"averageGlucoseMmol": 5.5,
"averageGlucoseMmolDelta": 2.5,
"hasTimeInTargetPercent": true,
"timeInTargetPercent": 0.35,
"timeInTargetPercentDelta": 0.2,
"hasTimeInTargetRecords": true,
"timeInTargetRecords": 10,
"timeInTargetRecordsDelta": 5,
"hasTimeInHighPercent": true,
"timeInHighPercent": 0.35,
"timeInHighPercentDelta": 0.2,
"hasTimeInHighRecords": true,
"timeInHighRecords": 10,
"timeInHighRecordsDelta": 5,
"hasTimeInVeryHighPercent": true,
"timeInVeryHighPercent": 0.35,
"timeInVeryHighPercentDelta": 0.2,
"hasTimeInVeryHighRecords": true,
"timeInVeryHighRecords": 10,
"timeInVeryHighRecordsDelta": 5,
"hasTimeInExtremeHighPercent": true,
"timeInExtremeHighPercent": 0.35,
"timeInExtremeHighPercentDelta": 0.2,
"hasTimeInExtremeHighRecords": true,
"timeInExtremeHighRecords": 10,
"timeInExtremeHighRecordsDelta": 5,
"hasTimeInAnyHighPercent": true,
"timeInAnyHighPercent": 0.35,
"timeInAnyHighPercentDelta": 0.2,
"hasTimeInAnyHighRecords": true,
"timeInAnyHighRecords": 10,
"timeInAnyHighRecordsDelta": 5,
"hasTimeInLowPercent": true,
"timeInLowPercent": 0.35,
"timeInLowPercentDelta": 0.2,
"hasTimeInLowRecords": true,
"timeInLowRecords": 10,
"timeInLowRecordsDelta": 5,
"hasTimeInVeryLowPercent": true,
"timeInVeryLowPercent": 0.35,
"timeInVeryLowPercentDelta": 0.2,
"hasTimeInVeryLowRecords": true,
"timeInVeryLowRecords": 10,
"timeInVeryLowRecordsDelta": 5,
"hasTimeInAnyLowPercent": true,
"timeInAnyLowPercent": 0.35,
"timeInAnyLowPercentDelta": 0.2,
"hasTimeInAnyLowRecords": true,
"timeInAnyLowRecords": 10,
"timeInAnyLowRecordsDelta": 5,
"hasTotalRecords": true,
"totalRecords": 10,
"totalRecordsDelta": 10,
"hasAverageDailyRecords": true,
"averageDailyRecords": 3.5,
"averageDailyRecordsDelta": 2.5
}
}
}
},
"reviews": [{"clinicianId": "string",
"time": "2019-08-24T14:15:22Z"
}
]
},
"clinic": {"id": "2fe2488217ee43e1b2e83c2f",
"address": "string",
"city": "Palo Alto",
"postalCode": "94301",
"state": "CA",
"country": "USA",
"patientTags": [{"id": "stringstringstringstring",
"name": "string"
}
],
"lastDeletedPatientTag": {"id": "stringstringstringstring",
"name": "string"
},
"phoneNumbers": [{"type": "main",
"number": "+1 (555) 555-1212"
}
],
"clinicType": "provider_practice",
"clinicSize": "0-249",
"name": "string",
"shareCode": "string",
"canMigrate": true,
"website": "http://example.com",
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"tierDescription": "Free",
"tier": "tier0100",
"preferredBgUnits": "mg/dL",
"suppressedNotifications": {"patientClinicInvitation": true
},
"timezone": "Africa/Abidjan"
}
}
]

Generate Clinic Merge Report

Generates a spreadsheet report for merging two clinics

Authorizations:

sessionToken

path Parameters

clinicId

required

string^[a-f0-9]{24}$

Request Body schema: application/json

Responses

Request samples

Payload

Content type

application/json

{ }

Confirmations

Manage confirmations for account creation, sharing invites, etc.

Invite Clinician

Send an invite to clinician's email address to join a clinic.

Authorizations:

sessionToken

path Parameters

clinicId

required

string^[a-f0-9]{24}$

Request Body schema: application/json

email required	string <email> (Email Address) >= 6 characters An email address, as specified by RFC 5322.
roles required	Array of strings (Clinician Permissions) non-empty unique Items Enum: "CLINIC_ADMIN" "CLINIC_MEMBER" "PRESCRIBER"

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/invites/clinicians

production

https://api.tidepool.org/v1/clinics/{clinicId}/invites/clinicians

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/invites/clinicians

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/invites/clinicians

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/invites/clinicians

Request samples

Payload

Content type

application/json

{"email": "example@tidepool.org",
"roles": ["CLINIC_ADMIN"
]
}

Response samples

Content type

application/json

{"id": "string",
"inviteId": "string",
"email": "user@example.com",
"name": "string",
"roles": ["CLINIC_ADMIN"
],
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z"
}

Resend Clinician Invite

Resend invite to the email address of the clinician.

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
inviteId required	string non-empty

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

production

https://api.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

Response samples

Content type

application/json

{"key": "Sds2PHMALZrmt++JyD5mIjLkZruJldiM",
"type": "password_reset",
"status": "pending",
"email": "example@tidepool.org",
"creatorId": "string",
"created": "2017-02-06T02:37:46Z",
"modified": "2017-02-06T02:37:46Z",
"creator": {"userid": "string",
"profile": {"fullName": "string",
"patient": {"birthday": "2012-08-30",
"diagnosisDate": "2013-05-09",
"isOtherPerson": false,
"fullName": "James Jellyfish"
}
}
},
"context": "string",
"restrictions": {"canAccept": true,
"requiredIdp": "string"
},
"expiresAt": "2024-01-30T08:11:00Z"
}

Delete Invite

Deletes unaccepted invite

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
inviteId required	string non-empty

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

production

https://api.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

Get Clinician Invite

Retrieve an invitation sent to clinician to join the clinic

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
inviteId required	string non-empty

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

production

https://api.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/invites/clinicians/{inviteId}

Response samples

Content type

application/json

{"key": "Sds2PHMALZrmt++JyD5mIjLkZruJldiM",
"type": "password_reset",
"status": "pending",
"email": "example@tidepool.org",
"creatorId": "string",
"created": "2017-02-06T02:37:46Z",
"modified": "2017-02-06T02:37:46Z",
"creator": {"userid": "string",
"profile": {"fullName": "string",
"patient": {"birthday": "2012-08-30",
"diagnosisDate": "2013-05-09",
"isOtherPerson": false,
"fullName": "James Jellyfish"
}
}
},
"context": "string",
"restrictions": {"canAccept": true,
"requiredIdp": "string"
},
"expiresAt": "2024-01-30T08:11:00Z"
}

Get Patient Invites

Retrieve the list of all pending invites from users who would like to share their accounts with the clinic and become patients.

Authorizations:

sessionToken

path Parameters

clinicId

required

string^[a-f0-9]{24}$

Responses

Accept Patient Invitation

Accept a pending invite from a user who would like to share their account with the clinic and become a patient.

Authorizations:

sessionToken

path Parameters

clinicId required	string^[a-f0-9]{24}$
inviteId required	string non-empty

Request Body schema: application/json

fullName	string non-empty The full name of the patient
birthDate	string <date>
mrn	string non-empty The medical record number of the patient
tags	Array of strings or null (Patient Tag ID List) unique

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/invites/patients/{inviteId}

production

https://api.tidepool.org/v1/clinics/{clinicId}/invites/patients/{inviteId}

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/invites/patients/{inviteId}

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/invites/patients/{inviteId}

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/invites/patients/{inviteId}

Request samples

Payload

Content type

application/json

{"fullName": "string",
"birthDate": "2012-08-30",
"mrn": "string",
"tags": ["stringstringstringstring"
]
}

List Clinician Invites

Retrieve a list of the outstanding invites to join a clinic

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

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

Responses

Dismiss Clinician Invite

Dismisses an invite sent from a clinic to clinician

Authorizations:

sessionToken

path Parameters

userId required	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
inviteId required	string non-empty

Responses

integration

https://external.integration.tidepool.org/v1/clinicians/{userId}/invites/{inviteId}

production

https://api.tidepool.org/v1/clinicians/{userId}/invites/{inviteId}

dev1

https://dev1.dev.tidepool.org/v1/clinicians/{userId}/invites/{inviteId}

qa1

https://qa1.development.tidepool.org/v1/clinicians/{userId}/invites/{inviteId}

qa2

https://qa2.development.tidepool.org/v1/clinicians/{userId}/invites/{inviteId}

Accept Clinician Invite

Accept an invite to join a clinic as clinician. The clinician will be associated to the currently authenticated user if the email in their profile matches the email of the invite.

Authorizations:

sessionToken

path Parameters

userId required	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
inviteId required	string non-empty

Responses

integration

https://external.integration.tidepool.org/v1/clinicians/{userId}/invites/{inviteId}

production

https://api.tidepool.org/v1/clinicians/{userId}/invites/{inviteId}

dev1

https://dev1.dev.tidepool.org/v1/clinicians/{userId}/invites/{inviteId}

qa1

https://qa1.development.tidepool.org/v1/clinicians/{userId}/invites/{inviteId}

qa2

https://qa2.development.tidepool.org/v1/clinicians/{userId}/invites/{inviteId}

Response samples

Content type

application/json

{"id": "string",
"inviteId": "string",
"email": "user@example.com",
"name": "string",
"roles": ["CLINIC_ADMIN"
],
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z"
}

Send Account Signup Confirmation

Sends account signup confirmation email.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

Request Body schema: application/json

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

{"code": 100,
"error": 0,
"reason": "string"
}

Resend account signup confirmation email

If a user didn't receive the confirmation email and logs in, they're directed to the confirmation-required page which can offer to resend the confirmation email.

path Parameters

required

string <email> (Email Address) >= 6 characters

Example: example@tidepool.org

Confirmation Email

Responses

Response samples

Content type

application/json

{"code": 100,
"error": 0,
"reason": "string"
}

Accept Account Signup

Marks the account as having been verified. This would be PUT by the web page at the link in the signup email.

path Parameters

key

required

string (Confirmation key that uniquely identifies each confirmation) = 32 characters

Example: Sds2PHMALZrmt++JyD5mIjLkZruJldiM

Confirmation Key

Request Body schema: application/json

password required	string <password> (Password) [ 8 .. 72 ] characters ^\S{8,72}$ Password
birthday required	string <date> (Birthday)

Responses

Request samples

Payload

Content type

application/json

{"password": "correctbatteryhorsestaple",
"birthday": "2012-08-30"
}

Response samples

Content type

application/json

{"code": 100,
"error": 0,
"reason": "string"
}

Dismiss Account Signup

In the event that someone uses the wrong email address, the receiver could explicitly dismiss a signup

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

Request Body schema: application/json

key

required

string (Confirmation key that uniquely identifies each confirmation) = 32 characters

Responses

Request samples

Payload

Content type

application/json

{"key": "Sds2PHMALZrmt++JyD5mIjLkZruJldiM"
}

Response samples

Content type

application/json

{"code": 100,
"error": 0,
"reason": "string"
}

Get Account Signup Confirmation

Fetch latest account signup confirmation for the provided userId

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

Responses

Response samples

Content type

application/json

{"key": "Sds2PHMALZrmt++JyD5mIjLkZruJldiM",
"type": "password_reset",
"status": "pending",
"email": "example@tidepool.org",
"creatorId": "string",
"created": "2017-02-06T02:37:46Z",
"modified": "2017-02-06T02:37:46Z",
"creator": {"userid": "string",
"profile": {"fullName": "string",
"patient": {"birthday": "2012-08-30",
"diagnosisDate": "2013-05-09",
"isOtherPerson": false,
"fullName": "James Jellyfish"
}
}
},
"context": "string",
"restrictions": {"canAccept": true,
"requiredIdp": "string"
},
"expiresAt": "2024-01-30T08:11:00Z"
}

Upsert Account Signup Confirmation

Add or refresh an account signup confirmation for the provided userId

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

Request Body schema: application/json

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

{"key": "Sds2PHMALZrmt++JyD5mIjLkZruJldiM",
"type": "password_reset",
"status": "pending",
"email": "example@tidepool.org",
"creatorId": "string",
"created": "2017-02-06T02:37:46Z",
"modified": "2017-02-06T02:37:46Z",
"creator": {"userid": "string",
"profile": {"fullName": "string",
"patient": {"birthday": "2012-08-30",
"diagnosisDate": "2013-05-09",
"isOtherPerson": false,
"fullName": "James Jellyfish"
}
}
},
"context": "string",
"restrictions": {"canAccept": true,
"requiredIdp": "string"
},
"expiresAt": "2024-01-30T08:11:00Z"
}

Cancel Account Signup

Cancels the account signup.

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

Request Body schema: application/json

key

required

string (Confirmation key that uniquely identifies each confirmation) = 32 characters

Responses

Request samples

Payload

Content type

application/json

{"key": "Sds2PHMALZrmt++JyD5mIjLkZruJldiM"
}

Response samples

Content type

application/json

{"code": 100,
"error": 0,
"reason": "string"
}

Send Password Reset Email

If the request is correctly formed, always returns a 200, even if the email address was not found (this way it can't be used to validate email addresses). If the email address is found in the Tidepool system, this will:

Create a confirm record and a random key
Send an email with a link containing the key

path Parameters

required

string <email> (Email Address) >= 6 characters

Example: example@tidepool.org

Confirmation Email

Responses

Response samples

Content type

application/json

{"code": 100,
"error": 0,
"reason": "string"
}

Accept password change

Accept the password change This endpoint will be invoked by the lost password screen with the key that was included in the URL of the lost password screen.

Request Body schema: application/json

string <password> (Password) [ 8 .. 72 ] characters ^\S{8,72}$

Password

Responses

Request samples

Payload

Content type

application/json

"correctbatteryhorsestaple"

Response samples

Content type

application/json

{"code": 100,
"error": 0,
"reason": "string"
}

Send Invitation to Join Care Team

Sends an invitation to join the care team of the user identified by userId.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

Request Body schema: application/json

email required	string <email> (Email Address) >= 6 characters An email address, as specified by RFC 5322.
required	object
nickname	string A user-friendly name for the recipient of the invitation.
	object (alertsconfig.v1) non-empty Configuration for alerts triggered in response to the status of a user's device and data.

Responses

Request samples

Payload

Content type

application/json

{"email": "example@tidepool.org",
"permissions": {"note": { },
"upload": { },
"view": { }
},
"nickname": "Julia",
"alertsConfig": {"urgentLow": {"enabled": false,
"threshold": {"units": "mg/dL",
"value": 105
}
},
"low": {"enabled": false,
"delay": 0,
"repeat": 0,
"threshold": {"units": "mg/dL",
"value": 105
}
},
"high": {"enabled": false,
"delay": 0,
"repeat": 0,
"threshold": {"units": "mg/dL",
"value": 105
}
},
"noCommunication": {"enabled": false,
"delay": 0
},
"notLooping": {"enabled": false,
"delay": 0
}
}
}

Response samples

Content type

application/json

{"key": "Sds2PHMALZrmt++JyD5mIjLkZruJldiM",
"type": "password_reset",
"status": "pending",
"email": "example@tidepool.org",
"creatorId": "string",
"created": "2017-02-06T02:37:46Z",
"modified": "2017-02-06T02:37:46Z",
"creator": {"userid": "string",
"profile": {"fullName": "string",
"patient": {"birthday": "2012-08-30",
"diagnosisDate": "2013-05-09",
"isOtherPerson": false,
"fullName": "James Jellyfish"
}
}
},
"context": "string",
"restrictions": {"canAccept": true,
"requiredIdp": "string"
},
"expiresAt": "2024-01-30T08:11:00Z"
}

Accept Invitation to Join Care Team

Accepts the invitation to join a care team.

Authorizations:

sessionToken

path Parameters

userId required	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... Tidepool User ID
invitedBy required	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... Invited by User ID

Request Body schema: application/json

key

required

string (Confirmation key that uniquely identifies each confirmation) = 32 characters

Responses

integration

https://external.integration.tidepool.org/confirm/accept/invite/{userId}/{invitedBy}

production

https://api.tidepool.org/confirm/accept/invite/{userId}/{invitedBy}

dev1

https://dev1.dev.tidepool.org/confirm/accept/invite/{userId}/{invitedBy}

qa1

https://qa1.development.tidepool.org/confirm/accept/invite/{userId}/{invitedBy}

qa2

https://qa2.development.tidepool.org/confirm/accept/invite/{userId}/{invitedBy}

Request samples

Payload

Content type

application/json

{"key": "Sds2PHMALZrmt++JyD5mIjLkZruJldiM"
}

Response samples

Content type

application/json

{"code": 100,
"error": 0,
"reason": "string"
}

Get Pending Care Team Invitations

Returns the still-pending invitations for an account you own or are an admin of. These are the invitations you have sent that have not been accepted. There is no way to tell if an invitation has been ignored.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

Responses

Response samples

Content type

application/json

[{"key": "Sds2PHMALZrmt++JyD5mIjLkZruJldiM",
"type": "password_reset",
"status": "pending",
"email": "example@tidepool.org",
"creatorId": "string",
"created": "2017-02-06T02:37:46Z",
"modified": "2017-02-06T02:37:46Z",
"creator": {"userid": "string",
"profile": {"fullName": "string",
"patient": {"birthday": "2012-08-30",
"diagnosisDate": "2013-05-09",
"isOtherPerson": false,
"fullName": "James Jellyfish"
}
}
},
"context": "string",
"restrictions": {"canAccept": true,
"requiredIdp": "string"
},
"expiresAt": "2024-01-30T08:11:00Z"
}
]

Get Received Care Team Invitations

Get list of received invitations for logged in user. These are invitations that have been sent to this user but not yet acted upon.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

Responses

Response samples

Content type

application/json

[{"key": "Sds2PHMALZrmt++JyD5mIjLkZruJldiM",
"type": "password_reset",
"status": "pending",
"email": "example@tidepool.org",
"creatorId": "string",
"created": "2017-02-06T02:37:46Z",
"modified": "2017-02-06T02:37:46Z",
"creator": {"userid": "string",
"profile": {"fullName": "string",
"patient": {"birthday": "2012-08-30",
"diagnosisDate": "2013-05-09",
"isOtherPerson": false,
"fullName": "James Jellyfish"
}
}
},
"context": "string",
"restrictions": {"canAccept": true,
"requiredIdp": "string"
},
"expiresAt": "2024-01-30T08:11:00Z"
}
]

Dismiss Care Team Invitation

Declines the invitation to join a care team.

Authorizations:

sessionToken

path Parameters

userId required	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... Tidepool User ID
invitedBy required	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... Invited by User ID

Request Body schema: application/json

key

required

string (Confirmation key that uniquely identifies each confirmation) = 32 characters

Responses

integration

https://external.integration.tidepool.org/confirm/dismiss/invite/{userId}/{invitedBy}

production

https://api.tidepool.org/confirm/dismiss/invite/{userId}/{invitedBy}

dev1

https://dev1.dev.tidepool.org/confirm/dismiss/invite/{userId}/{invitedBy}

qa1

https://qa1.development.tidepool.org/confirm/dismiss/invite/{userId}/{invitedBy}

qa2

https://qa2.development.tidepool.org/confirm/dismiss/invite/{userId}/{invitedBy}

Request samples

Payload

Content type

application/json

{"key": "Sds2PHMALZrmt++JyD5mIjLkZruJldiM"
}

Response samples

Content type

application/json

{"code": 100,
"error": 0,
"reason": "string"
}

Cancel Care Team Invitation

Cancels an invitation that has been sent to an email address.

Authorizations:

sessionToken

path Parameters

userId required	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... Tidepool User ID
invitedBy required	string <email> (Email Address) >= 6 characters Example: example@tidepool.org Invited by Email Address

Responses

Response samples

Content type

application/json

{"code": 100,
"error": 0,
"reason": "string"
}

Redox

Public endpoints invoked by Redox.

Data

Manages diabetes data in user's Tidepool account.

Device Model Name

string (Device Model Name) non-empty

A string identifying the model of the device.

The deviceModel is a non-empty string that encodes the model of device. We endeavor to match each manufacturer's standard for how they represent model name in terms of casing, whether parts of the name are represented as one word or two, etc.

"Devicey McDeviceface"

Device ID

string (Device ID) non-empty

Device identifier, if provided by the manufacturer.

"MMT-1711:12345678"

Blood Unit (mg/dL)

string (Blood Unit (mg/dL))

Enum: "mg/dL" "mg/dl"

"mg/dL"

Blood Value (mg/dL)

integer <int32> (Blood Value (mg/dL)) [ 0 .. 1000 ]

An integer value representing a mg/dL value.

105

Blood Glucose (mg/dL)

units required	string (Blood Unit (mg/dL)) Enum: "mg/dL" "mg/dl"
value required	integer <int32> (Blood Value (mg/dL)) [ 0 .. 1000 ] An integer value representing a `mg/dL` value.

{"units": "mg/dL",
"value": 105
}

Blood Unit (mmol/L)

string (Blood Unit (mmol/L))

Enum: "mmol/L" "mmol/l"

"mmol/L"

Blood Value (mmol/L)

number <float> (Blood Value (mmol/L)) >= 0

A floating point value representing a mmol/L value.

5.5

Blood Glucose (mmol/L)

units required	string (Blood Unit (mmol/L)) Enum: "mmol/L" "mmol/l"
value required	number <float> (Blood Value (mmol/L)) >= 0 A floating point value representing a `mmol/L` value.

{"units": "mmol/L",
"value": 5.5
}

Blood Glucose

One of

units required	string (Blood Unit (mg/dL)) Enum: "mg/dL" "mg/dl"
value required	integer <int32> (Blood Value (mg/dL)) [ 0 .. 1000 ] An integer value representing a `mg/dL` value.

Example

Blood Glucose (mg/dL)

{"units": "mg/dL",
"value": 105
}

Client Software Platform

string (Client Software Platform)

The software platform on which the client software was run.

"macOS 10.15.4"

Metadata

property name*

additional property

any

{ }

Client Software

name required	string (Reverse Domain Name) ^[a-zA-Z0-9](\|[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])(... Name in the reverse domain name notation.
version required	string (Semantic Version Number) >= 5 characters ^(0\|[1-9]\d)\.(0\|[1-9]\d)\.(0\|[1-9]\d*)(?:-... Semantic Version Number 2.0.0. Regex from their site.
platform	string (Client Software Platform) The software platform on which the client software was run.
	object (Metadata)

{"name": "org.tidepool.uploader",
"version": "2.36.1",
"platform": "macOS 10.15.4",
"private": { }
}

Clock Drift Offset

integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ]

Clock drift offset, expressed as milliseconds.

0

Computer Time

string <time> (Computer Time)

An ISO 8601 formatted timestamp without any timezone offset information.

The computerTime field encodes the local time at upload with no timezone offset information since we are storing timezone separately. We store this field in order to be able to audit and/or detect the correspondence between the user's browser time and the timezone they selected at the time of upload. If the user selected the timezone that was actually in effect for their browser at the time of upload, then applying the stored timezone to the UTC Zulu time field will match computerTime. If, on the other hand, the user selected a different timezone from that effective in their browser at the time of upload, applying the timezone to time will not match computerTime.

There are some use cases when it is perfectly justified to select a timezone that does not reflect the browser's current timezone. For example, some insulin pump users do not change the time on their devices when traveling for short periods of time across many timezones, but when uploading a device a user should always choose the timezone that aligns with the most recent data on the device and thus that will not match the local browser timezone.

"14:15:22Z"

Conversion Offset

integer <int64> (Conversion Offset)

Conversion offset, expressed as milliseconds.

0

Data Set Type

string (Data Set Type)

Enum: "continuous" "normal"

"continuous"

Deduplicator Descriptor

hash	string non-empty
version required	string (Semantic Version Number) >= 5 characters ^(0\|[1-9]\d)\.(0\|[1-9]\d)\.(0\|[1-9]\d*)(?:-... Semantic Version Number 2.0.0. Regex from their site.
name required	string (Reverse Domain Name) ^[a-zA-Z0-9](\|[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])(... Name in the reverse domain name notation.

{"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
}

Device Manufacturers

Array

string

["DeviceCo"
]

Device Serial Number

string (Device Serial Number) non-empty

A string encoding the device's serial number.

The deviceSerialNumber is a string that encodes the serial number of the device. Note that even if a manufacturer only uses digits in its serial numbers, the SN should be stored as a string regardless.

Uniquely of string fields in the Tidepool device data models, deviceSerialNumber may be an empty string. This is essentially a compromise: having the device serial number is extremely important (especially for e.g., clinical studies) but in 2016 we came across our first case where we cannot recover the serial number of the device that generated the data: Dexcom G5 data uploaded to Tidepool through Apple iOS's HealthKit integration.

"B97B6D59"

Device Tag

string (Device Tag) <= 100 characters

Enum: "bgm" "cgm" "insulin-pump" "fgm" "pen" "manual"

Tag indicating the function(s) of a particular device.

"bgm"

Device Tags

Array (non-empty)

string (Device Tag) <= 100 characters

Enum: "bgm" "cgm" "insulin-pump" "fgm" "pen" "manual"

Tag indicating the function(s) of a particular device.

["bgm"
]

Data Set ID

string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}|upid_[0-9a-f]{32}|[0-9a-f...

"ce8cc5f7595575945f91fc6710db6fef"

Time Processing

string (Time Processing)

Enum: "none" "across-the-board-timezone" "utc-bootstrapping"

A string indicating what variety of processing was used to create the time and related fields such as timezoneOffset on data in this upload.

For data auditing purposes, we store a string encoding the type of algorithm used to generate the time, timezoneOffset, and other related fields from the local deviceTime. At present, there are only three options for this value:

none for data sources that already include a UTC-anchored time value. At present, the only data source for which this is true is Dexcom G5 or Dexcom G6 data coming through Apple's iOS HealthKit integration.
across-the-board-timezone for devices (all BGMs, for example) that cannot have their deviceTime values "bootstrapped" to a UTC time value; in such cases, we apply a single user-selected timezone to every deviceTime "across the board" to generate the time value.
utc-bootstrapping for devices (most insulin pumps and CGMs) where we use a combination of the user-selected timezone at time of upload, the most recent timestamp on device, and the history of display time changes on the device to infer the correct time value for each record.

"utc-bootstrapping"

Time Zone

string (Time Zone)

A string timezone name from the IANA timezone database

"Europe/London"

Time Zone offset

integer <int32> (Time Zone offset) [ -10080 .. 10080 ]

Time zone offset, expressed as positive or negative number of minutes from UTC.

-420

Upload ID

string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}|upid_[0-9a-f]{12})$

"0d92d5c1c22117a18f3620b9e24d3c06"

Tidepool Data Set

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
byUser	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Client Software) The client software that provided diabetes data.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
computerTime	string <time> (Computer Time) An ISO 8601 formatted timestamp without any timezone offset information. The `computerTime` field encodes the local time at upload with no timezone offset information since we are storing `timezone` separately. We store this field in order to be able to audit and/or detect the correspondence between the user's browser time and the timezone they selected at the time of upload. If the user selected the timezone that was actually in effect for their browser at the time of upload, then applying the stored `timezone` to the UTC Zulu `time` field will match `computerTime`. If, on the other hand, the user selected a different timezone from that effective in their browser at the time of upload, applying the `timezone` to `time` will not match `computerTime`. There are some use cases when it is perfectly justified to select a timezone that does not reflect the browser's current timezone. For example, some insulin pump users do not change the time on their devices when traveling for short periods of time across many timezones, but when uploading a device a user should always choose the timezone that aligns with the most recent data on the device and thus that will not match the local browser timezone.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
dataSetType	string (Data Set Type) Enum: "continuous" "normal"
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceManufacturers	Array of strings (Device Manufacturers) An array of string tags indicating the manufacturer(s) of the device. In order to avoid confusion resulting from referring to a single manufacturer with more than one name—for example, using both 'Minimed' and 'Medtronic' interchangeably—we restrict the set of strings used to refer to manufacturers to the set listed above and enforce exact string matches (including casing). `deviceManufacturers` is an array of one or more string "tags" because there are devices resulting from a collaboration between more than one manufacturer, such as the Tandem G4 insulin pump with CGM integration (a collaboration between `Tandem` and `Dexcom`).
deviceModel	string (Device Model Name) non-empty A string identifying the model of the device. The `deviceModel` is a non-empty string that encodes the model of device. We endeavor to match each manufacturer's standard for how they represent model name in terms of casing, whether parts of the name are represented as one word or two, etc.
deviceSerialNumber	string (Device Serial Number) non-empty A string encoding the device's serial number. The `deviceSerialNumber` is a string that encodes the serial number of the device. Note that even if a manufacturer only uses digits in its serial numbers, the SN should be stored as a string regardless. Uniquely of string fields in the Tidepool device data models, `deviceSerialNumber` may be an empty string. This is essentially a compromise: having the device serial number is extremely important (especially for e.g., clinical studies) but in 2016 we came across our first case where we cannot recover the serial number of the device that generated the data: Dexcom G5 data uploaded to Tidepool through Apple iOS's HealthKit integration.
deviceTags	Array of strings (Device Tags) non-empty [ items <= 100 characters ] Items Enum: "bgm" "cgm" "insulin-pump" "fgm" "pen" "manual" An array of string tags indicating the function(s) of the device. The `deviceTags` array should be fairly self-explanatory as an array of tags indicating the function(s) of a particular device. For example, the Insulet OmniPod insulin delivery system has the tags `bgm` and `insulin-pump` since the PDM is both an insulin pump controller and includes a built-in blood glucose monitor.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
id	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string
time	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timeProcessing	string (Time Processing) Enum: "none" "across-the-board-timezone" "utc-bootstrapping" A string indicating what variety of processing was used to create the `time` and related fields such as `timezoneOffset` on data in this upload. For data auditing purposes, we store a string encoding the type of algorithm used to generate the `time`, `timezoneOffset`, and other related fields from the local `deviceTime`. At present, there are only three options for this value: `none` for data sources that already include a UTC-anchored `time` value. At present, the only data source for which this is true is Dexcom G5 or Dexcom G6 data coming through Apple's iOS HealthKit integration. `across-the-board-timezone` for devices (all BGMs, for example) that cannot have their `deviceTime` values "bootstrapped" to a UTC `time` value; in such cases, we apply a single user-selected timezone to every `deviceTime` "across the board" to generate the `time` value. `utc-bootstrapping` for devices (most insulin pumps and CGMs) where we use a combination of the user-selected timezone at time of upload, the most recent timestamp on device, and the history of display time changes on the device to infer the correct `time` value for each record.
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type	string Value: "upload"
version	string (Semantic Version Number) >= 5 characters ^(0\|[1-9]\d)\.(0\|[1-9]\d)\.(0\|[1-9]\d*)(?:-... Semantic Version Number 2.0.0. Regex from their site.
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$

{"type": "upload",
"client": {"name": "com.devicecorp.tidepooluploader",
"version": "0.100.0"
},
"dataSetType": "normal",
"deduplicator": {"name": "org.tidepool.deduplicator.device.deactivate.hash",
"version": "1.2.3"
},
"deviceManufacturers": ["DeviceCorp"
],
"deviceModel": "Devicey McDeviceface",
"deviceSerialNumber": "B97B6D59",
"deviceTags": ["bgm",
"cgm",
"insulin-pump"
],
"timeProcessing": "none",
"timezone": "Europe/London",
"clockDriftOffset": 0,
"conversionOffset": 0,
"deviceId": "DevId0987654321",
"deviceTime": "2016-06-27T18:09:55",
"time": "2016-06-28T01:09:55.132Z",
"timezoneOffset": -420
}

Tidepool Data Set Array

Array

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
byUser	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Client Software) The client software that provided diabetes data.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
computerTime	string <time> (Computer Time) An ISO 8601 formatted timestamp without any timezone offset information. The `computerTime` field encodes the local time at upload with no timezone offset information since we are storing `timezone` separately. We store this field in order to be able to audit and/or detect the correspondence between the user's browser time and the timezone they selected at the time of upload. If the user selected the timezone that was actually in effect for their browser at the time of upload, then applying the stored `timezone` to the UTC Zulu `time` field will match `computerTime`. If, on the other hand, the user selected a different timezone from that effective in their browser at the time of upload, applying the `timezone` to `time` will not match `computerTime`. There are some use cases when it is perfectly justified to select a timezone that does not reflect the browser's current timezone. For example, some insulin pump users do not change the time on their devices when traveling for short periods of time across many timezones, but when uploading a device a user should always choose the timezone that aligns with the most recent data on the device and thus that will not match the local browser timezone.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
dataSetType	string (Data Set Type) Enum: "continuous" "normal"
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceManufacturers	Array of strings (Device Manufacturers) An array of string tags indicating the manufacturer(s) of the device. In order to avoid confusion resulting from referring to a single manufacturer with more than one name—for example, using both 'Minimed' and 'Medtronic' interchangeably—we restrict the set of strings used to refer to manufacturers to the set listed above and enforce exact string matches (including casing). `deviceManufacturers` is an array of one or more string "tags" because there are devices resulting from a collaboration between more than one manufacturer, such as the Tandem G4 insulin pump with CGM integration (a collaboration between `Tandem` and `Dexcom`).
deviceModel	string (Device Model Name) non-empty A string identifying the model of the device. The `deviceModel` is a non-empty string that encodes the model of device. We endeavor to match each manufacturer's standard for how they represent model name in terms of casing, whether parts of the name are represented as one word or two, etc.
deviceSerialNumber	string (Device Serial Number) non-empty A string encoding the device's serial number. The `deviceSerialNumber` is a string that encodes the serial number of the device. Note that even if a manufacturer only uses digits in its serial numbers, the SN should be stored as a string regardless. Uniquely of string fields in the Tidepool device data models, `deviceSerialNumber` may be an empty string. This is essentially a compromise: having the device serial number is extremely important (especially for e.g., clinical studies) but in 2016 we came across our first case where we cannot recover the serial number of the device that generated the data: Dexcom G5 data uploaded to Tidepool through Apple iOS's HealthKit integration.
deviceTags	Array of strings (Device Tags) non-empty [ items <= 100 characters ] Items Enum: "bgm" "cgm" "insulin-pump" "fgm" "pen" "manual" An array of string tags indicating the function(s) of the device. The `deviceTags` array should be fairly self-explanatory as an array of tags indicating the function(s) of a particular device. For example, the Insulet OmniPod insulin delivery system has the tags `bgm` and `insulin-pump` since the PDM is both an insulin pump controller and includes a built-in blood glucose monitor.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
id	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string
time	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timeProcessing	string (Time Processing) Enum: "none" "across-the-board-timezone" "utc-bootstrapping" A string indicating what variety of processing was used to create the `time` and related fields such as `timezoneOffset` on data in this upload. For data auditing purposes, we store a string encoding the type of algorithm used to generate the `time`, `timezoneOffset`, and other related fields from the local `deviceTime`. At present, there are only three options for this value: `none` for data sources that already include a UTC-anchored `time` value. At present, the only data source for which this is true is Dexcom G5 or Dexcom G6 data coming through Apple's iOS HealthKit integration. `across-the-board-timezone` for devices (all BGMs, for example) that cannot have their `deviceTime` values "bootstrapped" to a UTC `time` value; in such cases, we apply a single user-selected timezone to every `deviceTime` "across the board" to generate the `time` value. `utc-bootstrapping` for devices (most insulin pumps and CGMs) where we use a combination of the user-selected timezone at time of upload, the most recent timestamp on device, and the history of display time changes on the device to infer the correct `time` value for each record.
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type	string Value: "upload"
version	string (Semantic Version Number) >= 5 characters ^(0\|[1-9]\d)\.(0\|[1-9]\d)\.(0\|[1-9]\d*)(?:-... Semantic Version Number 2.0.0. Regex from their site.
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$

[{"type": "upload",
"client": {"name": "com.devicecorp.tidepooluploader",
"version": "0.100.0"
},
"dataSetType": "normal",
"deduplicator": {"name": "org.tidepool.deduplicator.device.deactivate.hash",
"version": "1.2.3"
},
"deviceManufacturers": ["DeviceCorp"
],
"deviceModel": "Devicey McDeviceface",
"deviceSerialNumber": "B97B6D59",
"deviceTags": ["bgm",
"cgm",
"insulin-pump"
],
"timeProcessing": "none",
"timezone": "Europe/London",
"clockDriftOffset": 0,
"conversionOffset": 0,
"deviceId": "DevId0987654321",
"deviceTime": "2016-06-27T18:09:55",
"time": "2016-06-28T01:09:55.132Z",
"timezoneOffset": -420
}
]

New Tidepool Diabetes Data Set

	object (Client Software) The client software that provided diabetes data.
dataSetType required	string (Data Set Type) Enum: "continuous" "normal"
deviceId required	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceManufacturers required	Array of strings (Device Manufacturers) An array of string tags indicating the manufacturer(s) of the device. In order to avoid confusion resulting from referring to a single manufacturer with more than one name—for example, using both 'Minimed' and 'Medtronic' interchangeably—we restrict the set of strings used to refer to manufacturers to the set listed above and enforce exact string matches (including casing). `deviceManufacturers` is an array of one or more string "tags" because there are devices resulting from a collaboration between more than one manufacturer, such as the Tandem G4 insulin pump with CGM integration (a collaboration between `Tandem` and `Dexcom`).
deviceModel required	string (Device Model Name) non-empty A string identifying the model of the device. The `deviceModel` is a non-empty string that encodes the model of device. We endeavor to match each manufacturer's standard for how they represent model name in terms of casing, whether parts of the name are represented as one word or two, etc.
deviceSerialNumber required	string (Device Serial Number) non-empty A string encoding the device's serial number. The `deviceSerialNumber` is a string that encodes the serial number of the device. Note that even if a manufacturer only uses digits in its serial numbers, the SN should be stored as a string regardless. Uniquely of string fields in the Tidepool device data models, `deviceSerialNumber` may be an empty string. This is essentially a compromise: having the device serial number is extremely important (especially for e.g., clinical studies) but in 2016 we came across our first case where we cannot recover the serial number of the device that generated the data: Dexcom G5 data uploaded to Tidepool through Apple iOS's HealthKit integration.
deviceTags	Array of strings (Device Tags) non-empty [ items <= 100 characters ] Items Enum: "bgm" "cgm" "insulin-pump" "fgm" "pen" "manual" An array of string tags indicating the function(s) of the device. The `deviceTags` array should be fairly self-explanatory as an array of tags indicating the function(s) of a particular device. For example, the Insulet OmniPod insulin delivery system has the tags `bgm` and `insulin-pump` since the PDM is both an insulin pump controller and includes a built-in blood glucose monitor.
	object (Deduplicator Descriptor)
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timeProcessing required	string (Time Processing) Enum: "none" "across-the-board-timezone" "utc-bootstrapping" A string indicating what variety of processing was used to create the `time` and related fields such as `timezoneOffset` on data in this upload. For data auditing purposes, we store a string encoding the type of algorithm used to generate the `time`, `timezoneOffset`, and other related fields from the local `deviceTime`. At present, there are only three options for this value: `none` for data sources that already include a UTC-anchored `time` value. At present, the only data source for which this is true is Dexcom G5 or Dexcom G6 data coming through Apple's iOS HealthKit integration. `across-the-board-timezone` for devices (all BGMs, for example) that cannot have their `deviceTime` values "bootstrapped" to a UTC `time` value; in such cases, we apply a single user-selected timezone to every `deviceTime` "across the board" to generate the `time` value. `utc-bootstrapping` for devices (most insulin pumps and CGMs) where we use a combination of the user-selected timezone at time of upload, the most recent timestamp on device, and the history of display time changes on the device to infer the correct `time` value for each record.
timezone required	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset required	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.

{"client": {"name": "org.tidepool.uploader",
"version": "2.36.1",
"platform": "macOS 10.15.4",
"private": { }
},
"dataSetType": "continuous",
"deviceId": "MMT-1711:12345678",
"deviceManufacturers": ["DeviceCo"
],
"deviceModel": "Devicey McDeviceface",
"deviceSerialNumber": "B97B6D59",
"deviceTags": ["bgm"
],
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"time": "2017-02-06T02:37:46Z",
"timeProcessing": "utc-bootstrapping",
"timezone": "Europe/London",
"timezoneOffset": -420
}

Data Set State

string (Data Set State)

Enum: "open" "closed"

"open"

Tidepool Data Array

deviceId required	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceModel required	string (Device Model Name) non-empty A string identifying the model of the device. The `deviceModel` is a non-empty string that encodes the model of device. We endeavor to match each manufacturer's standard for how they represent model name in terms of casing, whether parts of the name are represented as one word or two, etc.
deviceSerialNumber required	string (Device Serial Number) non-empty A string encoding the device's serial number. The `deviceSerialNumber` is a string that encodes the serial number of the device. Note that even if a manufacturer only uses digits in its serial numbers, the SN should be stored as a string regardless. Uniquely of string fields in the Tidepool device data models, `deviceSerialNumber` may be an empty string. This is essentially a compromise: having the device serial number is extremely important (especially for e.g., clinical studies) but in 2016 we came across our first case where we cannot recover the serial number of the device that generated the data: Dexcom G5 data uploaded to Tidepool through Apple iOS's HealthKit integration.
state required	string (Data Set State) Enum: "open" "closed"
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone required	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset required	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.

{"deviceId": "MMT-1711:12345678",
"deviceModel": "Devicey McDeviceface",
"deviceSerialNumber": "B97B6D59",
"state": "open",
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420
}

Event History [Proposed]

Array

time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
required	JSONPatch (object) or JSONPatch (object) or JSONPatch (object) (JSONPatch) 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

[{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
]

Tidepool Data Type

string (Tidepool Data Type)

Enum: "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard"

Data type

"upload"

Base

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "upload",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06"
}

Alert

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
name required	string [ 1 .. 100 ] characters
priority	string Enum: "critical" "normal" "timeSensitive"
trigger	string Enum: "delayed" "immediate" "repeating"
triggerDelay	integer <int32> [ 0 .. 86400 ]
sound	string Enum: "name" "silence" "vibrate"
soundName	string [ 1 .. 100 ] characters
issuedTime required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
acknowledgedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
retractedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "alert",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"name": "string",
"priority": "critical",
"trigger": "delayed",
"triggerDelay": 86400,
"sound": "name",
"soundName": "string",
"issuedTime": "2017-02-06T02:37:46Z",
"acknowledgedTime": "2017-02-06T02:37:46Z",
"retractedTime": "2017-02-06T02:37:46Z"
}

Delivery Type

string (Delivery Type)

Enum: "automated" "scheduled" "suspend" "temp"

This defines the basal delivery type, used to differentiate between automated, scheduled, suspended and temporary basal types.

"automated"

Insulin Compound

amount

required

number <double> >= 0

{"amount": 0.1
}

Insulin Compound Array

Array ([ 1 .. 100 ] items)

amount

required

number <double> >= 0

[{"amount": 0.1
}
]

Insulin Concentration

value required	number <double> [ 0 .. 10000 ]
units required	string Value: "Units/mL"

{"value": 10000,
"units": "Units/mL"
}

Insulin Simple

actingType required	string Enum: "intermediate" "long" "rapid" "short"
brand	string [ 1 .. 100 ] characters
	object (Insulin Concentration)

{"actingType": "intermediate",
"brand": "string",
"concentration": {"value": 10000,
"units": "Units/mL"
}
}

Insulin Formulation

One of

	Array of objects (Insulin Compound Array) [ 1 .. 100 ] items
name	string [ 1 .. 100 ] characters

{"simple": {"actingType": "intermediate",
"brand": "string",
"concentration": {"value": 10000,
"units": "Units/mL"
}
},
"name": "string"
}

Basal Suppressed Scheduled

type	string Value: "basal"
deliveryType	string Value: "scheduled"
rate	number <double> (Insulin Delivery Rate) [ 0 .. 100 ] A floating point number >= 0 representing the amount of insulin delivered in units per hour.
	Insulin Formulation (object) or Insulin Formulation (object) (Insulin Formulation)
scheduleName	string (Insulin Delivery Schedule Name) [ 1 .. 1000 ] characters The name of the basal schedule.
	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.

{"type": "basal",
"deliveryType": "scheduled",
"rate": 100,
"insulinFormulation": {"compounds": [{"amount": 0.1
}
],
"name": "string"
},
"scheduleName": "string",
"annotations": [{"code": "wrong-device-time"
}
]
}

Basal Automated

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "basal" "alert" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
deliveryType required	string (Delivery Type) Enum: "automated" "scheduled" "suspend" "temp" This defines the basal delivery type, used to differentiate between automated, scheduled, suspended and temporary basal types.
duration required	integer <int64> (Insulin Delivery Duration) [ 0 .. 604800000 ] An integer value representing a duration of time in milliseconds.
expectedDuration	integer <int64> (Expected Insulin Delivery Duration) [ 0 .. 604800000 ] 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. `expectedDuration` cannot be less than the value of `duration`
	Insulin Formulation (object) or Insulin Formulation (object) (Insulin Formulation)
rate required	number <double> (Insulin Delivery Rate) [ 0 .. 100 ] A floating point number >= 0 representing the amount of insulin delivered in units per hour.
scheduleName	string (Insulin Delivery Schedule Name) [ 1 .. 1000 ] characters The name of the basal schedule.
	object (Basal Suppressed Scheduled)

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "basal",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"deliveryType": "automated",
"duration": 604800000,
"expectedDuration": 604800000,
"insulinFormulation": {"compounds": [{"amount": 0.1
}
],
"name": "string"
},
"rate": 100,
"scheduleName": "string",
"suppressed": {"type": "basal",
"deliveryType": "scheduled",
"rate": 100,
"insulinFormulation": {"compounds": [{"amount": 0.1
}
],
"name": "string"
},
"scheduleName": "string",
"annotations": [{"code": "wrong-device-time"
}
]
}
}

Basal Scheduled

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "basal" "alert" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
deliveryType	string (Delivery Type) Enum: "scheduled" "automated" "suspend" "temp" This defines the basal delivery type, used to differentiate between automated, scheduled, suspended and temporary basal types.
duration	integer <int64> (Insulin Delivery Duration) [ 0 .. 604800000 ] An integer value representing a duration of time in milliseconds.
expectedDuration	integer <int64> (Expected Insulin Delivery Duration) [ 0 .. 604800000 ] 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. `expectedDuration` cannot be less than the value of `duration`
	Insulin Formulation (object) or Insulin Formulation (object) (Insulin Formulation)
rate	number <double> (Insulin Delivery Rate) [ 0 .. 100 ] A floating point number >= 0 representing the amount of insulin delivered in units per hour.
scheduleName	string (Insulin Delivery Schedule Name) [ 1 .. 1000 ] characters The name of the basal schedule.

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "basal",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"deliveryType": "scheduled",
"duration": 604800000,
"expectedDuration": 604800000,
"insulinFormulation": {"compounds": [{"amount": 0.1
}
],
"name": "string"
},
"rate": 100,
"scheduleName": "string"
}

Basal Suppressed Automated

type	string Value: "basal"
deliveryType	string Value: "automated"
	object (Basal Suppressed Scheduled)
scheduleName	string (Insulin Delivery Schedule Name) [ 1 .. 1000 ] characters The name of the basal schedule.
rate	number <double> (Insulin Delivery Rate) [ 0 .. 100 ] A floating point number >= 0 representing the amount of insulin delivered in units per hour.
	Insulin Formulation (object) or Insulin Formulation (object) (Insulin Formulation)
	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.

{"type": "basal",
"deliveryType": "automated",
"suppressed": {"type": "basal",
"deliveryType": "scheduled",
"rate": 100,
"insulinFormulation": {"compounds": [{"amount": 0.1
}
],
"name": "string"
},
"scheduleName": "string",
"annotations": [{"code": "wrong-device-time"
}
]
},
"scheduleName": "string",
"rate": 100,
"insulinFormulation": {"compounds": [{"amount": 0.1
}
],
"name": "string"
},
"annotations": [{"code": "wrong-device-time"
}
]
}

Basal Suppressed Temporary

type	string Value: "basal"
deliveryType	string Value: "temporary"
	Basal Suppressed Automated (object) or Basal Suppressed Scheduled (object)
rate	number <double> (Insulin Delivery Rate) [ 0 .. 100 ] A floating point number >= 0 representing the amount of insulin delivered in units per hour.
percent	number <float> (Insulin Delivery Percentage) [ 0 .. 10 ] Floating point value representing a percentage, where 1.0 represents 100%.
	Insulin Formulation (object) or Insulin Formulation (object) (Insulin Formulation)
	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.

{"type": "basal",
"deliveryType": "temporary",
"suppressed": {"type": "basal",
"deliveryType": "automated",
"suppressed": {"type": "basal",
"deliveryType": "scheduled",
"rate": 100,
"insulinFormulation": {"compounds": [{"amount": 0.1
}
],
"name": "string"
},
"scheduleName": "string",
"annotations": [{"code": "wrong-device-time"
}
]
},
"scheduleName": "string",
"rate": 100,
"insulinFormulation": {"compounds": [{"amount": 0.1
}
],
"name": "string"
},
"annotations": [{"code": "wrong-device-time"
}
]
},
"rate": 100,
"percent": 10,
"insulinFormulation": {"compounds": [{"amount": 0.1
}
],
"name": "string"
},
"annotations": [{"code": "wrong-device-time"
}
]
}

Basal Suspend

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "basal" "alert" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
deliveryType	string (Delivery Type) Enum: "suspend" "automated" "scheduled" "temp" This defines the basal delivery type, used to differentiate between automated, scheduled, suspended and temporary basal types.
duration	integer <int64> (Insulin Delivery Duration) [ 0 .. 604800000 ] An integer value representing a duration of time in milliseconds.
expectedDuration	integer <int64> (Expected Insulin Delivery Duration) [ 0 .. 604800000 ] 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. `expectedDuration` cannot be less than the value of `duration`
	Basal Suppressed Automated (object) or Basal Suppressed Scheduled (object) or Basal Suppressed Temporary (object)

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "basal",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"deliveryType": "suspend",
"duration": 604800000,
"expectedDuration": 604800000,
"suppressed": {"type": "basal",
"deliveryType": "automated",
"suppressed": {"type": "basal",
"deliveryType": "scheduled",
"rate": 100,
"insulinFormulation": {"compounds": [{"amount": 0.1
}
],
"name": "string"
},
"scheduleName": "string",
"annotations": [{"code": "wrong-device-time"
}
]
},
"scheduleName": "string",
"rate": 100,
"insulinFormulation": {"compounds": [{"amount": 0.1
}
],
"name": "string"
},
"annotations": [{"code": "wrong-device-time"
}
]
}
}

Basal Temporary

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "basal" "alert" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
deliveryType	string (Delivery Type) Enum: "temp" "automated" "scheduled" "suspend" This defines the basal delivery type, used to differentiate between automated, scheduled, suspended and temporary basal types.
duration	integer <int64> (Insulin Delivery Duration) [ 0 .. 604800000 ] An integer value representing a duration of time in milliseconds.
expectedDuration	integer <int64> (Expected Insulin Delivery Duration) [ 0 .. 604800000 ] 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. `expectedDuration` cannot be less than the value of `duration`
	Insulin Formulation (object) or Insulin Formulation (object) (Insulin Formulation)
percent	number <float> (Insulin Delivery Percentage) [ 0 .. 10 ] Floating point value representing a percentage, where 1.0 represents 100%.
rate	number <double> (Insulin Delivery Rate) [ 0 .. 100 ] A floating point number >= 0 representing the amount of insulin delivered in units per hour.
	Basal Suppressed Automated (object) or Basal Suppressed Scheduled (object)

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "basal",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"deliveryType": "temp",
"duration": 604800000,
"expectedDuration": 604800000,
"insulinFormulation": {"compounds": [{"amount": 0.1
}
],
"name": "string"
},
"percent": 10,
"rate": 100,
"suppressed": {"type": "basal",
"deliveryType": "automated",
"suppressed": {"type": "basal",
"deliveryType": "scheduled",
"rate": 100,
"insulinFormulation": {"compounds": [{"amount": 0.1
}
],
"name": "string"
},
"scheduleName": "string",
"annotations": [{"code": "wrong-device-time"
}
]
},
"scheduleName": "string",
"rate": 100,
"insulinFormulation": {"compounds": [{"amount": 0.1
}
],
"name": "string"
},
"annotations": [{"code": "wrong-device-time"
}
]
}
}

Glucose Trend

string (Glucose Trend)

Enum: "constant" "slowFall" "slowRise" "moderateFall" "moderateRise" "rapidFall" "rapidRise"

Trends are annotated in terms of slow, moderate and rapid, since different manufacturers use different arrow glyphs.

"constant"

Glucose Trend Rate

number <double> (Glucose Trend Rate) [ -100 .. 100 ]

-100

Continuous Glucose

One of

units required	string (Blood Unit (mg/dL)) Enum: "mg/dL" "mg/dl"
value required	integer <int32> (Blood Value (mg/dL)) [ 0 .. 1000 ] An integer value representing a `mg/dL` value.
	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "cbg" "alert" "basal" "bloodKetone" "bolus" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
trend	string (Glucose Trend) Enum: "constant" "slowFall" "slowRise" "moderateFall" "moderateRise" "rapidFall" "rapidRise" Trends are annotated in terms of `slow`, `moderate` and `rapid`, since different manufacturers use different arrow glyphs.
trendRate	number <double> (Glucose Trend Rate) [ -100 .. 100 ]

Example

Blood Glucose (mg/dL)

{"units": "mg/dL",
"value": 105,
"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "upload",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"trend": "constant",
"trendRate": -100
}

Self Monitored Glucose

One of

units required	string (Blood Unit (mg/dL)) Enum: "mg/dL" "mg/dl"
value required	integer <int32> (Blood Value (mg/dL)) [ 0 .. 1000 ] An integer value representing a `mg/dL` value.
	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "smbg" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
subType	string (Self Monitored Glucose Sub Type) Enum: "linked" "manual" "scanned"

Example

Blood Glucose (mg/dL)

{"units": "mg/dL",
"value": 105,
"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "upload",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"subType": "scanned"
}

Blood Ketone

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "bloodKetone" "alert" "basal" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
units required	string (Blood Unit (mmol/L)) Enum: "mmol/L" "mmol/l"
value required	number <float> (Blood Value (mmol/L)) >= 0 A floating point value representing a `mmol/L` value.

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "bloodKetone",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"units": "mmol/L",
"value": 5.5
}

Bolus

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "bolus" "alert" "basal" "bloodKetone" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
subType required	string (Bolus Subtype) Enum: "automated" "dual/square" "normal" "square"
	Insulin Formulation (object) or Insulin Formulation (object) (Insulin Formulation)
deliveryContext	string (Bolus Delivery Context) Enum: "device" "algorithm" "remote" "undetermined"

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "bolus",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"subType": "automated",
"insulinFormulation": {"compounds": [{"amount": 0.1
}
],
"name": "string"
},
"deliveryContext": "device"
}

Bolus Automated

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "bolus" "alert" "basal" "bloodKetone" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
subType required	string (Bolus Subtype) Enum: "automated" "dual/square" "normal" "square"
	Insulin Formulation (object) or Insulin Formulation (object) (Insulin Formulation)
deliveryContext	string (Bolus Delivery Context) Enum: "device" "algorithm" "remote" "undetermined"
expectedNormal	number <float> [ 0 .. 100 ] Floating point value rounded to the appropriate significant figures for the device's precision.
normal required	number <float> [ 0 .. 100 ] Floating point value rounded to the appropriate significant figures for the device's precision.

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "bolus",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"subType": "automated",
"insulinFormulation": {"compounds": [{"amount": 0.1
}
],
"name": "string"
},
"deliveryContext": "device",
"expectedNormal": 100,
"normal": 100
}

Bolus Combination

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "bolus" "alert" "basal" "bloodKetone" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
subType required	string (Bolus Subtype) Enum: "dual/square" "automated" "normal" "square"
	Insulin Formulation (object) or Insulin Formulation (object) (Insulin Formulation)
deliveryContext	string (Bolus Delivery Context) Enum: "device" "algorithm" "remote" "undetermined"
duration required	integer <int64> [ 0 .. 86400000 ] Integer value representing milliseconds
expectedDuration	integer <int64> [ 0 .. 86400000 ] Integer value representing milliseconds
expectedExtended	number <float> [ 0 .. 100 ] Floating point value rounded to the appropriate significant figures for the device's precision.
expectedNormal	number <float> [ 0 .. 100 ] Floating point value rounded to the appropriate significant figures for the device's precision.
extended required	number <float> [ 0 .. 100 ] Floating point value rounded to the appropriate significant figures for the device's precision.
normal required	number <float> [ 0 .. 100 ] Floating point value rounded to the appropriate significant figures for the device's precision.

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "bolus",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"subType": "dual/square",
"insulinFormulation": {"compounds": [{"amount": 0.1
}
],
"name": "string"
},
"deliveryContext": "device",
"duration": 86400000,
"expectedDuration": 86400000,
"expectedExtended": 100,
"expectedNormal": 100,
"extended": 100,
"normal": 100
}

Bolus Extended

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "bolus" "alert" "basal" "bloodKetone" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
subType required	string (Bolus Subtype) Enum: "square" "automated" "dual/square" "normal"
	Insulin Formulation (object) or Insulin Formulation (object) (Insulin Formulation)
deliveryContext	string (Bolus Delivery Context) Enum: "device" "algorithm" "remote" "undetermined"
duration required	integer <int64> [ 0 .. 86400000 ] Integer value representing milliseconds
expectedDuration	integer <int64> [ 0 .. 86400000 ] Integer value representing milliseconds
expectedExtended	number <float> [ 0 .. 100 ] Floating point value rounded to the appropriate significant figures for the device's precision.
extended required	number <float> [ 0 .. 100 ] Floating point value rounded to the appropriate significant figures for the device's precision.

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "bolus",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"subType": "square",
"insulinFormulation": {"compounds": [{"amount": 0.1
}
],
"name": "string"
},
"deliveryContext": "device",
"duration": 86400000,
"expectedDuration": 86400000,
"expectedExtended": 100,
"extended": 100
}

Bolus Normal

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "bolus" "alert" "basal" "bloodKetone" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
subType required	string (Bolus Subtype) Enum: "normal" "automated" "dual/square" "square"
	Insulin Formulation (object) or Insulin Formulation (object) (Insulin Formulation)
deliveryContext	string (Bolus Delivery Context) Enum: "device" "algorithm" "remote" "undetermined"
expectedNormal	number <float> [ 0 .. 100 ] Floating point value rounded to the appropriate significant figures for the device's precision.
normal required	number <float> [ 0 .. 100 ] Floating point value rounded to the appropriate significant figures for the device's precision.

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "bolus",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"subType": "normal",
"insulinFormulation": {"compounds": [{"amount": 0.1
}
],
"name": "string"
},
"deliveryContext": "device",
"expectedNormal": 100,
"normal": 100
}

Blood Value (in mg/dL or mmol/L units)

One of

[ 0 .. 1000 ]

integer <int32> (Blood Value (mg/dL)) [ 0 .. 1000 ]

An integer value representing a mg/dL value.

Example

Blood Value (mg/dL)

105

Blood Glucose Target Value (mg/dL)

high	number [ 0 .. 1000 ] An integer encoding the upper bound of a PWD's blood glucose target. The minimum value should be >= `low` or `target`, whichever present
low	number [ 0 .. 1000 ] An integer encoding the lower bound of a PWD's blood glucose target.
range	number [ 0 .. 1000 ] An integer encoding the allowed deviation above or below the PWD's target blood glucose. Maximum should be min(`target`, 1000 - `target`) such that `target`-`range` >= 0 and `target`+`range` <= 1000
target	number [ 0 .. 1000 ] An integer encoding the PWD's target blood glucose as a single value.

{"high": 180,
"low": 80
}

Blood Glucose Target Value (mmol/L)

high	number [ 0 .. 55 ] An integer encoding the upper bound of a PWD's blood glucose target. The minimum value should be >= `low` or `target`, whichever present
low	number [ 0 .. 55 ] An integer encoding the lower bound of a PWD's blood glucose target.
range	number [ 0 .. 55 ] An integer encoding the allowed deviation above or below the PWD's target blood glucose. Maximum should be min(`target`, 1000 - `target`) such that `target`-`range` >= 0 and `target`+`range` <= 1000
target	number [ 0 .. 55 ] An integer encoding the PWD's target blood glucose as a single value.

{"high": 55,
"low": 55,
"range": 55,
"target": 55
}

Blood Glucose Target

One of

high	number [ 0 .. 1000 ] An integer encoding the upper bound of a PWD's blood glucose target. The minimum value should be >= `low` or `target`, whichever present
low	number [ 0 .. 1000 ] An integer encoding the lower bound of a PWD's blood glucose target.
range	number [ 0 .. 1000 ] An integer encoding the allowed deviation above or below the PWD's target blood glucose. Maximum should be min(`target`, 1000 - `target`) such that `target`-`range` >= 0 and `target`+`range` <= 1000
target	number [ 0 .. 1000 ] An integer encoding the PWD's target blood glucose as a single value.

Example

Blood Glucose Target Value (mg/dL)

{"high": 180,
"low": 80
}

Insulin Recommended

net	number <float> [ -100 .. 100 ] A floating point value representing units of insulin. Floating point value rounded to the appropriate significant figures for the device's precision.
correction	number <float> [ -100 .. 100 ] A floating point value representing units of insulin. Floating point value rounded to the appropriate significant figures for the device's precision.
carb	number <float> [ 0 .. 100 ] A floating point value representing units of insulin. Floating point value rounded to the appropriate significant figures for the device's precision.

{"net": -100,
"correction": -100,
"carb": 100
}

Bolus Calculator

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "wizard" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
	Blood Value (mg/dL) (integer) or Blood Value (mmol/L) (number) (Blood Value (in mg/dL or mmol/L units))
	Blood Glucose Target Value (mg/dL) (object) or Blood Glucose Target Value (mmol/L) (object) (Blood Glucose Target)
bolus	any The bolus event resulting from this wizard event.
carbInput	integer <int32> [ 0 .. 1000 ] An integer encoding the PWD's carbohydrate input into the bolus calculator.
insulinCarbRatio	number <double> [ 0 .. 250 ] An integer encoding the grams of carbohydrate "covered" by one unit of insulin for the PWD.
insulinOnBoard	number <float> [ 0 .. 250 ] A floating point value representing units of insulin.
	Blood Value (mg/dL) (integer) or Blood Value (mmol/L) (number) (Blood Value (in mg/dL or mmol/L units))
	object (Insulin Recommended) An object encoding the amount of insulin calculated as a recommended dose to "cover" the `bgInput` and `carbInput`, possibly taking into account the `insulinOnBoard`.
units	string
carbUnits	string (Carbohydrate Units) Enum: "grams" "exchanges"

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "wizard",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"bgInput": 105,
"bgTarget": {"high": 180,
"low": 80
},
"bolus": null,
"carbInput": 1000,
"insulinCarbRatio": 250,
"insulinOnBoard": 250,
"insulinSensitivity": 105,
"recommended": {"net": -100,
"correction": -100,
"carb": 100
},
"units": "string",
"carbUnits": "grams"
}

CGM Settings

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "cgmSettings" "alert" "basal" "bloodKetone" "bolus" "cbg" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
firmwareVersion	string [ 1 .. 100 ] characters
hardwareVersion	string [ 1 .. 100 ] characters
	object
	object
manufacturers	Array of strings [ 1 .. 10 ] characters [ items [ 1 .. 100 ] characters ]
model	string [ 1 .. 100 ] characters
name	string [ 1 .. 100 ] characters
	object
	object
serialNumber	string [ 1 .. 100 ] characters
softwareVersion	string [ 1 .. 100 ] characters
transmitterId	string
units	string Enum: "mg/dL" "mmol/L"

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "cgmSettings",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"firmwareVersion": "1.2",
"hardwareVersion": "2.3r45",
"highAlerts": {"enabled": true,
"level": 105,
"snooze": 86400000
},
"lowAlerts": {"enabled": true,
"level": 105,
"snooze": 86400000
},
"manufacturers": ["Acme"
],
"model": "Turbo CGM III",
"name": "My CGM",
"outOfRangeAlerts": {"enabled": true,
"snooze": 86400000
},
"rateOfChangeAlert": {"fallRate": {"enabled": true,
"rate": -10
},
"riseRate": {"enabled": true,
"rate": 0
}
},
"serialNumber": "1234567890",
"softwareVersion": "3.4.5",
"transmitterId": "G8X568",
"units": "mg/dL"
}

Controller Settings Device

firmwareVersion	string [ 1 .. 100 ] characters
hardwareVersion	string [ 1 .. 100 ] characters
manufacturers	Array of strings [ 1 .. 10 ] characters [ items [ 1 .. 100 ] characters ]
model	string [ 1 .. 100 ] characters
name	string [ 1 .. 100 ] characters
serialNumber	string [ 1 .. 100 ] characters
softwareVersion	string [ 1 .. 100 ] characters

{"firmwareVersion": "1.2",
"hardwareVersion": "2.3r45",
"manufacturers": ["Acme"
],
"model": "Super Controller",
"name": "My Controller",
"serialNumber": "1234567890",
"softwareVersion": "3.4.5"
}

Controller Settings Notifications

authorization	string Enum: "authorized" "denied" "ephemeral" "notDetermined" "provisional"
alert	boolean
criticalAlert	boolean
badge	boolean
sound	boolean
announcement	boolean
notificationCenter	boolean
lockScreen	boolean
alertStyle	string Enum: "alert" "banner" "none"

{"authorization": "authorized",
"alert": true,
"criticalAlert": true,
"badge": true,
"sound": true,
"announcement": true,
"notificationCenter": true,
"lockScreen": true,
"alertStyle": "alert"
}

Controller Settings

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "controllerSettings" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
	object (Controller Settings Device) The device for the controller settings.
	object (Controller Settings Notifications) The notifications for the controller settings.

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "controllerSettings",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"device": {"firmwareVersion": "1.2",
"hardwareVersion": "2.3r45",
"manufacturers": ["Acme"
],
"model": "Super Controller",
"name": "My Controller",
"serialNumber": "1234567890",
"softwareVersion": "3.4.5"
},
"notifications": {"authorization": "authorized",
"alert": true,
"criticalAlert": true,
"badge": true,
"sound": true,
"announcement": true,
"notificationCenter": true,
"lockScreen": true,
"alertStyle": "alert"
}
}

Device Event

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "deviceEvent" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
subType required	string (Device Event Sub Type) Enum: "alarm" "calibration" "prime" "pumpSettingsOverride" "reservoirChange" "sensorEvent" "settingsChange" "status" "timeChange" "transmitterEvent"

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "deviceEvent",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"subType": "alarm"
}

Device Alarm

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "deviceEvent" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
subType required	string (Device Event Sub Type) Enum: "alarm" "calibration" "prime" "pumpSettingsOverride" "reservoirChange" "sensorEvent" "settingsChange" "status" "timeChange" "transmitterEvent"
alarmType required	string Enum: "auto_off" "low_insulin" "low_power" "no_delivery" "no_insulin" "no_power" "occlusion" "other" "over_limit" String value encoding the type of alarm, with `other` as the catch-all/default category.
status	string The `id` of the status event logically connected with this event.

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "deviceEvent",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"subType": "alarm",
"alarmType": "auto_off",
"status": "string"
}

Device Calibration

One of

units required	string (Blood Unit (mg/dL)) Enum: "mg/dL" "mg/dl"
value required	integer <int32> (Blood Value (mg/dL)) [ 0 .. 1000 ] An integer value representing a `mg/dL` value.
	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "deviceEvent" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
subType required	string (Device Event Sub Type) Enum: "calibration" "alarm" "prime" "pumpSettingsOverride" "reservoirChange" "sensorEvent" "settingsChange" "status" "timeChange" "transmitterEvent"

Example

Blood Glucose (mg/dL)

{"units": "mg/dL",
"value": 105,
"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "upload",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"subType": "calibration"
}

Device Delivery Status

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "deviceEvent" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
subType required	string (Device Event Sub Type) Enum: "status" "alarm" "calibration" "prime" "pumpSettingsOverride" "reservoirChange" "sensorEvent" "settingsChange" "timeChange" "transmitterEvent"
duration	integer <int64> >= 0
expectedDuration	integer <int64> >= 0
	object
status required	string Enum: "resumed" "suspended"

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "deviceEvent",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"subType": "status",
"duration": 0,
"expectedDuration": 0,
"reason": {"suspended": "automatic",
"resumed": "automatic"
},
"status": "resumed"
}

Cannula Prime Event

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "deviceEvent" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
subType required	string (Device Event Sub Type) Enum: "prime" "alarm" "calibration" "pumpSettingsOverride" "reservoirChange" "sensorEvent" "settingsChange" "status" "timeChange" "transmitterEvent"
primeTarget required	string Value: "cannula"
volume required	number <float> [ 0 .. 10 ]

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "deviceEvent",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"subType": "prime",
"primeTarget": "cannula",
"volume": 10
}

Tubing Prime Event

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "deviceEvent" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
subType required	string (Device Event Sub Type) Enum: "prime" "alarm" "calibration" "pumpSettingsOverride" "reservoirChange" "sensorEvent" "settingsChange" "status" "timeChange" "transmitterEvent"
primeTarget required	string Value: "tubing"
volume required	number <float> [ 0 .. 100 ]

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "deviceEvent",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"subType": "prime",
"primeTarget": "tubing",
"volume": 100
}

Device Prime Event

One of

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "deviceEvent" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
subType required	string (Device Event Sub Type) Enum: "prime" "alarm" "calibration" "pumpSettingsOverride" "reservoirChange" "sensorEvent" "settingsChange" "status" "timeChange" "transmitterEvent"
primeTarget required	string Value: "cannula"
volume required	number <float> [ 0 .. 10 ]

Example

Cannula Prime Event

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "upload",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"subType": "prime",
"primeTarget": "cannula",
"volume": 10
}

Blood Unit (mg/dL or mmol/L)

One of

string (Blood Unit (mg/dL))

Enum: "mg/dL" "mg/dl"

Example

Blood Unit (mg/dL)

"mg/dL"

Device Pump Settings Override Event

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "deviceEvent" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
subType required	string (Device Event Sub Type) Enum: "pumpSettingsOverride" "alarm" "calibration" "prime" "reservoirChange" "sensorEvent" "settingsChange" "status" "timeChange" "transmitterEvent"
overrideType required	string Enum: "custom" "physicalActivity" "preprandial" "preset" "sleep"
overridePreset	string [ 1 .. 100 ] characters
method	string Enum: "automatic" "manual"
duration	number <float> [ 0 .. 604800 ]
expectedDuration	number <float> [ 0 .. 604800 ]
	Blood Glucose Target Value (mg/dL) (object) or Blood Glucose Target Value (mmol/L) (object) (Blood Glucose Target)
basalRateScaleFactor	number <float> [ 0.1 .. 10 ]
carbRatioScaleFactor	number <float> [ 0.1 .. 10 ]
insulinSensitivityScaleFactor	number <float> [ 0.1 .. 10 ]
	object

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "deviceEvent",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"subType": "pumpSettingsOverride",
"overrideType": "preset",
"overridePreset": "Running",
"method": "manual",
"duration": 2700,
"expectedDuration": 7200,
"bgTarget": {"high": 180,
"low": 80
},
"basalRateScaleFactor": 0.8,
"carbRatioScaleFactor": 1.25,
"insulinSensitivityScaleFactor": 1.25,
"units": {"bg": "mg/dL"
}
}

Device Reservoir Change

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "deviceEvent" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
subType required	string (Device Event Sub Type) Enum: "reservoirChange" "alarm" "calibration" "prime" "pumpSettingsOverride" "sensorEvent" "settingsChange" "status" "timeChange" "transmitterEvent"
status	string The `id` of the `status` event logically connected with this event.

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "deviceEvent",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"subType": "reservoirChange",
"status": "string"
}

DeviceSensorEvent [Proposed]

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "deviceEvent" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
subType required	string (Device Event Sub Type) Enum: "sensorEvent" "alarm" "calibration" "prime" "pumpSettingsOverride" "reservoirChange" "settingsChange" "status" "timeChange" "transmitterEvent"
eventType	string Enum: "expired" "start" "stop"

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "deviceEvent",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"subType": "sensorEvent",
"eventType": "expired"
}

Device Settings Change [Proposed]

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "deviceEvent" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
subType required	string (Device Event Sub Type) Enum: "settingsChange" "alarm" "calibration" "prime" "pumpSettingsOverride" "reservoirChange" "sensorEvent" "status" "timeChange" "transmitterEvent"
	object
	object
	object
	object

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "deviceEvent",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"subType": "settingsChange",
"basalSchedule": {"from": "string",
"to": "string"
},
"bgTarget": {"from": "string",
"to": "string"
},
"carbRatio": {"from": "string",
"to": "string"
},
"insulinSensitivityFactor": {"from": "string",
"to": "string"
}
}

Time Change Info

timeZoneName	string (Time Zone) A string timezone name from the IANA timezone database
time	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information

{"timeZoneName": "Europe/London",
"time": "2017-02-06T02:37:46"
}

Device Time Change

One of

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "deviceEvent" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
subType required	string (Device Event Sub Type) Enum: "timeChange" "alarm" "calibration" "prime" "pumpSettingsOverride" "reservoirChange" "sensorEvent" "settingsChange" "status" "transmitterEvent"
method required	string Enum: "automatic" "manual"
	object (Time Change Info)
required	object (Time Change Info)

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "upload",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"subType": "timeChange",
"change": "string"
}

DeviceTransmitterEvent [Proposed]

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "deviceEvent" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
subType required	string (Device Event Sub Type) Enum: "transmitterEvent" "alarm" "calibration" "prime" "pumpSettingsOverride" "reservoirChange" "sensorEvent" "settingsChange" "status" "timeChange"
eventType	string Enum: "expired" "start" "stop"

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "deviceEvent",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"subType": "transmitterEvent",
"eventType": "expired"
}

Blood Glucose for Dosing Decision

time	string <date-time>
required	Blood Value (mg/dL) (integer) or Blood Value (mmol/L) (number) (Blood Value (in mg/dL or mmol/L units))

{"time": "2019-08-24T14:15:22Z",
"value": 105
}

Start Time

start

required

number [ 0 .. 86400000 ]

{"start": 86400000
}

Blood Glucose Target Start

One of

high	number [ 0 .. 1000 ] An integer encoding the upper bound of a PWD's blood glucose target. The minimum value should be >= `low` or `target`, whichever present
low	number [ 0 .. 1000 ] An integer encoding the lower bound of a PWD's blood glucose target.
range	number [ 0 .. 1000 ] An integer encoding the allowed deviation above or below the PWD's target blood glucose. Maximum should be min(`target`, 1000 - `target`) such that `target`-`range` >= 0 and `target`+`range` <= 1000
target	number [ 0 .. 1000 ] An integer encoding the PWD's target blood glucose as a single value.
start required	number [ 0 .. 86400000 ]

Example

Blood Glucose Target Value (mg/dL)

{"high": 180,
"low": 80
}

Issue for Dosing Decision

id required	string [ 1 .. 100 ] characters
	object

{"id": "unknown",
"metadata": {"extra": "information"
}
}

Dosing Decision

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "dosingDecision" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
reason required	string [ 1 .. 100 ] characters
	object
	object
	object (Blood Glucose for Dosing Decision) A simple blood glucose for a dosing decision.
	object
	object
	Array of Blood Glucose Target Value (mg/dL) (object) or Blood Glucose Target Value (mmol/L) (object) (Blood Glucose Target Start)
	Array of objects (Blood Glucose for Dosing Decision)
	Array of objects (Blood Glucose for Dosing Decision)
	object
	object
	object
	Array of objects (Issue for Dosing Decision)
	Array of objects (Issue for Dosing Decision)
scheduleTimeZoneOffset	number <int32> [ -10080 .. 10080 ]
required	object

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "dosingDecision",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"reason": "bolus",
"originalFood": {"time": "2019-08-24T14:15:22Z",
"nutrition": {"absorptionDuration": 10800,
"carbohydrate": {"net": 25,
"units": "grams"
}
}
},
"food": {"time": "2019-08-24T14:15:22Z",
"nutrition": {"absorptionDuration": 10800,
"carbohydrate": {"net": 25,
"units": "grams"
}
}
},
"smbg": {"time": "2019-08-24T14:15:22Z",
"value": 105
},
"carbsOnBoard": {"time": "2019-08-24T14:15:22Z",
"amount": 18
},
"insulinOnBoard": {"time": "2019-08-24T14:15:22Z",
"amount": 0.75
},
"bgTargetSchedule": [{"high": 180,
"low": 80,
"start": 86400000
}
],
"bgHistorical": [{"time": "2019-08-24T14:15:22Z",
"value": 105
}
],
"bgForecast": [{"time": "2019-08-24T14:15:22Z",
"value": 105
}
],
"recommendedBasal": {"rate": 1.25,
"duration": 180000
},
"recommendedBolus": {"amount": 2.5
},
"requestedBolus": {"amount": 2
},
"warnings": [{"id": "unknown",
"metadata": {"extra": "information"
}
}
],
"errors": [{"id": "unknown",
"metadata": {"extra": "information"
}
}
],
"scheduleTimeZoneOffset": -480,
"units": {"bg": "mg/dL",
"carb": "grams",
"insulin": "Units"
}
}

Amount

units required	string
value required	number <double>

{"units": "string",
"value": 0.1
}

Ingredient

	object (Nutrition)
name	string [ 1 .. 100 ] characters
code	string [ 1 .. 100 ] characters
brand	string [ 1 .. 100 ] characters
	object (Amount)

{"nutrition": {"absorptionDuration": 10800,
"carbohydrate": {"net": 25,
"units": "grams"
}
},
"name": "string",
"code": "string",
"brand": "string",
"amount": {"units": "string",
"value": 0.1
}
}

Ingredient Array

Array ([ 1 .. 100 ] items)

	object (Nutrition)
name	string [ 1 .. 100 ] characters
code	string [ 1 .. 100 ] characters
brand	string [ 1 .. 100 ] characters
	object (Amount)

[{"nutrition": {"absorptionDuration": 10800,
"carbohydrate": {"net": 25,
"units": "grams"
}
},
"name": "string",
"code": "string",
"brand": "string",
"amount": {"units": "string",
"value": 0.1
}
}
]

Food

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "food" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
	object (Amount)
brand required	string [ 1 .. 100 ] characters
code required	string [ 1 .. 100 ] characters
	Array of objects (Ingredient Array) [ 1 .. 100 ] items An array of ingredients
meal required	string Enum: "breakfast" "lunch" "dinner" "snack" "other"
mealOther	string [ 1 .. 100 ] characters
name required	string [ 1 .. 100 ] characters
	object (Nutrition)

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "food",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"amount": {"units": "string",
"value": 0.1
},
"brand": "string",
"code": "string",
"ingredients": [{"nutrition": {"absorptionDuration": 10800,
"carbohydrate": {"net": 25,
"units": "grams"
}
},
"name": "string",
"code": "string",
"brand": "string",
"amount": {"units": "string",
"value": 0.1
}
}
],
"meal": "breakfast",
"mealOther": "string",
"name": "string",
"nutrition": {"absorptionDuration": 10800,
"carbohydrate": {"net": 25,
"units": "grams"
}
}
}

Insulin Dose

units required	string Value: "Units"
total required	number <float> [ 0 .. 250 ]
food	number <float> [ 0 .. 250 ]
correction	number <float> [ -250 .. 250 ]
active	number <float> [ 0 .. 250 ]

{"units": "Units",
"total": 250,
"food": 250,
"correction": -250,
"active": 250
}

Insulin

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "insulin" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
	object (Insulin Dose) An object representing an Insulin Dose
	Insulin Formulation (object) or Insulin Formulation (object) (Insulin Formulation)
site	string [ 0 .. 100 ] characters

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "insulin",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"dose": {"units": "Units",
"total": 250,
"food": 250,
"correction": -250,
"active": 250
},
"formulation": {"compounds": [{"amount": 0.1
}
],
"name": "string"
},
"site": "string"
}

Physical Activity

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "physicalActivity" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
activityType required	string (Physical Activity Type) Enum: "americanFootball" "archery" "australianFootball" "badminton" "barre" "baseball" "basketball" "bowling" "boxing" "climbing" "coreTraining" "cricket" "crossCountrySkiing" "crossTraining" "curling" "cycling" "dance" "danceInspiredTraining" "downhillSkiing" "elliptical" "equestrianSports" "fencing" "fishing" "flexibility" "functionalStrengthTraining" "golf" "gymnastics" "handball" "handCycling" "highIntensityIntervalTraining" "hiking" "hockey" "hunting" "jumpRope" "kickboxing" "lacrosse" "martialArts" "mindAndBody" "mixedCardio" "mixedMetabolicCardioTraining" "other" "paddleSports" "pilates" "play" "preparationAndRecovery" "racquetball" "rowing" "rugby" "running" "sailing" "skatingSports" "snowboarding" "snowSports" "soccer" "softball" "squash" "stairClimbing" "stairs" "stepTraining" "surfingSports" "swimming" "tableTennis" "taiChi" "tennis" "trackAndField" "traditionalStrengthTraining" "volleyball" "walking" "waterFitness" "waterPolo" "waterSports" "wheelchairRunPace" "wheelchairWalkPace" "wrestling" "yoga"
activityTypeOther	string (Other Activity Type) [ 1 .. 100 ] characters This is only applicable if the `activityType` is `other`
name required	string (Activity Name) [ 1 .. 100 ] characters
reportedIntensity required	string (Reported Intensity) Enum: "high" "low" "medium"
aggregate	boolean (Aggregate) Set to `true` if this is an aggregate activity.
	Distance (meters) (object) or Distance (kilometers) (object) or Distance (feet) (object) or Distance (yards) (object) or Distance (miles) (object) (Distance) Distance, expressed as `meters`, `kilometers`, `feet`, `yards`, or `miles`.
	Duration (hours) (object) or Duration (minutes) (object) or Duration (seconds) (object) (Duration) Duration, expressed as `hours`, `minutes` or `seconds`.
	Distance (feet) (object) or Distance (meters) (object)
	Energy (calories) (object) or Energy (kilocalories) (object) or Energy (joules) (object) or Energy (kilojoules) (object) (Energy)
	object (Flights)
	object (Laps)
	object (Steps)

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "physicalActivity",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"activityType": "curling",
"activityTypeOther": "skydiving",
"name": "Hiking the John Muir Trail",
"reportedIntensity": "medium",
"aggregate": false,
"distance": {"units": "meters",
"value": 42
},
"duration": {"units": "hours",
"value": 42
},
"elevationChange": {"units": "feet",
"value": 42
},
"energy": {"units": "calories",
"value": 10000000
},
"flight": {"count": 42
},
"lap": {"count": 5,
"distance": {"units": "meters",
"value": 42
}
},
"step": {"count": 42
}
}

Pump Settings Override Preset

abbreviation	string [ 1 .. 100 ] characters
duration	number <float> [ 0 .. 604800 ]
	Blood Glucose Target Value (mg/dL) (object) or Blood Glucose Target Value (mmol/L) (object) (Blood Glucose Target)
basalRateScaleFactor	number <float> [ 0.1 .. 10 ]
carbRatioScaleFactor	number <float> [ 0.1 .. 10 ]
insulinSensitivityScaleFactor	number <float> [ 0.1 .. 10 ]

{"abbreviation": "🏃‍♀️",
"duration": 7200,
"bgTarget": {"high": 180,
"low": 80
},
"basalRateScaleFactor": 0.8,
"carbRatioScaleFactor": 1.25,
"insulinSensitivityScaleFactor": 1.25
}

Pump Settings

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "pumpSettings" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
activeSchedule	string A string value encoding the name of the PWD's active basal schedule.
basalSchedule	object
basalSchedules	object A set of key-value pairs encoding the PWD's programmed basal schedules, where each key is a basal schedule name and each value is an array of basal schedule segment objects.
	Blood Glucose Target Value (mg/dL) (object) or Blood Glucose Target Value (mmol/L) (object) (Blood Glucose Target)
bgTargets	object
	object
carbRatio	number <double> [ 0 .. 250 ] An integer encoding the grams of carbohydrate "covered" by one unit of insulin for the PWD.
carbRatios	object A set of key-value pairs encoding the PWD's programmed carb ratio schedules, where each key is a schedule name and each value is an array of carb ratio segment objects.
	object
firmwareVersion	string [ 1 .. 100 ] characters
hardwareVersion	string [ 1 .. 100 ] characters
	Insulin Formulation (object) or Insulin Formulation (object) (Insulin Formulation)
insulinSensitivity	object
insulinSensitivities	object
manufacturers	Array of strings [ 0 .. 10 ] items unique [ items [ 1 .. 100 ] characters ]
model	string [ 1 .. 100 ] characters
name	string [ 1 .. 100 ] characters
serialNumber	string [ 1 .. 100 ] characters
softwareVersion	string [ 1 .. 100 ] characters
	object
dosingEnabled	boolean
	object
bgSafetyLimit	number <double> [ 0 .. 1000 ]
	object
	object

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "pumpSettings",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"activeSchedule": "string",
"basalSchedule": { },
"basalSchedules": { },
"bgTarget": {"high": 180,
"low": 80
},
"bgTargets": { },
"bolus": {"amountMaximum": { },
"calculator": {"enabled": true,
"insulin": {"duration": 10,
"units": "hours"
}
},
"extended": { }
},
"carbRatio": 250,
"carbRatios": { },
"display": {"bloodGlucose": {"units": "mg/dL"
}
},
"firmwareVersion": "1.2",
"hardwareVersion": "2.3r45",
"insulinFormulation": {"compounds": [{"amount": 0.1
}
],
"name": "string"
},
"insulinSensitivity": { },
"insulinSensitivities": { },
"manufacturers": ["Acme"
],
"model": "Pump A Lot",
"name": "My Pump",
"serialNumber": "string",
"softwareVersion": "3.4.5",
"units": {"bg": "mmol/L",
"carb": "exchanges"
},
"dosingEnabled": true,
"bgTargetPreMealTarget": {"low": 1000,
"high": 1000
},
"bgSafetyLimit": 75,
"insulinModel": {"modelType": "rapidAdult",
"modelTypeOther": "string",
"actionDelay": 86400,
"actionDuration": 86400,
"actionPeakOffset": 86400
},
"overridePresets": {"property1": {"abbreviation": "🏃‍♀️",
"duration": 7200,
"bgTarget": {"high": 180,
"low": 80
},
"basalRateScaleFactor": 0.8,
"carbRatioScaleFactor": 1.25,
"insulinSensitivityScaleFactor": 1.25
},
"property2": {"abbreviation": "🏃‍♀️",
"duration": 7200,
"bgTarget": {"high": 180,
"low": 80
},
"basalRateScaleFactor": 0.8,
"carbRatioScaleFactor": 1.25,
"insulinSensitivityScaleFactor": 1.25
}
}
}

Pump Status

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "pumpStatus" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
	object
	object
	object
deliveryIndeterminant	boolean
	object

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "pumpStatus",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"basalDelivery": {"state": "temporary",
"time": "2019-08-24T14:15:22Z",
"dose": {"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"rate": 1.25,
"amountDelivered": 0
}
},
"battery": {"time": "2019-08-24T14:15:22Z",
"state": "charging",
"remaining": 0.75,
"units": "percent"
},
"bolusDelivery": {"state": "delivering",
"dose": {"startTime": "2019-08-24T14:15:22Z",
"amount": 4.5,
"amountDelivered": 1.75
}
},
"deliveryIndeterminant": false,
"reservoir": {"time": "2019-08-24T14:15:22Z",
"remaining": 68,
"units": "Units"
}
}

Severity

integer <int32> (Severity) [ 0 .. 10 ]

5

State

string (State)

Enum: "alcohol" "cycle" "hyperglycemiaSymptoms" "hypoglycemiaSymptoms" "illness" "other" "stress"

"alcohol"

Other State

string (Other State) [ 1 .. 100 ] characters

Should only be present if state is other

"buzzed"

States

Array ([ 1 .. 100 ] items)

severity	integer <int32> (Severity) [ 0 .. 10 ]
state required	string (State) Enum: "alcohol" "cycle" "hyperglycemiaSymptoms" "hypoglycemiaSymptoms" "illness" "other" "stress"
stateOther	string (Other State) [ 1 .. 100 ] characters Should only be present if `state` is `other`

[{"severity": 5,
"state": "alcohol",
"stateOther": "buzzed"
}
]

Reported State

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "reportedState" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
required	Array of objects (States) [ 1 .. 100 ] items unique

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "reportedState",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"states": [{"severity": 5,
"state": "alcohol",
"stateOther": "buzzed"
}
]
}

Settings

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
name	string [ 1 .. 1000 ] characters
loopAppVersion	string [ 1 .. 1000 ] characters

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "upload",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"name": "string",
"loopAppVersion": "string"
}

Upload Device

deviceManufacturers	Array of strings (Device Manufacturers) An array of string tags indicating the manufacturer(s) of the device. In order to avoid confusion resulting from referring to a single manufacturer with more than one name—for example, using both 'Minimed' and 'Medtronic' interchangeably—we restrict the set of strings used to refer to manufacturers to the set listed above and enforce exact string matches (including casing). `deviceManufacturers` is an array of one or more string "tags" because there are devices resulting from a collaboration between more than one manufacturer, such as the Tandem G4 insulin pump with CGM integration (a collaboration between `Tandem` and `Dexcom`).
deviceModel	string (Device Model Name) non-empty A string identifying the model of the device. The `deviceModel` is a non-empty string that encodes the model of device. We endeavor to match each manufacturer's standard for how they represent model name in terms of casing, whether parts of the name are represented as one word or two, etc.
deviceSerialNumber	string (Device Serial Number) non-empty A string encoding the device's serial number. The `deviceSerialNumber` is a string that encodes the serial number of the device. Note that even if a manufacturer only uses digits in its serial numbers, the SN should be stored as a string regardless. Uniquely of string fields in the Tidepool device data models, `deviceSerialNumber` may be an empty string. This is essentially a compromise: having the device serial number is extremely important (especially for e.g., clinical studies) but in 2016 we came across our first case where we cannot recover the serial number of the device that generated the data: Dexcom G5 data uploaded to Tidepool through Apple iOS's HealthKit integration.
deviceTags	Array of strings (Device Tags) non-empty [ items <= 100 characters ] Items Enum: "bgm" "cgm" "insulin-pump" "fgm" "pen" "manual" An array of string tags indicating the function(s) of the device. The `deviceTags` array should be fairly self-explanatory as an array of tags indicating the function(s) of a particular device. For example, the Insulet OmniPod insulin delivery system has the tags `bgm` and `insulin-pump` since the PDM is both an insulin pump controller and includes a built-in blood glucose monitor.

{ }

Upload

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "upload" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
deviceManufacturers	Array of strings (Device Manufacturers) An array of string tags indicating the manufacturer(s) of the device. In order to avoid confusion resulting from referring to a single manufacturer with more than one name—for example, using both 'Minimed' and 'Medtronic' interchangeably—we restrict the set of strings used to refer to manufacturers to the set listed above and enforce exact string matches (including casing). `deviceManufacturers` is an array of one or more string "tags" because there are devices resulting from a collaboration between more than one manufacturer, such as the Tandem G4 insulin pump with CGM integration (a collaboration between `Tandem` and `Dexcom`).
deviceModel	string (Device Model Name) non-empty A string identifying the model of the device. The `deviceModel` is a non-empty string that encodes the model of device. We endeavor to match each manufacturer's standard for how they represent model name in terms of casing, whether parts of the name are represented as one word or two, etc.
deviceSerialNumber	string (Device Serial Number) non-empty A string encoding the device's serial number. The `deviceSerialNumber` is a string that encodes the serial number of the device. Note that even if a manufacturer only uses digits in its serial numbers, the SN should be stored as a string regardless. Uniquely of string fields in the Tidepool device data models, `deviceSerialNumber` may be an empty string. This is essentially a compromise: having the device serial number is extremely important (especially for e.g., clinical studies) but in 2016 we came across our first case where we cannot recover the serial number of the device that generated the data: Dexcom G5 data uploaded to Tidepool through Apple iOS's HealthKit integration.
deviceTags	Array of strings (Device Tags) non-empty [ items <= 100 characters ] Items Enum: "bgm" "cgm" "insulin-pump" "fgm" "pen" "manual" An array of string tags indicating the function(s) of the device. The `deviceTags` array should be fairly self-explanatory as an array of tags indicating the function(s) of a particular device. For example, the Insulet OmniPod insulin delivery system has the tags `bgm` and `insulin-pump` since the PDM is both an insulin pump controller and includes a built-in blood glucose monitor.
byUser	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Client Software) The client software that provided diabetes data.
computerTime	string <time> (Computer Time) An ISO 8601 formatted timestamp without any timezone offset information. The `computerTime` field encodes the local time at upload with no timezone offset information since we are storing `timezone` separately. We store this field in order to be able to audit and/or detect the correspondence between the user's browser time and the timezone they selected at the time of upload. If the user selected the timezone that was actually in effect for their browser at the time of upload, then applying the stored `timezone` to the UTC Zulu `time` field will match `computerTime`. If, on the other hand, the user selected a different timezone from that effective in their browser at the time of upload, applying the `timezone` to `time` will not match `computerTime`. There are some use cases when it is perfectly justified to select a timezone that does not reflect the browser's current timezone. For example, some insulin pump users do not change the time on their devices when traveling for short periods of time across many timezones, but when uploading a device a user should always choose the timezone that aligns with the most recent data on the device and thus that will not match the local browser timezone.
dataSetType	string (Data Set Type) Enum: "continuous" "normal"
timeProcessing	string (Time Processing) Enum: "none" "across-the-board-timezone" "utc-bootstrapping" A string indicating what variety of processing was used to create the `time` and related fields such as `timezoneOffset` on data in this upload. For data auditing purposes, we store a string encoding the type of algorithm used to generate the `time`, `timezoneOffset`, and other related fields from the local `deviceTime`. At present, there are only three options for this value: `none` for data sources that already include a UTC-anchored `time` value. At present, the only data source for which this is true is Dexcom G5 or Dexcom G6 data coming through Apple's iOS HealthKit integration. `across-the-board-timezone` for devices (all BGMs, for example) that cannot have their `deviceTime` values "bootstrapped" to a UTC `time` value; in such cases, we apply a single user-selected timezone to every `deviceTime` "across the board" to generate the `time` value. `utc-bootstrapping` for devices (most insulin pumps and CGMs) where we use a combination of the user-selected timezone at time of upload, the most recent timestamp on device, and the history of display time changes on the device to infer the correct `time` value for each record.
version	string (Semantic Version Number) >= 5 characters ^(0\|[1-9]\d)\.(0\|[1-9]\d)\.(0\|[1-9]\d*)(?:-... Semantic Version Number 2.0.0. Regex from their site.

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "upload",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"byUser": "string",
"client": {"name": "org.tidepool.uploader",
"version": "2.36.1",
"platform": "macOS 10.15.4",
"private": { }
},
"computerTime": "14:15:22Z",
"dataSetType": "continuous",
"timeProcessing": "utc-bootstrapping",
"version": "2.36.1"
}

Water Amount, in Gallons

units required	string Value: "gallons"
value required	number <double> [ 0 .. 10 ]

{"units": "gallons",
"value": 10
}

Water Amount, in Ounces

units required	string Value: "ounces"
value required	number <double> [ 0 .. 1280 ]

{"units": "ounces",
"value": 1280
}

Water Amount, in Liters

units required	string Value: "liters"
value required	number <double> [ 0 .. 37.854118 ]

{"units": "liters",
"value": 37.854118
}

Water Amount, in Milliliters

units required	string Value: "milliliters"
value required	number <double> [ 0 .. 37854.118 ]

{"units": "milliliters",
"value": 37854.118
}

Water Consumption

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "water" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
required	Water Amount, in Gallons (object) or Water Amount, in Ounces (object) or Water Amount, in Liters (object) or Water Amount, in Milliliters (object)

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "water",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"amount": {"units": "gallons",
"value": 10
}
}

Tidepool Diabetes Data

One of

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
name required	string [ 1 .. 100 ] characters
priority	string Enum: "critical" "normal" "timeSensitive"
trigger	string Enum: "delayed" "immediate" "repeating"
triggerDelay	integer <int32> [ 0 .. 86400 ]
sound	string Enum: "name" "silence" "vibrate"
soundName	string [ 1 .. 100 ] characters
issuedTime required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
acknowledgedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
retractedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information

Example

Alert

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "upload",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"name": "string",
"priority": "critical",
"trigger": "delayed",
"triggerDelay": 86400,
"sound": "name",
"soundName": "string",
"issuedTime": "2017-02-06T02:37:46Z",
"acknowledgedTime": "2017-02-06T02:37:46Z",
"retractedTime": "2017-02-06T02:37:46Z"
}

Tidepool Diabetes Data Array

Array (non-empty)

One of

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
name required	string [ 1 .. 100 ] characters
priority	string Enum: "critical" "normal" "timeSensitive"
trigger	string Enum: "delayed" "immediate" "repeating"
triggerDelay	integer <int32> [ 0 .. 86400 ]
sound	string Enum: "name" "silence" "vibrate"
soundName	string [ 1 .. 100 ] characters
issuedTime required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
acknowledgedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
retractedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information

[{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "alert",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"name": "string",
"priority": "critical",
"trigger": "delayed",
"triggerDelay": 86400,
"sound": "name",
"soundName": "string",
"issuedTime": "2017-02-06T02:37:46Z",
"acknowledgedTime": "2017-02-06T02:37:46Z",
"retractedTime": "2017-02-06T02:37:46Z"
}
]

Data Source ID

string (Data Source ID) = 32 characters ^[0-9a-f]{32}$

"c0ce05326529c6b35b0f4a568a344026"

Data Source State

string (Data Source State)

Enum: "connected" "disconnected" "error"

State of the data source.

"connected"

Data Source

createdTime required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
dataSetIds required	Array of strings (Data Set ID Array) non-empty unique [^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...] An array of data set IDs. The IDs in the array must be unique.
earliestDataTime required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
id required	string (Data Source ID) = 32 characters ^[0-9a-f]{32}$
lastImportTime required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
latestDataTime required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
providerName required	string (Provider Name) [ 1 .. 100 ] characters
providerSessionId required	string (Provider Session ID) ^[0-9a-z]{32}$
providerType required	string (Provider Type) Value: "oauth"
revision	integer <int32>
state required	string (Data Source State) Enum: "connected" "disconnected" "error" State of the data source.
userId required	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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

{"createdTime": "2017-02-06T02:37:46Z",
"dataSetIds": ["ce8cc5f7595575945f91fc6710db6fef"
],
"earliestDataTime": "2017-02-06T02:37:46Z",
"id": "c0ce05326529c6b35b0f4a568a344026",
"lastImportTime": "2017-02-06T02:37:46Z",
"latestDataTime": "2017-02-06T02:37:46Z",
"modifiedTime": "2017-02-06T02:37:46Z",
"providerName": "dexcom",
"providerSessionId": "string",
"providerType": "oauth",
"revision": 0,
"state": "connected",
"userId": "string"
}

New Data Source

providerName required	string (Provider Name) [ 1 .. 100 ] characters
providerSessionId required	string (Provider Session ID) ^[0-9a-z]{32}$
providerType required	string (Provider Type) Value: "oauth"
state required	string (Data Source State) Enum: "connected" "disconnected" "error" State of the data source.

{"providerName": "dexcom",
"providerSessionId": "string",
"providerType": "oauth",
"state": "connected"
}

Update Data Source

dataSetIds required	Array of strings (Data Set ID Array) non-empty unique [^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...] An array of data set IDs. The IDs in the array must be unique.
earliestDataTime required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
error	string
lastImportTime required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
latestDataTime required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
providerSessionId required	string (Provider Session ID) ^[0-9a-z]{32}$
state required	string (Data Source State) Enum: "connected" "disconnected" "error" State of the data source.

{"dataSetIds": ["ce8cc5f7595575945f91fc6710db6fef"
],
"earliestDataTime": "2017-02-06T02:37:46Z",
"error": "string",
"lastImportTime": "2017-02-06T02:37:46Z",
"latestDataTime": "2017-02-06T02:37:46Z",
"providerSessionId": "string",
"state": "connected"
}

Base

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "upload",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06"
}

Alert

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
name required	string [ 1 .. 100 ] characters
priority	string Enum: "critical" "normal" "timeSensitive"
trigger	string Enum: "delayed" "immediate" "repeating"
triggerDelay	integer <int32> [ 0 .. 86400 ]
sound	string Enum: "name" "silence" "vibrate"
soundName	string [ 1 .. 100 ] characters
issuedTime required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
acknowledgedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
retractedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "alert",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"name": "string",
"priority": "critical",
"trigger": "delayed",
"triggerDelay": 86400,
"sound": "name",
"soundName": "string",
"issuedTime": "2017-02-06T02:37:46Z",
"acknowledgedTime": "2017-02-06T02:37:46Z",
"retractedTime": "2017-02-06T02:37:46Z"
}

Bolus Automated

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "bolus" "alert" "basal" "bloodKetone" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
subType required	string (Bolus Subtype) Enum: "automated" "dual/square" "normal" "square"
	Insulin Formulation (object) or Insulin Formulation (object) (Insulin Formulation)
deliveryContext	string (Bolus Delivery Context) Enum: "device" "algorithm" "remote" "undetermined"
expectedNormal	number <float> [ 0 .. 100 ] Floating point value rounded to the appropriate significant figures for the device's precision.
normal required	number <float> [ 0 .. 100 ] Floating point value rounded to the appropriate significant figures for the device's precision.

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "bolus",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"subType": "automated",
"insulinFormulation": {"compounds": [{"amount": 0.1
}
],
"name": "string"
},
"deliveryContext": "device",
"expectedNormal": 100,
"normal": 100
}

State

string (State)

Enum: "alcohol" "cycle" "hyperglycemiaSymptoms" "hypoglycemiaSymptoms" "illness" "other" "stress"

"alcohol"

Reported State

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "reportedState" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
required	Array of objects (States) [ 1 .. 100 ] items unique

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "reportedState",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"states": [{"severity": 5,
"state": "alcohol",
"stateOther": "buzzed"
}
]
}

Metadata

property name*

additional property

any

{ }

Upload

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "upload" "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
deviceManufacturers	Array of strings (Device Manufacturers) An array of string tags indicating the manufacturer(s) of the device. In order to avoid confusion resulting from referring to a single manufacturer with more than one name—for example, using both 'Minimed' and 'Medtronic' interchangeably—we restrict the set of strings used to refer to manufacturers to the set listed above and enforce exact string matches (including casing). `deviceManufacturers` is an array of one or more string "tags" because there are devices resulting from a collaboration between more than one manufacturer, such as the Tandem G4 insulin pump with CGM integration (a collaboration between `Tandem` and `Dexcom`).
deviceModel	string (Device Model Name) non-empty A string identifying the model of the device. The `deviceModel` is a non-empty string that encodes the model of device. We endeavor to match each manufacturer's standard for how they represent model name in terms of casing, whether parts of the name are represented as one word or two, etc.
deviceSerialNumber	string (Device Serial Number) non-empty A string encoding the device's serial number. The `deviceSerialNumber` is a string that encodes the serial number of the device. Note that even if a manufacturer only uses digits in its serial numbers, the SN should be stored as a string regardless. Uniquely of string fields in the Tidepool device data models, `deviceSerialNumber` may be an empty string. This is essentially a compromise: having the device serial number is extremely important (especially for e.g., clinical studies) but in 2016 we came across our first case where we cannot recover the serial number of the device that generated the data: Dexcom G5 data uploaded to Tidepool through Apple iOS's HealthKit integration.
deviceTags	Array of strings (Device Tags) non-empty [ items <= 100 characters ] Items Enum: "bgm" "cgm" "insulin-pump" "fgm" "pen" "manual" An array of string tags indicating the function(s) of the device. The `deviceTags` array should be fairly self-explanatory as an array of tags indicating the function(s) of a particular device. For example, the Insulet OmniPod insulin delivery system has the tags `bgm` and `insulin-pump` since the PDM is both an insulin pump controller and includes a built-in blood glucose monitor.
byUser	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Client Software) The client software that provided diabetes data.
computerTime	string <time> (Computer Time) An ISO 8601 formatted timestamp without any timezone offset information. The `computerTime` field encodes the local time at upload with no timezone offset information since we are storing `timezone` separately. We store this field in order to be able to audit and/or detect the correspondence between the user's browser time and the timezone they selected at the time of upload. If the user selected the timezone that was actually in effect for their browser at the time of upload, then applying the stored `timezone` to the UTC Zulu `time` field will match `computerTime`. If, on the other hand, the user selected a different timezone from that effective in their browser at the time of upload, applying the `timezone` to `time` will not match `computerTime`. There are some use cases when it is perfectly justified to select a timezone that does not reflect the browser's current timezone. For example, some insulin pump users do not change the time on their devices when traveling for short periods of time across many timezones, but when uploading a device a user should always choose the timezone that aligns with the most recent data on the device and thus that will not match the local browser timezone.
dataSetType	string (Data Set Type) Enum: "continuous" "normal"
timeProcessing	string (Time Processing) Enum: "none" "across-the-board-timezone" "utc-bootstrapping" A string indicating what variety of processing was used to create the `time` and related fields such as `timezoneOffset` on data in this upload. For data auditing purposes, we store a string encoding the type of algorithm used to generate the `time`, `timezoneOffset`, and other related fields from the local `deviceTime`. At present, there are only three options for this value: `none` for data sources that already include a UTC-anchored `time` value. At present, the only data source for which this is true is Dexcom G5 or Dexcom G6 data coming through Apple's iOS HealthKit integration. `across-the-board-timezone` for devices (all BGMs, for example) that cannot have their `deviceTime` values "bootstrapped" to a UTC `time` value; in such cases, we apply a single user-selected timezone to every `deviceTime` "across the board" to generate the `time` value. `utc-bootstrapping` for devices (most insulin pumps and CGMs) where we use a combination of the user-selected timezone at time of upload, the most recent timestamp on device, and the history of display time changes on the device to infer the correct `time` value for each record.
version	string (Semantic Version Number) >= 5 characters ^(0\|[1-9]\d)\.(0\|[1-9]\d)\.(0\|[1-9]\d*)(?:-... Semantic Version Number 2.0.0. Regex from their site.

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "upload",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"byUser": "string",
"client": {"name": "org.tidepool.uploader",
"version": "2.36.1",
"platform": "macOS 10.15.4",
"private": { }
},
"computerTime": "14:15:22Z",
"dataSetType": "continuous",
"timeProcessing": "utc-bootstrapping",
"version": "2.36.1"
}

Tidepool Diabetes Data

One of

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
name required	string [ 1 .. 100 ] characters
priority	string Enum: "critical" "normal" "timeSensitive"
trigger	string Enum: "delayed" "immediate" "repeating"
triggerDelay	integer <int32> [ 0 .. 86400 ]
sound	string Enum: "name" "silence" "vibrate"
soundName	string [ 1 .. 100 ] characters
issuedTime required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
acknowledgedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
retractedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information

Example

Alert

{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "upload",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"name": "string",
"priority": "critical",
"trigger": "delayed",
"triggerDelay": 86400,
"sound": "name",
"soundName": "string",
"issuedTime": "2017-02-06T02:37:46Z",
"acknowledgedTime": "2017-02-06T02:37:46Z",
"retractedTime": "2017-02-06T02:37:46Z"
}

Tidepool Diabetes Data Array

Array (non-empty)

One of

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
createdUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deletedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
modifiedUserId	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... 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
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
name required	string [ 1 .. 100 ] characters
priority	string Enum: "critical" "normal" "timeSensitive"
trigger	string Enum: "delayed" "immediate" "repeating"
triggerDelay	integer <int32> [ 0 .. 86400 ]
sound	string Enum: "name" "silence" "vibrate"
soundName	string [ 1 .. 100 ] characters
issuedTime required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
acknowledgedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
retractedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information

[{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "alert",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"name": "string",
"priority": "critical",
"trigger": "delayed",
"triggerDelay": 86400,
"sound": "name",
"soundName": "string",
"issuedTime": "2017-02-06T02:37:46Z",
"acknowledgedTime": "2017-02-06T02:37:46Z",
"retractedTime": "2017-02-06T02:37:46Z"
}
]

Blood Unit (mg/dL or mmol/L)

One of

string (Blood Unit (mg/dL))

Enum: "mg/dL" "mg/dl"

Example

Blood Unit (mg/dL)

"mg/dL"

Basal Rate Start Array

Array

rate required	number <float> [ 0 .. 20 ] A floating point number >= 0 representing the amount of insulin delivered in Units per hour.
start required	integer <int64> [ 0 .. 86400000 ) Integer value representing milliseconds since midnight.

[{"rate": 20,
"start": 0
}
]

Carbohydrate Ratio

amount

required

number [ 0 .. 250 ]

{"amount": 250
}

Carbohydrate Ratio Start

start required	number [ 0 .. 86400000 ]
amount required	number [ 0 .. 250 ]

{"start": 86400000,
"amount": 250
}

Insulin Sensitivity Start

	Blood Value (mg/dL) (integer) or Blood Value (mmol/L) (number) (Blood Value (in mg/dL or mmol/L units))
start required	number [ 0 .. 86400000 ]

{"amount": 105,
"start": 86400000
}

Basal Rate Maximum

units required	string Value: "Units/hour"
value required	number [ 0 .. 100 ]

{"units": "Units/hour",
"value": 100
}

Bolus Amount Maximum

units required	string Value: "Units"
value required	number [ 0 .. 100 ]

{"units": "Units",
"value": 100
}

Suspend Threshold

required	Blood Unit (mg/dL) (string) or Blood Unit (mmol/L) (string) (Blood Unit (mg/dL or mmol/L))
required	Blood Value (mg/dL) (integer) or Blood Value (mmol/L) (number) (Blood Value (in mg/dL or mmol/L units))

{"units": "mg/dL",
"value": 105
}

Insulin Model

string (Insulin Model)

Enum: "rapidChild" "rapidAdult"

"rapidAdult"

Delete All Data for User

Delete all data for user specified by the userId.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

Responses

Response samples

Content type

application/json

{ }

Get Data Sets for User

Gets data sets for the user account specified by the userId.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

Responses

Response samples

Content type

application/json

{"data": [{"type": "upload",
"client": {"name": "com.devicecorp.tidepooluploader",
"version": "0.100.0"
},
"dataSetType": "normal",
"deduplicator": {"name": "org.tidepool.deduplicator.device.deactivate.hash",
"version": "1.2.3"
},
"deviceManufacturers": ["DeviceCorp"
],
"deviceModel": "Devicey McDeviceface",
"deviceSerialNumber": "B97B6D59",
"deviceTags": ["bgm",
"cgm",
"insulin-pump"
],
"timeProcessing": "none",
"timezone": "Europe/London",
"clockDriftOffset": 0,
"conversionOffset": 0,
"deviceId": "DevId0987654321",
"deviceTime": "2016-06-27T18:09:55",
"time": "2016-06-28T01:09:55.132Z",
"timezoneOffset": -420
}
]
}

Create New Data Set for User

Creates a new data set of type upload and data set type dataSetType for the user specified by the userId.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

Request Body schema: application/json

Create New Data Set

	object (Client Software) The client software that provided diabetes data.
dataSetType required	string (Data Set Type) Enum: "continuous" "normal"
deviceId required	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceManufacturers required	Array of strings (Device Manufacturers) An array of string tags indicating the manufacturer(s) of the device. In order to avoid confusion resulting from referring to a single manufacturer with more than one name—for example, using both 'Minimed' and 'Medtronic' interchangeably—we restrict the set of strings used to refer to manufacturers to the set listed above and enforce exact string matches (including casing). `deviceManufacturers` is an array of one or more string "tags" because there are devices resulting from a collaboration between more than one manufacturer, such as the Tandem G4 insulin pump with CGM integration (a collaboration between `Tandem` and `Dexcom`).
deviceModel required	string (Device Model Name) non-empty A string identifying the model of the device. The `deviceModel` is a non-empty string that encodes the model of device. We endeavor to match each manufacturer's standard for how they represent model name in terms of casing, whether parts of the name are represented as one word or two, etc.
deviceSerialNumber required	string (Device Serial Number) non-empty A string encoding the device's serial number. The `deviceSerialNumber` is a string that encodes the serial number of the device. Note that even if a manufacturer only uses digits in its serial numbers, the SN should be stored as a string regardless. Uniquely of string fields in the Tidepool device data models, `deviceSerialNumber` may be an empty string. This is essentially a compromise: having the device serial number is extremely important (especially for e.g., clinical studies) but in 2016 we came across our first case where we cannot recover the serial number of the device that generated the data: Dexcom G5 data uploaded to Tidepool through Apple iOS's HealthKit integration.
deviceTags	Array of strings (Device Tags) non-empty [ items <= 100 characters ] Items Enum: "bgm" "cgm" "insulin-pump" "fgm" "pen" "manual" An array of string tags indicating the function(s) of the device. The `deviceTags` array should be fairly self-explanatory as an array of tags indicating the function(s) of a particular device. For example, the Insulet OmniPod insulin delivery system has the tags `bgm` and `insulin-pump` since the PDM is both an insulin pump controller and includes a built-in blood glucose monitor.
	object (Deduplicator Descriptor)
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timeProcessing required	string (Time Processing) Enum: "none" "across-the-board-timezone" "utc-bootstrapping" A string indicating what variety of processing was used to create the `time` and related fields such as `timezoneOffset` on data in this upload. For data auditing purposes, we store a string encoding the type of algorithm used to generate the `time`, `timezoneOffset`, and other related fields from the local `deviceTime`. At present, there are only three options for this value: `none` for data sources that already include a UTC-anchored `time` value. At present, the only data source for which this is true is Dexcom G5 or Dexcom G6 data coming through Apple's iOS HealthKit integration. `across-the-board-timezone` for devices (all BGMs, for example) that cannot have their `deviceTime` values "bootstrapped" to a UTC `time` value; in such cases, we apply a single user-selected timezone to every `deviceTime` "across the board" to generate the `time` value. `utc-bootstrapping` for devices (most insulin pumps and CGMs) where we use a combination of the user-selected timezone at time of upload, the most recent timestamp on device, and the history of display time changes on the device to infer the correct `time` value for each record.
timezone required	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset required	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.

Responses

Request samples

Payload

Content type

application/json

{"client": {"name": "org.tidepool.uploader",
"version": "2.36.1",
"platform": "macOS 10.15.4",
"private": { }
},
"dataSetType": "continuous",
"deviceId": "MMT-1711:12345678",
"deviceManufacturers": ["DeviceCo"
],
"deviceModel": "Devicey McDeviceface",
"deviceSerialNumber": "B97B6D59",
"deviceTags": ["bgm"
],
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"time": "2017-02-06T02:37:46Z",
"timeProcessing": "utc-bootstrapping",
"timezone": "Europe/London",
"timezoneOffset": -420
}

Response samples

Content type

application/json

{"type": "upload",
"client": {"name": "com.devicecorp.tidepooluploader",
"version": "0.100.0"
},
"dataSetType": "normal",
"deduplicator": {"name": "org.tidepool.deduplicator.device.deactivate.hash",
"version": "1.2.3"
},
"deviceManufacturers": ["DeviceCorp"
],
"deviceModel": "Devicey McDeviceface",
"deviceSerialNumber": "B97B6D59",
"deviceTags": ["bgm",
"cgm",
"insulin-pump"
],
"timeProcessing": "none",
"timezone": "Europe/London",
"clockDriftOffset": 0,
"conversionOffset": 0,
"deviceId": "DevId0987654321",
"deviceTime": "2016-06-27T18:09:55",
"time": "2016-06-28T01:09:55.132Z",
"timezoneOffset": -420
}

List Data Sets for User

Returns a list of data sets for the user specified by the userId.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

query Parameters

page	integer <int32> (Page Number) >= 0 Default: 0 Example: page=0 Page number for pagination
size	integer <int32> (Page Size) [ 1 .. 1000 ] Default: 100 Example: size=42 Page size for pagination
client.name	string
deleted	boolean
deviceId	string

Responses

Response samples

Content type

application/json

{"data": [{"type": "upload",
"client": {"name": "com.devicecorp.tidepooluploader",
"version": "0.100.0"
},
"dataSetType": "normal",
"deduplicator": {"name": "org.tidepool.deduplicator.device.deactivate.hash",
"version": "1.2.3"
},
"deviceManufacturers": ["DeviceCorp"
],
"deviceModel": "Devicey McDeviceface",
"deviceSerialNumber": "B97B6D59",
"deviceTags": ["bgm",
"cgm",
"insulin-pump"
],
"timeProcessing": "none",
"timezone": "Europe/London",
"clockDriftOffset": 0,
"conversionOffset": 0,
"deviceId": "DevId0987654321",
"deviceTime": "2016-06-27T18:09:55",
"time": "2016-06-28T01:09:55.132Z",
"timezoneOffset": -420
}
]
}

Create New Data Set for User

Creates a new data set of type upload and data set type dataSetType for the user specified by the userId.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

Request Body schema: application/json

Create New Data Set

	object (Client Software) The client software that provided diabetes data.
dataSetType required	string (Data Set Type) Enum: "continuous" "normal"
deviceId required	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceManufacturers required	Array of strings (Device Manufacturers) An array of string tags indicating the manufacturer(s) of the device. In order to avoid confusion resulting from referring to a single manufacturer with more than one name—for example, using both 'Minimed' and 'Medtronic' interchangeably—we restrict the set of strings used to refer to manufacturers to the set listed above and enforce exact string matches (including casing). `deviceManufacturers` is an array of one or more string "tags" because there are devices resulting from a collaboration between more than one manufacturer, such as the Tandem G4 insulin pump with CGM integration (a collaboration between `Tandem` and `Dexcom`).
deviceModel required	string (Device Model Name) non-empty A string identifying the model of the device. The `deviceModel` is a non-empty string that encodes the model of device. We endeavor to match each manufacturer's standard for how they represent model name in terms of casing, whether parts of the name are represented as one word or two, etc.
deviceSerialNumber required	string (Device Serial Number) non-empty A string encoding the device's serial number. The `deviceSerialNumber` is a string that encodes the serial number of the device. Note that even if a manufacturer only uses digits in its serial numbers, the SN should be stored as a string regardless. Uniquely of string fields in the Tidepool device data models, `deviceSerialNumber` may be an empty string. This is essentially a compromise: having the device serial number is extremely important (especially for e.g., clinical studies) but in 2016 we came across our first case where we cannot recover the serial number of the device that generated the data: Dexcom G5 data uploaded to Tidepool through Apple iOS's HealthKit integration.
deviceTags	Array of strings (Device Tags) non-empty [ items <= 100 characters ] Items Enum: "bgm" "cgm" "insulin-pump" "fgm" "pen" "manual" An array of string tags indicating the function(s) of the device. The `deviceTags` array should be fairly self-explanatory as an array of tags indicating the function(s) of a particular device. For example, the Insulet OmniPod insulin delivery system has the tags `bgm` and `insulin-pump` since the PDM is both an insulin pump controller and includes a built-in blood glucose monitor.
	object (Deduplicator Descriptor)
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timeProcessing required	string (Time Processing) Enum: "none" "across-the-board-timezone" "utc-bootstrapping" A string indicating what variety of processing was used to create the `time` and related fields such as `timezoneOffset` on data in this upload. For data auditing purposes, we store a string encoding the type of algorithm used to generate the `time`, `timezoneOffset`, and other related fields from the local `deviceTime`. At present, there are only three options for this value: `none` for data sources that already include a UTC-anchored `time` value. At present, the only data source for which this is true is Dexcom G5 or Dexcom G6 data coming through Apple's iOS HealthKit integration. `across-the-board-timezone` for devices (all BGMs, for example) that cannot have their `deviceTime` values "bootstrapped" to a UTC `time` value; in such cases, we apply a single user-selected timezone to every `deviceTime` "across the board" to generate the `time` value. `utc-bootstrapping` for devices (most insulin pumps and CGMs) where we use a combination of the user-selected timezone at time of upload, the most recent timestamp on device, and the history of display time changes on the device to infer the correct `time` value for each record.
timezone required	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset required	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.

Responses

Request samples

Payload

Content type

application/json

{"client": {"name": "org.tidepool.uploader",
"version": "2.36.1",
"platform": "macOS 10.15.4",
"private": { }
},
"dataSetType": "continuous",
"deviceId": "MMT-1711:12345678",
"deviceManufacturers": ["DeviceCo"
],
"deviceModel": "Devicey McDeviceface",
"deviceSerialNumber": "B97B6D59",
"deviceTags": ["bgm"
],
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"time": "2017-02-06T02:37:46Z",
"timeProcessing": "utc-bootstrapping",
"timezone": "Europe/London",
"timezoneOffset": -420
}

Response samples

Content type

application/json

{"type": "upload",
"client": {"name": "com.devicecorp.tidepooluploader",
"version": "0.100.0"
},
"dataSetType": "normal",
"deduplicator": {"name": "org.tidepool.deduplicator.device.deactivate.hash",
"version": "1.2.3"
},
"deviceManufacturers": ["DeviceCorp"
],
"deviceModel": "Devicey McDeviceface",
"deviceSerialNumber": "B97B6D59",
"deviceTags": ["bgm",
"cgm",
"insulin-pump"
],
"timeProcessing": "none",
"timezone": "Europe/London",
"clockDriftOffset": 0,
"conversionOffset": 0,
"deviceId": "DevId0987654321",
"deviceTime": "2016-06-27T18:09:55",
"time": "2016-06-28T01:09:55.132Z",
"timezoneOffset": -420
}

Update Data Set

Updates the data set specified by the dataSetId.

Authorizations:

sessionToken

path Parameters

dataSetId

required

string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}|upid_[0-9a-f]{32}|[0-9a-f...

Example: ce8cc5f7595575945f91fc6710db6fef

Data Set ID

Request Body schema: application/json

Update Data Set

deviceId required	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceModel required	string (Device Model Name) non-empty A string identifying the model of the device. The `deviceModel` is a non-empty string that encodes the model of device. We endeavor to match each manufacturer's standard for how they represent model name in terms of casing, whether parts of the name are represented as one word or two, etc.
deviceSerialNumber required	string (Device Serial Number) non-empty A string encoding the device's serial number. The `deviceSerialNumber` is a string that encodes the serial number of the device. Note that even if a manufacturer only uses digits in its serial numbers, the SN should be stored as a string regardless. Uniquely of string fields in the Tidepool device data models, `deviceSerialNumber` may be an empty string. This is essentially a compromise: having the device serial number is extremely important (especially for e.g., clinical studies) but in 2016 we came across our first case where we cannot recover the serial number of the device that generated the data: Dexcom G5 data uploaded to Tidepool through Apple iOS's HealthKit integration.
state required	string (Data Set State) Enum: "open" "closed"
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone required	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset required	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.

Responses

Request samples

Payload

Content type

application/json

{"deviceId": "MMT-1711:12345678",
"deviceModel": "Devicey McDeviceface",
"deviceSerialNumber": "B97B6D59",
"state": "open",
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420
}

Response samples

Content type

application/json

{"type": "upload",
"client": {"name": "com.devicecorp.tidepooluploader",
"version": "0.100.0"
},
"dataSetType": "normal",
"deduplicator": {"name": "org.tidepool.deduplicator.device.deactivate.hash",
"version": "1.2.3"
},
"deviceManufacturers": ["DeviceCorp"
],
"deviceModel": "Devicey McDeviceface",
"deviceSerialNumber": "B97B6D59",
"deviceTags": ["bgm",
"cgm",
"insulin-pump"
],
"timeProcessing": "none",
"timezone": "Europe/London",
"clockDriftOffset": 0,
"conversionOffset": 0,
"deviceId": "DevId0987654321",
"deviceTime": "2016-06-27T18:09:55",
"time": "2016-06-28T01:09:55.132Z",
"timezoneOffset": -420
}

Delete Data Set

Deletes the data set specified by the dataSetId.

Authorizations:

sessionToken

path Parameters

dataSetId

required

string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}|upid_[0-9a-f]{32}|[0-9a-f...

Example: ce8cc5f7595575945f91fc6710db6fef

Data Set ID

Responses

Response samples

Content type

application/json

{ }

Get Data Set

Returns the data set specified by the dataSetId.

Authorizations:

sessionToken

path Parameters

dataSetId

required

string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}|upid_[0-9a-f]{32}|[0-9a-f...

Example: ce8cc5f7595575945f91fc6710db6fef

Data Set ID

Responses

Response samples

Content type

application/json

{ }

Update Data Set

Updates the data set specified by the dataSetId.

Authorizations:

sessionToken

path Parameters

dataSetId

required

string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}|upid_[0-9a-f]{32}|[0-9a-f...

Example: ce8cc5f7595575945f91fc6710db6fef

Data Set ID

Request Body schema: application/json

Update Data Set

deviceId required	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceModel required	string (Device Model Name) non-empty A string identifying the model of the device. The `deviceModel` is a non-empty string that encodes the model of device. We endeavor to match each manufacturer's standard for how they represent model name in terms of casing, whether parts of the name are represented as one word or two, etc.
deviceSerialNumber required	string (Device Serial Number) non-empty A string encoding the device's serial number. The `deviceSerialNumber` is a string that encodes the serial number of the device. Note that even if a manufacturer only uses digits in its serial numbers, the SN should be stored as a string regardless. Uniquely of string fields in the Tidepool device data models, `deviceSerialNumber` may be an empty string. This is essentially a compromise: having the device serial number is extremely important (especially for e.g., clinical studies) but in 2016 we came across our first case where we cannot recover the serial number of the device that generated the data: Dexcom G5 data uploaded to Tidepool through Apple iOS's HealthKit integration.
state required	string (Data Set State) Enum: "open" "closed"
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone required	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset required	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.

Responses

Request samples

Payload

Content type

application/json

{"deviceId": "MMT-1711:12345678",
"deviceModel": "Devicey McDeviceface",
"deviceSerialNumber": "B97B6D59",
"state": "open",
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420
}

Response samples

Content type

application/json

{"type": "upload",
"client": {"name": "com.devicecorp.tidepooluploader",
"version": "0.100.0"
},
"dataSetType": "normal",
"deduplicator": {"name": "org.tidepool.deduplicator.device.deactivate.hash",
"version": "1.2.3"
},
"deviceManufacturers": ["DeviceCorp"
],
"deviceModel": "Devicey McDeviceface",
"deviceSerialNumber": "B97B6D59",
"deviceTags": ["bgm",
"cgm",
"insulin-pump"
],
"timeProcessing": "none",
"timezone": "Europe/London",
"clockDriftOffset": 0,
"conversionOffset": 0,
"deviceId": "DevId0987654321",
"deviceTime": "2016-06-27T18:09:55",
"time": "2016-06-28T01:09:55.132Z",
"timezoneOffset": -420
}

Delete Data Set

Deletes an entire dataset specified by the dataSetId.

Authorizations:

sessionToken

path Parameters

dataSetId

required

string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}|upid_[0-9a-f]{32}|[0-9a-f...

Example: ce8cc5f7595575945f91fc6710db6fef

Data Set ID

Responses

Response samples

Content type

application/json

{ }

Upload Data to Data Set

Uploads data to a user's data set identified by the dataSetId.

Authorizations:

sessionToken

path Parameters

dataSetId

required

string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}|upid_[0-9a-f]{32}|[0-9a-f...

Example: ce8cc5f7595575945f91fc6710db6fef

Data Set ID

Request Body schema: application/json

Array (non-empty)

One of

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
name required	string [ 1 .. 100 ] characters
priority	string Enum: "critical" "normal" "timeSensitive"
trigger	string Enum: "delayed" "immediate" "repeating"
triggerDelay	integer <int32> [ 0 .. 86400 ]
sound	string Enum: "name" "silence" "vibrate"
soundName	string [ 1 .. 100 ] characters
issuedTime required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
acknowledgedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
retractedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information

Responses

Request samples

Payload

Content type

application/json

[{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "alert",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"name": "string",
"priority": "critical",
"trigger": "delayed",
"triggerDelay": 86400,
"sound": "name",
"soundName": "string",
"issuedTime": "2017-02-06T02:37:46Z",
"acknowledgedTime": "2017-02-06T02:37:46Z",
"retractedTime": "2017-02-06T02:37:46Z"
}
]

Response samples

Content type

application/json

[{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "alert",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"name": "string",
"priority": "critical",
"trigger": "delayed",
"triggerDelay": 86400,
"sound": "name",
"soundName": "string",
"issuedTime": "2017-02-06T02:37:46Z",
"acknowledgedTime": "2017-02-06T02:37:46Z",
"retractedTime": "2017-02-06T02:37:46Z"
}
]

Upload Data to Data Set

Uploads data to a user's data set identified by the dataSetId.

Authorizations:

sessionToken

path Parameters

dataSetId

required

string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}|upid_[0-9a-f]{32}|[0-9a-f...

Example: ce8cc5f7595575945f91fc6710db6fef

Data Set ID

Request Body schema: application/json

Array (non-empty)

One of

	Array of objects or Blood Glucose Out of Range (object) (Annotation Array) [ 0 .. 100 ] items unique An array of annotations.
archivedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
archivedDatasetId	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	Array 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.
clockDriftOffset	integer <int64> (Clock Drift Offset) [ -86400000 .. 86400000 ] Clock drift offset, expressed as milliseconds.
conversionOffset	integer <int64> (Conversion Offset) Conversion offset, expressed as milliseconds.
createdTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
	object (Deduplicator Descriptor)
deletedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
deviceId	string (Device ID) non-empty Device identifier, if provided by the manufacturer.
deviceTime	string (Date/Time without Timezone) ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ RFC 3339 / ISO 8601 timestamp without timezone information
guid	string Deprecated A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.
	Array of objects (Event History [Proposed]) Revision history of the event
id required	string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}\|upid_[0-9a-f]{32}\|[0-9a-f...
	object (Location) Location information associated with the resource. One or both of `name` and `gps` must be specified.
modifiedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
notes	Array of strings (Note Array) [ 1 .. 100 ] items [ items [ 1 .. 1000 ] characters ] An array of 1 to 100 notes.
	object (Origin) External origin information for the source of the resource.
	object (Payload) Additional user-specified metadata. The maximum size is 4K bytes.
source	string Value: "carelink"
tags	Array of strings (Tag Array) [ items [ 1 .. 100 ] characters ] An array of tags.
time required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
timezone	string (Time Zone) A string timezone name from the IANA timezone database
timezoneOffset	integer <int32> (Time Zone offset) [ -10080 .. 10080 ] Time zone offset, expressed as positive or negative number of minutes from UTC.
type required	string (Tidepool Data Type) Enum: "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Data type
uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$
name required	string [ 1 .. 100 ] characters
priority	string Enum: "critical" "normal" "timeSensitive"
trigger	string Enum: "delayed" "immediate" "repeating"
triggerDelay	integer <int32> [ 0 .. 86400 ]
sound	string Enum: "name" "silence" "vibrate"
soundName	string [ 1 .. 100 ] characters
issuedTime required	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
acknowledgedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information
retractedTime	string <date-time> (Date/Time) RFC 3339 / ISO 8601 timestamp with timezone information

Responses

Request samples

Payload

Content type

application/json

[{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "alert",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"name": "string",
"priority": "critical",
"trigger": "delayed",
"triggerDelay": 86400,
"sound": "name",
"soundName": "string",
"issuedTime": "2017-02-06T02:37:46Z",
"acknowledgedTime": "2017-02-06T02:37:46Z",
"retractedTime": "2017-02-06T02:37:46Z"
}
]

Response samples

Content type

application/json

[{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "alert",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"name": "string",
"priority": "critical",
"trigger": "delayed",
"triggerDelay": 86400,
"sound": "name",
"soundName": "string",
"issuedTime": "2017-02-06T02:37:46Z",
"acknowledgedTime": "2017-02-06T02:37:46Z",
"retractedTime": "2017-02-06T02:37:46Z"
}
]

Delete Data from Data Set

Deletes data from data set specified by the dataSetId.

Authorizations:

sessionToken

path Parameters

dataSetId

required

string (Data Set ID) [ 17 .. 37 ] characters ^(upid_[0-9a-f]{12}|upid_[0-9a-f]{32}|[0-9a-f...

Example: ce8cc5f7595575945f91fc6710db6fef

Data Set ID

Responses

Response samples

Content type

application/json

{ }

Get Data for User

Get data for the specified userId. You can filter the data to pull with several query parameters.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

query Parameters

uploadId	string (Upload ID) [ 17 .. 32 ] characters ^([0-9a-f]{32}\|upid_[0-9a-f]{12})$ Example: uploadId=0d92d5c1c22117a18f3620b9e24d3c06 Upload ID. Search for data by `uploadId`. Only objects with a `uploadId` field matching the specified `uploadId` parameter will be returned.
deviceId	string (Device ID) non-empty Example: deviceId=MMT-1711:12345678 Device ID. Search for data by `deviceId`. Only objects with a `deviceId` field matching the specified `uploadId` parameter will be returned.
type	Array of strings (Tidepool Data Type) non-empty Items Enum: "alert" "basal" "bloodKetone" "bolus" "cbg" "cgmSettings" "controllerSettings" "controllerStatus" "deviceEvent" "deviceStatus" "dosingDecision" "food" "insulin" "physicalActivity" "pumpSettings" "pumpStatus" "reportedState" "smbg" "upload" "water" "wizard" Example: type=cbg,smbg Upload Type. The data type to search for. Only objects with a `type` field matching the specified `type` parameter will be returned. It can be a single value like `/data/userid?type=smbg` or a comma separated list like `/data/userid?type=smgb,cbg`. If is a comma separated list, then objects matching any of the types will be returned.
	Array of Self Monitored Glucose Sub Type (string) or Bolus Subtype (string) or Device Event Sub Type (string) (Data Sub Type) Sub Type. The data subtype to search for. Only objects with a `subType` field matching the specified `subType` parameter will be returned. It can be a single value like `?subtype=physicalactivity` or a comma separated list like `?subtypetype=physicalactivity,steps`. If it is a comma separated list, then objects matching any of the types will be returned.
startDate	string <date-time> (Date/Time) Example: startDate=2017-02-06T02:37:46Z Start Date. Only objects with `time` field equal to or greater than start date will be returned. Must be in ISO 8601 date/time format e.g. `2015-10-10T15:00:00.000Z`.
endDate	string <date-time> (Date/Time) Example: endDate=2017-02-06T02:37:46Z End Date. Only objects with `time` field less than to or equal to start date will be returned. Must be in ISO 8601 date/time format e.g. `2015-10-10T15:00:00.000Z`.
latest	boolean Default: false Latest Data. Returns only the most recent results for each `type` matching the results filtered by the other query parameters.
dexcom	boolean Default: false Dexcom Data
carelink	boolean Default: false Carelink Data
medtronic	boolean Default: false Medtronic Data

Responses

Response samples

Content type

application/json

[{"annotations": [{"code": "wrong-device-time"
}
],
"archivedTime": "2017-02-06T02:37:46Z",
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [{"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deduplicator": {"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [{"time": "2017-02-06T02:37:46Z",
"changes": {"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {"name": "string",
"gps": {"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {"units": "degrees",
"value": -122.1625595
},
"latitude": {"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {"value": 42,
"units": "meters"
},
"verticalAccuracy": {"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"notes": ["string"
],
"origin": {"id": "string",
"name": "string",
"payload": { },
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": { },
"source": "carelink",
"tags": ["string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "alert",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"name": "string",
"priority": "critical",
"trigger": "delayed",
"triggerDelay": 86400,
"sound": "name",
"soundName": "string",
"issuedTime": "2017-02-06T02:37:46Z",
"acknowledgedTime": "2017-02-06T02:37:46Z",
"retractedTime": "2017-02-06T02:37:46Z"
}
]

List Data Sources for User

Returns a list of data sources for the user specified by the userId.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

query Parameters

page	integer <int32> (Page Number) >= 0 Default: 0 Example: page=0 Page number for pagination
size	integer <int32> (Page Size) [ 1 .. 1000 ] Default: 100 Example: size=42 Page size for pagination

Responses

Response samples

Content type

application/json

[{"createdTime": "2017-02-06T02:37:46Z",
"dataSetIds": ["ce8cc5f7595575945f91fc6710db6fef"
],
"earliestDataTime": "2017-02-06T02:37:46Z",
"id": "c0ce05326529c6b35b0f4a568a344026",
"lastImportTime": "2017-02-06T02:37:46Z",
"latestDataTime": "2017-02-06T02:37:46Z",
"modifiedTime": "2017-02-06T02:37:46Z",
"providerName": "dexcom",
"providerSessionId": "string",
"providerType": "oauth",
"revision": 0,
"state": "connected",
"userId": "string"
}
]

Get Data Source

Returns the data source specified by the dataSourceId.

Authorizations:

sessionToken

path Parameters

dataSourceId

required

string (Data Source ID) = 32 characters ^[0-9a-f]{32}$

Example: c0ce05326529c6b35b0f4a568a344026

Data Source ID

Responses

Response samples

Content type

application/json

{"createdTime": "2017-02-06T02:37:46Z",
"dataSetIds": ["ce8cc5f7595575945f91fc6710db6fef"
],
"earliestDataTime": "2017-02-06T02:37:46Z",
"id": "c0ce05326529c6b35b0f4a568a344026",
"lastImportTime": "2017-02-06T02:37:46Z",
"latestDataTime": "2017-02-06T02:37:46Z",
"modifiedTime": "2017-02-06T02:37:46Z",
"providerName": "dexcom",
"providerSessionId": "string",
"providerType": "oauth",
"revision": 0,
"state": "connected",
"userId": "string"
}

Export

Enable bulk export of diabetes data from user's Tidepool account.

Messages

List, create and manage messages (also known as notes) in the user's account.

All APIs require a valid session token provided via the X-Tidepool-Session-Token header. There is currently no unauthenticated access to messages.

The common API input parameter userId is a Tidepool User ID that identifies the user whose account contains the messages. That user may have shared their account with (=given permission to) other users who can view and manage messages in their account. Therefore, in each API request the user ID identified with the session token must either a) match the userId parameter, or b) the corresponding user must have been granted the note permission to manage messages in the user account identified by userId.

Similarly, in the API responses the groupid field is a Tidepool User ID that identifies the user whose account contains the messages, corresponding to the userId parameter in requests. The userid field identifies the user who actually created the message, corresponding to the user ID encoded within the session token. The message was created by the owner of the account if these two fields match.

Each message has a unique message ID, and the messages can be threaded. A user can create either a new message, or create a reply to another message. Each message contains a parentmessage field that contains the message ID of previous message in the thread. Messages that have no parentmessage field value (i.e. it is null) are top-level messages, that is, the beginning of a message thread.

See the Authorization API for details on how permissions are managed.

List All Messages

List all messages in the user account identified by userId, optionally within the time range bounded by starttime and/or endtime.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

query Parameters

starttime	string <date-time> (Date/Time) Example: starttime=2017-02-06T02:37:46Z Start Time. Start date/time of the range for messages
endtime	string <date-time> (Date/Time) Example: endtime=2017-02-06T02:37:46Z End Time. End date/time of the range for messages

Responses

Response samples

Content type

application/json

{"messages": [{"message": {"id": "60e64ddf98b2350011b0f37f",
"guid": "b9468a76-4afc-4c33-8d1d-1f08324d9160",
"parentmessage": "60e64ddf98b2350011b0f37f",
"userid": "string",
"groupid": "string",
"timestamp": "2017-02-06T02:37:46Z",
"createdtime": "2017-02-06T02:37:46Z",
"modifiedtime": "2017-02-06T02:37:46Z",
"messagetext": "I ate a taco with 10g of carbs",
"user": {"fullName": "James Jellyfish"
}
}
}
]
}

List Top-Level Messages

List only the top-level message threads in the user account identified by userId, optionally within the time range bounded by starttime and/or endtime. Top-level messages are the starting point of each message thread (i.e. parentmessage == null), that is, messages that are not responses to other messages.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

query Parameters

starttime	string <date-time> (Date/Time) Example: starttime=2017-02-06T02:37:46Z Start Time. Start date/time of the range for messages
endtime	string <date-time> (Date/Time) Example: endtime=2017-02-06T02:37:46Z End Time. End date/time of the range for messages

Responses

Response samples

Content type

application/json

{"messages": [{"message": {"id": "60e64ddf98b2350011b0f37f",
"guid": "b9468a76-4afc-4c33-8d1d-1f08324d9160",
"parentmessage": "60e64ddf98b2350011b0f37f",
"userid": "string",
"groupid": "string",
"timestamp": "2017-02-06T02:37:46Z",
"createdtime": "2017-02-06T02:37:46Z",
"modifiedtime": "2017-02-06T02:37:46Z",
"messagetext": "I ate a taco with 10g of carbs",
"user": {"fullName": "James Jellyfish"
}
}
}
]
}

Create New Top-Level Message

Creates a new top-level message (thread) in the account identified by userId. Top-level messages are the starting point of a message thread (i.e. parentmessage == null), that is, not a response to any other message.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"message": {"messagetext": "string",
"timestamp": "2017-02-06T02:37:46Z",
"guid": "b9468a76-4afc-4c33-8d1d-1f08324d9160"
}
}

Response samples

Content type

application/json

{"id": "60e64ddf98b2350011b0f37f"
}

Reply to Message

Adds a reply to an existing message identified by messageId.

Authorizations:

sessionToken

path Parameters

messageId

required

string (Message ID) = 24 characters ^[0-9a-f]{24}$

Example: 60e64ddf98b2350011b0f37f

Message ID

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"message": {"messagetext": "string",
"timestamp": "2017-02-06T02:37:46Z",
"guid": "b9468a76-4afc-4c33-8d1d-1f08324d9160"
}
}

Response samples

Content type

application/json

{"id": "60e64ddf98b2350011b0f37f"
}

Get Message by ID

Returns message identified by messageId

Authorizations:

sessionToken

path Parameters

messageId

required

string (Message ID) = 24 characters ^[0-9a-f]{24}$

Example: 60e64ddf98b2350011b0f37f

Message ID

Responses

Response samples

Content type

application/json

{"message": {"id": "60e64ddf98b2350011b0f37f",
"guid": "b9468a76-4afc-4c33-8d1d-1f08324d9160",
"parentmessage": "60e64ddf98b2350011b0f37f",
"userid": "string",
"groupid": "string",
"timestamp": "2017-02-06T02:37:46Z",
"createdtime": "2017-02-06T02:37:46Z",
"modifiedtime": "2017-02-06T02:37:46Z",
"messagetext": "I ate a taco with 10g of carbs",
"user": {"fullName": "James Jellyfish"
}
}
}

Get Message Thread by ID

Returns message thread identified by messageId

Authorizations:

sessionToken

path Parameters

messageId

required

string (Message ID) = 24 characters ^[0-9a-f]{24}$

Example: 60e64ddf98b2350011b0f37f

Message ID

Responses

Response samples

Content type

application/json

{"messages": [{"message": {"id": "60e64ddf98b2350011b0f37f",
"guid": "b9468a76-4afc-4c33-8d1d-1f08324d9160",
"parentmessage": "60e64ddf98b2350011b0f37f",
"userid": "string",
"groupid": "string",
"timestamp": "2017-02-06T02:37:46Z",
"createdtime": "2017-02-06T02:37:46Z",
"modifiedtime": "2017-02-06T02:37:46Z",
"messagetext": "I ate a taco with 10g of carbs",
"user": {"fullName": "James Jellyfish"
}
}
}
]
}

Update Message

Updates the message identified by messageId. Either the timestamp or the messagetext field or both must be supplied in the request body. No other fields of the message may be updated. The modifiedtime field of the message will indicate when the message was last modified.

Authorizations:

sessionToken

path Parameters

messageId

required

string (Message ID) = 24 characters ^[0-9a-f]{24}$

Example: 60e64ddf98b2350011b0f37f

Message ID

Request Body schema: application/json

object or object

Responses

Request samples

Payload

Content type

application/json

{"message": {"messagetext": "string",
"timestamp": "2017-02-06T02:37:46Z"
}
}

Response samples

Content type

application/json

{"messages": ["string"
]
}

Delete Message

Deletes the message identified by messageId.

Authorizations:

sessionToken

path Parameters

messageId

required

string (Message ID) = 24 characters ^[0-9a-f]{24}$

Example: 60e64ddf98b2350011b0f37f

Message ID

Responses

Response samples

Content type

application/json

{"messages": ["string"
]
}

Metadata

Create and update user metadata.

Get Metadata Collections

Returns list of valid metadata collections.

Authorizations:

sessionToken

Responses

Response samples

Content type

application/json

["profile",
"groups",
"private"
]

Get User Metadata Collection

Returns the user's metadata collection corresponding to collectionName. Each metadata collection is an unbounded JSON object with client-defined fields.

Authorizations:

sessionToken

path Parameters

userId required	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... Tidepool User ID
collectionName required	string (Metadata Collection Name) Enum: "profile" "preferences" "settings" "groups" "private" Example: profile Metadata Collection Name

Responses

Response samples

Content type

application/json

Example

Profile

{"fullName": "James Jellyfish",
"patient": {"diagnosisType": "type1",
"diagnosisDate": "2013-05-09",
"birthday": "2012-08-30",
"biologicalSex": "male",
"targetDevices": ["bayercontournext"
],
"targetTimezone": "US/Eastern",
"about": "Jellyman is awesome!"
}
}

Update User Metadata Collection

Updates the user's metadata collection corresponding to collectionName. Each metadata collection is an unbounded JSON object with client-defined fields.

Authorizations:

sessionToken

path Parameters

userId required	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... Tidepool User ID
collectionName required	string (Metadata Collection Name) Enum: "profile" "preferences" "settings" "groups" "private" Example: profile Metadata Collection Name

Request Body schema: application/json

Any of

fullName	string (Full Name)
	object

Responses

Request samples

Payload

Content type

application/json

Example

Profile

{"fullName": "James Jellyfish",
"patient": {"diagnosisType": "type1",
"diagnosisDate": "2013-05-09",
"birthday": "2012-08-30",
"biologicalSex": "male",
"targetDevices": ["bayercontournext"
],
"targetTimezone": "US/Eastern",
"about": "Jellyman is awesome!"
}
}

Response samples

Content type

application/json

Example

Profile

{"fullName": "James Jellyfish",
"patient": {"diagnosisType": "type1",
"diagnosisDate": "2013-05-09",
"birthday": "2012-08-30",
"biologicalSex": "male",
"targetDevices": ["bayercontournext"
],
"targetTimezone": "US/Eastern",
"about": "Jellyman is awesome!"
}
}

Update User Metadata Collection

Updates the user's metadata collection corresponding to collectionName. Each metadata collection is an unbounded JSON object with client-defined fields.

Authorizations:

sessionToken

path Parameters

userId required	string (Tidepool User ID) ^([0-9a-f]{10}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-... Tidepool User ID
collectionName required	string (Metadata Collection Name) Enum: "profile" "preferences" "settings" "groups" "private" Example: profile Metadata Collection Name

Request Body schema: application/json

Any of

fullName	string (Full Name)
	object

Responses

Request samples

Payload

Content type

application/json

Example

Profile

{"fullName": "James Jellyfish",
"patient": {"diagnosisType": "type1",
"diagnosisDate": "2013-05-09",
"birthday": "2012-08-30",
"biologicalSex": "male",
"targetDevices": ["bayercontournext"
],
"targetTimezone": "US/Eastern",
"about": "Jellyman is awesome!"
}
}

Response samples

Content type

application/json

Example

Profile

{"fullName": "James Jellyfish",
"patient": {"diagnosisType": "type1",
"diagnosisDate": "2013-05-09",
"birthday": "2012-08-30",
"biologicalSex": "male",
"targetDevices": ["bayercontournext"
],
"targetTimezone": "US/Eastern",
"about": "Jellyman is awesome!"
}
}

List Users

List all users who have trustee or trustor access to the user account identified by userId.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

Responses

Response samples

Content type

application/json

[{"emailVerified": true,
"emails": ["example@tidepool.org"
],
"termsAccepted": "2017-02-06T02:37:46Z",
"roles": ["clinic"
],
"userid": "string",
"username": "example@tidepool.org",
"profile": {"fullName": "James Jellyfish",
"patient": {"diagnosisType": "type1",
"diagnosisDate": "2013-05-09",
"birthday": "2012-08-30",
"biologicalSex": "male",
"targetDevices": ["bayercontournext"
],
"targetTimezone": "US/Eastern",
"about": "Jellyman is awesome!"
}
},
"trusteePermissions": {"note": { },
"upload": { },
"view": { }
}
}
]

Metrics

Record metrics events.

These metrics APIs are intended for use by Tidepool products to capture free-form metrics events. The APIs have no request body, nor do they return any meaningful responses. There are very few constraints or validation of the input parameters. Any number of additional query parameters can be included in the API requests, and they are recorded along with the metrics event. It is OK to send them asynchronously in a fire-and-forget manner.

Record Metrics Event for User

Records a new metrics event for the user identified by the userId parameter. This API does not require a session token, but if one is provided it must be a valid token. The userId parameter is not validated. Any query parameters supplied with the request will be recorded as part of the event.

Authorizations:

sessionToken

path Parameters

userId

required

string (Tidepool User ID) ^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...

Tidepool User ID

eventName

required

string (Metrics Event Name)

Example: blip%20-%20Viewed%20Care%20Team%20List

Client-defined event name. The metrics service imposes no restrictions on the event name. The event name must be URL-safe, or encoded as such, as it is sent as part of the URL path. Current best practice is to prefix the event name with the client application name, such as blip, followed by the actual event name, such as Viewed Care Team List. The resulting full event name might be blip - Viewed Care Team List, but encoded in URL-safe manner (i.e. converting spaces to %20). This allows differentiation between recording similar events by different client applications.

Responses

Record Metrics Event for Logged-In User

Records a new metrics event for the user identified by the session token. This API requires a session token, and it must be a valid user token. The userId parameter is extracted from the session token. Any query parameters supplied with the request will be recorded as part of the event.

Authorizations:

sessionToken

path Parameters

eventName

required

string (Metrics Event Name)

Example: blip%20-%20Viewed%20Care%20Team%20List

Responses

Prescriptions

Manage prescriptions for Tidepool Loop

List Prescriptions

Retrieve the list of prescriptions created by clinic members

Authorizations:

sessionToken

path Parameters

clinicId

required

string

query Parameters

id	string
patientUserId	string
patientEmail	string <email>
state	string
createdAfter	string <date-time> inclusive
createdBefore	string <date-time> exclusive
modifiedAfter	string <date-time> inclusive
modifiedBefore	string <date-time> exclusive

Responses

Response samples

Content type

application/json

[{"id": "stringstringstringstring",
"patientUserId": "string",
"state": "draft",
"expirationTime": "2017-02-06T02:37:46Z",
"prescriberUserId": "string",
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"latestRevision": {"revisionId": 0,
"attributes": {"firstName": "string",
"lastName": "string",
"birthday": "2012-08-30",
"mrn": "string",
"email": "example@tidepool.org",
"sex": "male",
"weight": {"value": 0,
"units": "string"
},
"yearOfDiagnosis": 1900,
"phoneNumber": {"countryCode": "string",
"number": "string"
},
"initialSettings": {"bloodGlucoseUnits": "mg/dL",
"basalRateSchedule": [{"rate": 20,
"start": 0
}
],
"bloodGlucoseTargetSchedule": [{"high": 180,
"low": 80,
"start": 86400000
}
],
"carbohydrateRatioSchedule": [{"start": 86400000,
"amount": 250
}
],
"insulinSensitivitySchedule": [{"amount": 105,
"start": 86400000
}
],
"basalRateMaximum": {"units": "Units/hour",
"value": 100
},
"bolusAmountMaximum": {"units": "Units",
"value": 100
},
"bloodGlucoseSuspendThreshold": {"units": "mg/dL",
"value": 105
},
"insulinModel": "rapidAdult",
"pumpId": "6c959a5b-72ed-42d2-b9cd-0943e9536d18",
"cgmId": "fdcf79e5-bf1b-4255-aa02-cde99493e17e",
"bloodGlucoseTargetPhysicalActivity": {"high": 180,
"low": 80
},
"bloodGlucoseTargetPreprandial": {"high": 180,
"low": 80
}
},
"training": "inPerson",
"therapySettings": "initial",
"prescriberTermsAccepted": true,
"state": "draft",
"calculator": {"method": "weight",
"weight": 0.1,
"weightUnits": "kg",
"totalDailyDoseScaleFactor": 1,
"totalDailyDose": 0.1,
"recommendedBasalRate": 0.1,
"recommendedInsulinSensitivity": 0.1,
"recommendedCarbohydrateRatio": 0.1
},
"revisionHash": "string",
"createdUserId": "string",
"caregiverFirstName": "string",
"caregiverLastName": "string",
"accountType": "patient",
"createdTime": "2017-02-06T02:37:46Z"
}
},
"clinicId": "2fe2488217ee43e1b2e83c2f"
}
]

Create a Prescription

Create a new prescription

Authorizations:

sessionToken

path Parameters

clinicId

required

string

Request Body schema: application/json

firstName	string
lastName	string
birthday	string <date> (Birthday)
mrn	string
email	string <email> (Email Address) >= 6 characters An email address, as specified by RFC 5322.
sex	string Enum: "male" "female" "undisclosed"
	object (Weight)
yearOfDiagnosis	integer <int32> >= 1900
	object (Phone Number)
	object (Pump Settings)
training	string Enum: "inPerson" "inModule"
therapySettings	string Enum: "initial" "transferPumpSettings"
prescriberTermsAccepted	boolean
state required	string (Prescriptions State) Enum: "draft" "pending" "submitted" "claimed" "active" "inactive" "expired"
	object (calculator.v1)
revisionHash required	string^[A-Fa-f0-9]{64}$ Canonicalized and SHA-512-encrypted hex output of the sent revision payload
caregiverFirstName	string
caregiverLastName	string
accountType	string Enum: "patient" "caregiver"

Responses

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"birthday": "2012-08-30",
"mrn": "string",
"email": "example@tidepool.org",
"sex": "male",
"weight": {"value": 0,
"units": "string"
},
"yearOfDiagnosis": 1900,
"phoneNumber": {"countryCode": "string",
"number": "string"
},
"initialSettings": {"bloodGlucoseUnits": "mg/dL",
"basalRateSchedule": [{"rate": 20,
"start": 0
}
],
"bloodGlucoseTargetSchedule": [{"high": 180,
"low": 80,
"start": 86400000
}
],
"carbohydrateRatioSchedule": [{"start": 86400000,
"amount": 250
}
],
"insulinSensitivitySchedule": [{"amount": 105,
"start": 86400000
}
],
"basalRateMaximum": {"units": "Units/hour",
"value": 100
},
"bolusAmountMaximum": {"units": "Units",
"value": 100
},
"bloodGlucoseSuspendThreshold": {"units": "mg/dL",
"value": 105
},
"insulinModel": "rapidAdult",
"pumpId": "6c959a5b-72ed-42d2-b9cd-0943e9536d18",
"cgmId": "fdcf79e5-bf1b-4255-aa02-cde99493e17e",
"bloodGlucoseTargetPhysicalActivity": {"high": 180,
"low": 80
},
"bloodGlucoseTargetPreprandial": {"high": 180,
"low": 80
}
},
"training": "inPerson",
"therapySettings": "initial",
"prescriberTermsAccepted": true,
"state": "draft",
"calculator": {"method": "weight",
"weight": 0.1,
"weightUnits": "kg",
"totalDailyDoseScaleFactor": 1,
"totalDailyDose": 0.1,
"recommendedBasalRate": 0.1,
"recommendedInsulinSensitivity": 0.1,
"recommendedCarbohydrateRatio": 0.1
},
"revisionHash": "string",
"caregiverFirstName": "string",
"caregiverLastName": "string",
"accountType": "patient"
}

Response samples

Content type

application/json

{"id": "stringstringstringstring",
"patientUserId": "string",
"state": "draft",
"expirationTime": "2017-02-06T02:37:46Z",
"prescriberUserId": "string",
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"latestRevision": {"revisionId": 0,
"attributes": {"firstName": "string",
"lastName": "string",
"birthday": "2012-08-30",
"mrn": "string",
"email": "example@tidepool.org",
"sex": "male",
"weight": {"value": 0,
"units": "string"
},
"yearOfDiagnosis": 1900,
"phoneNumber": {"countryCode": "string",
"number": "string"
},
"initialSettings": {"bloodGlucoseUnits": "mg/dL",
"basalRateSchedule": [{"rate": 20,
"start": 0
}
],
"bloodGlucoseTargetSchedule": [{"high": 180,
"low": 80,
"start": 86400000
}
],
"carbohydrateRatioSchedule": [{"start": 86400000,
"amount": 250
}
],
"insulinSensitivitySchedule": [{"amount": 105,
"start": 86400000
}
],
"basalRateMaximum": {"units": "Units/hour",
"value": 100
},
"bolusAmountMaximum": {"units": "Units",
"value": 100
},
"bloodGlucoseSuspendThreshold": {"units": "mg/dL",
"value": 105
},
"insulinModel": "rapidAdult",
"pumpId": "6c959a5b-72ed-42d2-b9cd-0943e9536d18",
"cgmId": "fdcf79e5-bf1b-4255-aa02-cde99493e17e",
"bloodGlucoseTargetPhysicalActivity": {"high": 180,
"low": 80
},
"bloodGlucoseTargetPreprandial": {"high": 180,
"low": 80
}
},
"training": "inPerson",
"therapySettings": "initial",
"prescriberTermsAccepted": true,
"state": "draft",
"calculator": {"method": "weight",
"weight": 0.1,
"weightUnits": "kg",
"totalDailyDoseScaleFactor": 1,
"totalDailyDose": 0.1,
"recommendedBasalRate": 0.1,
"recommendedInsulinSensitivity": 0.1,
"recommendedCarbohydrateRatio": 0.1
},
"revisionHash": "string",
"createdUserId": "string",
"caregiverFirstName": "string",
"caregiverLastName": "string",
"accountType": "patient",
"createdTime": "2017-02-06T02:37:46Z"
}
},
"clinicId": "2fe2488217ee43e1b2e83c2f"
}

Get Prescription

Retrieve a prescription by id

Authorizations:

sessionToken

path Parameters

prescriptionId required	string
clinicId required	string

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/prescriptions/{prescriptionId}

production

https://api.tidepool.org/v1/clinics/{clinicId}/prescriptions/{prescriptionId}

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/prescriptions/{prescriptionId}

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/prescriptions/{prescriptionId}

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/prescriptions/{prescriptionId}

Response samples

Content type

application/json

{"id": "stringstringstringstring",
"patientUserId": "string",
"state": "draft",
"expirationTime": "2017-02-06T02:37:46Z",
"prescriberUserId": "string",
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"latestRevision": {"revisionId": 0,
"attributes": {"firstName": "string",
"lastName": "string",
"birthday": "2012-08-30",
"mrn": "string",
"email": "example@tidepool.org",
"sex": "male",
"weight": {"value": 0,
"units": "string"
},
"yearOfDiagnosis": 1900,
"phoneNumber": {"countryCode": "string",
"number": "string"
},
"initialSettings": {"bloodGlucoseUnits": "mg/dL",
"basalRateSchedule": [{"rate": 20,
"start": 0
}
],
"bloodGlucoseTargetSchedule": [{"high": 180,
"low": 80,
"start": 86400000
}
],
"carbohydrateRatioSchedule": [{"start": 86400000,
"amount": 250
}
],
"insulinSensitivitySchedule": [{"amount": 105,
"start": 86400000
}
],
"basalRateMaximum": {"units": "Units/hour",
"value": 100
},
"bolusAmountMaximum": {"units": "Units",
"value": 100
},
"bloodGlucoseSuspendThreshold": {"units": "mg/dL",
"value": 105
},
"insulinModel": "rapidAdult",
"pumpId": "6c959a5b-72ed-42d2-b9cd-0943e9536d18",
"cgmId": "fdcf79e5-bf1b-4255-aa02-cde99493e17e",
"bloodGlucoseTargetPhysicalActivity": {"high": 180,
"low": 80
},
"bloodGlucoseTargetPreprandial": {"high": 180,
"low": 80
}
},
"training": "inPerson",
"therapySettings": "initial",
"prescriberTermsAccepted": true,
"state": "draft",
"calculator": {"method": "weight",
"weight": 0.1,
"weightUnits": "kg",
"totalDailyDoseScaleFactor": 1,
"totalDailyDose": 0.1,
"recommendedBasalRate": 0.1,
"recommendedInsulinSensitivity": 0.1,
"recommendedCarbohydrateRatio": 0.1
},
"revisionHash": "string",
"createdUserId": "string",
"caregiverFirstName": "string",
"caregiverLastName": "string",
"accountType": "patient",
"createdTime": "2017-02-06T02:37:46Z"
}
},
"clinicId": "2fe2488217ee43e1b2e83c2f"
}

Delete Prescription

Clinician only endpoint to delete a prescription. Works only when the prescription has status draft.

Authorizations:

sessionToken

path Parameters

prescriptionId required	string
clinicId required	string

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/prescriptions/{prescriptionId}

production

https://api.tidepool.org/v1/clinics/{clinicId}/prescriptions/{prescriptionId}

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/prescriptions/{prescriptionId}

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/prescriptions/{prescriptionId}

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/prescriptions/{prescriptionId}

Response samples

Content type

application/json

{"code": 0,
"reason": "string"
}

Create new revision

Add a new revision to a prescription which is still a draft.

Authorizations:

sessionToken

path Parameters

prescriptionId required	string
clinicId required	string

Request Body schema: application/json

firstName	string
lastName	string
birthday	string <date> (Birthday)
mrn	string
email	string <email> (Email Address) >= 6 characters An email address, as specified by RFC 5322.
sex	string Enum: "male" "female" "undisclosed"
	object (Weight)
yearOfDiagnosis	integer <int32> >= 1900
	object (Phone Number)
	object (Pump Settings)
training	string Enum: "inPerson" "inModule"
therapySettings	string Enum: "initial" "transferPumpSettings"
prescriberTermsAccepted	boolean
state required	string (Prescriptions State) Enum: "draft" "pending" "submitted" "claimed" "active" "inactive" "expired"
	object (calculator.v1)
revisionHash required	string^[A-Fa-f0-9]{64}$ Canonicalized and SHA-512-encrypted hex output of the sent revision payload
caregiverFirstName	string
caregiverLastName	string
accountType	string Enum: "patient" "caregiver"

Responses

integration

https://external.integration.tidepool.org/v1/clinics/{clinicId}/prescriptions/{prescriptionId}/revisions

production

https://api.tidepool.org/v1/clinics/{clinicId}/prescriptions/{prescriptionId}/revisions

dev1

https://dev1.dev.tidepool.org/v1/clinics/{clinicId}/prescriptions/{prescriptionId}/revisions

qa1

https://qa1.development.tidepool.org/v1/clinics/{clinicId}/prescriptions/{prescriptionId}/revisions

qa2

https://qa2.development.tidepool.org/v1/clinics/{clinicId}/prescriptions/{prescriptionId}/revisions

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"birthday": "2012-08-30",
"mrn": "string",
"email": "example@tidepool.org",
"sex": "male",
"weight": {"value": 0,
"units": "string"
},
"yearOfDiagnosis": 1900,
"phoneNumber": {"countryCode": "string",
"number": "string"
},
"initialSettings": {"bloodGlucoseUnits": "mg/dL",
"basalRateSchedule": [{"rate": 20,
"start": 0
}
],
"bloodGlucoseTargetSchedule": [{"high": 180,
"low": 80,
"start": 86400000
}
],
"carbohydrateRatioSchedule": [{"start": 86400000,
"amount": 250
}
],
"insulinSensitivitySchedule": [{"amount": 105,
"start": 86400000
}
],
"basalRateMaximum": {"units": "Units/hour",
"value": 100
},
"bolusAmountMaximum": {"units": "Units",
"value": 100
},
"bloodGlucoseSuspendThreshold": {"units": "mg/dL",
"value": 105
},
"insulinModel": "rapidAdult",
"pumpId": "6c959a5b-72ed-42d2-b9cd-0943e9536d18",
"cgmId": "fdcf79e5-bf1b-4255-aa02-cde99493e17e",
"bloodGlucoseTargetPhysicalActivity": {"high": 180,
"low": 80
},
"bloodGlucoseTargetPreprandial": {"high": 180,
"low": 80
}
},
"training": "inPerson",
"therapySettings": "initial",
"prescriberTermsAccepted": true,
"state": "draft",
"calculator": {"method": "weight",
"weight": 0.1,
"weightUnits": "kg",
"totalDailyDoseScaleFactor": 1,
"totalDailyDose": 0.1,
"recommendedBasalRate": 0.1,
"recommendedInsulinSensitivity": 0.1,
"recommendedCarbohydrateRatio": 0.1
},
"revisionHash": "string",
"caregiverFirstName": "string",
"caregiverLastName": "string",
"accountType": "patient"
}

Response samples

Content type

application/json

{"revisionId": 0,
"attributes": {"firstName": "string",
"lastName": "string",
"birthday": "2012-08-30",
"mrn": "string",
"email": "example@tidepool.org",
"sex": "male",
"weight": {"value": 0,
"units": "string"
},
"yearOfDiagnosis": 1900,
"phoneNumber": {"countryCode": "string",
"number": "string"
},
"initialSettings": {"bloodGlucoseUnits": "mg/dL",
"basalRateSchedule": [{"rate": 20,
"start": 0
}
],
"bloodGlucoseTargetSchedule": [{"high": 180,
"low": 80,
"start": 86400000
}
],
"carbohydrateRatioSchedule": [{"start": 86400000,
"amount": 250
}
],
"insulinSensitivitySchedule": [{"amount": 105,
"start": 86400000
}
],
"basalRateMaximum": {"units": "Units/hour",
"value": 100
},
"bolusAmountMaximum": {"units": "Units",
"value": 100
},
"bloodGlucoseSuspendThreshold": {"units": "mg/dL",
"value": 105
},
"insulinModel": "rapidAdult",
"pumpId": "6c959a5b-72ed-42d2-b9cd-0943e9536d18",
"cgmId": "fdcf79e5-bf1b-4255-aa02-cde99493e17e",
"bloodGlucoseTargetPhysicalActivity": {"high": 180,
"low": 80
},
"bloodGlucoseTargetPreprandial": {"high": 180,
"low": 80
}
},
"training": "inPerson",
"therapySettings": "initial",
"prescriberTermsAccepted": true,
"state": "draft",
"calculator": {"method": "weight",
"weight": 0.1,
"weightUnits": "kg",
"totalDailyDoseScaleFactor": 1,
"totalDailyDose": 0.1,
"recommendedBasalRate": 0.1,
"recommendedInsulinSensitivity": 0.1,
"recommendedCarbohydrateRatio": 0.1
},
"revisionHash": "string",
"createdUserId": "string",
"caregiverFirstName": "string",
"caregiverLastName": "string",
"accountType": "patient",
"createdTime": "2017-02-06T02:37:46Z"
}
}

Claim Prescription

Claim a submitted prescription using an access code and date of birth.

Authorizations:

sessionToken

path Parameters

userId

required

string

Request Body schema: application/json

accessCode required	string (Access Code) = 6 characters ^[A-HJ-NP-Z2-9]+$
birthday required	string <date> (Birthday)

Responses

Request samples

Payload

Content type

application/json

{"accessCode": "string",
"birthday": "2012-08-30"
}

Response samples

Content type

application/json

{"id": "stringstringstringstring",
"patientUserId": "string",
"state": "draft",
"expirationTime": "2017-02-06T02:37:46Z",
"prescriberUserId": "string",
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"latestRevision": {"revisionId": 0,
"attributes": {"firstName": "string",
"lastName": "string",
"birthday": "2012-08-30",
"mrn": "string",
"email": "example@tidepool.org",
"sex": "male",
"weight": {"value": 0,
"units": "string"
},
"yearOfDiagnosis": 1900,
"phoneNumber": {"countryCode": "string",
"number": "string"
},
"initialSettings": {"bloodGlucoseUnits": "mg/dL",
"basalRateSchedule": [{"rate": 20,
"start": 0
}
],
"bloodGlucoseTargetSchedule": [{"high": 180,
"low": 80,
"start": 86400000
}
],
"carbohydrateRatioSchedule": [{"start": 86400000,
"amount": 250
}
],
"insulinSensitivitySchedule": [{"amount": 105,
"start": 86400000
}
],
"basalRateMaximum": {"units": "Units/hour",
"value": 100
},
"bolusAmountMaximum": {"units": "Units",
"value": 100
},
"bloodGlucoseSuspendThreshold": {"units": "mg/dL",
"value": 105
},
"insulinModel": "rapidAdult",
"pumpId": "6c959a5b-72ed-42d2-b9cd-0943e9536d18",
"cgmId": "fdcf79e5-bf1b-4255-aa02-cde99493e17e",
"bloodGlucoseTargetPhysicalActivity": {"high": 180,
"low": 80
},
"bloodGlucoseTargetPreprandial": {"high": 180,
"low": 80
}
},
"training": "inPerson",
"therapySettings": "initial",
"prescriberTermsAccepted": true,
"state": "draft",
"calculator": {"method": "weight",
"weight": 0.1,
"weightUnits": "kg",
"totalDailyDoseScaleFactor": 1,
"totalDailyDose": 0.1,
"recommendedBasalRate": 0.1,
"recommendedInsulinSensitivity": 0.1,
"recommendedCarbohydrateRatio": 0.1
},
"revisionHash": "string",
"createdUserId": "string",
"caregiverFirstName": "string",
"caregiverLastName": "string",
"accountType": "patient",
"createdTime": "2017-02-06T02:37:46Z"
}
},
"clinicId": "2fe2488217ee43e1b2e83c2f"
}

List Prescriptions for Patient

Retrieve a list of prescription that the user has claimed

Authorizations:

sessionToken

path Parameters

userId

required

string

Responses

Get Prescription for User

Retrieve a prescription by id

Authorizations:

sessionToken

path Parameters

userId required	string
prescriptionId required	string

Responses

integration

https://external.integration.tidepool.org/v1/patients/{userId}/prescriptions/{prescriptionId}

production

https://api.tidepool.org/v1/patients/{userId}/prescriptions/{prescriptionId}

dev1

https://dev1.dev.tidepool.org/v1/patients/{userId}/prescriptions/{prescriptionId}

qa1

https://qa1.development.tidepool.org/v1/patients/{userId}/prescriptions/{prescriptionId}

qa2

https://qa2.development.tidepool.org/v1/patients/{userId}/prescriptions/{prescriptionId}

Response samples

Content type

application/json

{"id": "stringstringstringstring",
"patientUserId": "string",
"state": "draft",
"expirationTime": "2017-02-06T02:37:46Z",
"prescriberUserId": "string",
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"latestRevision": {"revisionId": 0,
"attributes": {"firstName": "string",
"lastName": "string",
"birthday": "2012-08-30",
"mrn": "string",
"email": "example@tidepool.org",
"sex": "male",
"weight": {"value": 0,
"units": "string"
},
"yearOfDiagnosis": 1900,
"phoneNumber": {"countryCode": "string",
"number": "string"
},
"initialSettings": {"bloodGlucoseUnits": "mg/dL",
"basalRateSchedule": [{"rate": 20,
"start": 0
}
],
"bloodGlucoseTargetSchedule": [{"high": 180,
"low": 80,
"start": 86400000
}
],
"carbohydrateRatioSchedule": [{"start": 86400000,
"amount": 250
}
],
"insulinSensitivitySchedule": [{"amount": 105,
"start": 86400000
}
],
"basalRateMaximum": {"units": "Units/hour",
"value": 100
},
"bolusAmountMaximum": {"units": "Units",
"value": 100
},
"bloodGlucoseSuspendThreshold": {"units": "mg/dL",
"value": 105
},
"insulinModel": "rapidAdult",
"pumpId": "6c959a5b-72ed-42d2-b9cd-0943e9536d18",
"cgmId": "fdcf79e5-bf1b-4255-aa02-cde99493e17e",
"bloodGlucoseTargetPhysicalActivity": {"high": 180,
"low": 80
},
"bloodGlucoseTargetPreprandial": {"high": 180,
"low": 80
}
},
"training": "inPerson",
"therapySettings": "initial",
"prescriberTermsAccepted": true,
"state": "draft",
"calculator": {"method": "weight",
"weight": 0.1,
"weightUnits": "kg",
"totalDailyDoseScaleFactor": 1,
"totalDailyDose": 0.1,
"recommendedBasalRate": 0.1,
"recommendedInsulinSensitivity": 0.1,
"recommendedCarbohydrateRatio": 0.1
},
"revisionHash": "string",
"createdUserId": "string",
"caregiverFirstName": "string",
"caregiverLastName": "string",
"accountType": "patient",
"createdTime": "2017-02-06T02:37:46Z"
}
},
"clinicId": "2fe2488217ee43e1b2e83c2f"
}

Update Prescription State

Update prescription state

Authorizations:

sessionToken

path Parameters

userId required	string
prescriptionId required	string

Responses

integration

https://external.integration.tidepool.org/v1/patients/{userId}/prescriptions/{prescriptionId}

production

https://api.tidepool.org/v1/patients/{userId}/prescriptions/{prescriptionId}

dev1

https://dev1.dev.tidepool.org/v1/patients/{userId}/prescriptions/{prescriptionId}

qa1

https://qa1.development.tidepool.org/v1/patients/{userId}/prescriptions/{prescriptionId}

qa2

https://qa2.development.tidepool.org/v1/patients/{userId}/prescriptions/{prescriptionId}

Response samples

Content type

application/json

{"id": "stringstringstringstring",
"patientUserId": "string",
"state": "draft",
"expirationTime": "2017-02-06T02:37:46Z",
"prescriberUserId": "string",
"createdTime": "2017-02-06T02:37:46Z",
"createdUserId": "string",
"deletedTime": "2017-02-06T02:37:46Z",
"deletedUserId": "string",
"modifiedTime": "2017-02-06T02:37:46Z",
"modifiedUserId": "string",
"latestRevision": {"revisionId": 0,
"attributes": {"firstName": "string",
"lastName": "string",
"birthday": "2012-08-30",
"mrn": "string",
"email": "example@tidepool.org",
"sex": "male",
"weight": {"value": 0,
"units": "string"
},
"yearOfDiagnosis": 1900,
"phoneNumber": {"countryCode": "string",
"number": "string"
},
"initialSettings": {"bloodGlucoseUnits": "mg/dL",
"basalRateSchedule": [{"rate": 20,
"start": 0
}
],
"bloodGlucoseTargetSchedule": [{"high": 180,
"low": 80,
"start": 86400000
}
],
"carbohydrateRatioSchedule": [{"start": 86400000,
"amount": 250
}
],
"insulinSensitivitySchedule": [{"amount": 105,
"start": 86400000
}
],
"basalRateMaximum": {"units": "Units/hour",
"value": 100
},
"bolusAmountMaximum": {"units": "Units",
"value": 100
},
"bloodGlucoseSuspendThreshold": {"units": "mg/dL",
"value": 105
},
"insulinModel": "rapidAdult",
"pumpId": "6c959a5b-72ed-42d2-b9cd-0943e9536d18",
"cgmId": "fdcf79e5-bf1b-4255-aa02-cde99493e17e",
"bloodGlucoseTargetPhysicalActivity": {"high": 180,
"low": 80
},
"bloodGlucoseTargetPreprandial": {"high": 180,
"low": 80
}
},
"training": "inPerson",
"therapySettings": "initial",
"prescriberTermsAccepted": true,
"state": "draft",
"calculator": {"method": "weight",
"weight": 0.1,
"weightUnits": "kg",
"totalDailyDoseScaleFactor": 1,
"totalDailyDose": 0.1,
"recommendedBasalRate": 0.1,
"recommendedInsulinSensitivity": 0.1,
"recommendedCarbohydrateRatio": 0.1
},
"revisionHash": "string",
"createdUserId": "string",
"caregiverFirstName": "string",
"caregiverLastName": "string",
"accountType": "patient",
"createdTime": "2017-02-06T02:37:46Z"
}
},
"clinicId": "2fe2488217ee43e1b2e83c2f"
}

Summary

Summary Data

This API is for a component within the data service that calculates summary statistics for user accounts. These routes are mostly executed by the task and clinic-worker services.

Tasks

List, create and manage generic background tasks.