Healthcare Card V1

Sample Code:

class HealthcareCardV1(raw_prediction)

Healthcare Card API version 1 inference prediction.

static get_endpoint_info(klass)

Retrives the endpoint information for an Inference.

Should never retrieve info for CustomV1, as a custom endpoint should be created to use CustomV1.

Parameters:

klass (Type[Inference]) – product subclass to access endpoint information.

Return type:

Dict[str, str]

endpoint_name: Optional[str] = 'us_healthcare_cards'

Name of the endpoint.

endpoint_version: Optional[str] = '1'

Version of the endpoint.

is_rotation_applied: Optional[bool]

Whether the document has had any rotation applied to it.

page_id: Optional[int]

Optional page id for page-level predictions.

pages: List[Page[HealthcareCardV1Document]]

Page-level prediction(s).

prediction: HealthcareCardV1Document

Document-level prediction.

product: Product

Name and version of a given product, as sent back by the API.

class HealthcareCardV1Document(raw_prediction, page_id=None)

Healthcare Card API version 1.0 document data.

Parameters:
  • raw_prediction (Dict[str, Any]) –

  • page_id (Optional[int]) –

company_name: StringField

The name of the company that provides the healthcare plan.

copays: List[HealthcareCardV1Copay]

Is a fixed amount for a covered service.

dependents: List[StringField]

The list of dependents covered by the healthcare plan.

enrollment_date: DateField

The date when the member enrolled in the healthcare plan.

group_number: StringField

The group number associated with the healthcare plan.

issuer_80840: StringField

The organization that issued the healthcare plan.

member_id: StringField

The unique identifier for the member in the healthcare system.

member_name: StringField

The name of the member covered by the healthcare plan.

payer_id: StringField

The unique identifier for the payer in the healthcare system.

rx_bin: StringField

The BIN number for prescription drug coverage.

rx_grp: StringField

The group number for prescription drug coverage.

rx_pcn: StringField

The PCN number for prescription drug coverage.

class HealthcareCardV1Copay(raw_prediction, page_id=None)

Is a fixed amount for a covered service.

Parameters:
  • raw_prediction (Dict[str, Any]) –

  • page_id (Optional[int]) –

to_table_line()

Output in a format suitable for inclusion in an rST table.

Return type:

str

bounding_box: Optional[Quadrilateral]

A right rectangle containing the word in the document.

confidence: float

The confidence score.

page_n: int

The document page on which the information was found.

polygon: Polygon

A polygon containing the word in the document.

service_fees: Optional[float]

The price of service.

service_name: Optional[str]

The name of service of the copay.