Page Comparison

Table of Contents

minLevel	1
maxLevel	7

Intakes

POST /intakes
Status
colour Yellow
title V3

Create intake information.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
`provider_id`	`Integer`	(optional) The ID of the provider who is being visited
`reason_for_visit`	`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_code`	`String`	Room’s code
`attachments`	`Array`	(optional) 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`	(optional) `CA/AL/...`
`phone`	`String`	(optional) e.g `7123465789`

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
colour Yellow
title V3

Update a selected intake data object

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.vseepreview.com/vc/next/api_v3/intakes/57a0705e-1c4c-4f24-b51d-3c71ac1f0144"

{
  "data": {
      "id": "56e8c536-566c-44b6-bbca-66f0ac1f0144"
  }
}

GET /intakes/:id
Status
colour Yellow
title V3

Retrieve a selected intake data object

Parameters

None

Response

Code Block


curl -X GET \
  -H "X-ApiToken: 5a2eb231d652b49f4d7fc0fbb78328fb" \
  -H "X-AccountCode: vclinic" \
  "https://api.vseepreview.com/vc/next/api_v3/intakes/57a0705e-1c4c-4f24-b51d-3c71ac1f0144"

{
  "data": {
    "modified": 1471465080,
    "created": 1471465080,
    "type": "1",
    "reason_for_visit": "the reason",
    "attachments": [
      {
        "creator_id": "57557b4c65d-7ef8-461f-8951-43b1ac1f0144",
        "remarkname": null"575004c7-b350-421d-8542-4dcdac1f0144.png",
        "usingpath": 1"files/2016/08/17/57b4c65d-7ef8-461f-8951-43b1ac1f0144.png",
        "modifiedsize": {12859,
          "secext": 1471465053"png",
          "usectype": 9660000,
        },
"creator_id": "575",
        "remark": null,
        "using": 1,
        "modified": {
          "sec": 1471465053,
          "usec": 966000
        },
        "created": {
          "sec": 1471465053,
          "usec": 967000
        }
      }
    ],
    "id": "57b4c678-de20-4c1a-a52b-43e9ac1f0144"
  }
}

Walkin Visits

POST /visits/add_walkin
Status
colour Yellow
title V3

Create a walkin walk-in visit

Parameters

Parameter	Type	Description
`provider_id`	`String`	(optional) The ID of the provider who is being visited if patient is starting an appointment. Shouldn’t pass this for walkins.
`intake_id`	`String`	The ID of the intake.
`visit_data_id`	`String`	The ID of a scheduled appointment. This one is used in the case when the patient visits a scheduled appointment.
`visit_id`	`String`	(optional) The ID of a scheduled appointment. This one is used in the case when the patient visits a scheduled appointment.
`user_code`	`String`	(optional) Patient’s code ID on behalf of whom the intake will be created
`room_code`	`String`	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

...

Parameter

...

Type

...

Description

...

id

add_econsult
Status
colour Yellow
title V3

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
`intake_id`	`String`	The ID of the

visit/appointmentreason

intake
`room_code`	`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

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"false,
   }
}

POST /visits/add_econsult

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

...

intake_id

...

String

...

The ID of the intake

...

room_code

...

String

...

Room code (required)

Response

Code Block

curl --location --request POST 'https://api.vsee.me/api_v3/visits/add_econsult' \
--header 'X-ApiToken: 5a2eb231d652b49f4d7fc0fbb78328fb' \
--header 'X-AccountCode: vclinic' \
--header 'X-ApiKey: 44c4d9bec884a8ca356177bebd59551d' \
--header 'Content-Type: application/json' \
--data-raw '{
   "intake_id": "6050d1a8-b120-45b4-a568-61a664457b11",
   "room_code": "vclinic_room_code"
}'


{
   "data": {
       "incharge": false,
       "isEditExpired": false,
       "id": "14814100",
       "    "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
colour Yellow
title V3

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)

ResponseSample minimal request

Code Block


curl -k -X GETlocation -H "X-ApiToken: 6366a7018a39536a1ef4b63626f8e734" -request GET 'https://api-vclinic.vsee.me/api_v3/availability?room_code=xxxx&start=1668129300&end=1670000000' 
{
  "data": {
    "slots": [
\
--header 'X-ApiToken: vclinic_admin_token' \
--header 'X-AccountCode: vclinic' \
--header 'X-ApiKey: vclinic_api_key' \
--header 'X-ApiSecret: vclinic_api_secret'

{
    "data": {
        "slot_idslots": "5277",[
         "slot_start": 1470186000,  {
      "slot_end": 1470186900,         "slot_bookedid": 0"10996909",
                "slot_availablestart": 1,1669239900,
                "groupslot_idend": "57106583f46874e70afc93b4"1669240800,
                }"slot_booked": 0,
           ]     "slot_available": 1,
    }   ] }  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":"group_id": "637e920e-bd34-4d3f-82c0-804b0adc0a9f"
            },
            {
    "slots": [       {         "slot_id": "410996909",
                "slot_start": 14970636001669240800,
                "slot_end": 14970654001669241700,
                "slot_booked": 0,
                "slot_available": "1",
                "group_id": "59399694637e920e-9ec0bd34-41084d3f-927d82c0-7776c0a8016f804b0adc0a9f"
      }     ]   },
}

The above data response format will change soon to

Code Block

{],
  "data": [     "slot_data": {
              "start10996909": 1470186000,{
       "end": 1470186900,        "providersid": ["12310996909",
"345"]      },      {    "provider_id": "12456470",
                "account_code": "carebyte",
                "start": 1470186000"1669239900",
                "end": 1470186900"1669243500",
       "providers         "group_id": ["123", "345"]"637e920e-bd34-4d3f-82c0-804b0adc0a9f",
                "status": "10",
         }        ]"created": "1669239310",
              ] }

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"


{ "modified": "1669239310",
                "consultation": {
                    "duration": 15,
                    "dataslots": 1
{         "member_id": 17778181,      }
  "provider_id": 12456470,         "account_code": "vclinic",}
        }
"code": "615f2e2eabc46ad94e9b6457b11",   }
}

Other sample requests

Code Block

curl -k -X GET -H "start"X-ApiToken: 1631628616,
  6366a7018a39536a1ef4b63626f8e734" https://api.vseepreview.com/vc/next/api_v3/availability

{
     "enddata": 1631628916,{
        "actual_start"slots": 1631628211,[
      {
 "actual_end": null,
        "specialtyslot_id": null"5277",
        "stateslot_start": null1470186000,
        "typeslot_end": 21470186900,
        "statusslot_booked": 300,
        "completedslot_byavailable": null1,
        "roomgroup_id": 1002387,"57106583f46874e70afc93b4"
      },
 "room_code": "vclinicroom",    
    "modified": 1633630312,
]      
  "created": 1633627694, }
  ]
}

curl  "provider": {
            "id": "12456470",
            "email": "anton+providersa@vseelab.com",
    -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": [
      {
        "subtypeslot_id": "4824",
        "slot_start": 1497063600,
  "vseeid": "anton+providersa@vseelab.com",      "slot_end": 1497065400,
        "photoslot_booked": null0,
            "fullslot_nameavailable": "Anton Provider1",
            "title"group_id": "",59399694-9ec0-4108-927d-7776c0a8016f"
      }
    ]
"suffix": ""
  }
}
      
},

The above data response format will change soon to

Code Block

{
  "data": [
    "member": {       
       "idstart": "17778181",1470186000,
       "end": 1470186900,
       "codeproviders": ["anton+vclinic2@vseelab.com123", "345"]
     },
     "email": "anton+vclinic2@vseelab.com",{
       "start": 1470186000,
       "vseeidend": "cmo+615f28cd70804d8994d62bd564457b11"1470186900,

           "photoproviders": null,
            "full_name": "Anton Test",
            "phone": "5551231122"["123", "345"]
         },    
   ] "subType": 3,         "more_provider_ids":
null,  ]
      "guest_emails": null,
        "guest_mobiles": null,
        "reminder_type": null,
        "reminder_time": null,
        "host_ids": [
            "12456470"
        ],
        "hosts": [}

POST /visits
Status
colour Yellow
title V3

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.vseepreview.com/vc/next/api_v3/appointments"


{
    "data": {
        "member_id": 17778181,
  {      "provider_id": 12456470,
         "usernameaccount_code": "anton+providersa@vseelab.comvclinic",
        "code": "615f2e2eabc46ad94e9b6457b11",
        "emailstart": "anton+providersa@vseelab.com",1631628616,
        "end": 1631628916,
        "phoneactual_start": ""1631628211,
        "actual_end": null,
        "timezonespecialty_id": "America/Los_Angeles"null,
        "state": null,
        "vseeidtype": "anton+providersa@vseelab.com"2,
        "status": 30,
        "fullcompleted_nameby": "Anton Provider"null,
        "room_id": 1002387,
        "titleroom_code": "vclinicroom",
        "modified": 1633630312,
        "suffixcreated": "",1633627694,
        "provider": {
            "id": "12456470",
                "photo_attachment_id"email": "anton+providersa@vseelab.com",
                "rolesubtype": "owner482",
            }
"vseeid": "anton+providersa@vseelab.com",
       ],         "creatorphoto": {null,
            "idfull_name": "15729940Anton Provider",
            "codetitle": "60aed4242c90409099385cef64457b11",
            "vseeidsuffix": "d55d2f77ff3653891a587fdfa83207b4@vsee.com","
        },
        "typemember": 160,{
            "subtypeid": "17778181",
            "first_namecode": null"anton+vclinic2@vseelab.com",
            "last_nameemail": null"anton+vclinic2@vseelab.com",
            "account_codevseeid": "vcliniccmo+615f28cd70804d8994d62bd564457b11",
        },    "photo": null,
   "pending_actions": [],
        "isfull_testname": false,"Anton Test",
            "meetingphone": {"5551231122"
        },
     "recording_auto_start   "subType": false3,
   
        "phonemore_provider_numbersids": {null,
        "guest_emails": null,
        "USguest_mobiles": [null,
        "reminder_type": null,
          "+1.650.758.0255"
"reminder_time": null,
        "host_ids": [
     ]       "12456470"
     },   ],
         "hosts": [
            {
                "username": "anton+providersa@vseelab.com",
                "email": "chauanton+provider@vseelabprovidersa@vseelab.com",
            ],    "phone": "",
       "expiry": 1633643316,        "timezone": "America/Los_Angeles",
   "conference_pin": 838759,             "meeting_idvseeid": "1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi"
anton+providersa@vseelab.com",
       },         "one_time_link_tokenfull_name": "l0vht6wkxjAnton Provider",
        "notify_list": [],         "paymenttitle": {"",
                "durationsuffix": null"",
                "amountid": "25.0012456470",
            "description    "photo_attachment_id": "Cloud",
Clinic Default One-time Charge Message",             "idrole": "615cec5b-14c8-4493-b9ce-365764457b11owner"
            },
        "intake_id": "615f2de7-8ab8-48d3-80d8-53f564457b11"],
        "related_walkin_idcreator": "18407370", {
            "call_logsid": {"15729940",
            "total_startcode": 1633628208"60aed4242c90409099385cef64457b11",
            "total_endvseeid": 1633628268"d55d2f77ff3653891a587fdfa83207b4@vsee.com",
            "total_durationtype": 60160,
            "waiting_timesubtype": 0"",
            "providerfirst_id_1name": "anton+providersa@vseelab.com"null,
            "calllast_start_1name": 1633628208null,
            "callaccount_duration_1code": 60, "vclinic"
        },
        "waitpending_time_1actions": 0,
   [],
        "patientsis_test": [false,
        "meeting": {
      "cmo+615f28cd70804d8994d62bd564457b11"      "recording_auto_start": false,
     ],         "phone_numbers": {
   "source": "v2",             "source_idsUS": [
                  "1633628104000_1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi",  "+1.650.758.0255"
                 "1633628745000_1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi"]
            },
  ]         }, "hosts": [
      "incharge": false,         "intake": {anton+providersa@vseelab.com",
               "provider_id": "12456470chau+provider@vseelab.com",
            "member_id": "17778181"],
            "room_codeexpiry": "vclinicroom"1633643316,
            "locationconference_pin": "MI"838759,
            "phonemeeting_id": "5551234415",1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi"
        },
        "typeone_time_link_token": "2l0vht6wkxj",
            "room"notify_list": "vclinicroom"[],
            "modifiedpayment": 1633627623,{
            "createdduration": 1633627623null,
            "visit_idamount": "1840716725.00",
            "attachmentsdescription": "Cloud Clinic Default One-time Charge Message",
            "reason_for_visitid": "",615cec5b-14c8-4493-b9ce-365764457b11"
        },
        "consentintake_id": "true615f2de7-8ab8-48d3-80d8-53f564457b11",
            "consultation"related_walkin_id": {"18407370",
                "description"call_logs": "test",
 {
              "durationtotal_start": 601633628208,
  
             "chargetotal_end": false1633628268,
 
              "grouptotal_duration": false60,
                "slots"waiting_time": 10,
                "amount"provider_id_1": 0"anton+providersa@vseelab.com",
                "visiblecall_tostart_patient1": true1633628208,
                "id"call_duration_1": "615cec5b-14c8-4493-b9ce-365764457b11"60,
                "currency"wait_time_1": "USD"
            }0,
            "idpatients": "615f2de7-8ab8-48d3-80d8-53f564457b11"[
        },         "related_walkin": {"cmo+615f28cd70804d8994d62bd564457b11"
             "start": 1633628101],
            "endsource": 1633631701"v2",
            "statussource_ids": 30,
   [
        "id": "18407370"         }"1633628104000_1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi",
        "postvisit": {          "1633628745000_1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi"
  "member_id": "17778181",         ]
   "class_id": null,    },
        "visit_idincharge": "18407167"false,
            "modifiedintake": 1633627695,{
            "createdprovider_id": 1633627695"12456470",
            "member_id": "615f2e2f-c240-4088-a28b-594b64457b11"17778181",
            },"room_code": "vclinicroom",
            "isEditExpiredlocation": false,"MI",
            "roomphone": {"5551234415",
            "idtype": "100230872",
            "coderoom": "vclinicroom",
            "namemodified": "VClinic UAT"1633627623,
            "domaincreated": "vclinic.vseepreview.com"1633627623,
            "accountvisit_codeid": "vclinic18407167",
            "slugattachments": "UAT",
        },         "account": {"reason_for_visit": "",
             "codeconsent": "vclinictrue",
            "nameconsultation": "VClinic", {
                "domaindescription": "vclinic.vseepreview.comtest",
                "vsee_apiduration": {60,
                "meetingcharge": {
false,
                   "enabledgroup": truefalse,
   
                "guest_invite_enabledslots": true1,
                "amount": 0,
  "adhoc_group_call": {             "visible_to_patient": true,
          "disabled": true     "id": "615cec5b-14c8-4493-b9ce-365764457b11",
              }  "currency": "USD"
            },
}             }"id": "615f2de7-8ab8-48d3-80d8-53f564457b11"
        },
        "rootrelated_visitwalkin": {
            "idstart": 1633628101,
            "18407167end": 1633631701,
            "group_chat_idstatus": null30,
            "participantsid": null"18407370"
        },
        "postvisit": {
            "member_id": "1840716717778181",
            "subtypeclass_id": 3null,
       },     "svisit_id": "ms18407167"
}

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": , , , , <ul>, <ol>, <li>, , 

Parameters

Response

Code Block

curl -k -X GET \
  -H "X-ApiToken: 5a2eb231d652b49f4d7fc0fbb78328fb" \
  -H "X-AccountCode: vclinic" \
  "https://api.vsee.me/api_v3/visits.json"

{
  "data": [
    {,
            "modified": 1633627695,
            "created": 1633627695,
            "id": "615f2e2f-c240-4088-a28b-594b64457b11"
        },
        "isEditExpired": false,
        "room": {
            "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": {
                    "enabled": true,
                    "guest_invite_enabled": true,
                    "adhoc_group_call": {
                        "disabled": true
                    }
                }
            }
        },
        "root_visit": {
            "id": "18407167",
            "group_chat_id": null,
            "participants": null
        },
        "id": "18407167",
        "subtype": 3
    },
    "s": "ms"
}

POST /visits/close
Status
colour Yellow
title V3

Close/Cancel a visit or an appointment

Parameters

Parameter	Type	Description
`id`	`String`	The ID of the visit/appointment
`reason`	`String`

"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": {
        "id": "1525"
  }
}

POST /visits/delete
Status
colour Yellow
title V3

Force cancel a visit. You can use admin token to cancel any existing visits.

Parameters

Parameter	Type	Description
`id`	`String`	The ID of the visit/appointment

Response

Code Block
curl --location 'https://api.vseepreview.com/vc/stable/api_v3/visits/delete' \ --header 'X-ApiToken: 614c588d4b03c60d9c6e480d14978164' \ --header 'X-AccountCode: vclinic' \ --form 'id="5010007042332"'

GET /visits
Status
colour Yellow
title V3

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": , , , , <ul>, <ol>, <li>, , 

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",
      "member_id": "575",
      "provider_id": "1096",
      "account_code": "vclinic",
      "code": "57a07c26947c4544aeef4e5cac1f0144",
      "start": "1470669300",
      "end": "1470670200",
      "actual_start": null,
      "actual_end": null,
      "specialty_id": null,
      "state": null,
      "type": "2",
      "subtype": "3",
      "status": "20",
      "completed_by": null,
      "created": 1470135334,
      "modified": 1470135334,
      "room_id": null,
      "_id": "7727",
      "payment": {
        "duration": null,
        "amount": "0.00",
        "description": "CMO Config Level One-time charge"
      },
      "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.vseepreview.com/vc/next/api_v3/files/index/app_user/photo/1096/?auth_code=8350f279578774a6e31787fc5a5a05d2948770e0",
        "active": true,
        "title": "",
        "suffix": "",
        "tos": true,
        "phone": "(334) 229-4100",
        "subtype": "482"
      },
      "member": {
        "id": "7727575",
        "member_idcode": "575553ea41edfd041bd94475276ac1f0144",
        "providerfirst_idname": "1096Keven2",
        "accountlast_codename": "vclinicTeodoro2",
        "codeusername": "57a07c26947c4544aeef4e5cac1f0144anton+1@vsee.com",
        "startvseeid": "1470669300conciergedev+user575",
        "enddob": "14706702001983-02-02",
        "actual_startemail": null"anton+1@vsee.com",
        "actual_endgender": null2,
        "specialty_idactive": nulltrue,
        "statetos": nulltrue,
        "typephone": "27123456111",
        "subtype": "3","
      }
    },
    "statuspostvisit": "20",{
      "completedvisit_byid": null"9709",
      "createdmodified": 14701353341473370072,
      "modifiedcreated": 14701353341473368099,
      "roommember_id": null": "1290",
      "_idmodifiedBy": "7727Alexey Provider 2",
      "paymentdraft": {
 false,
      "durationattachments": null[],

       "amountphysical_exam": "0.00<p>dfvevofivuoiwue<\/p><p>iou<\/p><p>oi<\/p>",

       "descriptionassessment_plan": "CMO Config Level One-time charge"
      }<p>oiuoiwfuweoifu<\/p><p>efweiofweiofuweoif<\/p><p><br><\/p>",
      "reason_for_visit": "Allergic reaction",
      "invoice_idreason_for_visit_other": "57a071d0-c0dc-45a6-9bc3-40fdac1f0144",
      "providerschema": {"",
        "iddiagnosis": "1096"Allergic reaction,initial encounter (T78.40XA),Asthma (J45.909)",
      "codepatient_instructions": "563b40f082584368bee10335ac1f0144<p>Plan \/ Discharge...<br><\/p>",
        "first_namedisposition": "AntonReferred to ED",
        "last_namedea": "Provider III",
 
      "usernamenpi": "anton+provider3@vsee.com",
    }
}

 "vseeid": "conciergedev+user1096",
        "email": "anton+provider3@vsee.com",
        "photo":

GET /visits/:id
Status
colour Yellow
title V3
and Sample Visit Object

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.mevseepreview.com/vc/next/api_v3/files/index/app_user/photo/1096/?auth_code=8350f279578774a6e31787fc5a5a05d2948770e0",
   visits/7727.json"

{
    "activedata": true,{
        "titlemember_id": ""17778181,
        "suffixprovider_id": "",
        "tos": true,
        "phone": "(334) 229-4100",
        "subtype": "482"
      },12456470,
        "memberaccount_code": {"vclinic",
        "idcode": "575615f2e2eabc46ad94e9b6457b11",
        "codestart": "553ea41edfd041bd94475276ac1f0144"1631628616,
        "first_nameend": "Keven2"1631628916,
        "lastactual_namestart": "Teodoro2"1631628211,
        "usernameactual_end": "anton+1@vsee.com"null,
        "vseeidspecialty_id": "conciergedev+user575"null,
        "dobstate": "1983-02-02"null,
        "emailtype": "anton+1@vsee.com"2,
        "genderstatus": 230,
        "activecompleted_by": truenull,
        "tosroom_id": true1002387,
        "phoneroom_code": "7123456111vclinicroom",
        "subtypemodified": 1633630312,
""        }
"created": 1633627694,
   },     "postvisitprovider": {
      "visit_      "id": "970912456470",
            "modifiedemail": 1473370072"anton+providersa@vseelab.com",
      "created": 1473368099,       "member_idsubtype": "1290482",
      "modifiedBy      "vseeid": "Alexey Provider 2","anton+providersa@vseelab.com",
            "draftphoto": falsenull,
      "attachments": [],       "physicalfull_examname": "<p>dfvevofivuoiwue<\/p><p>iou<\/p><p>oi<\/p>Anton Provider",
      "assessment_plan": "<p>oiuoiwfuweoifu<\/p><p>efweiofweiofuweoif<\/p><p><br><\/p>",       "reason_for_visit"title": "Allergic reaction",
      "reason_for_visit_other": "",       "schemasuffix": "",
      "diagnosis": "Allergic reaction},initial
encounter (T78.40XA),Asthma (J45.909)",       "patient_instructionsmember": "<p>Plan \/ Discharge...<br><\/p>", {
            "dispositionid": "Referred to ED",17778181",
            "deacode": "anton+vclinic2@vseelab.com",
      "npi      "email": "anton+vclinic2@vseelab.com",
    }      }

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"

{"vseeid": "cmo+615f28cd70804d8994d62bd564457b11",
            "photo": null,
            "full_name": "Anton Test",
            "dataphone": {"5551231122"
        "member_id": 17778181},
        "provider_idsubType": 124564703,
        "accountmore_provider_codeids": "vclinic"null,
        "codeguest_emails": "615f2e2eabc46ad94e9b6457b11"null,
        "startguest_mobiles": 1631628616null,
        "endreminder_type": 1631628916null,
        "actualreminder_starttime": 1631628211null,
        "actualhost_endids": null, [
            "specialty_id": null12456470"
        ],
        "statehosts": [
null,         "type": 2,  {
      "status": 30,         "completed_byusername": null"anton+providersa@vseelab.com",
        "room_id": 1002387,
        "room_codeemail": "vclinicroomanton+providersa@vseelab.com",
        "modified": 1633630312,         "createdphone": 1633627694"",
        "provider": {             "id"timezone": "12456470America/Los_Angeles",
                "emailvseeid": "anton+providersa@vseelab.com",
                "subtypefull_name": "482Anton Provider",
                "vseeidtitle": "anton+providersa@vseelab.com",
                "photosuffix": null"",
            "full_name    "id": "Anton Provider12456470",
            "title    "photo_attachment_id": "",,
                "suffixrole": "owner"
        },    }
    "member": {   ],
         "idcreator": "17778181",{
            "codeid": "anton+vclinic2@vseelab.com15729940",
            "emailcode": "anton+vclinic2@vseelab.com60aed4242c90409099385cef64457b11",
            "vseeid": "cmo+615f28cd70804d8994d62bd564457b11d55d2f77ff3653891a587fdfa83207b4@vsee.com",
            "phototype": null160,
            "full_namesubtype": "Anton Test",
            "phonefirst_name": "5551231122"
        }null,
        "subType": 3,         "morelast_provider_idsname": null,
        "guest_emails": null,
        "guestaccount_mobilescode": null,"vclinic"
        "reminder_type": null},
        "reminderpending_timeactions": null[],
        "hostis_idstest": [
  false,
         "12456470"    "meeting": {
   ],         "hostsrecording_auto_start": [false,
            "phone_numbers": {
                "usernameUS": "anton+providersa@vseelab.com",[
                   "email": "anton+providersa@vseelab.com",1.650.758.0255"
                ]
      "phone": "",      },
            "timezonehosts": "America/Los_Angeles",[
                "vseeid": "anton+providersa@vseelab.com",
                "full_name": "Anton Provider",chau+provider@vseelab.com"
            ],
            "titleexpiry": "",
   1633643316,
            "suffixconference_pin": ""838759,
                "meeting_id": "12456470",1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi"
        },
        "photoone_time_attachmentlink_idtoken": "l0vht6wkxj",
        "notify_list": [],
        "rolepayment": "owner"{
            }
"duration": null,
       ],
        "creatoramount": {"25.00",
            "iddescription": "15729940Cloud Clinic Default One-time Charge Message",
            "codeid": "60aed4242c90409099385cef64457b11",615cec5b-14c8-4493-b9ce-365764457b11"
        },
        "vseeidintake_id": "d55d2f77ff3653891a587fdfa83207b4@vsee.com",
   615f2de7-8ab8-48d3-80d8-53f564457b11",
        "typerelated_walkin_id": 160,
   "18407370",
        "subtypecall_logs": "",{
            "firsttotal_namestart": null1633628208,
            "lasttotal_nameend": null1633628268,
            "accounttotal_codeduration": "vclinic"
    60,
    },         "pendingwaiting_actionstime": []0,
        "is_test    "provider_id_1": false"anton+providersa@vseelab.com",
        "meeting    "call_start_1": {1633628208,
            "recordingcall_autoduration_start1": false60,
            "phonewait_time_numbers1": {0,
                "USpatients": [

                   "+1.650.758.0255cmo+615f28cd70804d8994d62bd564457b11"
            ],
   ]             }"source": "v2",
            "hostssource_ids": [
                "anton+providersa@vseelab.com1633628104000_1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi",
                "chau+provider@vseelab.com"1633628745000_1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi"
            ]
        ]},
        "incharge": false,
  "expiry      "intake": 1633643316,{
            "conferenceprovider_pinid": 838759"12456470",
            "meetingmember_id": "1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi"17778181",
        },         "one_time_link_tokenroom_code": "l0vht6wkxjvclinicroom",
            "notify_listlocation": [],"MI",
            "paymentphone": {"5551234415",
            "durationtype": null"2",
            "amountroom": "25.00vclinicroom",
            "descriptionmodified": "Cloud Clinic Default One-time Charge Message" 1633627623,
            "created": 1633627623,
            "visit_id": "615cec5b-14c8-4493-b9ce-365764457b11"
18407167",
       },         "intake_id"attachments": "615f2de7-8ab8-48d3-80d8-53f564457b11",
            "relatedreason_walkinfor_idvisit": "18407370",
            "call_logsconsent": {"true",
            "total_startconsultation": 1633628208,{
                "total_enddescription": 1633628268"test",
                "total_duration": 60,
            "waiting_time    "charge": 0false,
            "provider_id_1    "group": "anton+providersa@vseelab.com"false,
            "call_start_1    "slots": 16336282081,
                "call_duration_1amount": 600,
                "waitvisible_timeto_1patient": 0true,
                "patientsid": ["615cec5b-14c8-4493-b9ce-365764457b11",
                "cmo+615f28cd70804d8994d62bd564457b11currency": "USD"
            ]},
            "sourcemedical_profile": "v2",{
              "source_idsid": ["553ea41ef468747652d11034",
              "user_id":  "1633628104000_1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi"575",
                "1633628745000_1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi"
family_conditions": {
           ]     "data": [
   },            "incharge": false,  {
      "intake": {             "provider_idcondition": "12456470Diabetes",
    
       "member_id": "17778181",             "room_coderelations": "vclinicroom",[
            "location": "MI",             "phone": "5551234415","Paternal grandparents"
            "type": "2",           ]
   "room": "vclinicroom",             "modified": 1633627623},
            "created": 1633627623,     {
       "visit_id": "18407167",             "attachmentscondition": "Ulcer disease",
            "reason_for_visit": "",        "relations": [
        "consent": "true",             "consultationMother":
  {                 "description": "test", ]
                "duration": 60, }
               "charge": false],
                "groupmodified": false1467623311,
                "slotsmodifiedBy": 1,"Keven Teodoro"
               "amount": 0},
                "visible_to_patient"conditions": true,{
                "iddata": "615cec5b-14c8-4493-b9ce-365764457b11",
    [
            "currency": "USD"     {
       },             "medical_profilecondition": { "Kidney disease"
                 "_id": "553ea41ef468747652d11034" },
              "user_id": "575",    {
                    "family_conditionscondition": {"Kidney stones"
                 "data": [ },
                  {
                    "condition": "DiabetesStroke",
                  }
   "relations": [            ],
          "Paternal grandparents"     "modified": 1472059195,
              ]  "modifiedBy": "Keven2 Teodoro2"
              },
                 "social_history": {

                   "conditiondata": "Ulcer disease"[],
                    "relationsmodified": [1472588123,
                "modifiedBy": "Keven2     "Mother"Teodoro2",
                "modified_by": {
   ]               "id": "575",
  }                "type": ]200,
                  "modifiedsubtype": 1467623311"",
                  "modifiedByfirst_name": "Keven TeodoroKeven2",
              },    "last_name": "Teodoro2",
         "conditions": {           "photo": ""
     "data": [          }
        {      },
              "conditionhealth_habits": "Kidney{
disease"                "data": [],
 },               "modified": 1470128370,
  {              "modifiedBy": "Keven2 Teodoro2"
     "condition": "Kidney stones"       },
           },   "surgeries": {
              {  "data": [
                 "condition": "Stroke" {
                  }  "procedure": "C-section"
             ],     },
           "modified": 1472059195,      {
          "modifiedBy": "Keven2 Teodoro2"        "procedure": "Heart valve replaced"
   },               "social_history": {}
                 "data": [],
                "modified": 14725881231471769856,
                "modifiedBy": "Keven2 Teodoro2",
              },
 "modified_by": {                   "id"medications": "575",
 {
                "typedata": 200[],
 
                "subtypemodified": ""1471769958,
                  "first_namemodifiedBy": "Keven2 Teodoro2",
                  "lastmodified_nameby": "Teodoro2",{
                  "photoid": "575",
                }  "type": "200",
           },               "health_habits": {"subtype": "",
                  "datafirst_name": [],"Keven2",
                  "modifiedlast_name": 1470128370,"Teodoro2"
                "modifiedBy": "Keven2 Teodoro2"}
              },
              "surgeriesallergies": {
                "data": [],
                "modified": 1471986123,
{                     "proceduremodifiedBy": "C-section"Keven2 Teodoro2",
                "modified_by": {
},                   {
 "id": "575",
                  "proceduretype": "Heart valve replaced200",
                  }
"subtype": "",
               ],                 "modified"first_name": 1471769856"Keven2",
                  "modifiedBylast_name": "Keven2 Teodoro2"
              },  }
            "medications": { },
               "datamodified": [],{
                "modifiedsec": 14717699581472059195,
                "modifiedByusec": "Keven2 Teodoro2",
      806000
          "modified_by": {   },
               "idcreated": "575",
 {
                "typesec": "200"1430168606,
                  "subtypeusec": "",596000
              }
     "first_name": "Keven2",      },
            "last_nameid": "Teodoro2615f2de7-8ab8-48d3-80d8-53f564457b11"
        },
       } "related_walkin": {
            },
"start": 1633628101,
             "allergiesend": {1633631701,
                "datastatus": []30,
               "id": "modified18407370":
1471986123,        },
        "modifiedBypostvisit": "Keven2 Teodoro2",{
                "modifiedmember_byid": {"17778181",
                  ""class_id": "575",
     null,
            "typevisit_id": "20018407167",
                  "subtype"modified": "",
     1633627695,
            "first_namecreated": "Keven2"1633627695,
                  "last_name"id": "Teodoro2615f2e2f-c240-4088-a28b-594b64457b11"
        },
       } "postvisit": {
            }"visit_id": "9709",
              "modified": {1473370072,
          "created": 1473368099,
    "sec": 1472059195,     "member_id": "1290",
          "usecmodifiedBy": "Second 806000Provider 2",
          "draft": false,
 },         "attachments": [],
    "created": {     "physical_exam": "<p>dfvevofivuoiwue<\/p><p>iou<\/p><p>oi<\/p>",
          "secassessment_plan": 1430168606,
  "<p>oiuoiwfuweoifu<\/p><p>efweiofweiofuweoif<\/p><p><br><\/p>",
             "usec"reason_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"",
  
         "id": "18407370"     "attachments": [
  },         "postvisit": {
              "member_id": "1777818157e4f034-3a0c-4b1d-bc15-221bac1f0144",
              "class_idname": null,"Water_nature_canyon_cliffs_horseshoe_bend_rivers_2560x1600.jpg",
              "visit_idpath": "18407167files/2016/09/23/57e4f034-3a0c-4b1d-bc15-221bac1f0144.jpg",
              "modifiedsize": 16336276951692776,
              "createdext": 1633627695"jpg",
              "idtype": "615f2e2f-c240-4088-a28b-594b64457b11"0,
         },     "creator_id": "1096",
  "postvisit": {           "visit_idremark": "9709",null,
              "modifiedusing": 14733700721,
              "createdmodified": 1473368099, {
                "member_idsec": "1290"1474621492,
          "modifiedBy": "Second Provider 2",   "usec": 858000
      "draft": 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": "1096vclinic.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,
                "meetingSchedule": {0,
            "PharmacyNote": "",
      "enabled": true,       "InternalNote": "",
             "guest_invite_enabledPrescriberId": true"826",
            "LocationId": "DEMO-ACCOUNT",
      "adhoc_group_call": {           "PrescriptionDate": "2016-01-30T00:00:00",
             "disabledSignDate": true"0001-01-01T00:00:00",
            "Status": "Current",
      }      "PharmacyNcpdpId": "0001060",
         }   "RouteDetail": "e-Sent:Jan 30 2016  3:41PM Test 000 Pharmacy  }10.6MU<br />Sent",
        },         "prescriptionsBeforeVisitPartnerMedID": ["",
          {  "PrescriberName": "Dr. John Will, M.D."
      "ID": "97316",    },
        "DrugIDprescriptions": "69117"[],

           "NDC"root_visit": "00122206038",{
            "RxNormCodeid": "26065418407167",
            "Druggroup_chat_id": "One Tab Daily with Iron oral tablet" null,
            "Supplyparticipants": false, null
        },
        "Compoundid": false,
   "18407167",
        "Directionssubtype": "1 Milliliter(s) 1 to 2 times a day",
            "Qty": 60,
            "QtyQual": "Tablet",
            "Refills": 0,
            "DaysSupply": 0,3
    }
}

POST /visits/:id?version=2
Status
colour Yellow
title V3

Update an appointment

Parameters

Parameter	Type	Description
`slot_start`	`Integer`	(optional) The timestamp of the beginning of the appointment (in UNIX timestamp format)
`slot_end`	`Integer`	(optional) The timestamp of the ending of the appointment (in UNIX timestamp format)
`provider_id`	`String`	(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": {
            "SubstitutionAllowedFlag"member_id": 1567,
            "Schedule"provider_id": 0566,
   
        "PharmacyNoteaccount_code": "vclinic",

           "InternalNotecode": "615f2e2eabc46ad94e9b6457b11",
            "PrescriberIdstart": "826",
  1631628616,
         "LocationIdend": "DEMO-ACCOUNT"1631628916,
        ...
   "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
colour Yellow
title V3

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",
            "PharmacyNcpdpId"member_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,
            "id"actual_end": "184071671458024955",
            "groupspecialty_chat_id": null,
    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

{
  "data": {"created": 1458024914,
        "modified": 1458024914,
        "room_id": null,
        "_id": "1504",
        "member_idpayment": "508", {
              "provider_idduration": "509"15,
         "account_code     "amount": "fruitstreet00.00",
              "codedescription": "56e7b1d2b90c4d68953e3d02ac1f0144",FruitStreet Config Level One-time charge"
        "start": "1459973100"},
        "endintake": "1459974000",{
        "actual_start": 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_idcreated": null1458024708,
              "visit_id": "1504",
        "payment": {       "id": "56e7b104-ded0-4096-979b-395bac1f0144"
       "duration": 15},
              "amount"provider": "00.00",{
              "descriptionid": "FruitStreet Config Level One-time charge"509",
        },         "intake"first_name": {"Ligeng",
              "providerlast_name": "509Doctor",
              "reason_for_visitusername": "Test intake functionalitiesligeng+provider1@vsee.com",
              "resetvseeid": "truewellikodev+user509",
              "typeemail": "1ligeng+provider1@vsee.com",
              "modifiedactive": 1458024914true,
              "createdtitle": 1458024708"",
              "visit_idtos": "1504"false,
              "idphone": "56e7b104-ded0-4096-979b-395bac1f01446506506500"
        },
        "providermember": {
              "id": "509508",
              "first_name": "Ligeng",
              "last_name": "Doctor01",
              "username": "ligeng+provider1@vsee.com+1@vsee.com",
              "vseeid": "wellikodev+user508",
              "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
colour Yellow
title V3

Retrieve PDF visit summary

Code Block

breakoutMode	wide

curl  "member": {
              "id": "508",
        --location 'https://api-vclinic.vseepreview.com/vc/stable/api_v3/visits/1000000/exports/visit_summary' \
--header 'X-ApiToken: ******' \
--header 'X-AccountCode: vclinic' 

OK 200
{
     "first_namedata": "Ligeng",{
        "url": "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
`id`	`"id": "1504"`	Unique visit ID
`related_appointment_id`	`"related_appointment_id": "2504"`	When an appointment is started, a new visit object of type `walkin` is created. The relation to the original appointment ID is stored in this field.
`related_walkin_id`	`"related_walkin_id": "1504"`	When an appointment is started, a new visit object of type `walkin` is created. It’s ID is appended to the original appointment’s Visit object.
`adhoc_visit_id`	`"adhoc_visit_id": "3504"`
`invite_id`	`"invite_id": "4504"`	When a user is invited into an appointment call, the inviting appointment ID is stored here.
`root_visit`	`"root_visit": {` `"id": "18407167",` `group_chat_id": null,` `participants": null` `}`

Versions Compared

Old Version 6

New Version Current

Key

Intakes

POST /intakes
Status
colour Yellow
title V3

Custom parameters

POST /intakes/:id

GET /intakes/:id

POST /intakes/:id
Status
colour Yellow
title V3

GET /intakes/:id
Status
colour Yellow
title V3

Walkin Visits

POST /visits/add_walkin
Status
colour Yellow
title V3

Asynchronous Visits

POST /visits/

add_econsult
Status
colour Yellow
title V3

POST /visits/add_econsult

Appointment API

GET /availability
Status
colour Yellow
title V3

POST /visits

POST /visits
Status
colour Yellow
title V3

GET /visits

POST /visits/close
Status
colour Yellow
title V3

POST /visits/delete
Status
colour Yellow
title V3

GET /visits
Status
colour Yellow
title V3

GET /visits/:id
Status
colour Yellow
title V3
and Sample Visit Object

GET /visits/:id

POST /visits/:id?version=2
Status
colour Yellow
title V3

Add provider into a TDB visit

Remove provider from an appointment

GET /visits/current
Status
colour Yellow
title V3

GET /visits/current

Visit export

GET /visits/:id/exports/visit_summary
Status
colour Yellow
title V3

Understanding Visit object ID

Page Comparison

Versions Compared

Old Version 6

New Version Current

Key

Intakes

POST /intakes StatuscolourYellowtitleV3

Custom parameters

POST /intakes/:id

GET /intakes/:id

POST /intakes/:id StatuscolourYellowtitleV3

GET /intakes/:id StatuscolourYellowtitleV3

Walkin Visits

POST /visits/add_walkin StatuscolourYellowtitleV3

Asynchronous Visits

POST /visits/

add_econsult StatuscolourYellowtitleV3

POST /visits/add_econsult

Appointment API

GET /availability StatuscolourYellowtitleV3

POST /visits

POST /visits StatuscolourYellowtitleV3

GET /visits

POST /visits/close StatuscolourYellowtitleV3

POST /visits/delete StatuscolourYellowtitleV3

GET /visits StatuscolourYellowtitleV3

GET /visits/:id StatuscolourYellowtitleV3 and Sample Visit Object

GET /visits/:id

POST /visits/:id?version=2 StatuscolourYellowtitleV3

Add provider into a TDB visit

Remove provider from an appointment

GET /visits/current StatuscolourYellowtitleV3

GET /visits/current

Visit export

GET /visits/:id/exports/visit_summary StatuscolourYellowtitleV3

Understanding Visit object ID

POST /intakes
Status
colour Yellow
title V3

POST /intakes/:id
Status
colour Yellow
title V3

GET /intakes/:id
Status
colour Yellow
title V3

POST /visits/add_walkin
Status
colour Yellow
title V3

add_econsult
Status
colour Yellow
title V3

GET /availability
Status
colour Yellow
title V3

POST /visits
Status
colour Yellow
title V3

POST /visits/close
Status
colour Yellow
title V3

POST /visits/delete
Status
colour Yellow
title V3

GET /visits
Status
colour Yellow
title V3

GET /visits/:id
Status
colour Yellow
title V3
and Sample Visit Object

POST /visits/:id?version=2
Status
colour Yellow
title V3

GET /visits/current
Status
colour Yellow
title V3

GET /visits/:id/exports/visit_summary
Status
colour Yellow
title V3