US Healthcare Card

The Node.js SDK supports the Mindee V1 Healthcare Card API.

Product Specifications

Specification	Details
Endpoint Name	us_healthcare_cards
Recommended Version	v1.3
Supports Polling/Webhooks	✔️ Yes
Support Synchronous HTTP Calls	❌ No
Geography	🇺🇸 United States

Quick-Start

Using the sample below, we are going to illustrate how to extract the data that we want using the SDK.

Sample Code

const mindee = require("mindee");
// for TS or modules:
// import * as mindee from "mindee";

// Init a new client
const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });

// Load a file from disk
const inputSource = mindeeClient.docFromPath("/path/to/the/file.ext");

// Parse the file
const apiResponse = mindeeClient.enqueueAndParse(
  mindee.product.us.HealthcareCardV1,
  inputSource
);

// Handle the response Promise
apiResponse.then((resp) => {
  // print a string summary
  console.log(resp.document.toString());
});

Sample Output (rST)

########
Document
########
:Mindee ID: 5e917fc8-5c13-42b2-967f-954f4eed9959
:Filename: default_sample.jpg

Inference
#########
:Product: mindee/us_healthcare_cards v1.3
:Rotation applied: Yes

Prediction
==========
:Company Name: UnitedHealthcare
:Plan Name: Choice Plus
:Member Name: SUBSCRIBER SMITH
:Member ID: 123456789
:Issuer 80840:
:Dependents: SPOUSE SMITH
             CHILD1 SMITH
             CHILD2 SMITH
             CHILD3 SMITH
:Group Number: 98765
:Payer ID: 87726
:RX BIN: 610279
:RX ID:
:RX GRP: UHEALTH
:RX PCN: 9999
:Copays:
  +--------------+----------------------+
  | Service Fees | Service Name         |
  +==============+======================+
  | 20.00        | office_visit         |
  +--------------+----------------------+
  | 300.00       | emergency_room       |
  +--------------+----------------------+
  | 75.00        | urgent_care          |
  +--------------+----------------------+
  | 30.00        | specialist           |
  +--------------+----------------------+
:Enrollment Date:

Standard Fields

These fields are generic and used in several products.

Basic Field

Each prediction object contains a set of fields that inherit from the generic Field class.

A typical Field object will have the following attributes:

• value (number | string): corresponds to the field value. Can be undefined if no value was extracted.

• confidence (number): the confidence score of the field prediction.

• boundingBox ([Point, Point, Point, Point]): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.

• polygon (Point[]): contains the relative vertices coordinates (Point) of a polygon containing the field in the image.

• pageId (number): the ID of the page, always undefined when at document-level.

• reconstructed (boolean): indicates whether an object was reconstructed (not extracted as the API gave it).

A Point simply refers to an array of two numbers ([number, number]).

Aside from the previous attributes, all basic fields have access to a toString() method that can be used to print their value as a string.

Date Field

Aside from the basic Field attributes, the date field DateField also implements the following:

• dateObject (Date): an accessible representation of the value as a JavaScript object.

String Field

The text field StringField only has one constraint: its value is a string (or undefined).

Specific Fields

Fields which are specific to this product; they are not used in any other product.

Copays Field

Copayments for covered services.

A HealthcareCardV1Copay implements the following attributes:

• serviceFees (number): The price of the service.

• serviceName (string): The name of the service. Possible values include:

  • primary_care

  • emergency_room

  • urgent_care

  • specialist

  • office_visit

  • prescription

Attributes

The following fields are extracted for Healthcare Card V1:

Company Name

companyName (StringField): The name of the company that provides the healthcare plan.

console.log(result.document.inference.prediction.companyName.value);

Copays

copays (HealthcareCardV1Copay[]): Copayments for covered services.

for (const copaysElem of result.document.inference.prediction.copays) {
  console.log(copaysElem.value);
}

Dependents

dependents (StringField[]): The list of dependents covered by the healthcare plan.

for (const dependentsElem of result.document.inference.prediction.dependents) {
  console.log(dependentsElem.value);
}

Enrollment Date

enrollmentDate (DateField): The date when the member enrolled in the healthcare plan.

console.log(result.document.inference.prediction.enrollmentDate.value);

Group Number

groupNumber (StringField): The group number associated with the healthcare plan.

console.log(result.document.inference.prediction.groupNumber.value);

Issuer 80840

issuer80840 (StringField): The organization that issued the healthcare plan.

console.log(result.document.inference.prediction.issuer80840.value);

Member ID

memberId (StringField): The unique identifier for the member in the healthcare system.

console.log(result.document.inference.prediction.memberId.value);

Member Name

memberName (StringField): The name of the member covered by the healthcare plan.

console.log(result.document.inference.prediction.memberName.value);

Payer ID

payerId (StringField): The unique identifier for the payer in the healthcare system.

console.log(result.document.inference.prediction.payerId.value);

Plan Name

planName (StringField): The name of the healthcare plan.

console.log(result.document.inference.prediction.planName.value);

RX BIN

rxBin (StringField): The BIN number for prescription drug coverage.

console.log(result.document.inference.prediction.rxBin.value);

RX GRP

rxGrp (StringField): The group number for prescription drug coverage.

console.log(result.document.inference.prediction.rxGrp.value);

RX ID

rxId (StringField): The ID number for prescription drug coverage.

console.log(result.document.inference.prediction.rxId.value);

RX PCN

rxPcn (StringField): The PCN number for prescription drug coverage.

console.log(result.document.inference.prediction.rxPcn.value);