Versions Compared

Old Version 60

changes.mady.by.user An Nguyen

Saved on

compared with

New Version Current

changes.mady.by.user Anton Tolkachiov

Saved on

Key

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

...

Info

The following APIs can be called using patient’s token or Clinic Admin token

GET api_v3/users/

...

:user_id

...

/insurances
Status
colourYellow
titleV3

This returns a list of insurance cards associated with this user

Expand
titleResponse (200)
Code Block
languagejson
{
    "data": [
        {
            "card_type": "primary",
            "insurer_code": "(sandbox) HUMANA",
            "subscriber_number": "11000022",
            "group_number": "GN00022",
            "responsible_party": "self",
            "guarantor_first_name": "VSee",
            "guarantor_middle_name": "Edward",
            "guarantor_last_name": "Patient 11000022",
            "guarantor_dob": "1986-01-01",
            "guarantor_gender": 1,
            "guarantor_address": "54 Rainbow St",
            "guarantor_address_2": "#12-22",
            "guarantor_city": "Sunnyvale",
            "guarantor_zip": "10001",
            "guarantor_state": "CA",
            "consent": true
        },
        {
            "card_type": "secondary",
            "insurer_code": "(sandbox) CALIFORNIA MEDICAL",
            "subscriber_num": "11000023",
            "responsible_party": "child",
            "guarantor_first_name": "VSee",
            "guarantor_last_name": "Patient 11000023",
            "guarantor_middle_name": "Edward",
            "guarantor_dob": "1944-01-01",
            "guarantor_gender": 2,
            "guarantor_address": "52 Rainbow St",
            "guarantor_city": "Sunnyvale",
            "guarantor_zip": "10001",
            "guarantor_state": "CA",
            "consent": true
        }
    ],
    "version": "2.0"
}

POST api_v3/users/{user_id}/insurances/import
Status
colourYellow
titleV3

  • Payload should include array of up to 2 insurance detail, one is primary and the other is secondary

  • If insurance type already exists, it will be overwritten

...

Expand
titleResponse (200)
Code Block
languagejson
{
    "data": [
        {
            "card_type": "primary",
            "insurer_code": "(sandbox) HUMANA",
            "subscriber_number": "11000022",
            "group_number": "GN00022",
            "responsible_party": "self",
            "guarantor_first_name": "VSee",
            "guarantor_middle_name": "Edward",
            "guarantor_last_name": "Patient 11000022",
            "guarantor_dob": "1986-01-01",
            "guarantor_gender": 1,
            "guarantor_address": "54 Rainbow St",
            "guarantor_address_2": "#12-22",
            "guarantor_city": "Sunnyvale",
            "guarantor_zip": "10001",
            "guarantor_state": "CA",
            "consent": true
        },
        {
            "card_type": "secondary",
            "insurer_code": "(sandbox) CALIFORNIA MEDICAL",
            "subscriber_number": "11000023",
            "responsible_party": "child",
            "guarantor_first_name": "VSee",
            "guarantor_last_name": "Patient 11000023",
            "guarantor_middle_name": "Edward",
            "guarantor_dob": "1944-01-01",
            "guarantor_gender": 2,
            "guarantor_address": "52 Rainbow St",
            "guarantor_city": "Sunnyvale",
            "guarantor_zip": "10001",
            "guarantor_state": "CA",
            "consent": true
        }
    ],
    "version": "2.0"
}

POST api_v3/users/{user_id}/insurances/{primary|secondary}
Status
colourYellow
titleV3

Update primary or secondary insurance

...

Expand
titleResponse (200)
Code Block
languagejson
{
    "data": {
        "card_type": "primary",
        "insurer_code": "(sandbox) HUMANA",
        "subscriber_number": "11000022",
        "group_number": "GN00022",
        "responsible_party": "self",
        "guarantor_first_name": "VSee",
        "guarantor_middle_name": "Edward",
        "guarantor_last_name": "Patient 11000022",
        "guarantor_dob": "1986-01-01",
        "guarantor_gender": 1,
        "guarantor_address": "54 Rainbow St",
        "guarantor_address_2": "#12-22",
        "guarantor_city": "Sunnyvale",
        "guarantor_zip": "10001",
        "guarantor_state": "CA",
        "consent": true
    },
    "version": "2.0"
}

GET api_v3/users/{user_id}/insurances/{primary|secondary}
Status
colourYellow
titleV3

Retrieve primary or secondary insurance

Expand
titleResponse (200)
Code Block
languagejson
{
    "data": {
        "card_type": "primary",
        "insurer_code": "(sandbox) HUMANA",
        "subscriber_number": "11000022",
        "group_number": "GN00022",
        "responsible_party": "self",
        "guarantor_first_name": "VSee",
        "guarantor_middle_name": "Edward",
        "guarantor_last_name": "Patient 11000022",
        "guarantor_dob": "1986-01-01",
        "guarantor_gender": 1,
        "guarantor_address": "54 Rainbow St",
        "guarantor_address_2": "#12-22",
        "guarantor_city": "Sunnyvale",
        "guarantor_zip": "10001",
        "guarantor_state": "CA",
        "consent": true
    },
    "version": "2.0"
}

DELETE api_v3/users/{user_id}/insurances/{primary|secondary}
Status
colourYellow
titleV3

Expand
titleResponse (204)
Code Block
204 No Content

Eligibility check

POST api_v3/users/{user_id}/insurances/primary/eligibility/check
Status
colourYellow
titleV3

  • Check and return queue status and current eligibility status

...

Expand
titleResponse 2 (429 Too Many Requests)
Code Block
languagejson
{
    "code": 429,
    "message": "Started at Tue, 14 Nov 2023 12:05:00 +0700"
}

GET api_v3/users/{user_id}/insurances/primary/eligibility

  • Return queue status and current eligibility status

Status
colourYellow
titleV3

  • Return queue status and current eligibility status

Expand
titleResponse 1
Code Block
languagejson
{
    "data": {
        "job_id": "655300b4-2378-4ec7-98bf-34b50a7d6499",
        "status": "pending"
    }
}
Expand
titleResponse 2
Code Block
languagejson
{
    "data": {
        "status": "active"
    }
}

Claims Center

GET api_v3/reports/claims?from_date=2024-09-02&to_date=2024-09-05
Status
colourYellow
titleV3

  • Return list of visits with other data that is relevant for claim

Retrieve data list

GET api_v3/insurances/list/insurers

Sample request

Code Block
languagebash
curl --location 'https://api-vclinic.vseepreview.com/vc/stable/api_v3/insurances/list/insurers' \
--header 'X-AccountCode: vclinic'

Sample response

Expand
titleResponse
Code Block
languagejson
{
	"data": [
		{
			"id": "AAND",
			"text": "A AND I BENEFIT ADMINISTRATORS",
			"description": "A AND I BENEFIT ADMINISTRATORS"
		}, {
			"id": "AGADM",
			"text": "A G ADMINISTRATORS LLC",
			"description": "A G ADMINISTRATORS LLC"
		}, {
			"id": "AAGA",
			"text": "AAG AMERICAN ADMINISTRATIVE GRP",
			"description": "AAG AMERICAN ADMINISTRATIVE GRP"
		}, {
			"id": "AAGG",
			"text": "AAG GALLAGHER BENEFITS",
			"description": "AAG GALLAGHER BENEFITS"
		}, {
			"id": "AARP",
			"text": "AARP",
			"description": "AARP"
		}
	]
}

GET api_v3/insurances/list/billing_modifiers

Sample request

Code Block
languagebash
curl --location 'https://api-vclinic.vseepreview.com/vc/stable/api_v3/insurances/list/billing_modifiers' \
--header 'X-AccountCode: vclinic'

Sample response

Expand
titleResponse
Code Block
languagejson
{
	"data": [
		{
			"id": "20",
			"text": "20",
			"description": "20"
		}, {
			"id": "F8",
			"text": "F8",
			"description": "F8"
		}, {
			"id": "LC",
			"text": "LC",
			"description": "LC"
		}, {
			"id": "T5",
			"text": "T5",
			"description": "T5"
		}, {
			"id": "XP",
			"text": "XP",
			"description": "XP"
		}
	]
}

GET api_v3/insurances/list/dxs

Sample request

Code Block
languagebash
curl --location 'https://api-vclinic.vseepreview.com/vc/stable/api_v3/insurances/list/dxs' \
--header 'X-AccountCode: vclinic'

Sample response

Expand
Code Block
languagejson
{
	"data": [
		{
			"code": "I10",
			"description": "Essential (primary) hypertension",
			"advancedmd": {
				"code": "diag0010"
			}
		},
		{
			"code": "E11.9",
			"description": "Type 2 diabetes mellitus without complications",
			"advancedmd": {
				"code": "diag0021"
			}
		}
	]
}

GET api_v3/insurances/list/procedures

Sample request

Code Block
languagebash
curl --location 'https://api-vclinic.vseepreview.com/vc/stable/api_v3/insurances/list/procedures' \
--header 'X-AccountCode: vclinic'

Sample response

Expand
Code Block
languagejson
{
  "data": [
    {
      "id": "10001",
      "text": "INITIAL CONSULTATION - BASIC ASSESSMENT",
      "description": "Basic initial consultation to assess patient health status"
    },
    {
      "id": "10002",
      "text": "FOLLOW-UP VISIT - CONDITION MONITORING",
      "description": "Routine follow-up to monitor ongoing health conditions"
    },
    {
      "id": "10003",
      "text": "DIAGNOSTIC EVALUATION - LAB TEST REVIEW",
      "description": "Evaluation session for discussing lab test results with the patient"
    },
    {
      "id": "10004",
      "text": "TELEHEALTH CONSULT - MINOR ISSUES",
      "description": "Remote consultation for addressing minor health concerns"
    },
    {
      "id": "10005",
      "text": "EXTENDED CONSULTATION - TREATMENT PLANNING",
      "description": "Extended session for planning and discussing long-term treatment options"
    }
  ]
}