API docs by Redocly

Vim Data Source API Integration (0.1.0)

Download OpenAPI specification:Download

API for managing patient insights

Access Token Retrival

Obtaining a Bearer service token to make API requests

Authenticate and Retrieve an Access Token

This endpoint authenticates clients and provides access tokens for subsequent API calls.

Request Body schema: application/json

Authentication request body containing client credentials

client_id
required
string

Unique defined ID for the client

client_secret
required
string

Provided client secret information

grant_type
required
string
Default: "client_credentials"

OAuth 2.0 grant type, must be set to client_credentials

Responses

Request samples

Content type
application/json
{
  • "client_id": "example-client-id",
  • "client_secret": "example-client-secret",
  • "grant_type": "client_credentials"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "Bearer",
  • "expires_in": 3600
}

Patient Identification

Identify the patient based on personal information

Identify an Eligible Patient

Identifies a patient that is eligible to the service by their personal details information.

Authorizations:
bearerAuth
header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed

Content-Type
required
string
Default: application/json

Media type of the body of the request

Request Body schema: application/json

Patient identification details

first_name
required
string

Patient's first name

last_name
required
string

Patient's last name

dob
required
string <date>

Patient's date of birth in yyyy-mm-dd format

member_id
string

[CONDITIONAL] Patient's member ID - At least one of member_id, ehr_id, or zip_code is required

ehr_id
string

[CONDITIONAL] Patient's EHR ID - At least one of member_id, ehr_id, or zip_code is required

zip_code
string

[CONDITIONAL] Patient's ZIP code - At least one of member_id, ehr_id, or zip_code is required

insurer
string

Patient's insurance provider

state
string

Patient's state of residence

Responses

Request samples

Content type
application/json
{
  • "first_name": "John",
  • "last_name": "Doe",
  • "dob": "1990-07-19",
  • "member_id": "123445455",
  • "ehr_id": "a1b2c3d4",
  • "zip_code": "90210",
  • "insurer": "United Health Care",
  • "state": "FL"
}

Response samples

Content type
application/json
{
  • "is_eligible": true,
  • "patient_id": "d4fon0UkvtdfNBW1JfD5"
}

Get Patient Care Insights

Retrieving patient care insights such as diagnosis gaps and care insights

Fetching Patient Care Insights

Retrieving patient care insights for the patient identified in the previous step

Authorizations:
bearerAuth
header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed

Content-Type
required
string
Default: application/json

Media type of the body of the request

Request Body schema: application/json

Patient identifier

patient_id
required
string

Unique patient identifier

Responses

Request samples

Content type
application/json
{
  • "patient_id": "d4fon0UkvtdfNBW1JfD5"
}

Response samples

Content type
application/json
Example
[
  • {
    },
  • {
    },
  • {
    }
]

Patient Care Insights Feedback

Sending feedback about the care insights

Sending feedback about the insight

Authorizations:
bearerAuth
header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed

Content-Type
required
string
Default: application/json

Media type of the body of the request

Request Body schema: application/json

Feedback request details - schema varies based on data_type

data_type
required
string

Type of gaps data - diagnosis_gap or insight

patient_id
required
string

The unique ID of the patient

id
required
string

The unique ID of the gap selected by the user

required
object
required
object
object
object
system
string
Enum: "ICD-10" "HCC"

The main gap system as displayed in the application.

code
string

The original code provided by the customer, which corresponds to the selected code(s) by the user.

description
string

The description of the gap selected by the user.

type
string
Enum: "KNOWN" "SUSPECTED"

Indication for a previously known diagnosis or a suspected diagnosis.

Array of objects

The medical code(s) selected by the user with their descriptions.

Responses

Request samples

Content type
application/json
Example
{
  • "data_type": "diagnosis_gap",
  • "patient_id": "d4fon0UkvtdfNBW1JfD5",
  • "id": "Ae3uywUB0YwdwxxdA4M5",
  • "action": {
    },
  • "organization": {
    },
  • "system": "HCC",
  • "type": "KNOWN",
  • "status": "OPEN",
  • "medical_codes": [
    ]
}

Response samples

Content type
application/json
{
  • "update_status": "SUCCESS"
}