US Healthcare Card

US Healthcare Card

The Java 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.

Healthcare Card Sample

Sample Code

Sample Output (rST)

Field Types

Standard Fields

These fields are generic and used in several products.

BaseField

Each prediction object contains a set of fields that inherit from the generic BaseField class. A typical BaseField object will have the following attributes:

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

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

  • polygon (Polygon): contains the relative vertices coordinates (polygon extends List<Point>) of a polygon containing the field in the image.

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

A Point simply refers to a List of Double.

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

StringField

The text field StringField extends BaseField, but also implements:

  • value (String): corresponds to the field value.

  • rawValue (String): corresponds to the raw value as it appears on the document.

DateField

The date field DateField extends BaseField, but also implements:

  • value (LocalDate): an accessible representation of the value as a Java object. Can be null.

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 (Double): 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: The name of the company that provides the healthcare plan.

Copays

copays(List<HealthcareCardV1Copay>): Copayments for covered services.

Dependents

dependents: The list of dependents covered by the healthcare plan.

Enrollment Date

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

Group Number

groupNumber: The group number associated with the healthcare plan.

Issuer 80840

issuer80840: The organization that issued the healthcare plan.

Member ID

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

Member Name

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

Payer ID

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

Plan Name

planName: The name of the healthcare plan.

RX BIN

rxBin: The BIN number for prescription drug coverage.

RX GRP

rxGrp: The group number for prescription drug coverage.

RX ID

rxId: The ID number for prescription drug coverage.

RX PCN

rxPcn: The PCN number for prescription drug coverage.

Last updated

Was this helpful?