Page Comparison

Table of Contents

minLevel	1
maxLevel	7

Intakes

POST /intakes
Status
colour Yellow
title V3

Create intake information.

...

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 intake information

...

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

Get the specific intake

Parameters

...

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": [
      {
        "_id": "57b4c65d-7ef8-461f-8951-43b1ac1f0144",
        "name": "575004c7-b350-421d-8542-4dcdac1f0144.png",
        "path": "files/2016/08/17/57b4c65d-7ef8-461f-8951-43b1ac1f0144.png",
        "size": 12859,
        "ext": "png",
        "type": 0,
        "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 visit

Parameters

...

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.vseepreview.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/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.

...

Code Block

curl --location --request POST 'https://api.vseepreview.com/vc/next/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",
       "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

...

Code Block
{ "data": [ { "start": 1470186000, "end": 1470186900, "providers": ["123", "345"] }, { "start": 1470186000, "end": 1470186900, "providers": ["123", "345"] } ] ] }

POST /visits
Status
colour Yellow
title V3

Create an appointment

Parameters

...

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,
        "account_code": "vclinic",
        "code": "615f2e2eabc46ad94e9b6457b11",
        "start": 1631628616,
        "end": 1631628916,
        "actual_start": 1631628211,
        "actual_end": null,
        "specialty_id": null,
        "state": null,
        "type": 2,
        "status": 30,
        "completed_by": null,
        "room_id": 1002387,
        "room_code": "vclinicroom",
        "modified": 1633630312,
        "created": 1633627694,
        "provider": {
            "id": "12456470",
            "email": "anton+providersa@vseelab.com",
            "subtype": "482",
            "vseeid": "anton+providersa@vseelab.com",
            "photo": null,
            "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",
            "phone": "5551231122"
        },
        "subType": 3,
        "more_provider_ids": null,
        "guest_emails": null,
        "guest_mobiles": null,
        "reminder_type": null,
        "reminder_time": null,
        "host_ids": [
            "12456470"
        ],
        "hosts": [
            {
                "username": "anton+providersa@vseelab.com",
                "email": "anton+providersa@vseelab.com",
                "phone": "",
                "timezone": "America/Los_Angeles",
                "vseeid": "anton+providersa@vseelab.com",
                "full_name": "Anton Provider",
                "title": "",
                "suffix": "",
                "id": "12456470",
                "photo_attachment_id": "",
                "role": "owner"
            }
        ],
        "creator": {
            "id": "15729940",
            "code": "60aed4242c90409099385cef64457b11",
            "vseeid": "d55d2f77ff3653891a587fdfa83207b4@vsee.com",
            "type": 160,
            "subtype": "",
            "first_name": null,
            "last_name": null,
            "account_code": "vclinic"
        },
        "pending_actions": [],
        "is_test": false,
        "meeting": {
            "recording_auto_start": false,
            "phone_numbers": {
                "US": [
                    "+1.650.758.0255"
                ]
            },
            "hosts": [
                "anton+providersa@vseelab.com",
                "chau+provider@vseelab.com"
            ],
            "expiry": 1633643316,
            "conference_pin": 838759,
            "meeting_id": "1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi"
        },
        "one_time_link_token": "l0vht6wkxj",
        "notify_list": [],
        "payment": {
            "duration": null,
            "amount": "25.00",
            "description": "Cloud Clinic Default One-time Charge Message",
            "id": "615cec5b-14c8-4493-b9ce-365764457b11"
        },
        "intake_id": "615f2de7-8ab8-48d3-80d8-53f564457b11",
        "related_walkin_id": "18407370",
        "call_logs": {
            "total_start": 1633628208,
            "total_end": 1633628268,
            "total_duration": 60,
            "waiting_time": 0,
            "provider_id_1": "anton+providersa@vseelab.com",
            "call_start_1": 1633628208,
            "call_duration_1": 60,
            "wait_time_1": 0,
            "patients": [
                "cmo+615f28cd70804d8994d62bd564457b11"
            ],
            "source": "v2",
            "source_ids": [
                "1633628104000_1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi",
                "1633628745000_1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi"
            ]
        },
        "incharge": false,
        "intake": {
            "provider_id": "12456470",
            "member_id": "17778181",
            "room_code": "vclinicroom",
            "location": "MI",
            "phone": "5551234415",
            "type": "2",
            "room": "vclinicroom",
            "modified": 1633627623,
            "created": 1633627623,
            "visit_id": "18407167",
            "attachments": "",
            "reason_for_visit": "",
            "consent": "true",
            "consultation": {
                "description": "test",
                "duration": 60,
                "charge": false,
                "group": false,
                "slots": 1,
                "amount": 0,
                "visible_to_patient": true,
                "id": "615cec5b-14c8-4493-b9ce-365764457b11",
                "currency": "USD"
            },
            "id": "615f2de7-8ab8-48d3-80d8-53f564457b11"
        },
        "related_walkin": {
            "start": 1633628101,
            "end": 1633631701,
            "status": 30,
            "id": "18407370"
        },
        "postvisit": {
            "member_id": "17778181",
            "class_id": null,
            "visit_id": "18407167",
            "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

...

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.

...

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.

...

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": "575",
        "code": "553ea41edfd041bd94475276ac1f0144",
        "first_name": "Keven2",
        "last_name": "Teodoro2",
        "username": "anton+1@vsee.com",
        "vseeid": "conciergedev+user575",
        "dob": "1983-02-02",
        "email": "anton+1@vsee.com",
        "gender": 2,
        "active": true,
        "tos": true,
        "phone": "7123456111",
        "subtype": ""
      }
    },
    "postvisit": {
      "visit_id": "9709",
      "modified": 1473370072,
      "created": 1473368099,
      "member_id": "1290",
      "modifiedBy": "Alexey Provider 2",
      "draft": false,
      "attachments": [],
      "physical_exam": "<p>dfvevofivuoiwue<\/p><p>iou<\/p><p>oi<\/p>",
      "assessment_plan": "<p>oiuoiwfuweoifu<\/p><p>efweiofweiofuweoif<\/p><p><br><\/p>",
      "reason_for_visit": "Allergic reaction",
      "reason_for_visit_other": "",
      "schema": "",
      "diagnosis": "Allergic reaction,initial encounter (T78.40XA),Asthma (J45.909)",
      "patient_instructions": "<p>Plan \/ Discharge...<br><\/p>",
      "disposition": "Referred to ED",
      "dea": "",
      "npi": ""
    }
}

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

Get detailed information for a certain appointment.

...

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": {
        "member_id": 17778181,
        "provider_id": 12456470,
        "account_code": "vclinic",
        "code": "615f2e2eabc46ad94e9b6457b11",
        "start": 1631628616,
        "end": 1631628916,
        "actual_start": 1631628211,
        "actual_end": null,
        "specialty_id": null,
        "state": null,
        "type": 2,
        "status": 30,
        "completed_by": null,
        "room_id": 1002387,
        "room_code": "vclinicroom",
        "modified": 1633630312,
        "created": 1633627694,
        "provider": {
            "id": "12456470",
            "email": "anton+providersa@vseelab.com",
            "subtype": "482",
            "vseeid": "anton+providersa@vseelab.com",
            "photo": null,
            "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",
            "phone": "5551231122"
        },
        "subType": 3,
        "more_provider_ids": null,
        "guest_emails": null,
        "guest_mobiles": null,
        "reminder_type": null,
        "reminder_time": null,
        "host_ids": [
            "12456470"
        ],
        "hosts": [
            {
                "username": "anton+providersa@vseelab.com",
                "email": "anton+providersa@vseelab.com",
                "phone": "",
                "timezone": "America/Los_Angeles",
                "vseeid": "anton+providersa@vseelab.com",
                "full_name": "Anton Provider",
                "title": "",
                "suffix": "",
                "id": "12456470",
                "photo_attachment_id": "",
                "role": "owner"
            }
        ],
        "creator": {
            "id": "15729940",
            "code": "60aed4242c90409099385cef64457b11",
            "vseeid": "d55d2f77ff3653891a587fdfa83207b4@vsee.com",
            "type": 160,
            "subtype": "",
            "first_name": null,
            "last_name": null,
            "account_code": "vclinic"
        },
        "pending_actions": [],
        "is_test": false,
        "meeting": {
            "recording_auto_start": false,
            "phone_numbers": {
                "US": [
                    "+1.650.758.0255"
                ]
            },
            "hosts": [
                "anton+providersa@vseelab.com",
                "chau+provider@vseelab.com"
            ],
            "expiry": 1633643316,
            "conference_pin": 838759,
            "meeting_id": "1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi"
        },
        "one_time_link_token": "l0vht6wkxj",
        "notify_list": [],
        "payment": {
            "duration": null,
            "amount": "25.00",
            "description": "Cloud Clinic Default One-time Charge Message",
            "id": "615cec5b-14c8-4493-b9ce-365764457b11"
        },
        "intake_id": "615f2de7-8ab8-48d3-80d8-53f564457b11",
        "related_walkin_id": "18407370",
        "call_logs": {
            "total_start": 1633628208,
            "total_end": 1633628268,
            "total_duration": 60,
            "waiting_time": 0,
            "provider_id_1": "anton+providersa@vseelab.com",
            "call_start_1": 1633628208,
            "call_duration_1": 60,
            "wait_time_1": 0,
            "patients": [
                "cmo+615f28cd70804d8994d62bd564457b11"
            ],
            "source": "v2",
            "source_ids": [
                "1633628104000_1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi",
                "1633628745000_1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi"
            ]
        },
        "incharge": false,
        "intake": {
            "provider_id": "12456470",
            "member_id": "17778181",
            "room_code": "vclinicroom",
            "location": "MI",
            "phone": "5551234415",
            "type": "2",
            "room": "vclinicroom",
            "modified": 1633627623,
            "created": 1633627623,
            "visit_id": "18407167",
            "attachments": "",
            "reason_for_visit": "",
            "consent": "true",
            "consultation": {
                "description": "test",
                "duration": 60,
                "charge": false,
                "group": false,
                "slots": 1,
                "amount": 0,
                "visible_to_patient": true,
                "id": "615cec5b-14c8-4493-b9ce-365764457b11",
                "currency": "USD"
            },
            "medical_profile": {
              "_id": "553ea41ef468747652d11034",
              "user_id": "575",
              "family_conditions": {
                "data": [
                  {
                    "condition": "Diabetes",
                    "relations": [
                      "Paternal grandparents"
                    ]
                  },
                  {
                    "condition": "Ulcer disease",
                    "relations": [
                      "Mother"
                    ]
                  }
                ],
                "modified": 1467623311,
                "modifiedBy": "Keven Teodoro"
              },
              "conditions": {
                "data": [
                  {
                    "condition": "Kidney disease"
                  },
                  {
                    "condition": "Kidney stones"
                  },
                  {
                    "condition": "Stroke"
                  }
                ],
                "modified": 1472059195,
                "modifiedBy": "Keven2 Teodoro2"
              },
              "social_history": {
                "data": [],
                "modified": 1472588123,
                "modifiedBy": "Keven2 Teodoro2",
                "modified_by": {
                  "id": "575",
                  "type": 200,
                  "subtype": "",
                  "first_name": "Keven2",
                  "last_name": "Teodoro2",
                  "photo": ""
                }
              },
              "health_habits": {
                "data": [],
                "modified": 1470128370,
                "modifiedBy": "Keven2 Teodoro2"
              },
              "surgeries": {
                "data": [
                  {
                    "procedure": "C-section"
                  },
                  {
                    "procedure": "Heart valve replaced"
                  }
                ],
                "modified": 1471769856,
                "modifiedBy": "Keven2 Teodoro2"
              },
              "medications": {
                "data": [],
                "modified": 1471769958,
                "modifiedBy": "Keven2 Teodoro2",
                "modified_by": {
                  "id": "575",
                  "type": "200",
                  "subtype": "",
                  "first_name": "Keven2",
                  "last_name": "Teodoro2"
                }
              },
              "allergies": {
                "data": [],
                "modified": 1471986123,
                "modifiedBy": "Keven2 Teodoro2",
                "modified_by": {
                  "id": "575",
                  "type": "200",
                  "subtype": "",
                  "first_name": "Keven2",
                  "last_name": "Teodoro2"
                }
              },
              "modified": {
                "sec": 1472059195,
                "usec": 806000
              },
              "created": {
                "sec": 1430168606,
                "usec": 596000
              }
            },
            "id": "615f2de7-8ab8-48d3-80d8-53f564457b11"
        },
        "related_walkin": {
            "start": 1633628101,
            "end": 1633631701,
            "status": 30,
            "id": "18407370"
        },
        "postvisit": {
            "member_id": "17778181",
            "class_id": null,
            "visit_id": "18407167",
            "modified": 1633627695,
            "created": 1633627695,
            "id": "615f2e2f-c240-4088-a28b-594b64457b11"
        },
        "postvisit": {
          "visit_id": "9709",
          "modified": 1473370072,
          "created": 1473368099,
          "member_id": "1290",
          "modifiedBy": "Second Provider 2",
          "draft": false,
          "attachments": [],
          "physical_exam": "<p>dfvevofivuoiwue<\/p><p>iou<\/p><p>oi<\/p>",
          "assessment_plan": "<p>oiuoiwfuweoifu<\/p><p>efweiofweiofuweoif<\/p><p><br><\/p>",
          "reason_for_visit": "Allergic reaction",
          "reason_for_visit_other": "",
          "schema": "",
          "diagnosis": "Allergic reaction,initial encounter (T78.40XA),Asthma (J45.909)",
          "patient_instructions": "<p>Plan \/ Discharge...<br><\/p>",
          "disposition": "Referred to ED",
          "dea": "",
          "npi": "",
          "attachments": [
            {
              "_id": "57e4f034-3a0c-4b1d-bc15-221bac1f0144",
              "name": "Water_nature_canyon_cliffs_horseshoe_bend_rivers_2560x1600.jpg",
              "path": "files/2016/09/23/57e4f034-3a0c-4b1d-bc15-221bac1f0144.jpg",
              "size": 1692776,
              "ext": "jpg",
              "type": 0,
              "creator_id": "1096",
              "remark": null,
              "using": 1,
              "modified": {
                "sec": 1474621492,
                "usec": 858000
              },
              "created": {
                "sec": 1474621492,
                "usec": 858000
              }
            }
          ]
        },
        "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
                    }
                }
            }
        },
        "prescriptionsBeforeVisit": [
          {
            "ID": "97316",
            "DrugID": "69117",
            "NDC": "00122206038",
            "RxNormCode": "260654",
            "Drug": "One Tab Daily with Iron oral tablet",
            "Supply": false,
            "Compound": false,
            "Directions": "1 Milliliter(s) 1 to 2 times a day",
            "Qty": 60,
            "QtyQual": "Tablet",
            "Refills": 0,
            "DaysSupply": 0,
            "SubstitutionAllowedFlag": 1,
            "Schedule": 0,
            "PharmacyNote": "",
            "InternalNote": "",
            "PrescriberId": "826",
            "LocationId": "DEMO-ACCOUNT",
            "PrescriptionDate": "2016-01-30T00:00:00",
            "SignDate": "0001-01-01T00:00:00",
            "Status": "Current",
            "PharmacyNcpdpId": "0001060",
            "RouteDetail": "e-Sent:Jan 30 2016  3:41PM Test 000 Pharmacy 10.6MU<br />Sent",
            "PartnerMedID": "",
            "PrescriberName": "Dr. John Will, M.D."
          },
        "prescriptions": [],

        "root_visit": {
            "id": "18407167",
            "group_chat_id": null,
            "participants": null
        },
        "id": "18407167",
        "subtype": 3
    }
}

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

Update an appointment

Parameters

...

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

...

Code Block

curl -X GET \
  -H "X-ApiToken: 6366a7018a39536a1ef4b63626f8e734" \
  https://api.vseepreview.com/vc/next/api_v3/visits/current.json

{
  "data": {
        "id": "1504",
        "member_id": "508",
        "provider_id": "509",
        "account_code": "fruitstreet",
        "code": "56e7b1d2b90c4d68953e3d02ac1f0144",
        "start": "1459973100",
        "end": "1459974000",
        "actual_start": null,
        "actual_end": "1458024955",
        "specialty_id": null,
        "state": null,
        "type": "2",
        "status": "40",
        "completed_by": "508",
        "created": 1458024914,
        "modified": 1458024914,
        "room_id": null,
        "_id": "1504",
        "payment": {
              "duration": 15,
              "amount": "00.00",
              "description": "FruitStreet Config Level One-time charge"
        },
        "intake": {
              "provider": "509",
              "reason_for_visit": "Test intake functionalities",
              "reset": "true",
              "type": "1",
              "modified": 1458024914,
              "created": 1458024708,
              "visit_id": "1504",
              "id": "56e7b104-ded0-4096-979b-395bac1f0144"
        },
        "provider": {
              "id": "509",
              "first_name": "Ligeng",
              "last_name": "Doctor",
              "username": "ligeng+provider1@vsee.com",
              "vseeid": "wellikodev+user509",
              "email": "ligeng+provider1@vsee.com",
              "active": true,
              "title": "",
              "tos": false,
              "phone": "6506506500"
        },
        "member": {
              "id": "508",
              "first_name": "Ligeng",
              "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"
        }
  }
}

Visit export

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

Retrieve PDF visit summary

Code Block

curl --location 'https://api.vsee.me/api_v3/visits/1000000/exports/visit_summary' \
--header 'X-ApiToken: ******' \
--header 'X-AccountCode: vclinic' 

OK 200
{
    "data": {
        "url": "https://clinic.vsee.me/visits/exports/d6880792f1fa01****"
    }
}

Understanding Visit object ID

...

Versions Compared

Old Version 19

New Version 20

Key

Intakes

POST /intakes
Status
colour Yellow
title V3

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

Appointment API

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

Visit export

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

Understanding Visit object ID

Page Comparison

Versions Compared

Old Version 19

New Version 20

Key

Intakes

POST /intakes StatuscolourYellowtitleV3

POST /intakes/:id StatuscolourYellowtitleV3

GET /intakes/:id StatuscolourYellowtitleV3

Walkin Visits

POST /visits/add_walkin StatuscolourYellowtitleV3

Asynchronous Visits

POST /visits/add_econsult StatuscolourYellowtitleV3

Appointment API

GET /availability StatuscolourYellowtitleV3

POST /visits StatuscolourYellowtitleV3

POST /visits/close StatuscolourYellowtitleV3

POST /visits/delete StatuscolourYellowtitleV3

GET /visits StatuscolourYellowtitleV3

GET /visits/:id StatuscolourYellowtitleV3 and Sample Visit Object

POST /visits/:id?version=2 StatuscolourYellowtitleV3

GET /visits/current StatuscolourYellowtitleV3

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

POST /visits/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