US Healthcare Card

US Healthcare Card

The PHP 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

<?php

use Mindee\Client;
use Mindee\Product\Us\HealthcareCard\HealthcareCardV1;

// Init a new client
$mindeeClient = new Client("my-api-key");

// Load a file from disk
$inputSource = $mindeeClient->sourceFromPath("/path/to/the/file.ext");

// Parse the file asynchronously
$apiResponse = $mindeeClient->enqueueAndParse(HealthcareCardV1::class, $inputSource);

echo $apiResponse->document;

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:

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:

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

• confidence (float): 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 (integer): the ID of the page, always null when at document-level.

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

A Point simply refers to a list of two numbers ([float, float]).

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.

DateField

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

• dateObject (date): an accessible representation of the value as a php object. Can be null.

StringField

The text field StringField implements the following:

• value (string): represents the value of the field as a string.

• rawValue (string): the value of the string as it appears on the document.

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 (float): 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.

echo $result->document->inference->prediction->companyName->value;

Copays

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

foreach ($result->document->inference->prediction->copays as $copaysElem)
{
    echo $copaysElem->value;
}

Dependents

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

foreach ($result->document->inference->prediction->dependents as $dependentsElem)
{
    echo $dependentsElem->value;
}

Enrollment Date

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

echo $result->document->inference->prediction->enrollmentDate->value;

Group Number

groupNumber : The group number associated with the healthcare plan.

echo $result->document->inference->prediction->groupNumber->value;

Issuer 80840

issuer80840 : The organization that issued the healthcare plan.

echo $result->document->inference->prediction->issuer80840->value;

Member ID

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

echo $result->document->inference->prediction->memberId->value;

Member Name

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

echo $result->document->inference->prediction->memberName->value;

Payer ID

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

echo $result->document->inference->prediction->payerId->value;

Plan Name

planName : The name of the healthcare plan.

echo $result->document->inference->prediction->planName->value;

RX BIN

rxBin : The BIN number for prescription drug coverage.

echo $result->document->inference->prediction->rxBin->value;

RX GRP

rxGrp : The group number for prescription drug coverage.

echo $result->document->inference->prediction->rxGrp->value;

RX ID

rxId : The ID number for prescription drug coverage.

echo $result->document->inference->prediction->rxId->value;

RX PCN

rxPcn : The PCN number for prescription drug coverage.

echo $result->document->inference->prediction->rxPcn->value;