v1

latestOpenAPI 3.0.22026-07-2414318.0 KB
insurance_policies

List insurance policies

Retrieve a list of patient insurance policies. Can be filtered by parameters such as patient_id to view specific coverage details.

get/practices/{practice_id}/insurance-policies

Path parameters

practice_idstring required

Practice ID in which the requested resource exists

Query parameters

pageinteger

Page number of dataset

per_pageinteger

Custom page size of dataset

sortstring

String with a comma-separated list of parameters by which to sort the dataset. To specify a descending order, add a "-" character before the parameter. For example, ?sort=-created_at,id

Response

OK

clearinghouse_copaynumber nullable
company_idinteger
created_atstring date-time
external_idstring nullable
external_insurance_company_idstring

Provide this to automatically look up and assign the internal company_id

extraobject
idinteger
in_network_effective_location_idsinteger[]
is_archivedboolean
is_externalboolean
is_manually_verifiedboolean
is_photos_exist_in_ehrboolean
manual_copaynumber nullable
member_idstring nullable
namestring
notestring nullable
patient_idstring required

Patient ID from your integration who owns the resource

{"stackTrail":"components:schemas:InsurancePolicy:properties:photo_back_upload_id","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:InsurancePolicy:properties:photo_front_upload_id","oasType":"schema","type":"unknown"}
priority'primary' | 'secondary' | 'tertiary' | 'other'