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`
Blood Pressure
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)

ResponseE.g.

curl -k -X GET -H "X-AccountCode: vclinic" "

Code Block

breakoutMode	wide

request: POST https://api.vsee.mevseepreview.com/vc/stable/api_v3/rooms"
/users/905/devices
headers: {
    "dataX-AccountCode": [{
  "vclinic",
     "slug"X-ApiKey": "room1vclinic_api_secret",
    
   "nameX-ApiToken": "Room 1",
     vclinic_api_token"
}
parameters: {
  "domaindevice_id": "demo.vsee.me004D320DCAA2",
  
     "code"device_name": "room1_codeThermometer PT3SBT",
        "created": 1427922788,
        "modified": 1427922788
    }, ...]
}

...

"type": "ihealth_thermometer_pt3sbt"
}

POST /api_v3/health

Parameters

Parameter	Type	Description
`X-AccountCode`	`Header`
`X-ApiKey`	`Header`
`X-ApiToken`	`Header`

Clinic Admin token (app token)

domain

String

Clinic’s domain

code

String

(optional) Room code (should be unique)

slug

String

(optional) Set this room as default, other rooms will lose default status.

name

String

Room's name

Response

...


`type`	`String`	Device type (in device table)
`date`	`String`	Recorded date (yyyy-mm-dd)
`time`	`Int`	Unix timestamp
`device_id`	`String`	Device unique ID
`data_type`	`String`	Data type (in data table)
`data_class`	`String`
Data Value	`String`	Data type = value
Data Unit	`String`	Data unit = unit value

E.g.

Code Block

breakoutMode	wide

request: POST https://api.vsee.mevseepreview.com/vc/stable/api_v3/rooms' \
--header 'X-AccountCode: vclinic' \
--header 'X-ApiToken: 83ec6843c3af534c551ab609d869dd82' \
--form 'domain=vclinic.vsee.me' \
--form 'slug=provider00102' \
--form 'name=provider00102 room'

{
    "data": {
        "visits": {
            "walkin": {
                "enabled": true
            },
            "appointment": {
                "enabled": false
            }
        },
        "auth": {
            "guest": {
                "type": 600,
                "log_in": {
                    "enabled": true
                }
            }
        },
        "subtitle": "If this is an emergency, please call 911.",
        "slug": "provider00102",
        "name": "provider00102 room",
        "domain": "vclinic.vsee.me",
        "active": true,
        "users": "85741",
        "account_code": "clinic",
        "provider_ids": [
            "85741"
        ],
        "public_access_room": true,
        "modified": 1605728974,
        "created": 1605728974,
        "payment": {
            "consultations": [
                {
                    "id": "5fb57ace-4808-4346-ad3c-3348925862c1",
                    "description": "15-min Consultation",
                    "duration": 15,
                    "amount": 0,
                    "group": false,
                    "charge": false,
                    "slots": 1
                }
            ],
            "currency": "USD",
            "__note__": "paymentCurrency will be deprecated by 1 Jun 2017"
        },
        "operation_settings": {
            "is_closed": false,
            "close_msg": "Service currently not available. Please check back later",
            "default_timezone": "America/Los_Angeles"
        },
        "id": "171",
        "code": "b4vjj"
    }
}

If room already exists (http response code 400):

Code Block
{ "code": 400, "message": "In domain 'vclinic.vsee.me' slug 'uat2' already exists." }

POST /users/:id/rooms

Associate a room to a user

Parameters

...

Parameter

...

Type

...

Description

...

code

...

String

...

Room code

...

default

...

Boolean

...

(optional) Set this room as default, other rooms will lose default status.

Response

Code Block


curl --location --request POST 'https://api.vsee.me/api_v3/users/85741/rooms' \
--header 'X-AccountCode: vclinic' \
--header 'X-ApiToken: 83ec6843c3af534c551ab609d869dd82' \
--form 'code=b4vjj''

{
    "data": [
        {
            "_id": "171",
            "slug": "provider00102",
            "name": "provider00102 room",
            "domain": "clinic.vseepreview.com",
            "code": "b4vjj",
            "active": true,
            "users": "85741",
            "account_code": "clinic",
            "provider_ids": [
                "85741"
            ],
            "public_access_room": true,
            "modified": {
                "sec": 1605728974,
                "usec": 177000
            },
            "created": {
                "sec": 1605728974,
                "usec": 177000
            },
            "payment": {
                "consultations": [
                    {
                        "id": "5fb57ace-4808-4346-ad3c-3348925862c1",
                        "description": "15-min Consultation",
                        "duration": 15,
                        "amount": 0,
                        "group": false,
                        "charge": false,
                        "slots": 1
                    }
                ]
            },
            "default": false
        }
    ]
}health
headers: {
  "X-AccountCode": "vclinic",
  "X-ApiKey": "vclinic_api_key",
  "X-ApiToken": "vclinic_api_token"
}
parameters: {
  "type": "ihealth_thermometer_pt3sbt",
  "date": "2021-08-25",
  "time": 1695626540,
  "device_id": "004D320DCAA2",
  "data_type": "temperature_body",
  "data_class": "body",
  "temperature_body": "36.76",
  "temperature_unit": "cel"
}

parameters for blood glucose

Code Block
"data_type": "bg", "bg": 100, "bg_unit": "mg/dL"

parameters for blood pressure

Code Block
"data_type": "bp", "hp": 100, "lp": 90, "bp_unit": "mmHg"

parameters for weight

Code Block
"data_type": "weight", "weight": 100, "weight_unit": "lbs"

parameters for active minutes & steps

Code Block
"data_type": "active_minutes", "active_minutes": 100, "steps": 1000

parameters for pulse & blood oxygen

Code Block
"data_type": "hr", "hr": 100, "bo": 100

Versions Compared

Old Version 2

New Version Current

Key

Device

list

Data classifications

APIs

POST /users/{user_id}/devices

POST /api_v3/health

POST /users/:id/rooms

Page Comparison

Versions Compared

Old Version 2

New Version Current

Key

Device

list

Data classifications

APIs

POST /users/{user_id}/devices

POST /api_v3/health

POST /users/:id/rooms