Patient Side Integration

Owned by Anton Tolkachiov
Last updated: Nov 18, 2024
3 min read

Prerequisites: I already have a portal for patients with a way to sign up and login. I want to extend the functionality by letting them proceed to VSee Clinic without a need of additional sign up / login.

 

Use case #1: Log patient in and take them to VSee Clinic's patient dashboard

Try it yourself https://customportal.vseepreview.com/vc/clinic_demo/standard/use_case_1.php

Step 1: Obtain patient access token from POST /users/sso API call

The API will return you the token (data.token.token) look like this 66bcd0acff324e8a44992d9596b5d361.

Step 2: Redirect the user to your VSee Clinic page

You need to provide the user with a button or link to redirect to VSee Clinic. The URL will follow this pattern

{portal_base_url}auth?sso_token={token}&next={next_url}

e.g

https://vclinic.vseepreview.com/vc/next/auth?sso_token=66bcd0acff324e8a44992d9596b5d361&next=/u/clinic

This will log user in, then redirect user to

https://vclinic.vseepreview.com/vc/next/u/clinic

Additional options: - disable_navigation: 1 - disable all email communication

e.g

https://vclinic.vseepreview.com/vc/next/auth?sso_token=66bcd0acff324e8a44992d9596b5d361&next=/u/clinic&disable_navigation=1

Use case #2: Log Patient In using SSO Token and Start a Video Session

Try it yourself https://customportal.vseepreview.com/vc/clinic_demo/standard/use_case_2.php

Step 1: Obtain patient access token from POST /users/sso API call

The API will return you the token (data.token.token) look like this 66bcd0acff324e8a44992d9596b5d361. User's ID (data.id) will also be used as member_id later in Step 3.

Step 2: Create intake object via POST /intakes API

Use the SSO token from Step 1 in the X-ApiToken header field. You will get an intake ID in the response (data.id), e.g. 61165a8e-d8cc-47da-bd8e-597d64457b1f

Step 3: Create a walkin visit via POST /visits/add_walkin API

Use SSO token from Step 1 in the X-ApiToken header field and intake_id from Step 2. You will get a visit ID in the response (data.id, e.g. 67258

Step 4: Redirect the patient into the video call/chat page:

https://vclinic.vseepreview.com/vc/next/auth?sso_token=9fa6239291aa27d9528416cdcafbd6a5&next=/visits/start/67258

Use case #3: Log Patient In using SSO Token and Schedule An Appointment

Try it yourself https://customportal.vseepreview.com/vc/clinic_demo/standard/use_case_3.php

Step 1: Obtain patient access token from POST /users/sso API call

The API will return you the token (data.token.token) look like this 66bcd0acff324e8a44992d9596b5d361. User's ID (data.id will also be used as member_id later in Step 3.

Step 2: Create intake object via POST /intakes API

Use the SSO token from Step 1 in the X-ApiToken header field. You will get an intake ID in the response (data.id), e.g. 61165a8e-d8cc-47da-bd8e-597d64457b1f

Step 3: Create a scheduled appointment visit via POST /visits API

Use the SSO token from Step 1 in the X-ApiToken header field and intake_id from Step 2. You will get a visit ID in the response (data.id) e.g. 67258

If your clinic is configured to use one time appointment links then the visit object will also contain data.one_time_link_token, e.g. f7gybzjd9o

You can build a link using the format below and send it to the patient:

https://vclinic.vseepreview.com/vc/next/members/appointment/67258?token=f7gybzjd9o

Step 3b: Allow the user to proceed with scheduling manually

You can optionally allow the user to see the intake that you have created in step #2, confirm the data and proceed to the scheduling calendar in VSee Clinic interface.

You can do so by sending the user to the landing page and passing the intake_id parameterhttps://vclinic.vseepreview.com/vc/stable/u/clinic?intake_id=61165a8e-d8cc-47da-bd8e-597d64457b1f&action=appointment#schedule-appointment

Note: To successfully schedule a visit, providers' Availability (Slots) should be set up first. This can only be avoided if Admin API Token is used, that will override the schedule and force create an appointment even with an empty calendar.

Use case #4: Log Patient In using SSO Token and Create an eConsult (Asynchronous Visit)

Try it yourself https://customportal.vseepreview.com/vc/clinic_demo/standard/use_case_4.php

Step 1: Obtain patient access token from POST /users/sso API call

The API will return you the token (data.token.token) look like this 66bcd0acff324e8a44992d9596b5d361. User's ID (data.id will also be used as member_id later in Step 3.

Step 2: Create intake object via POST /intakes API

Use the SSO token from Step 1 in the X-ApiToken header field. You will get an intake ID in the response (data.id), e.g. 61165a8e-d8cc-47da-bd8e-597d64457b1f

Step 3: Create an asynchronous visit (econsult) via POST /add_econsult API

Use the SSO token from Step 1 in the X-ApiToken header field and intake_id from Step 2. You will get a visit ID in the response (data.id) e.g. 67258

As this is an asynchronous visit, all the providers assigned to this waiting room will see it and will need to click Accept it.

Use case #5: Guest invite link

Try it yourself https://customportal.vseepreview.com/vc/clinic_demo/standard/index.php

Apply Step 1 to 3 from Use case #2 or #3 to get a visit object.

Step 4: Retrieve visit object from GET /visits/:id

{ "id": "8888", "code": "63ac801a697049cbbf865d660a0300ce", ... }

Extract out code value and form the invite link like https://vclinic.vseepreview.com/vc/next/visits/join/63ac801a697049cbbf865d660a0300ce