Insurance and Financial

Insurance and Financial

Purpose

The Insurance and Financial API handles information about patient insurance and financial transactions for hospitals. In a future version of the API, they will be standardized under the "financials" resource.

Endpoint List

• v2/healthplan/providers
• v2/healthplans
• v2/patients/copay
• v2/patients/copay/{consultationId}/paymentstatus
• v2.1/patients/{patientId}/payments/credits
• v2.1/patients/{patientId}/payments/debits

Recipes

Any endpoints that handle administrative functions are listed under the "Administrative Functions" page.

Handling Copays and Other Payments

1. Use POST v2/patients/copay to make a copay.
2. Use POST v2.1/patients/{patientId}/payments/debits to make a payment. This function can be used for any type of payment, not just copays.
3. Use GET v2/patients/copay/{consultationId}/paymentstatus to check on a copay's payment status.
4. Use GET v2.1/patients/{patientId}/payments/credits to see a patient's history of payments.

Using Health Plans

1. Use GET v2/healthplans to get all healthplans available to the current user.
2. Use GET v2/healthplan/providers to get all providers which handle the current user's health plans.