Sign in

v2

latestOpenAPI 3.0.02026-07-2632977728.5 KB
Clinical

Create eligibility checks list request. Use the UUID returned in the response to retrieve the batch of records. Results returned in order of id or updated_at.

post/api/eligibility_checks_list

Query parameters

order_bystring

Order results by a specific field. Valid options include [id, updated_at]. Default: id.

page_sizeinteger

Number of results to return per page. Value between 1 and 1000.

pageinteger

Number of page to return. Value between 1 and max number of pages in result set.

sincestring

Inclusive lower bound on record updated/created time

patientinteger

Patient ID filter

appointment_date_rangestring

Inclusive bounded date range on appointment scheduled date

appointment_datestring

Filter on specific appointment scheduled date

query_date_rangestring

Inclusive bounded date range on eligibility check date

query_datestring

Filter on specific eligibility check date

service_typesstring

Filter for checks included within a comma-separated list of service type codes (STCs)

verboseboolean

When True includes full coverage details

Response

Created

statusstring

Status of the request. Upon creation this will be "In progress"

uuidstring

UUID of the batch of patients.

descriptionstring

Contains link to load the batch by UUID