Sign in

v2

latestOpenAPI 3.0.02026-07-2632977728.5 KB
Clinical

Create clinical note list request. Use the UUID returned in the response to retrieve the batch of records. Results returned in order of ID.

post/api/clinical_notes_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.

patientinteger

Patient ID filter

Patient ID filter

officeinteger

Office ID filter

Office ID filter

doctorinteger

Doctor ID filter

Doctor ID filter

sincestring

Inclusive lower bound on clinical note updated/created time.

Inclusive lower bound on clinical note updated/created time.

date_rangestring

Inclusive bounded date range on appointment scheduled date

Inclusive bounded date range on appointment scheduled date

datestring

Filter on specific appointment scheduled date

Filter on specific appointment scheduled date

verboseboolean

When true includes yellow notes

When true includes yellow notes

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