Device Table | ||
|---|---|---|
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 |
...
POST /users/{user_id}/devices
Parameters
Parameter | Type | Description |
|---|---|---|
|
| |
|
| |
|
| |
|
| Device unique ID |
|
| Device name (in device table) |
|
| Device type (in device table) |
ResponseE.g.
| Code Block |
|---|
curl -k -X GET -H "X-AccountCoderequest: vclinic"POST "https://api.vsee.meio/vc/dev/api_v3/rooms" /users/905/devices headers: { "dataX-AccountCode": [{ = chroniccare360; "slugX-ApiKey": "room1", = 904520ec0f12c77932bb6d0f25791131; "nameX-ApiToken": "Room 1", = b74078949cb62a0cc2c59ba8d7362728; } parameters: { "domain": "demo.vsee.me", device_id" = "004D320DCAA2"; "code": "room1_code", "device_name" = "Thermometer PT3SBT"; "createdtype": 1427922788, "modified": 1427922788 }, ...] } |
...
= "ihealth_thermometer_pt3sbt";
}
|
Data Table | |||
|---|---|---|---|
Data | Data Type | Unit | 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 |
|---|---|---|
|
| |
|
| |
|
| Clinic Admin token (app token) |
|
| Clinic’s domain |
|
| (optional) Room code (should be unique) |
|
| (optional) Set this room as default, other rooms will lose default status. |
|
| Room's name |
Response
...
|
| Device type (in device table) |
|
| Recorded date (yyyy-mm-dd) |
|
| Device unique ID |
|
| Data type (in data table) |
Data Value |
| Data type = value |
Data Unit |
| Data unit = unit value |
E.g.
| Code Block |
|---|
request: POST https://api.vsee.meio/vc/latest/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": { health headers: { "X-AccountCode" = chroniccare360; "X-ApiKey" = 904520ec0f12c77932bb6d0f25791131; "X-ApiToken" = b74078949cb62a0cc2c59ba8d7362728; } parameters: { "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 } ] } = "ihealth_thermometer_pt3sbt"; "date" = "2021-08-25"; "device_id" = "004D320DCAA2"; "data_type" = "temperature_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 |