Patient Identification

The purpose of this endpoint is to uniquely identify a patient on the customer's side, based on information Vim extracts from the EHR. The Vim platform is able to extract various demographic information about the patient, such as:

• first & last name
• date of birth
• MRN (EHR identifier)
• member ID
• address (full, state, city, zip)

Vim can send any subset of these fields to the customer's endpoint, depending on how the customer is able to uniquely identify a patient. The output of this endpoint is a patient ID or token (for an eligible patient) that can be later used to retrieve gaps for said patient. Vim can also provide some metadata about the user preforming the action if needed, such as EHR username, Vim organization ID, etc...

Request Details

• Method: POST
• URL Pattern: https://<clientDomain>/api/identifyPatient

Input Example

{
    "firstName": "John",
    "lastName": "Doe",
    "dob": "10-10-1958",
    "memberId": "abc12345",
    "MRN": "123456",
    "address": {
      "fullAddress": "6044 NORTH KEATING, CHICAGO, IL, 60646",
      "city": "CHICAGO",
      "state": "IL",
      "zipCode": "60646"
    }
}

Output Example

Eligible member:

{
  "isEligible": true, 
  "patientToken": "123hj2g4kh43lkj34lrb4r4kj3n2j4lht437y5rn4j32k4htbnr3"
}

Non-eligible member:

{
  "isEligible": false,
  "patientToken": null
}

⭐ It's important to clarify - if the member is not eligible, the following getGaps call will not be invoked.