Object

Documentation

Properties

idstring✻

format: uuid

Documentation

Example
"f906f26b-6a0c-4c72-97f2-c9ad8701f730"

userIdstring✻

format: uuid

Documentation

Example
"70c09d76-e53c-470f-916a-ef33706382b4"

typestring✻

Documentation

Examples
"bloodGlucose"
"bolusCalculation"
"diabetesType"

deviceobject

Devices include Continuous Glucose Monitors, Bolus Calculators, and any other health or fitness peripherals that produce the sample data stored in HDS. Device objects are immutable: You set the device's properties when you create the Device object, and they cannot change.

Documentation

Properties

idstring

An identifier that uniquely identifies the device object on the hardware running this code.

<= 256 characters

Documentation

Example
"34de05f1-ecb3-4dea-ab16-81e1a584ebfb"

firmwareVersionstring

An arbitrary string representing the current version of the firmware running on the device.

<= 256 characters

Documentation

Example
"3.0.5"

hardwareVersionstring

An arbitrary string representing the hardware version of the device.

<= 256 characters

Documentation

Example
"6.1.0"

manufacturerstring

A string representing the device's manufacturer.

<= 256 characters

Documentation

Example
"Novo Nordisk A/S"

modelstring

A string representing the device's model.

<= 256 characters

Documentation

Example
"NovoPen 6"

namestring✻

The user-facing name for the device.

<= 256 characters

Documentation

Example
"NovoPen"

softwareVersionstring

An arbitrary string representing the version of the software running on the device.

<= 256 characters

Documentation

Example
"8.1.2"
Example
{
	"id": "34de05f1-ecb3-4dea-ab16-81e1a584ebfb",
	"firmwareVersion": "3.0.5",
	"hardwareVersion": "6.1.0",
	"manufacturer": "Novo Nordisk A/S",
	"model": "NovoPen 6",
	"name": "NovoPen",
	"softwareVersion": "8.1.2"
}

metadataobject

The metadata for an object.

<= 100 properties

Documentation

Extends
Metadata External IDMetadata TimeZoneMetadata User Entered
Additional Properties
One

Metadata Boolean

Metadata Number

Metadata String

Example
{
	"externalId": "EX123",
	"timeZone": "Europe/Copenhagen",
	"userEntered": false,
	"property1": true,
	"property2": 100,
	"property3": "abc"
}

sourceobject✻

An object indicating the source of a HDS object.

Documentation

Properties

idstring✻

The source's identifier.

format: uuid

Documentation

Example
"f6c8e76c-d8a3-4339-879a-4a626edba805"

namestring✻

The source app name.

<= 256 characters

Documentation

Example
"hda"

versionstring✻

A string that identifies a particular version of the source.

<= 256 characters

Documentation

Example
"2.18.0"
Example
{
	"id": "f6c8e76c-d8a3-4339-879a-4a626edba805",
	"name": "hda",
	"version": "2.18.0"
}

createdAtstring✻

format: date-time

Documentation

Example
"2024-01-29T13:15:40.390Z"
Example
{
	"id": "f906f26b-6a0c-4c72-97f2-c9ad8701f730",
	"userId": "70c09d76-e53c-470f-916a-ef33706382b4",
	"type": "object",
	"metadata": {
		"externalId": "EX123",
		"timeZone": "Europe/Copenhagen",
		"userEntered": false,
		"property1": true,
		"property2": 123,
		"property3": "abc"
	},
	"device": {
		"id": "34de05f1-ecb3-4dea-ab16-81e1a584ebfb",
		"firmwareVersion": "3.0.5",
		"hardwareVersion": "6.1.0",
		"manufacturer": "Novo Nordisk A/S",
		"model": "NovoPen 6",
		"name": "NovoPen",
		"softwareVersion": "8.1.2"
	},
	"source": {
		"id": "f6c8e76c-d8a3-4339-879a-4a626edba805",
		"name": "hda",
		"version": "2.18.0"
	},
	"createdAt": "2024-01-29T13:15:40.390Z"
}