| Table of Contents | ||||
|---|---|---|---|---|
|
Intakes
POST /intakes
...
| Status | ||||
|---|---|---|---|---|
|
Create intake data object
Custom parameters
Apart from the parameters below, any amount of custom JSON field-value pairs may be sent. They will all be saved into the Intake object. Later they may be displayed to the provider (please contact VSee to configure the rendering format).
Parameters
Parameter | Type | Description |
|---|---|---|
|
| (optional) The ID of the provider who is being visited |
|
| (optional) Reason for visit |
|
| (optional) Visit type: 1 - walkin; 2 - schedule |
|
| (optional) Patient’s code ID on behalf of whom the intake will be created |
|
| Room’s code |
|
| (optional) Multiple formats supported: |
|
| (optional) |
|
| (optional) e.g |
ResponseSample Request
| Code Block |
|---|
curl -k -X POST -d "provider=541&reason_for_visit=Test&reset=true&type=1" https://api.vsee.mevseepreview.com/vc/next/api_v3/intakes.json { "data": { "id": "56e8c536-566c-44b6-bbca-66f0ac1f0144" } } |
POST /intakes/:id
Update intake information
Parameters
...
Parameter
...
Type
...
Description
...
provider_id
...
Integer
...
(optional) The ID of the provider who is being visited
...
reasonforvisit
...
String
...
(optional) Reason for visit
...
type
...
Integer
...
(optional) Visit type: 1 - walkin; 2 - schedule
...
member_id
...
String
...
(optional) Patient’s code ID on behalf of whom the intake will be created
...
room* room_code
...
String
...
Room’s code
...
attachments
...
Array
...
Multiple formats supported: [{id:"577af3e6-9e48-4a51-9315-2ba8c0a8210a"}, ...] or ["577af3e6-9e48-4a51-9315-2ba8c0a8210a", ...] or 577af3e6-9e48-4a51-9315-2ba8c0a8210a,577af3e6-9e48-4a51-9315-2ba8c0a8210a,...
...
location
...
String
...
CA/AL/...
...
phone
...
String
...
7123465789
...
consultation
...
Object
...
(optional) Required for payment related, the consultation objects can be found at GET /rooms/:code API
Response
| Code Block |
|---|
curl -X POST -H "X-ApiToken: 5a2eb231d652b49f4d7fc0fbb78328fb" -H "X-AccountCode: vclinic" -H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" -F "location=CA" -F "phone=7123456789" -F "reason_for_visit=Test intake functionalities 2" "https://api.vsee.me/api_v3/intakes/57a0705e-1c4c-4f24-b51d-3c71ac1f0144"
{
"data": {
"id": "56e8c536-566c-44b6-bbca-66f0ac1f0144"
}
} |
GET /intakes/:id
Get the specific intake
Parameters
None
Response
...
Sample Request with Custom Params
| Code Block |
|---|
curl -k -X POST -d "provider=541&reason_for_visit=Test&reset=true&type=1" https://api.vseepreview.com/vc/next/api_v3/intakes.json
{
"data": {
"id": "56e8c536-566c-44b6-bbca-66f0ac1f0144",
"custom_is_allergic": "Yes",
"custom_symptoms": "Rash, Red Eyes",
"custom_symptoms_duration": "2 weeks"
}
}
|
POST /intakes/:id
| Status | ||||
|---|---|---|---|---|
|
Update a selected intake data object
Parameters
Parameter | Type | Description |
|---|---|---|
|
| (optional) The ID of the provider who is being visited |
|
| (optional) Reason for visit |
|
| (optional) Visit type: 1 - walkin; 2 - schedule |
|
| (optional) Patient’s code ID on behalf of whom the intake will be created |
|
| Room’s code |
|
| Multiple formats supported: |
|
|
|
|
|
|
|
| (optional) Required for payment related, the consultation objects can be found at |
Response
| Code Block |
|---|
curl -X POST -H "X-ApiToken: 5a2eb231d652b49f4d7fc0fbb78328fb" -H "X-AccountCode: vclinic" -H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" -F "location=CA" -F "phone=7123456789" -F "reason_for_visit=Test intake functionalities 2" "https://api.vseepreview.com/vc/next/api_v3/intakes/57a0705e-1c4c-4f24-b51d-3c71ac1f0144" { "data": { "_id": "57b4c65d56e8c536-7ef8566c-461f44b6-8951bbca-43b1ac1f014466f0ac1f0144", } } |
GET /intakes/:id
| Status | ||||
|---|---|---|---|---|
|
Retrieve a selected intake data object
Parameters
None
Response
| Code Block |
|---|
curl -X GET \ "name" -H "X-ApiToken: 5a2eb231d652b49f4d7fc0fbb78328fb"575004c7-b350-421d-8542-4dcdac1f0144.png", "path": "files/2016/08/17/57b4c65d-7ef8-461f-8951-43b1ac1f0144.png", "size": 12859, \ -H "X-AccountCode: vclinic" \ "https://api.vseepreview.com/vc/next/api_v3/intakes/57a0705e-1c4c-4f24-b51d-3c71ac1f0144" { "data": { "extmodified": "png"1471465080, "typecreated": 01471465080, "creator_id"type": "5751", "remark"reason_for_visit": "the nullreason", "usingattachments": 1,[ "modified": { "sec_id": 1471465053"57b4c65d-7ef8-461f-8951-43b1ac1f0144", "usecname": 966000"575004c7-b350-421d-8542-4dcdac1f0144.png", }"path": "files/2016/08/17/57b4c65d-7ef8-461f-8951-43b1ac1f0144.png", "createdsize": { 12859, "ext": "png", "sectype": 14714650530, "creator_id": "575", "usecremark": 967000null, }"using": 1, "modified": { } ], "idsec": "57b4c678-de20-4c1a-a52b-43e9ac1f0144" } } |
...
1471465053,
"usec": 966000
},
"created": {
"sec": 1471465053,
"usec": 967000
}
}
],
"id": "57b4c678-de20-4c1a-a52b-43e9ac1f0144"
}
}
|
Walkin Visits
POST /visits/add_walkin
| Status | ||||
|---|---|---|---|---|
|
Create a walkin walk-in visit
Parameters
Parameter | Type | Description |
|---|---|---|
|
| (optional) The ID of the provider who is being visited if patient is starting an appointment. Shouldn’t pass this for walkins. |
|
| The ID of the intake. |
|
| The ID of a scheduled appointment. This one is used in the case when the patient visits a scheduled appointment. |
|
| (optional) The ID of a scheduled appointment. This one is used in the case when the patient visits a scheduled appointment. |
|
| (optional) Patient’s code ID on behalf of whom the intake will be created |
|
| Current room’s code in which the visit will be created |
Response
| Code Block |
|---|
curl -k -X POST \ -H "X-ApiToken: 5a2eb231d652b49f4d7fc0fbb78328fb" \ -H "X-AccountCode: vclinic" \ -H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" \ -F "provider_id=826" \ -F "intake_id=57a0705e-1c4c-4f24-b51d-3c71ac1f0144" \ -F "room_code=ceproom1" \ "https://api.vsee.mevseepreview.com/vc/next/api_v3/visits/add_walkin" { "data": { "id": "1525", "member_id": "508", "provider_id": "509", "account_code": null, "code": "56e8c580f55c44a2868b66f0ac1f0144", "start": "1458095488", "end": "1458096388", "actual_start": null, "actual_end": null, "specialty_id": null, "state": null, "type": "1", "status": "10", "completed_by": null, "created": 1458095488, "modified": 1458095488, "room_id": null, "_id": "1525", "payment": { "duration": 15, "amount": "00.00", "description": "FruitStreet Config Level One-time charge" }, "intake": { "provider": "509", "reason_for_visit": "Test intake functionalities 1", "type": "1", "modified": 1458095488, "created": 1458095414, "visit_id": "1525", "id": "56e8c536-566c-44b6-bbca-66f0ac1f0144" }, "provider": { "id": "509", "first_name": "Ligeng", "last_name": "Doctor", "vseeid": "wellikodev+user509", "title": "" }, "member": { "id": "508", "first_name": "Ligeng", "last_name": "01", "vseeid": "wellikodev+user508", "dob": "2014-09-10", "gender": 1, "phone": "6506506500" }, } } |
Asynchronous Visits
POST /visits/
...
Close/Cancel a visit or an appointment
Parameters
add_econsult
| Status | ||||
|---|---|---|---|---|
|
Create an asynchronous e-consult visit. The econsult will be created without scheduling, the providers will see it on their dashboards and will need to accept it.
Parameters
Parameter | Type | Description |
|---|---|---|
|
| The ID of the |
reason
String
"patientendcall" - Patient click End Call button on VSee
"patientexitroom" - Patient click Exit Waiting Room
"call_ended" - When call ended not by patient, could be due to network problem or provider ended the call
"patientcancelappointment" - Patient click cancel appointment button
"maxwaitingtime_reached" - Patient side max waiting time reached
intake | ||
|
| Room code (required) |
Response
| Code Block |
|---|
curl -k-location -X-request POST -H "X-ApiToken: 5a2eb231d652b49f4d7fc0fbb78328fb" -H "'https://api.vseepreview.com/vc/next/api_v3/visits/add_econsult' \ --header 'X-ApiToken: 5a2eb231d652b49f4d7fc0fbb78328fb' \ --header 'X-AccountCode: vclinic" -H "' \ --header 'X-ApiKey: 44c4d9bec884a8ca356177bebd59551d' \ --header 'Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" -F "id=14" "https://api.vsee.me/api_v3/visits/close" { application/json' \ --data-raw '{ "intake_id": "6050d1a8-b120-45b4-a568-61a664457b11", "room_code": "vclinic_room_code" }' { "data": { "idincharge": "1525" } } |
Appointment API
GET /availability [public access available upon request]
Get provider's available slots
Parameters
...
Parameter
...
Type
...
Location
...
Description
...
room_code
...
String
...
Query string
...
(optional) Room code. If not given, will try to fall back to Intake.room
...
start
...
Integer
...
Query string
...
Search for available slots from this start time
...
end
...
Integer
...
Query string
...
Search for available slots up to this end time
...
duration
...
Integer
...
Query string
...
Search for available slots during certain seconds
...
provider_id
...
String
...
Query string
...
(optional) Pick only this provider’s slots
...
intake_id
...
String
...
Query string
...
Intake ID. Should be passed when patient is choosing a slot for an appointment. It will use intake’s location, specialty, etc.
...
consultation_id
...
String
...
Query string
...
Consultation ID. This will help to determine slot duration
...
X-ApiKey
...
String
...
Header
...
(beta) Header value is required if the application want to retrieve availablity without user token
...
X-ApiSecret
...
String
...
Header
...
(beta) Header value is required if the application want to retrieve availablity without user token
Notes: If application want to retrieve providers availability slots for a room without user token, the following are required X-ApiKey, X-ApiSecret, room_code, start, end, consultation_id. location will be required if you want to filter by state as well.
Notes: The time range parameters 'start', 'end' and 'duration' obey the following rules:
...
input
...
actual
...
start
...
end
...
duration
...
start
...
end
...
duration
...
1
...
not set
...
not set
...
not set
...
available
...
available+4d
...
4d
...
2
...
set
...
not set
...
not set
...
start
If 'nearest' is set, then we search for the nearest slots since the start time
...
start+4d
nearest+4d
...
4d
...
3
...
set
...
set
...
not set
...
start
...
end
...
(ignored)
...
4
...
set
...
not set
...
set
...
start
If 'nearest' is set, then we search for the nearest slots since the start time
...
start+duration
nearest+duration
...
duration
...
5
...
not set
...
set
...
not set
...
end-4d
...
end
...
4d
...
6
...
not set
...
set
...
set
...
end-duration
...
end
...
duration
...
7
...
not set
...
not set
...
set
...
available
...
available+duration
...
duration
...
8
...
set
...
set
...
set
...
start
...
end
...
(ignored)
(available: The start time of the 1st available slot)
Response
| Code Block |
|---|
curl -k -X GETfalse, "isEditExpired": false, "id": "14814100", "member_id": 14396847, "provider_id": 0, "account_code": "vclinic", "code": "6050d2e590d847429d312c8664457b11", "start": 1615909605, "end": 1615910505, "actual_start": null, "actual_end": null, "specialty_id": null, "state": "--", "type": 3, "status": 20, "completed_by": null, "room_id": 10019500, "room_code": "vclinic_room_code", "member": { "id": "14396847", "code": "member_01", "type": "200", "subtype": "", "first_name": "Ligeng", "last_name": "Member 01", "full_name": "Ligeng Member 01", "active": true, "vseeid": "cmo+604ef759ccd04d859847431864457b13" }, "pending_actions": [], "invoice": { "user_id": 14396847, "status": 10, "currency": "USD", "livemode": false, "amount_due": 0, "visit_id": "14814100", "modified": 1615909605, "created": 1615909605, "id": "6050d2e5-f680-4695-b284-2c8664457b11" }, "creator": { "id": "14396847", "code": "member_01", "vseeid": "cmo+604ef759ccd04d859847431864457b13", "type": 200, "subtype": "", "first_name": "Ligeng", "last_name": "Member 01", "account_code": "vclinic" }, "invoice_id": "6050d2e5-f680-4695-b284-2c8664457b11", "intake_id": "6050d1a8-b120-45b4-a568-61a664457b11", "postvisit": { "member_id": "14396847", "class_id": null, "visit_id": "14814100", "modified": 1615909605, "created": 1615909605 }, "account": { "domain": null, "code": "vclinic", "name": "VClinic" }, "room": { "id": "10019500", "code": "vclinic_room_code", "name": "VClinic UAT Room" }, "intake": { "reason_for_visit": "This is to test the API", "question_1": "Answer 1", "question_2": "Answer 2", "location": "--", "modified": 1615909288, "created": 1615909288, "visit_id": "14814100", "invoice_id": "6050d2e5-f680-4695-b284-2c8664457b11", "id": "6050d1a8-b120-45b4-a568-61a664457b11" }, "subtype": 4, "expiry": 1615924905 } } |
Appointment API
GET /availability
| Status | ||||
|---|---|---|---|---|
|
Get provider's available slots
Parameters
Parameter | Type | Location | Description |
|---|---|---|---|
|
|
| (optional) Room code. If not given, will try to fall back to Intake.room |
|
|
| Search for available slots from this start time |
|
|
| Search for available slots up to this end time |
|
|
| Search for available slots during certain seconds |
|
|
| (optional) Pick only this provider’s slots |
|
|
| Intake ID. Should be passed when patient is choosing a slot for an appointment. It will use intake’s location, specialty, etc. |
|
|
| Consultation ID. This will help to determine slot duration |
|
|
| (beta) Header value is required if the application want to retrieve availablity without user token |
|
|
| (beta) Header value is required if the application want to retrieve availablity without user token |
Notes: If application want to retrieve providers availability slots for a room without user token, the following are required X-ApiKey, X-ApiSecret, room_code, start, end, consultation_id. location will be required if you want to filter by state as well.
Notes: The time range parameters 'start', 'end' and 'duration' obey the following rules:
input | actual | |||||
|---|---|---|---|---|---|---|
start | end | duration | start | end | duration | |
1 | not set | not set | not set | available | available+4d | 4d |
2 | set | not set | not set |
|
| 4d |
3 | set | set | not set | start | end | (ignored) |
4 | set | not set | set |
|
| duration |
5 | not set | set | not set | end-4d | end | 4d |
6 | not set | set | set | end-duration | end | duration |
7 | not set | not set | set | available | available+duration | duration |
8 | set | set | set | start | end | (ignored) |
(available: The start time of the 1st available slot)
Sample minimal request
| Code Block |
|---|
curl --location --request GET 'https://api-vclinic.vsee.me/api_v3/availability?room_code=xxxx&start=1668129300&end=1670000000' \
--header 'X-ApiToken: vclinic_admin_token' \
--header 'X-AccountCode: vclinic' \
--header 'X-ApiKey: vclinic_api_key' \
--header 'X-ApiSecret: vclinic_api_secret'
{
"data": {
"slots": [
{
"slot_id": "10996909",
"slot_start": 1669239900,
"slot_end": 1669240800,
"slot_booked": 0,
"slot_available": 1,
"group_id": "637e920e-bd34-4d3f-82c0-804b0adc0a9f"
},
{
"slot_id": "10996909",
"slot_start": 1669240800,
"slot_end": 1669241700,
"slot_booked": 0,
"slot_available": 1,
"group_id": "637e920e-bd34-4d3f-82c0-804b0adc0a9f"
},
],
"slot_data": {
"10996909": {
"id": "10996909",
"provider_id": "12456470",
"account_code": "carebyte",
"start": "1669239900",
"end": "1669243500",
"group_id": "637e920e-bd34-4d3f-82c0-804b0adc0a9f",
"status": "10",
"created": "1669239310",
"modified": "1669239310",
"consultation": {
"duration": 15,
"slots": 1
}
}
}
}
}
|
Other sample requests
| Code Block |
|---|
curl -k -X GET -H "X-ApiToken: 6366a7018a39536a1ef4b63626f8e734" https://api.vseepreview.com/vc/next/api_v3/availability
{
"data": {
"slots": [
{
"slot_id": "5277",
"slot_start": 1470186000,
"slot_end": 1470186900,
"slot_booked": 0,
"slot_available": 1,
"group_id": "57106583f46874e70afc93b4"
},
]
}
]
}
curl -X GET \
'https://api.vseepreview.com/vc/next/api_v3/availability?consultation_id=593999b2-08e4-404c-82f8-772dc0a8016f&start=1497063600&end=1497065400&location=AL&room_code=234yn' \
-H 'x-accountcode: vclinic' \
-H 'x-apikey: vclinic_api_key' \
-H 'x-apisecret: vclinic_api_secret' \
{
"data": {
"slots": [
{
"slot_id": "4",
"slot_start": 1497063600,
"slot_end": 1497065400,
"slot_booked": 0,
"slot_available": "1",
"group_id": "59399694-9ec0-4108-927d-7776c0a8016f"
}
]
}
}
|
The above data response format will change soon to
| Code Block |
|---|
{
"data": [
{
"start": 1470186000,
"end": 1470186900,
"providers": ["123", "345"]
},
{
"start": 1470186000,
"end": 1470186900,
"providers": ["123", "345"]
}
]
]
}
|
POST /visits
| Status | ||||
|---|---|---|---|---|
|
Create an appointment
Parameters
Parameter | Type | Description |
|---|---|---|
|
| The ID of the visiting patient (optional - only use in paramedic workflow) |
|
| The timestamp of the beginning of the appointment (in UNIX timestamp format) |
|
| The timestamp of the ending of the appointment (in UNIX timestamp format) |
|
| Room code (required) |
|
| 2 - scheduling |
|
| The ID of the intake |
|
| (optional) The ID of the provider who is being visited |
Response
| Code Block |
|---|
curl -X POST \ -H "X-ApiToken: 6366a7018a39536a1ef4b63626f8e7345a2eb231d652b49f4d7fc0fbb78328fb" https://api.vsee.me/api_v3/availability\ { -H "data"X-AccountCode: {vclinic" \ -H "slots": [ { "slot_id": "5277", "slot_start": 1470186000, "slot_end": 1470186900, "slot_booked": 0, Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" \ -F "member_id=575" \ -F "slot_start=1470669300" \ -F "slot_end=1470670200" \ -F "type=2" \ -F "intakeId=57a0705e-1c4c-4f24-b51d-3c71ac1f0144" \ "https://api.vseepreview.com/vc/next/api_v3/appointments" { "slot_availabledata": 1,{ "groupmember_id": "57106583f46874e70afc93b4" }17778181, ] }"provider_id": 12456470, ] } curl -X GET \ 'https://api.vsee.me/api_v3/availability?consultation_id=593999b2-08e4-404c-82f8-772dc0a8016f&start=1497063600&end=1497065400&location=AL&room_code=234yn' \ -H 'x-accountcode: vclinic' \ -H 'x-apikey: vclinic_api_key' \ -H 'x-apisecret: vclinic_api_secret' \ { "data": { "account_code": "vclinic", "code": "615f2e2eabc46ad94e9b6457b11", "start": 1631628616, "end": 1631628916, "slotsactual_start": 1631628211, [ {"actual_end": null, "slotspecialty_id": "4"null, "slot_startstate": 1497063600null, "slot_endtype": 14970654002, "slot_bookedstatus": 030, "slotcompleted_availableby": "1"null, "grouproom_id": "59399694-9ec0-4108-927d-7776c0a8016f"1002387, } "room_code": "vclinicroom", ] } } "modified": 1633630312, |
The above data response format will change soon to
| Code Block |
|---|
{ "datacreated": [1633627694, { "provider": { "startid": 1470186000"12456470", "end": 1470186900, "providersemail": ["123", "345"] }, anton+providersa@vseelab.com", { "startsubtype": 1470186000, "482", "end": 1470186900, "providersvseeid": ["123anton+providersa@vseelab.com", "345"] } "photo": null, ] ] } |
POST /visits
Create an appointment
Parameters
...
Parameter
...
Type
...
Description
...
member_id
...
String
...
The ID of the visiting patient (optional - only use in paramedic workflow)
...
slot_start
...
Integer
...
The timestamp of the beginning of the appointment (in UNIX timestamp format)
...
slot_end
...
Integer
...
The timestamp of the ending of the appointment (in UNIX timestamp format)
...
room_code
...
String
...
Room code (required)
...
type
...
Integer
...
2 - scheduling
...
intake_id
...
String
...
The ID of the intake
...
provider_id
...
String
...
(optional) The ID of the provider who is being visited
Response
| Code Block |
|---|
curl -X POST \ -H "X-ApiToken: 5a2eb231d652b49f4d7fc0fbb78328fb" \ -H "X-AccountCode: vclinic" \ -H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" \ -F "member_id=575" \ -F "slot_start=1470669300" \ -F "slot_end=1470670200" \ -F "type=2" \ -F "intakeId=57a0705e-1c4c-4f24-b51d-3c71ac1f0144" \ "https://api.vsee.me/api_v3/appointments" { "data": {"full_name": "Anton Provider", "title": "", "suffix": "" }, "member": { "id": "17778181", "code": "anton+vclinic2@vseelab.com", "email": "anton+vclinic2@vseelab.com", "vseeid": "cmo+615f28cd70804d8994d62bd564457b11", "photo": null, "full_name": "Anton Test", "member_idphone": 17778181,"5551231122" "provider_id": 12456470}, "account_codesubType": "vclinic"3, "codemore_provider_ids": "615f2e2eabc46ad94e9b6457b11"null, "startguest_emails": 1631628616null, "endguest_mobiles": 1631628916null, "actualreminder_starttype": 1631628211null, "actualreminder_endtime": null, "specialtyhost_idids": [ null, "state12456470": null, "type": 2], "statushosts": 30,[ "completed_by": null, { "room_id": 1002387, "room_codeusername": "vclinicroomanton+providersa@vseelab.com", "modifiedemail": 1633630312"anton+providersa@vseelab.com", "created": 1633627694, "providerphone": { "", "idtimezone": "12456470America/Los_Angeles", "emailvseeid": "anton+providersa@vseelab.com", "subtypefull_name": "482Anton Provider", "vseeidtitle": "anton+providersa@vseelab.com", "photosuffix": null"", "full_name "id": "Anton Provider12456470", "titlephoto_attachment_id": "", "suffixrole": "owner" } ], "membercreator": { "id": "1777818115729940", "code": "anton+vclinic2@vseelab.com60aed4242c90409099385cef64457b11", "emailvseeid": "anton+vclinic2@vseelabd55d2f77ff3653891a587fdfa83207b4@vsee.com", "type": 160, "vseeidsubtype": "cmo+615f28cd70804d8994d62bd564457b11", "photofirst_name": null, "fulllast_name": "Anton Test"null, "phoneaccount_code": "5551231122vclinic" }, "subTypepending_actions": 3[], "moreis_provider_idstest": nullfalse, "guest_emailsmeeting": null,{ "guestrecording_auto_mobilesstart": nullfalse, "reminderphone_typenumbers": null,{ "reminder_time": null, "host_idsUS": [ "12456470" ],"+1.650.758.0255" "hosts": [ ] { }, "usernamehosts": "anton+providersa@vseelab.com",[ "email": "anton+providersa@vseelab.com", "phone": "", chau+provider@vseelab.com" "timezone": "America/Los_Angeles", ], "vseeidexpiry": "anton+providersa@vseelab.com", 1633643316, "fullconference_namepin": "Anton Provider"838759, "title"meeting_id": "",1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi" }, "suffixone_time_link_token": "l0vht6wkxj", "notify_list": [], "idpayment": "12456470",{ "photo_attachment_id"duration": "", null, "roleamount": "owner25.00", } "description": "Cloud Clinic Default One-time Charge Message", ], "id": "creator": {"615cec5b-14c8-4493-b9ce-365764457b11" }, "intake_id": "15729940615f2de7-8ab8-48d3-80d8-53f564457b11", "code"related_walkin_id": "60aed4242c90409099385cef64457b1118407370", "vseeid"call_logs": "d55d2f77ff3653891a587fdfa83207b4@vsee.com",{ "typetotal_start": 1601633628208, "subtypetotal_end": ""1633628268, "firsttotal_nameduration": null60, "lastwaiting_nametime": null0, "accountprovider_id_code1": "vclinicanton+providersa@vseelab.com", }, "pending_actions"call_start_1": []1633628208, "is_test": false, "meeting"call_duration_1": {60, "recordingwait_autotime_start1": false0, "phone_numberspatients": { [ "cmo+615f28cd70804d8994d62bd564457b11" "US": [ ], "source": "+1.650.758.0255""v2", "source_ids": [ ] }"1633628104000_1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi", "hosts": [ "1633628745000_1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi" "anton+providersa@vseelab.com",] }, "chau+provider@vseelab.comincharge": false, "intake": { ], "expiryprovider_id": 1633643316"12456470", "conferencemember_pinid": 838759"17778181", "meetingroom_idcode": "1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi"vclinicroom", }"location": "MI", "one_time_link_token "phone": "l0vht6wkxj5551234415", "notify_list "type": []"2", "paymentroom": {"vclinicroom", "durationmodified": null1633627623, "amountcreated": "25.00"1633627623, "descriptionvisit_id": "Cloud Clinic Default One-time Charge Message18407167", "idattachments": "615cec5b-14c8-4493-b9ce-365764457b11"", }, "intake_id"reason_for_visit": "615f2de7-8ab8-48d3-80d8-53f564457b11", "related_walkin_id "consent": "18407370true", "call_logs "consultation": { "total_start "description": 1633628208,"test", "total_endduration": 163362826860, "total_duration "charge": 60false, "waiting_timegroup": 0false, "provider_id_1slots": "anton+providersa@vseelab.com",1, "call_start_1amount": 16336282080, "callvisible_durationto_1patient": 60true, "wait_time_1 "id": 0,"615cec5b-14c8-4493-b9ce-365764457b11", "patientscurrency": ["USD" }, "cmo+615f28cd70804d8994d62bd564457b11" "id": "615f2de7-8ab8-48d3-80d8-53f564457b11" ], }, "sourcerelated_walkin": "v2",{ "source_ids": [ start": 1633628101, "1633628104000_1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi""end": 1633631701, "status": 30, "1633628745000_1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi" ]"id": "18407370" }, "inchargepostvisit": { false, "intakemember_id": {"17778181", "providerclass_id": "12456470"null, "membervisit_id": "1777818118407167", "room_codemodified": "vclinicroom"1633627695, "locationcreated": "MI"1633627695, "phoneid": "5551234415",615f2e2f-c240-4088-a28b-594b64457b11" }, "typeisEditExpired": "2", false, "room": "vclinicroom",{ "modifiedid": 1633627623"10023087", "createdcode": 1633627623"vclinicroom", "visit_idname": "18407167VClinic UAT", "attachmentsdomain": "vclinic.vseepreview.com", "reasonaccount_for_visitcode": "vclinic", "consentslug": "trueUAT", }, "consultationaccount": { "descriptioncode": "testvclinic", "durationname": 60"VClinic", "chargedomain": false, "vclinic.vseepreview.com", "groupvsee_api": false,{ "slotsmeeting": 1,{ "amountenabled": 0true, "visibleguest_toinvite_patientenabled": true, "id": "615cec5b-14c8-4493-b9ce-365764457b11", "adhoc_group_call": { "currency": "USD"disabled": true }, "id": "615f2de7-8ab8-48d3-80d8-53f564457b11" } }, } "related_walkin": { }, "startroot_visit": 1633628101,{ "endid": 1633631701"18407167", "statusgroup_chat_id": 30null, "idparticipants": "18407370"null }, "postvisitid": { "18407167", "member_idsubtype": "17778181",3 }, "s": "class_id": null, "visit_id": "18407167", "modified": 1633627695, "created": 1633627695, "id": "615f2e2f-c240-4088-a28b-594b64457b11" }, "isEditExpired": false,"ms" } |
POST /visits/close
| Status | ||||
|---|---|---|---|---|
|
Close/Cancel a visit or an appointment
Parameters
Parameter | Type | Description |
|---|---|---|
|
| The ID of the visit/appointment |
|
|
"patient_end_call" - Patient click End Call button on VSee
"patient_exit_room" - Patient click Exit Waiting Room
"call_ended" - When call ended not by patient, could be due to network problem or provider ended the call
"patient_cancel_appointment" - Patient click cancel appointment button
"max_waiting_time_reached" - Patient side max waiting time reached
Response
| Code Block |
|---|
curl -k -X POST -H "X-ApiToken: 5a2eb231d652b49f4d7fc0fbb78328fb" -H "X-AccountCode: vclinic" -H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" -F "id=14" "https://api.vseepreview.com/vc/next/api_v3/visits/close" { "data": { "roomid": {"1525" } } |
POST /visits/delete
| Status | ||||
|---|---|---|---|---|
|
Force cancel a visit. You can use admin token to cancel any existing visits.
Parameters
Parameter | Type | Description |
|---|---|---|
|
| The ID of the visit/appointment |
Response
| Code Block |
|---|
curl --location 'https://api.vseepreview.com/vc/stable/api_v3/visits/delete' \ "id": "10023087", "code": "vclinicroom", "name": "VClinic UAT", "domain": "vclinic.vseepreview.com", "account_code": "vclinic", "slug": "UAT" }, "account": { "code": "vclinic", "name": "VClinic", "domain": "vclinic.vseepreview.com", "vsee_api": { "meeting": { --header 'X-ApiToken: 614c588d4b03c60d9c6e480d14978164' \ --header 'X-AccountCode: vclinic' \ --form 'id="5010007042332"' |
GET /visits
| Status | ||||
|---|---|---|---|---|
|
Get the visits list of the patient. The frontend can check the data["start"] field. If the start field is greater than the current timestamp then the visit is a upcoming appointment, otherwise it’s a past session. Group appointments and one-to-one appointments are now differentiated by the field visit_group_id which only exists in group appointments data.
For one-to-one appointments, consultation information can be retrieved from intake.consultation; for group appointments, consultation information has to be got from visit_group.consultation.
The following sample response offers 2 example for one-to-one appointment and one for group appointment.
Fields that can be returned for fields with format: "html": <u>, <b>, <i>, <strong>, <ul>, <ol>, <li>, <p>, <br>
Parameters
Response
| Code Block |
|---|
curl -k -X GET \ -H "X-ApiToken: 5a2eb231d652b49f4d7fc0fbb78328fb" \ -H "X-AccountCode: vclinic" \ "https://api.vseepreview.com/vc/next/api_v3/visits.json" { "data": [ { "id": "7727", "enabledmember_id": true"575", "guest_invite_enabled"provider_id": true"1096", "adhoc_group_call"account_code": {"vclinic", "code": "57a07c26947c4544aeef4e5cac1f0144", "disabledstart": true"1470669300", "end": "1470670200", "actual_start": null, } "actual_end": null, "specialty_id": null, } "state": null, "type": "2", } "subtype": "3", }, "status": "20", "rootcompleted_visitby": {null, "created": 1470135334, "idmodified": "18407167", 1470135334, "grouproom_chat_id": null, "_id": "7727", "participantspayment": null{ "duration": }null, "idamount": "184071670.00", "description": "CMO Config Level One-time charge" "subtype": 3 }, "s": "ms" } |
GET /visits
Get the visits list of the patient. The frontend can check the data["start"] field. If the start field is greater than the current timestamp then the visit is a upcoming appointment, otherwise it’s a past session. Group appointments and one-to-one appointments are now differentiated by the field visit_group_id which only exists in group appointments data.
For one-to-one appointments, consultation information can be retrieved from intake.consultation; for group appointments, consultation information has to be got from visit_group.consultation.
The following sample response offers 2 example for one-to-one appointment and one for group appointment.
Fields that can be returned for fields with format: "html": <u>, <b>, <i>, <strong>, <ul>, <ol>, <li>, <p>, <br>
Parameters
Response
| Code Block |
|---|
curl -k -X GET \ -H "X-ApiToken: 5a2eb231d652b49f4d7fc0fbb78328fb" \ -H "X-AccountCode: vclinic" \ invoice_id": "57a071d0-c0dc-45a6-9bc3-40fdac1f0144", "provider": { "id": "1096", "code": "563b40f082584368bee10335ac1f0144", "first_name": "Anton", "last_name": "Provider III", "username": "anton+provider3@vsee.com", "vseeid": "conciergedev+user1096", "email": "anton+provider3@vsee.com", "photo": "https://api.vsee.mevseepreview.com/vc/next/api_v3/visits.json" {/files/index/app_user/photo/1096/?auth_code=8350f279578774a6e31787fc5a5a05d2948770e0", "dataactive": [true, "title": "", { "idsuffix": "7727", "member_idtos": "575"true, "provider_idphone": "1096(334) 229-4100", "account_codesubtype": "vclinic482", "code": "57a07c26947c4544aeef4e5cac1f0144"}, "startmember": "1470669300",{ "endid": "1470670200575", "actual_startcode": null"553ea41edfd041bd94475276ac1f0144", "actualfirst_endname": null"Keven2", "specialtylast_idname": null"Teodoro2", "stateusername": null,"anton+1@vsee.com", "typevseeid": "2conciergedev+user575", "subtypedob": "31983-02-02", "statusemail": "20anton+1@vsee.com", "completed_bygender": null2, "createdactive": 1470135334true, "modifiedtos": 1470135334true, "room_idphone": null"7123456111", "_idsubtype": "7727", "payment":} { }, "durationpostvisit": null, { "amountvisit_id": "0.009709", "descriptionmodified": "CMO Config Level One-time charge"1473370072, }"created": 1473368099, "invoicemember_id": "57a071d0-c0dc-45a6-9bc3-40fdac1f01441290", "providermodifiedBy": {"Alexey Provider 2", "iddraft": false, "1096", "attachments": [], "codephysical_exam": "563b40f082584368bee10335ac1f0144<p>dfvevofivuoiwue<\/p><p>iou<\/p><p>oi<\/p>", "firstassessment_nameplan": "Anton<p>oiuoiwfuweoifu<\/p><p>efweiofweiofuweoif<\/p><p><br><\/p>", "lastreason_for_namevisit": "ProviderAllergic IIIreaction", "username"reason_for_visit_other": "anton+provider3@vsee.com", "vseeidschema": "conciergedev+user1096", "emaildiagnosis": "anton+provider3@vsee.com", Allergic reaction,initial encounter (T78.40XA),Asthma (J45.909)", "photopatient_instructions": "https://api.vsee.me/api_v3/files/index/app_user/photo/1096/?auth_code=8350f279578774a6e31787fc5a5a05d2948770e0", <p>Plan \/ Discharge...<br><\/p>", "activedisposition": true,"Referred to ED", "titledea": "", "npi": "suffix": "", "tos": true, "phone": "(334) 229-4100", "subtype": "482" }, "member": { "id": "575"," } } |
GET /visits/:id
| Status | ||||
|---|---|---|---|---|
|
Get detailed information for a certain appointment.
Group appointments and one-to-one appointments are now differentiated by the field "visitgroupid" which only exists in group appointments data.
For one-to-one appointments, consultation information can be retrieved from intake.consultation; for group appointments, consultation information has to be got from visit_group.consultation.
Parameters
None
Response
| Code Block |
|---|
curl -k -X GET \ -H "X-ApiToken: 5a2eb231d652b49f4d7fc0fbb78328fb" \ -H "X-AccountCode: vclinic" \ "https://api.vseepreview.com/vc/next/api_v3/visits/7727.json" { "data": { "codemember_id": "553ea41edfd041bd94475276ac1f0144"17778181, "firstprovider_nameid": "Keven2"12456470, "lastaccount_namecode": "Teodoro2vclinic", "usernamecode": "anton+1@vsee.com615f2e2eabc46ad94e9b6457b11", "vseeidstart": "conciergedev+user575"1631628616, "dobend": "1983-02-02"1631628916, "emailactual_start": "anton+1@vsee.com"1631628211, "genderactual_end": 2null, "activespecialty_id": truenull, "tosstate": truenull, "phonetype": "7123456111"2, "subtypestatus": "" } }, 30, "postvisit": { "visit_id": "9709", "modifiedcompleted_by": 1473370072null, "createdroom_id": 14733680991002387, "memberroom_idcode": "1290vclinicroom", "modifiedBymodified": "Alexey1633630312, Provider 2", "draftcreated": false1633627694, "attachmentsprovider": [],{ "physical_examid": "<p>dfvevofivuoiwue<\/p><p>iou<\/p><p>oi<\/p>12456470", "assessment_plan "email": "<p>oiuoiwfuweoifu<\/p><p>efweiofweiofuweoif<\/p><p><br><\/p>anton+providersa@vseelab.com", "reason_for_visit": "Allergic reaction", "reason_for_visit_other"subtype": "482", "schema": "", "diagnosisvseeid": "Allergic reaction,initial encounter (T78.40XA),Asthma (J45.909)",anton+providersa@vseelab.com", "patient_instructionsphoto": "<p>Plan \/ Discharge...<br><\/p>",null, "dispositionfull_name": "ReferredAnton to EDProvider", "deatitle": "", "npisuffix": "" } } |
GET /visits/:id
Get detailed information for a certain appointment.
Group appointments and one-to-one appointments are now differentiated by the field "visitgroupid" which only exists in group appointments data.
For one-to-one appointments, consultation information can be retrieved from intake.consultation; for group appointments, consultation information has to be got from visit_group.consultation.
Parameters
None
Response
| Code Block |
|---|
curl -k -X GET \ -H "X-ApiToken: 5a2eb231d652b49f4d7fc0fbb78328fb" \ -H "X-AccountCode: vclinic" \ "https://api.vsee.me/api_v3/visits/7727.json" { }, "member": { "id": "17778181", "code": "anton+vclinic2@vseelab.com", "dataemail": { "anton+vclinic2@vseelab.com", "member_idvseeid": 17778181"cmo+615f28cd70804d8994d62bd564457b11", "provider_id "photo": 12456470null, "accountfull_codename": "vclinic",Anton Test", "codephone": "615f2e2eabc46ad94e9b6457b115551231122", "start": 1631628616}, "endsubType": 16316289163, "actualmore_provider_startids": 1631628211null, "actualguest_endemails": null, "specialtyguest_idmobiles": null, "statereminder_type": null, "typereminder_time": 2null, "statushost_ids": 30,[ "completed_by12456470": null, "room_id": 1002387], "room_codehosts": [ "vclinicroom", "modified": 1633630312, { "created": 1633627694, "providerusername": { "anton+providersa@vseelab.com", "idemail": "12456470anton+providersa@vseelab.com", "emailphone": "anton+providersa@vseelab.com", "subtypetimezone": "482America/Los_Angeles", "vseeid": "anton+providersa@vseelab.com", "photo": null, "full_name": "Anton Provider", "title": "", "suffix": "", }, "id": "member": {12456470", "photo_attachment_id": "17778181", "code": "anton+vclinic2@vseelab.com", "emailrole": "anton+vclinic2@vseelab.comowner", "vseeid": "cmo+615f28cd70804d8994d62bd564457b11",} "photo": null, ], "full_namecreator": "Anton{ Test", "phoneid": "555123112215729940" , }, "subTypecode": 3, "60aed4242c90409099385cef64457b11", "more_provider_ids": null, "guest_emailsvseeid": null"d55d2f77ff3653891a587fdfa83207b4@vsee.com", "guest_mobiles "type": null160, "reminder_type "subtype": null"", "reminderfirst_timename": null, "hostlast_idsname": [null, "account_code": "12456470vclinic" ]}, "hostspending_actions": [], "is_test": false, { "meeting": { "usernamerecording_auto_start": "anton+providersa@vseelab.com", false, "emailphone_numbers": "anton+providersa@vseelab.com",{ "phoneUS": "", [ "timezone": "America/Los_Angeles",+1.650.758.0255" ] "vseeid": "anton+providersa@vseelab.com", }, "full_namehosts": "Anton Provider",[ "title": ""anton+providersa@vseelab.com", "suffix": "",chau+provider@vseelab.com" ], "idexpiry": "12456470"1633643316, "photoconference_attachment_idpin": ""838759, "role"meeting_id": "owner1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi" } ], "creatorone_time_link_token": {"l0vht6wkxj", "id"notify_list": "15729940", [], "codepayment": "60aed4242c90409099385cef64457b11",{ "vseeidduration": "d55d2f77ff3653891a587fdfa83207b4@vsee.com"null, "typeamount": 160"25.00", "subtypedescription": "Cloud Clinic Default One-time Charge Message", "first_nameid": null, "615cec5b-14c8-4493-b9ce-365764457b11" }, "lastintake_nameid": null"615f2de7-8ab8-48d3-80d8-53f564457b11", "account_code"related_walkin_id": "vclinic" }18407370", "pendingcall_actionslogs": [],{ "istotal_teststart": false1633628208, "meeting "total_end": {1633628268, "recordingtotal_auto_startduration": false60, "phonewaiting_numberstime": { 0, "USprovider_id_1": ["anton+providersa@vseelab.com", "+1.650.758.0255" "call_start_1": 1633628208, "call_duration_1": 60, ] }"wait_time_1": 0, "hostspatients": [ "antoncmo+providersa@vseelab.com615f28cd70804d8994d62bd564457b11", ], "chau+provider@vseelab.com" ]"source": "v2", "expirysource_ids": 1633643316,[ "conference_pin": 838759,1633628104000_1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi", "meeting1633628745000_id": "1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi" }, ] "one_time_link_token": "l0vht6wkxj" }, "notify_listincharge": []false, "paymentintake": { "durationprovider_id": null"12456470", "amountmember_id": "25.0017778181", "descriptionroom_code": "Cloud Clinic Default One-time Charge Messagevclinicroom", "idlocation": "615cec5b-14c8-4493-b9ce-365764457b11" MI", }, "intake_id"phone": "615f2de7-8ab8-48d3-80d8-53f564457b115551234415", "related_walkin_id "type": "184073702", "call_logs "room": {"vclinicroom", "total_startmodified": 16336282081633627623, "total_endcreated": 16336282681633627623, "totalvisit_durationid": 60"18407167", "waiting_timeattachments": 0"", "providerreason_idfor_1visit": "anton+providersa@vseelab.com"", "call_start_1consent": 1633628208"true", "call_duration_1consultation": 60,{ "wait_time_1description": 0"test", "patientsduration": [60, "cmo+615f28cd70804d8994d62bd564457b11"charge": false, ], "group": false, "sourceslots": "v2",1, "source_idsamount": [0, "1633628104000visible_1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi"to_patient": true, "1633628745000_1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi"id": "615cec5b-14c8-4493-b9ce-365764457b11", ] "currency": "USD" }, }, "incharge": false, "intakemedical_profile": { "provider_id": "12456470553ea41ef468747652d11034", "memberuser_id": "17778181575", "roomfamily_codeconditions": "vclinicroom", { "locationdata": "MI",[ "phone": "5551234415", { "type": "2", "roomcondition": "vclinicroomDiabetes", "modifiedrelations": [ 1633627623, "created": 1633627623, "Paternal grandparents" "visit_id": "18407167", "attachments": "", ] "reason_for_visit": "", }, "consent": "true", { "consultation": { "descriptioncondition": "testUlcer disease", "duration": 60, "relations": [ "charge": false, "groupMother": false, "slots": 1, ] "amount": 0, } "visible_to_patient": true ], "idmodified": "615cec5b-14c8-4493-b9ce-365764457b11"1467623311, "currencymodifiedBy": "USDKeven Teodoro" }, "medical_profileconditions": { "_iddata": "553ea41ef468747652d11034",[ "user_id": "575", { "family_conditions": { "condition": "Kidney disease" "data": [ }, { { "condition": "Diabetes", "condition": "Kidney stones" "relations": [ }, "Paternal grandparents" { ] "condition": "Stroke" }, } { ], "conditionmodified": "Ulcer disease",1472059195, "modifiedBy": "Keven2 Teodoro2" "relations": [ }, "Mothersocial_history": { "data": [], ] "modified": 1472588123, } "modifiedBy": "Keven2 ]Teodoro2", "modified_by": 1467623311,{ "modifiedByid": "Keven Teodoro"575", }"type": 200, "conditionssubtype": {"", "datafirst_name": ["Keven2", { "last_name": "Teodoro2", "conditionphoto": ""Kidney disease" } }, }, { "health_habits": { "conditiondata": "Kidney stones"[], }"modified": 1470128370, "modifiedBy": "Keven2 {Teodoro2" }, "condition": "Stroke" "surgeries": { } "data": [ ], { "modified": 1472059195, "modifiedByprocedure": "Keven2 Teodoro2""C-section" }, "social_history": { "dataprocedure": [], "Heart valve replaced" "modified": 1472588123, } "modifiedBy": "Keven2 Teodoro2"], "modified_by": {1471769856, "idmodifiedBy": "575", Keven2 Teodoro2" "type": 200, }, "subtypemedications": "",{ "first_namedata": "Keven2", [], "last_namemodified": "Teodoro2"1471769958, "photomodifiedBy": "Keven2 Teodoro2", } "modified_by": { }, "health_habits": {"id": "575", "datatype": []"200", "modifiedsubtype": 1470128370"", "modifiedByfirst_name": "Keven2 Teodoro2", }, "last_name": "Teodoro2" "surgeries": { } "data": [ }, "allergies": { "proceduredata": "C-section"[], }, "modified": 1471986123, { "modifiedBy": "Keven2 Teodoro2", "proceduremodified_by": "Heart{ valve replaced" "id": "575", } ],"type": "200", "modifiedsubtype": 1471769856"", "modifiedByfirst_name": "Keven2", Teodoro2" }, "last_name": "Teodoro2" "medications": { } "data": [], }, "modified": 1471769958,{ "modifiedBysec": "Keven2 Teodoro2"1472059195, "modified_byusec": {806000 "id": "575", }, "typecreated": "200",{ "subtypesec": ""1430168606, "first_name": "Keven2usec",: 596000 } "last_name": "Teodoro2" }, } "id": "615f2de7-8ab8-48d3-80d8-53f564457b11" }, "related_walkin": { "allergies": { "start": 1633628101, "dataend": [], 1633631701, "modifiedstatus": 147198612330, "modifiedByid": "Keven218407370" Teodoro2", }, "modified_bypostvisit": { ""member_id": "57517778181", "typeclass_id": "200"null, "subtype"visit_id": "18407167", "modified": 1633627695, "first_name": "Keven2", "created": 1633627695, "last_nameid": "Teodoro2615f2e2f-c240-4088-a28b-594b64457b11" }, } "postvisit": { }, "visit_id": "9709", "modified": {1473370072, "created": 1473368099, "sec": 1472059195, "member_id": "1290", "usecmodifiedBy": 806000"Second Provider 2", }"draft": false, "createdattachments": {[], "physical_exam": "<p>dfvevofivuoiwue<\/p><p>iou<\/p><p>oi<\/p>", "sec": 1430168606, "assessment_plan": "<p>oiuoiwfuweoifu<\/p><p>efweiofweiofuweoif<\/p><p><br><\/p>", "usecreason_for_visit": 596000 "Allergic reaction", }"reason_for_visit_other": "", }"schema": "", "iddiagnosis": "615f2de7-8ab8-48d3-80d8-53f564457b11" Allergic reaction,initial encounter (T78.40XA),Asthma (J45.909)", }, "relatedpatient_walkininstructions": {"<p>Plan \/ Discharge...<br><\/p>", "startdisposition": 1633628101,"Referred to ED", "enddea": 1633631701"", "statusnpi": 30"", "idattachments": "18407370"[ }, "postvisit": {{ "member_id": "17778181", "class_id": null,57e4f034-3a0c-4b1d-bc15-221bac1f0144", "visit_idname": "18407167Water_nature_canyon_cliffs_horseshoe_bend_rivers_2560x1600.jpg", "modifiedpath": 1633627695"files/2016/09/23/57e4f034-3a0c-4b1d-bc15-221bac1f0144.jpg", "createdsize": 16336276951692776, "idext": "615f2e2f-c240-4088-a28b-594b64457b11"jpg", }, "type": 0, "postvisit": { "visitcreator_id": "97091096", "modifiedremark": 1473370072null, "createdusing": 14733680991, "member_id": "1290", "modified": { "modifiedBysec": "Second Provider 2", 1474621492, "draftusec": 858000 false, "attachments": [], }, "physical_examcreated": "<p>dfvevofivuoiwue<\/p><p>iou<\/p><p>oi<\/p>",{ "assessment_plan": "<p>oiuoiwfuweoifu<\/p><p>efweiofweiofuweoif<\/p><p><br><\/p>", "sec": 1474621492, "reason_for_visit": "Allergic reaction", "reason_for_visit_otherusec": "",858000 "schema": "",} "diagnosis": "Allergic reaction,initial encounter (T78.40XA),Asthma (J45.909)", } ] "patient_instructions": "<p>Plan \/ Discharge...<br><\/p>", }, "dispositionisEditExpired": "Referred to ED"false, "dearoom": { "", "npiid": "10023087", "attachmentscode": ["vclinicroom", { "name": "VClinic UAT", "_iddomain": "57e4f034-3a0c-4b1d-bc15-221bac1f0144vclinic.vseepreview.com", "nameaccount_code": "Water_nature_canyon_cliffs_horseshoe_bend_rivers_2560x1600.jpgvclinic", "pathslug": "files/2016/09/23/57e4f034-3a0c-4b1d-bc15-221bac1f0144.jpg",UAT" }, "sizeaccount": 1692776,{ "extcode": "jpgvclinic", "typename": 0"VClinic", "creator_iddomain": "1096", "vclinic.vseepreview.com", "remarkvsee_api": null,{ "usingmeeting": 1, { "modifiedenabled": { true, "secguest_invite_enabled": 1474621492true, "usec": 858000 "adhoc_group_call": { }, "createddisabled": {true "sec": 1474621492, } "usec": 858000 } } }, } "prescriptionsBeforeVisit": [ ] { }, "isEditExpiredID": false"97316", "roomDrugID": {"69117", "idNDC": "1002308700122206038", "codeRxNormCode": "vclinicroom260654", "nameDrug": "VClinic UATOne Tab Daily with Iron oral tablet", "domainSupply": "vclinic.vseepreview.com"false, "account_codeCompound": "vclinic"false, "slugDirections": "UAT" },1 Milliliter(s) 1 to 2 times a day", "accountQty": {60, "codeQtyQual": "vclinicTablet", "nameRefills": "VClinic"0, "domainDaysSupply": "vclinic.vseepreview.com"0, "vsee_apiSubstitutionAllowedFlag": 1, { "Schedule": 0, "meeting": { "PharmacyNote": "", "enabledInternalNote": true"", "PrescriberId": "826", "guest_invite_enabled "LocationId": true"DEMO-ACCOUNT", "PrescriptionDate": "2016-01-30T00:00:00", "adhoc_group_call": { "SignDate": "0001-01-01T00:00:00", "disabledStatus": true"Current", "PharmacyNcpdpId": "0001060", } "RouteDetail": "e-Sent:Jan 30 2016 3:41PM Test 000 Pharmacy 10.6MU<br />Sent", } }"PartnerMedID": "", }, "prescriptionsBeforeVisitPrescriberName": ["Dr. John Will, M.D." { }, "IDprescriptions": "97316", [], "DrugIDroot_visit": "69117",{ "NDCid": "0012220603818407167", "RxNormCodegroup_chat_id": "260654"null, "Drugparticipants": "One Tab Daily with Iron oral tablet", null "Supply": false, }, "Compoundid": false"18407167", "subtype": 3 "Directions": "1 Milliliter(s) 1 to 2 times a day", "Qty": 60, "QtyQual": "Tablet", "Refills": 0, } } |
POST /visits/:id?version=2
| Status | ||||
|---|---|---|---|---|
|
Update an appointment
Parameters
Parameter | Type | Description |
|---|---|---|
|
| (optional) The timestamp of the beginning of the appointment (in UNIX timestamp format) |
|
| (optional) The timestamp of the ending of the appointment (in UNIX timestamp format) |
|
| (optional) The ID of the provider who is being visited |
Add provider into a TDB visit
Please supply new provider_id
Response
| Code Block |
|---|
curl -X POST \ -H "X-ApiToken: 5a2eb231d652b49f88880fbb78328fb" \ -H "X-AccountCode: vclinic" \ -H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" \ -F "provider_id=566" \ "https://api.vseepreview.com/vc/next/api_v3/visits/666?version=2" { "data": { "DaysSupply"member_id": 0567, "SubstitutionAllowedFlag"provider_id": 1566, "Schedule"account_code": 0, "vclinic", "PharmacyNotecode": "615f2e2eabc46ad94e9b6457b11", "InternalNotestart": ""1631628616, "PrescriberIdend": "826"1631628916, ... "LocationId": "DEMO-ACCOUNT", "PrescriptionDate": "2016-01-30T00:00:00", "SignDate": "0001-01-01T00:00:00", } } |
Remove provider from an appointment
Do the same as above but this time set provider_id to 0
GET /visits/current
| Status | ||||
|---|---|---|---|---|
|
Get current visit in progress
Parameters
None
Response
| Code Block |
|---|
curl -X GET \ -H "X-ApiToken: 6366a7018a39536a1ef4b63626f8e734" \ https://api.vseepreview.com/vc/next/api_v3/visits/current.json { "data": { "Statusid": "Current1504", "PharmacyNcpdpIdmember_id": "0001060508", "RouteDetail"provider_id": "e-Sent:Jan 30 2016 3:41PM Test 000 Pharmacy 10.6MU<br />Sent", 509", "PartnerMedIDaccount_code": "fruitstreet", "PrescriberNamecode": "Dr. John Will56e7b1d2b90c4d68953e3d02ac1f0144", M.D." }"start": "1459973100", "prescriptionsend": []"1459974000", "rootactual_visitstart": { null, "idactual_end": "184071671458024955", "groupspecialty_chat_id": null, "participantsstate": null, }"type": "2", "idstatus": "1840716740", "subtypecompleted_by": 3"508", } } |
GET /visits/current
Get current visit in progress
Parameters
None
Response
| Code Block |
|---|
curl -X GET \ -H "X-ApiToken: 6366a7018a39536a1ef4b63626f8e734" \ https://api.vsee.me/api_v3/visits/current.json { "created": 1458024914, "datamodified": {1458024914, "room_id": "1504"null, "member_id": "5081504", "provider_idpayment": "509",{ "account_codeduration": "fruitstreet"15, "codeamount": "56e7b1d2b90c4d68953e3d02ac1f0144",00.00", "startdescription": "1459973100",FruitStreet Config Level One-time charge" "end": "1459974000"}, "actual_startintake": null,{ "actual_endprovider": "1458024955509", "specialty_id "reason_for_visit": null,"Test intake functionalities", "state": null, "typereset": "2true", "status": "40", "completed_by"type": "5081", "created": 1458024914, "modified": 1458024914, "room_id "created": null1458024708, "visit_id": "1504", "paymentid": { "56e7b104-ded0-4096-979b-395bac1f0144" }, "durationprovider": 15,{ "amountid": "00.00509", "descriptionfirst_name": "FruitStreet Config Level One-time charge"Ligeng", }, "intake"last_name": {"Doctor", "providerusername": "509ligeng+provider1@vsee.com", "reason_for_visitvseeid": "Test intake functionalitieswellikodev+user509", "resetemail": "trueligeng+provider1@vsee.com", "typeactive": "1"true, "modifiedtitle": 1458024914"", "createdtos": 1458024708false, "visit_idphone": "15046506506500", }, "idmember": "56e7b104-ded0-4096-979b-395bac1f0144" { }, "providerid": {"508", "idfirst_name": "509Ligeng", "firstlast_name": "Ligeng01", "last_nameusername": "Doctor""ligeng+1@vsee.com", "usernamevseeid": "ligengwellikodev+provider1@vsee.comuser508", "vseeiddob": "wellikodev+user5092014-09-10", "email": "ligeng+provider1@vsee1@vsee.com", "activegender": true1, "titleactive": ""true, "tos": falsetrue, "phone": "6506506500" }, } } |
Visit export
GET /visits/:id/exports/visit_summary
| Status | ||||
|---|---|---|---|---|
|
Retrieve PDF visit summary
| Code Block | ||
|---|---|---|
| ||
curl "member": { --location 'https://api-vclinic.vseepreview.com/vc/stable/api_v3/visits/1000000/exports/visit_summary' \ --header 'X-ApiToken: ******' \ --header 'X-AccountCode: vclinic' OK 200 { "iddata": "508",{ "first_name"url": "Ligeng",https://clinic.vsee.me/visits/exports/d6880792f1fa01****" } "last_name": "01", "username": "ligeng+1@vsee.com", "vseeid": "wellikodev+user508", "dob": "2014-09-10", "email": "ligeng+1@vsee.com", "gender": 1, "active": true, "tos": true, "phone": "6506506500" } } } } |
Understanding Visit object ID
There is a unique Visit.id field for every Visit object.
However some visits may be related to each other, following these rules:
Field | Sample | Meaning |
|---|---|---|
|
| Unique visit ID |
|
| When an appointment is started, a new visit object of type |
|
| When an appointment is started, a new visit object of type |
|
| |
|
| When a user is invited into an appointment call, the inviting appointment ID is stored here. |
|
|