Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

...

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

...

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

...

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

...

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.

...