API docs by Redocly

VIM Integration (0.1.0)

Download OpenAPI specification:

API for managing patient prospective Gaps

Service Token Retrieval

Obtaining a Bearer service token to make API requests

Authenticate and retrieve an access token

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

Authorizations:
apiKeyHeader
header Parameters
X-API-KEY
required
string
Request Body schema: application/json
required
clientId
required
string

Unique Allymar defined ID for the client

secret
required
string

Allymar provided client secret information

username
string

Name of the user using the system

organizationId
string

Allymar defined organization identifier

Responses

Request samples

Content type
application/json
{
  • "clientId": "string",
  • "secret": "string",
  • "username": "string",
  • "organizationId": "string"
}

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "tokenType": "Bearer",
  • "expiresIn": 3600
}

Patient Identification

Identify the patient based on personal identifiable information

Identify a patient in the system

Identifies a patient by their personal details and membership information.

Authorizations:
service
header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed. This is the token that is provided during the 'token' API request.

Content-Type
required
string
Default: application/json

Media type of the body of the request.

Request Body schema: application/json
required
firstName
required
string

Patient first name

lastName
required
string

Patient last name

dob
required
string <date>

Patient date of birth

memberId
string

Member insurance ID. Conditional field.

mrn
string

Patient EHR unique identifier. Conditional field.

zipCode
string

Patient Zip code. Conditional field.

insurer
string

Patient insurance company.

state
string

Patient state.

Responses

Request samples

Content type
application/json
{
  • "firstName": "John",
  • "lastName": "Doe",
  • "dob": "1990-07-19",
  • "memberId": "123445455",
  • "mrn": "a1b2c3d4",
  • "zipCode": "90210",
  • "insurer": "United Health Care",
  • "state": "Arizona"
}

Response samples

Content type
application/json
{
  • "isEligible": "string",
  • "patientId": "string"
}

Document Management

Manage and retrieve documents associated with patients.

Retrieve a document for a patient

Retrieves a document associated with a specific patient ID and document ID.

Authorizations:
service
query Parameters
patientId
required
string

Unique identifier for the patient.

documentId
required
string

Unique identifier for the document.

header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed.

Responses

Get Patient Diagnosis Gaps

Identify patient's Diagnosis Gaps

Identify patient's Diagnosis Gaps

Identify patient's Diagnosis Gaps - HCC and non-HCC Gaps are indicated by the same function

Authorizations:
service
header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed. This is the token that is provided during the 'token' API request.

Content-Type
required
string
Default: application/json

Media type of the body of the request.

Request Body schema: application/json
required
patientId
required
string
YoS
string

Responses

Request samples

Content type
application/json
{
  • "patientId": "d4fon0UkvtdfNBW1JfD5",
  • "YoS": "2023"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Patient Diagnosis Gaps Feedback

Get feedback from the EHR (PCP) about the Diagnosis Gap Feedback

Submit feedback on diagnostic gaps

Authorizations:
service
header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed. This is the token that is provided during the 'token' API request.

Content-Type
required
string
Default: application/json

Media type of the body of the request.

Request Body schema: application/json
required
patientId
required
string

The unique ID of the patient.

gapId
required
string

The unique ID of the gap selected by the user.

gapType
string
Enum: "Known" "Suspected"

Indication for a previously known diagnosis or a suspected diagnosis.

organizationName
required
string

The organization name associated with the user.

vimOrganizationKey
required
string

The unique organization ID as available in the Vim system.

userFirstName
string

The user's first name.

userLastName
string

The user's last name.

ehrUsername
required
string

The user's EHR username.

userNpi
string

The user's National Provider Identifier (NPI).

encounterId
string

The EHR encounter ID.

encounterDate
string <date>
gapSystem
required
string

The main gap system as displayed in the application.

gapCode
required
string

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

gapDescription
string

The description of the gap selected by the user.

selectedMedicalCodes
required
Array of strings

The ICD code(s) selected by the user.

actionDate
required
string <date>

The date of the reported action (EST).

actionType
required
string
Enum: "agree" "accept" "dismiss" "undo"

The reason of the reported action.

actionReason
required
string

The reason of the reported action.

actionAdditionalComments
string

The free text added by the user for the reported action. Available only for the "dismiss" actionType

Responses

Request samples

Content type
application/json
{
  • "patientId": "d4fon0UkvtdfNBW1JfD5",
  • "gapId": "Ae3uywUB0YwdwxxdA4M5",
  • "gapType": "Known",
  • "organizationName": "Test Medical",
  • "vimOrganizationKey": "string",
  • "userFirstName": "John",
  • "userLastName": "Doe",
  • "ehrUsername": "JDoe",
  • "userNpi": "1676809742",
  • "encounterId": "string",
  • "encounterDate": "2024-01-20",
  • "gapSystem": "HCC",
  • "gapCode": "59",
  • "gapDescription": "Major Depressive, Bipolar, and Paranoid Disorders",
  • "selectedMedicalCodes": [
    ],
  • "actionDate": "2024-02-07",
  • "actionType": "undo",
  • "actionReason": "NOT_PRESENT",
  • "actionAdditionalComments": "Patient did not display symptoms"
}

Response samples

Content type
application/json
{
  • "updateStatus": "SUCCESS",
  • "code": 1
}

Get Patient Care & Quality Gaps

Identify patient's Care & Quality Gaps

Retrieve care & quality gaps for a patient

Returns a list of care & quality gaps for a given patient based on their patientId.

Authorizations:
service
header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed. This is the token that is provided during the 'token' API request.

Content-Type
required
string
Default: application/json

Media type of the body of the request.

Request Body schema: application/json
required
patientId
required
string
YoS
string

Responses

Request samples

Content type
application/json
{
  • "patientId": "d4fon0UkvtdfNBW1JfD5",
  • "YoS": "2023"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Patient Care & Quality Gaps Feedback

Get feedback from the EHR (PCP) about the Care & Quality Gaps Feedback

Submit feedback on care & quality gaps

Submits feedback for a specific care gap based on the provided information.

Authorizations:
service
header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed. This is the token that is provided during the 'token' API request.

Content-Type
required
string
Default: application/json

Media type of the body of the request.

Request Body schema: application/json
required
patientId
required
string

The unique ID of the patientId.

gapId
required
string

The unique ID of the gap selected by the user.

gapType
string
Enum: "Known" "Suspected"

Indication for a previously known diagnosis or a suspected diagnosis.

organizationName
required
string

The organization name associated with the user.

vimOrganizationKey
required
string

The unique organization ID as available in the Vim system.

userFirstName
string

The user's first name.

userLastName
string

The user's last name.

ehrUsername
required
string

The user's EHR username.

userNpi
string

The user's National Provider Identifier (NPI).

encounterId
string

The EHR encounter ID.

encounterDate
required
string <date>

The EHR encounter date according to the organization's timezone.

gapSystem
string

The main gap system as displayed in the application.

gapCode
string

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

gapDescription
string

The description of the gap selected by the user.

selectedMedicalCodes
Array of strings

The ICD code(s) selected by the user.

actionDate
required
string <date>

The date of the reported action (EST).

actionType
required
string
Enum: "agree" "dismiss" "accept" "undo"

The reason of the reported action.

actionReason
required
string

The reason of the reported action.

actionAdditionalComments
string

The free text added by the user for the reported action. Available only for the "dismiss" actionType

Responses

Request samples

Content type
application/json
{
  • "patientId": "d4fon0UkvtdfNBW1JfD5",
  • "gapId": "Ae3uywUB0YwdwxxdA4M5",
  • "gapType": "Known",
  • "organizationName": "Test Medical",
  • "vimOrganizationKey": "string",
  • "userFirstName": "John",
  • "userLastName": "Doe",
  • "ehrUsername": "J_doe",
  • "userNpi": "1676809742",
  • "encounterId": "string",
  • "encounterDate": "2024-01-20",
  • "gapSystem": "HCC",
  • "gapCode": "59",
  • "gapDescription": "Major Depressive, Bipolar, and Paranoid Disorders",
  • "selectedMedicalCodes": [
    ],
  • "actionDate": "2024-02-07",
  • "actionType": "undo",
  • "actionReason": "NOT_PRESENT",
  • "actionAdditionalComments": "Patient did not display symptoms"
}

Response samples

Content type
application/json
{
  • "updateStatus": "SUCCESS",
  • "code": 1
}

Get Evidence and Annotations

Get All the evidences and annotations for the given DxGap Id

Get All the evidences and annotations for the given DxGap Id

Get All the evidences and annotations for the given DxGap Id

Authorizations:
service
header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed. This is the token that is provided during the 'token' API request.

Content-Type
required
string
Default: application/json

Media type of the body of the request.

Request Body schema: application/json
required
patientId
required
string

Id of the Patient

gapId
required
string

Id of the specific DxGap

chartId
string

Id of the specific Chart

evidenceId
string

Id of the specific Evidence

Responses

Request samples

Content type
application/json
{
  • "patientId": "string",
  • "gapId": "string",
  • "chartId": "string",
  • "evidenceId": "string"
}

Response samples

Content type
application/json
Example
[ ]