Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Device

...

list

Device category

Device name

Device type

Pulse, Oximeter

Pulse Oximeter PO3M

ihealth_po_po3

Scale

Scale HS2S

ihealth_scale_hs22

Active Minutes, Steps

Apple Health

applehealth

Samsung Health

samsunghealth

Blood Pressure

Blood Pressure RPM-BP100

welchallync_bp_bp100

Glucose Meters

Glucose Meters Gluco+/BG5S

ihealth_bg_bg5s

Thermometer

Thermometer PT3SBT

ihealth_thermometer_pt3sbt

Data classifications

Data

Data Class

Data Type

Unit

Unit value

Type

Range

1

Temperature

body

temperature_body

temperature_unit

cel | fah

float

2

Blood Glucose

body

bg

bg_unit

mg/dL | mmol/L

3

Blood Pressure

body

hp, lp

bp_unit

mmHg | kPa

int

4

Weight

body

weight

weight_unit

lbs | kg

float

5

Active Minutes

body

active_minutes

int

6

Steps

body

steps

int

7

Pulse

body

hr

float

8

Blood Oxygen

body

bo

float

9

Illuminance

environment

illuminance

illuminance_unit

lux

10

Humidity

environment

humidity

humidity_unit

percentage

11

Gas

environment

gas

12

Movement

environment

movement

movement

TBD

boolean | int

0 | 1

13

Noise

environment

noise

noise_unit

TBD

float

0.0 - 1.0

14

Range

environment

range

range_unit

cm

float

2-400 cm

APIs

POST /users/{user_id}/devices

Device registration

Parameters

Parameter

Type

Description

X-AccountCode

Header

X-ApiKey

Header

X-ApiToken

Header

device_id

String

Device unique ID

device_name

String

Device name (in device table)

type

String

Device type (in device table)

...

Code Block
request: POST https://api.vsee.io/vc/next/api_v3/users/905/devices
headers: {
  "X-AccountCode": ***account_code***,
  "X-ApiKey": ***api_key***,
  "X-ApiToken": ***api_token***
}
parameters: {
  "device_id": "004D320DCAA2",
  "device_name": "Thermometer PT3SBT",
  "type": "ihealth_thermometer_pt3sbt"
}

...

Data Table

...

Data

...

Data Type

...

...

Unit value

...

Temperature

...

temperature_body

...

temperature_unit

...

cel | fah

...

Blood Glucose

...

bg

...

bg_unit

...

mg/dL | mmol/L

...

Blood Pressure

...

hp, lp

...

bp_unit

...

mmHg | kPa

...

Weight

...

weight

...

weight_unit

...

lbs | kg

...

Active Minutes

...

active_minutes

...

Steps

...

steps

...

Pulse

...

hr

...

Blood Oxygen

...

bo

POST /api_v3/health

Parameters

Parameter

Type

Description

X-AccountCode

Header

X-ApiKey

Header

X-ApiToken

Header

type

String

Device type (in device table)

date

String

Recorded date (yyyy-mm-dd)

device_id

String

Device unique ID

data_type

String

Data type (in data table)

Data Value

String

Data type = value

Data Unit

String

Data unit = unit value

...

Code Block
request: POST https://api.vsee.io/vc/next/api_v3/health
headers: {
  "X-AccountCode": ***account_code***,
  "X-ApiKey": ***api_key***,
  "X-ApiToken": ***api_token***
}
parameters: {
  "type": "ihealth_thermometer_pt3sbt",
  "date": "2021-08-25",
  "device_id": "004D320DCAA2",
  "data_type": "temperature_body",
  "data_class": "body",
  "temperature_body": "36.76",
  "temperature_unit": "cel"
}

...