{"files":{"SKILL.md":"---\nname: openapi-schema\ndescription: \"openapi-schema API skill. Use when working with openapi-schema for api. Covers 323 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# openapi-schema\nAPI version: v4 - Hunt Valley\n\n## Auth\nOAuth2\n\n## Base URL\nhttps://app.drchrono.com\n\n## Setup\n1. Configure auth: OAuth2\n2. GET /api/day_sheet_charges -- retrieve daysheet charges report for a given date range\n3. POST /api/claim_billing_notes -- create first claim_billing_note\n\n## Endpoints\n323 endpoints across 1 group. See references/api-spec.lap for full details.\n\n### Api\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /api/day_sheet_charges | Retrieve daysheet charges report for a given date range |\n| POST | /api/claim_billing_notes | Create a new billing note |\n| GET | /api/claim_billing_notes | Retrieve or search billing notes |\n| POST | /api/signed_consent_forms | signed_consent_forms Create |\n| PATCH | /api/signed_consent_forms | signed_consent_forms Update |\n| GET | /api/signed_consent_forms | signed_consent_forms Get |\n| POST | /api/custom_appointment_fields | Create custom appointment fields |\n| GET | /api/custom_appointment_fields | Retrieve or search custom appointment fields |\n| PUT | /api/lab_orders/{id} | Update an existing lab order |\n| PATCH | /api/lab_orders/{id} | Update an existing lab order |\n| GET | /api/lab_orders/{id} | Retrieve an existing lab order |\n| DELETE | /api/lab_orders/{id} | Delete an existing lab order |\n| POST | /api/clinical_notes_list | Create clinical note list request.  Use the UUID returned in the response to retrieve the batch of records. Results returned in order of ID. |\n| GET | /api/clinical_notes_list | Retrieve or search clinical notes in batches. Results returned in order of ID. |\n| GET | /api/custom_vitals/{id} | Retrieve an existing custom vital type |\n| PUT | /api/sublabs/{id} | Update an existing sub vendor |\n| PATCH | /api/sublabs/{id} | Update an existing sub vendor |\n| GET | /api/sublabs/{id} | Retrieve an existing sub vendor |\n| DELETE | /api/sublabs/{id} | Delete an existing sub vendor |\n| GET | /api/patients/{id}/qrda1 | Retrieve patient QRDA1 |\n| POST | /api/problems | Create patient problems |\n| GET | /api/problems | Retrieve or search patient problems |\n| GET | /api/staff |  |\n| PUT | /api/patient_messages/{id} |  |\n| PATCH | /api/patient_messages/{id} |  |\n| GET | /api/patient_messages/{id} |  |\n| GET | /api/eligibility_checks | Retrieve or search past eligibility checks for patient |\n| PUT | /api/doctor_work_schedule/{id} | Update an existing doctor's entire work schedule |\n| PATCH | /api/doctor_work_schedule/{id} | Update an existing doctor's work schedule |\n| GET | /api/doctor_work_schedule/{id} | Retrieve a work schedule for the doctor (beta) |\n| POST | /api/medications | Create patient medications |\n| GET | /api/medications | Retrieve or search patient medications |\n| POST | /api/custom_demographics | Create custom demographics fields |\n| GET | /api/custom_demographics | Retrieve or search custom demographics fields |\n| POST | /api/appointments_list |  |\n| GET | /api/appointments_list |  |\n| POST | /api/appointment_profiles | Create appointment profiles for a doctor's calendar |\n| GET | /api/appointment_profiles | Retrieve or search appointment profiles for a doctor's calendar |\n| POST | /api/patient_communications | Create patient communication for CQM |\n| GET | /api/patient_communications | Retrieve or search patient communications for CQM |\n| GET | /api/patient_authorizations | Retrieve or search patient authorizations |\n| PUT | /api/appointment_profiles/{id} | Update an existing appointment profile |\n| PATCH | /api/appointment_profiles/{id} | Update an existing appointment profile |\n| GET | /api/appointment_profiles/{id} | Retrieve an existing appointment profile |\n| DELETE | /api/appointment_profiles/{id} | Delete an existing appointment profile |\n| POST | /api/messages | Create messages in doctor's message center |\n| GET | /api/messages | Retrieve or search messages in doctor's message center |\n| PUT | /api/clinical_note_field_values/{id} | Update an existing clinical note field value |\n| PATCH | /api/clinical_note_field_values/{id} | Update an existing clinical note field value |\n| GET | /api/clinical_note_field_values/{id} | Retrieve an existing clinical note field value |\n| POST | /api/task_categories | Create a task category |\n| GET | /api/task_categories | Retrieve or search task categories |\n| GET | /api/fee_schedules_v2 |  |\n| GET | /api/custom_insurance_plan_names/{id} | Retrieve an existing custom insurance plan name |\n| GET | /api/care_team_members |  |\n| POST | /api/line_items_list | Create a billing line items list request |\n| GET | /api/line_items_list | Retrieve the list of billing line items |\n| POST | /api/consent_forms/{id}/unapply_from_appointment | Unassign (unapply) a consent form from appointment |\n| POST | /api/consent_forms/{id}/apply_to_appointment | Assign (apply) a consent form to appointment |\n| POST | /api/consent_forms | Create a patient consent form |\n| GET | /api/consent_forms | Retrieve or search patient consent forms |\n| PUT | /api/reminder_profiles/{id} | Update an existing reminder profile |\n| PATCH | /api/reminder_profiles/{id} | Update an existing reminder profile |\n| GET | /api/reminder_profiles/{id} | Retrieve an existing reminder profile |\n| DELETE | /api/reminder_profiles/{id} | Delete an existing reminder profile |\n| GET | /api/day_sheet_patient_payments | Retrieve daysheet cash report for a given date range |\n| POST | /api/offices/{id}/add_exam_room | Add an exam room to the office |\n| GET | /api/eligibility_checks/{id} | Retrieve an existing past eligibility check |\n| POST | /api/patients_list | Submit patient list request.  Use the UUID returned in the response to retrieve the batch of patients. |\n| GET | /api/patients_list | Retrieve or search patients in batches. This resource returns identical data to `GET /api/patients` but uses an asynchronous batch-based approach to data delivery. This is an efficient choice for large historical record loading use cases. Retrieve the results/status of a previously created patient_list request using the UUID returned in the response. Results are ordered by patient ID number. |\n| POST | /api/patient_interventions | Create patient intervention for CQM |\n| GET | /api/patient_interventions | Retrieve or search patient interventions for CQM |\n| POST | /api/patient_messages |  |\n| GET | /api/patient_messages |  |\n| PUT | /api/patient_physical_exams/{id} | Update an existing patient physical exam for CQM |\n| PATCH | /api/patient_physical_exams/{id} | Update an existing patient physical exam for CQM |\n| GET | /api/patient_physical_exams/{id} | Retrieve an existing patient physical exam for CQM |\n| POST | /api/clinical_note_field_values | Create clinical note field value |\n| GET | /api/clinical_note_field_values | Retrieve or search clinical note field values |\n| GET | /api/inventory_vaccines/{id} | Retrieve an existing vaccine inventory |\n| POST | /api/patients | Create patient |\n| GET | /api/patients | Retrieve or search patients |\n| GET | /api/implantable_devices/{id} | Retrieve an existing implantable device |\n| PUT | /api/patient_communications/{id} | Update an existing patient communication for CQM |\n| PATCH | /api/patient_communications/{id} | Update an existing patient communication for CQM |\n| GET | /api/patient_communications/{id} | Retrieve an existing patient communication for CQM |\n| GET | /api/offices | Retrieve or search offices |\n| GET | /api/prescription_messages/{id} | Retrieve an existing prescription message |\n| GET | /api/implantable_devices | Retrieve or search implantable devices |\n| POST | /api/patient_risk_assessments |  |\n| GET | /api/patient_risk_assessments |  |\n| PUT | /api/task_statuses/{id} | Update an existing task status |\n| PATCH | /api/task_statuses/{id} | Update an existing task status |\n| GET | /api/task_statuses/{id} | Retrieve an existing task status |\n| POST | /api/patients_summary |  |\n| GET | /api/patients_summary |  |\n| PUT | /api/documents/{id} | Update an existing patient document |\n| PATCH | /api/documents/{id} | Update an existing patient document |\n| GET | /api/documents/{id} | Retrieve an existing patient document |\n| DELETE | /api/documents/{id} | Delete an existing appointment template |\n| GET | /api/office_work_schedule | Get the work schedule for the authed doctor's primary office (beta) |\n| POST | /api/patients/{id}/onpatient_access | Send new onpatient invite to patient |\n| GET | /api/patients/{id}/onpatient_access | Retrieve or search existing onpatient access invites |\n| DELETE | /api/patients/{id}/onpatient_access | Revoke sent onpatient invites |\n| POST | /api/comm_logs | Create communication (phone call) logs |\n| GET | /api/comm_logs | Retrieve or search communicatioin (phone call) logs |\n| PUT | /api/lab_results/{id} | Update an existing lab result |\n| PATCH | /api/lab_results/{id} | Update an existing lab result |\n| GET | /api/lab_results/{id} | Retrieve an existing lab result |\n| DELETE | /api/lab_results/{id} | Delete an existing lab result |\n| PUT | /api/medications/{id} | Update an existing patient medications |\n| PATCH | /api/medications/{id} | Update an existing patient medications |\n| GET | /api/medications/{id} | Retrieve an existing patient medications |\n| GET | /api/day_sheet_credits | Retrieve daysheet credits/adjustments report for a given date range |\n| POST | /api/task_templates | Create a task template |\n| GET | /api/task_templates | Retrieve or search task templates |\n| POST | /api/transactions_list | Create transactions list request.  Use the UUID returned in the response to retrieve the batch of records. Results returned in order of id or updated_at. |\n| GET | /api/transactions_list | Retrieve or search transactions in batches. Results returned in order of ID or updated_at. |\n| PATCH | /api/medications/{id}/append_to_pharmacy_note | Append a message to the \"pharmacy_note\" section of the prescription, in a new paragraph |\n| PUT | /api/office_work_schedule/{id} | Update an existing office's entire work schedule |\n| PATCH | /api/office_work_schedule/{id} | Update an existing office's work schedule |\n| GET | /api/office_work_schedule/{id} | Retrieve a work schedule (beta) |\n| PUT | /api/patient_vaccine_records/{id} | Update an existing patient vaccine records |\n| PATCH | /api/patient_vaccine_records/{id} | Update an existing patient vaccine records |\n| GET | /api/patient_vaccine_records/{id} | Retrieve an existing patient vaccine records |\n| PUT | /api/patient_flag_types/{id} | Update an existing patient flag type |\n| PATCH | /api/patient_flag_types/{id} | Update an existing patient flag type |\n| GET | /api/patient_flag_types/{id} | Retrieve an existing patient flag type |\n| GET | /api/inventory_categories/{id} | Retrieve an existing inventory category |\n| PATCH | /api/clinical_note_field_types/{id} | Update the `freedraw_image_size` of an existing clinical note FreeDraw Field |\n| GET | /api/clinical_note_field_types/{id} | Retrieve an existing clinial note field type |\n| PUT | /api/tasks/{id} | Update an existing task |\n| PATCH | /api/tasks/{id} | Update an existing task |\n| GET | /api/tasks/{id} | Retrieve an existing task |\n| GET | /api/doctor_work_schedule | Get the work schedule for the authed doctor's primary office (beta) |\n| GET | /api/doctor_options | Retrieve or search doctor options within practice group |\n| GET | /api/fee_schedules |  |\n| PUT | /api/patient_risk_assessments/{id} |  |\n| PATCH | /api/patient_risk_assessments/{id} |  |\n| GET | /api/patient_risk_assessments/{id} |  |\n| GET | /api/inventory_categories | Retrieve or search inventory categories |\n| PUT | /api/lab_documents/{id} | Update an existing lab order document |\n| PATCH | /api/lab_documents/{id} | Update an existing lab order document |\n| GET | /api/lab_documents/{id} | Retrieve an existing appointment template |\n| DELETE | /api/lab_documents/{id} | Delete an existing lab order document |\n| PUT | /api/appointment_templates/{id} | Update an existing appointment template |\n| PATCH | /api/appointment_templates/{id} | Update an existing appointment template |\n| GET | /api/appointment_templates/{id} | Retrieve an existing appointment template |\n| DELETE | /api/appointment_templates/{id} | Delete an existing appointment template |\n| PUT | /api/patient_interventions/{id} | Update an existing patient intervention for CQM |\n| PATCH | /api/patient_interventions/{id} | Update an existing patient intervention for CQM |\n| GET | /api/patient_interventions/{id} | Retrieve an existing patient intervention for CQM |\n| POST | /api/task_statuses | Create a task status |\n| GET | /api/task_statuses | Retrieve or search task statuses |\n| PUT | /api/allergies/{id} | Update an existing patient allergy |\n| PATCH | /api/allergies/{id} | Update an existing patient allergy |\n| GET | /api/allergies/{id} | Retrieve an existing patient allergy |\n| GET | /api/patients/{id}/ccda | Retrieve patient CCDA |\n| GET | /api/patient_payments/{id} | Retrieve an existing patient payment |\n| GET | /api/lab_orders_summary |  |\n| POST | /api/patient_payments | Create patient payment |\n| GET | /api/patient_payments | Retrieve or search patient payments |\n| POST | /api/clinical_note_field_values_list | Create clinical note field value list request.  Use the UUID returned in the response to retrieve the batch of records. Results returned in order of ID. |\n| GET | /api/clinical_note_field_values_list | Retrieve or search clinical note values (soap notes) in batches. Results returned in order of ID or by updated_at. |\n| GET | /api/care_plans/{id} | Retrieve an existing care plan |\n| GET | /api/billing_profiles | Retrieve or search billing profiles |\n| GET | /api/billing_profiles/{id} | Retrieve an existing billing profiles |\n| GET | /api/availability | Retrieve availability slots for the given date and office, doctor, or exam room. |\n| PUT | /api/task_templates/{id} | Update an existing task template |\n| PATCH | /api/task_templates/{id} | Update an existing task template |\n| GET | /api/task_templates/{id} | Retrieve an existing task template |\n| GET | /api/fee_schedules/{id} |  |\n| PUT | /api/appointments/{id} | Update an existing appointment or break |\n| PATCH | /api/appointments/{id} | Update an existing appointment or break |\n| GET | /api/appointments/{id} | Retrieve an existing appointment or break |\n| DELETE | /api/appointments/{id} | Delete an existing appointment or break |\n| POST | /api/telehealth_appointments |  |\n| GET | /api/telehealth_appointments |  |\n| GET | /api/care_plans | Retrieve or search care plans |\n| POST | /api/patient_physical_exams | Create patient physical exam for CQM |\n| GET | /api/patient_physical_exams | Retrieve or search patient physical exams for CQM |\n| GET | /api/line_item_deletions | Retrieve or search billing line item deletions. When a billing line item is deleted, a record of its original ID and the appointment it was attached to will be logged and is accessible from this resource. |\n| GET | /api/signed_consent_forms/{id} | signed_consent_forms Read |\n| GET | /api/clinical_note_templates/{id} | Retrieve an existing clinical note tempalte |\n| GET | /api/transactions | Retrieve or search insurance transactions associated with billing line items |\n| POST | /api/lab_results | Create lab results. An example lab workflow is as following: |\n| GET | /api/lab_results | Retrieve or search lab results |\n| GET | /api/custom_insurance_plan_names | Retrieve or search custom insurance plan names |\n| PUT | /api/problems/{id} | Update an existing patient problems |\n| PATCH | /api/problems/{id} | Update an existing patient problems |\n| GET | /api/problems/{id} | Retrieve an existing patient problems |\n| POST | /api/amendments | Create patient amendments to a patient's clinical records |\n| GET | /api/amendments | Retrieve or search patient amendments. You can only interact with amendments created by your API application |\n| POST | /api/lab_orders | Create lab orders. An example lab workflow is as following: |\n| GET | /api/lab_orders | Retrieve or search lab orders |\n| PATCH | /api/message_threads/{id} | Partially update a message thread. |\n| GET | /api/message_threads/{id} | Retrieve a single message thread by ID (beta) |\n| GET | /api/doctors/{id} | Retrieve an existing doctor |\n| POST | /api/patient_flag_types | Create patient flag types |\n| GET | /api/patient_flag_types | Retrieve or search patient flag types |\n| GET | /api/recurring_appointment_instances | List all instances (materialized and virtual) within a recurring |\n| GET | /api/day_sheet_totals | Retrieve daysheet totals report for a given date range |\n| PUT | /api/custom_appointment_fields/{id} | Update an existing custom appointment field |\n| PATCH | /api/custom_appointment_fields/{id} | Update an existing custom appointment field |\n| GET | /api/custom_appointment_fields/{id} | Retrieve an existing custom appointment field |\n| POST | /api/eobs | Create EOB object |\n| GET | /api/eobs | Retrieve or search EOB objects |\n| GET | /api/users/{id} | Retrieve an existing user, `/api/users/current` can be used to identify logged in user, it will redirect to `/api/users/{current_user_id}` |\n| GET | /api/insurances |  |\n| POST | /api/telehealth_appointment_history |  |\n| GET | /api/telehealth_appointment_history |  |\n| POST | /api/task_notes | Create a task note |\n| GET | /api/task_notes | Retrieve or search task notes |\n| POST | /api/tasks | Create a task |\n| GET | /api/tasks | Retrieve or search tasks |\n| PUT | /api/patients_summary/{id} |  |\n| PATCH | /api/patients_summary/{id} |  |\n| GET | /api/patients_summary/{id} |  |\n| DELETE | /api/patients_summary/{id} |  |\n| POST | /api/lab_documents | Create lab order documents. An example lab workflow is as following: |\n| GET | /api/lab_documents | Retrieve or search lab order documents |\n| PUT | /api/consent_forms/{id} | Update an existing patient consent form |\n| PATCH | /api/consent_forms/{id} | Update an existing patient consent form |\n| GET | /api/consent_forms/{id} | Retrieve an existing patient consent form |\n| PUT | /api/lab_tests/{id} | Update an existing lab test |\n| PATCH | /api/lab_tests/{id} | Update an existing lab test |\n| GET | /api/lab_tests/{id} | Retrieve an existing lab test |\n| DELETE | /api/lab_tests/{id} | Delete an existing lab test |\n| POST | /api/prescription_messages_list | Create prescription messages list request.  Use the UUID returned in the response to retrieve the batch of records. Results returned in order of id or updated_at. |\n| GET | /api/prescription_messages_list | Retrieve or search prescription messages in batches. Results returned in order of ID or updated_at. |\n| PUT | /api/patients/{id} | Update an existing patient |\n| PATCH | /api/patients/{id} | Update an existing patient |\n| GET | /api/patients/{id} | Retrieve an existing patient |\n| DELETE | /api/patients/{id} | Delete an existing patient |\n| GET | /api/patients/{id}/ccda_async | Retrieve patient CCDA async. |\n| GET | /api/custom_vitals | Retrieve or search custom vital types |\n| GET | /api/user_groups | Retrieve or search user groups |\n| GET | /api/care_team_members/{id} |  |\n| GET | /api/claim_billing_notes/{id} | Retrieve an existing billing note |\n| POST | /api/inventory_vaccines | Create vaccine inventory |\n| GET | /api/inventory_vaccines | Retrieve or search vaccine inventories |\n| GET | /api/transactions/{id} | Retrieve an existing insurance transaction |\n| GET | /api/procedures |  |\n| PUT | /api/patient_lab_results/{id} |  |\n| PATCH | /api/patient_lab_results/{id} |  |\n| GET | /api/patient_lab_results/{id} |  |\n| DELETE | /api/patient_lab_results/{id} |  |\n| PUT | /api/amendments/{id} | Update an existing patient amendment, you can only interact with amendments created by your API application |\n| PATCH | /api/amendments/{id} | Update an existing patient amendment, you can only interact with amendments created by your API application |\n| GET | /api/amendments/{id} | Retrieve an existing patient amendment, you can only interact with amendments created by your API application |\n| DELETE | /api/amendments/{id} | Delete an existing patient amendment, you can only interact with amendments created by your API application |\n| POST | /api/lab_tests | Create lab tests. An example lab workflow is as following: |\n| GET | /api/lab_tests | Retrieve or search lab tests |\n| PUT | /api/appointments_list/{id} |  |\n| PATCH | /api/appointments_list/{id} |  |\n| GET | /api/appointments_list/{id} |  |\n| DELETE | /api/appointments_list/{id} |  |\n| POST | /api/patient_lab_results |  |\n| GET | /api/patient_lab_results |  |\n| PUT | /api/task_categories/{id} | Update an existing task category |\n| PATCH | /api/task_categories/{id} | Update an existing task category |\n| GET | /api/task_categories/{id} | Retrieve an existing task category |\n| GET | /api/fee_schedules_v2/{id} |  |\n| GET | /api/insurances/{id} |  |\n| GET | /api/clinical_notes |  |\n| POST | /api/eligibility_checks_list | 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. |\n| GET | /api/eligibility_checks_list | Retrieve or search eligibility checks in batches. Results returned in order of ID or updated_at. |\n| GET | /api/telehealth_appointment_history/{id} |  |\n| GET | /api/clinical_notes/{id} |  |\n| GET | /api/clinical_note_field_types | Retrieve or search clinical note field types |\n| POST | /api/documents | Create documents |\n| GET | /api/documents | Retrieve or search documents |\n| GET | /api/staff/{id} |  |\n| GET | /api/users | Retrieve or search users, `/api/users/current` can be used to identify logged in user, it will redirect to `/api/users/{current_user_id}` |\n| GET | /api/lab_orders_summary/{id} |  |\n| GET | /api/audit_log | Retrieve or search audit logs. |\n| PUT | /api/task_notes/{id} | Update an existing task note |\n| PATCH | /api/task_notes/{id} | Update an existing task note |\n| GET | /api/task_notes/{id} | Retrieve an existing task note |\n| PUT | /api/custom_demographics/{id} | Update an existing custom demographics field |\n| PATCH | /api/custom_demographics/{id} | Update an existing custom demographics field |\n| GET | /api/custom_demographics/{id} | Retrieve an existing custom demographics field |\n| PUT | /api/messages/{id} | Update an existing message in doctor's message center |\n| PATCH | /api/messages/{id} | Update an existing message in doctor's message center |\n| GET | /api/messages/{id} | Retrieve an existing message in doctor's message center |\n| DELETE | /api/messages/{id} | Delete an existing message in doctor's message center |\n| GET | /api/eobs/{id} | Retrieve an existing EOB object |\n| GET | /api/doctor_options/{id} | Retrieve existing options for a doctor |\n| POST | /api/allergies | Create patient allergy |\n| GET | /api/allergies | Retrieve or search patient allergies |\n| POST | /api/appointments | Create a new appointment or break on doctor's calendar |\n| GET | /api/appointments | Retrieve or search appointment or breaks. |\n| GET | /api/procedures/{id} |  |\n| GET | /api/clinical_note_templates | Retrieve or search clinical note templates |\n| PUT | /api/line_items/{id} |  |\n| PATCH | /api/line_items/{id} |  |\n| GET | /api/line_items/{id} | Retrieve an existing billing line item |\n| DELETE | /api/line_items/{id} |  |\n| GET | /api/doctors | Retrieve or search doctors within practice group |\n| POST | /api/reminder_profiles | Create reminder profile |\n| GET | /api/reminder_profiles | Retrieve or search reminder profiles |\n| GET | /api/patient_payment_log | Retrieve or search patient payment logs |\n| PUT | /api/offices/{id} | Update an existing office |\n| PATCH | /api/offices/{id} | Update an existing office |\n| GET | /api/offices/{id} | Retrieve an existing office |\n| GET | /api/patient_payment_log/{id} | Retrieve an existing patient payment log |\n| POST | /api/appointment_templates | Create appointment templates for a doctor's calendar |\n| GET | /api/appointment_templates | Retrieve or search appointment templates for a doctor's calendar |\n| POST | /api/patient_vaccine_records | Create patient vaccine records |\n| GET | /api/patient_vaccine_records | Retrieve or search patient vaccine records |\n| PUT | /api/telehealth_appointments/{id} |  |\n| PATCH | /api/telehealth_appointments/{id} |  |\n| GET | /api/telehealth_appointments/{id} |  |\n| PUT | /api/comm_logs/{id} | Update an existing communication (phone call) logs |\n| PATCH | /api/comm_logs/{id} | Update an existing communication (phone call) logs |\n| GET | /api/comm_logs/{id} | Retrieve an existing communication (phone call) logs |\n| GET | /api/prescription_messages | Retrieve or search prescription messages |\n| GET | /api/user_groups/{id} | Retrieve an existing user group |\n| POST | /api/line_items | Create billing line item for appointments |\n| GET | /api/line_items | Retrieve or search billing line items |\n| POST | /api/sublabs | Create sub-vendors |\n| GET | /api/sublabs | Retrieve or search sub vendors |\n| GET | /api/message_threads | Retrieve or search message threads in doctor's message center. (beta) |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"List all day_sheet_charges?\" -> GET /api/day_sheet_charges\n- \"Create a claim_billing_note?\" -> POST /api/claim_billing_notes\n- \"List all claim_billing_notes?\" -> GET /api/claim_billing_notes\n- \"Create a signed_consent_form?\" -> POST /api/signed_consent_forms\n- \"List all signed_consent_forms?\" -> GET /api/signed_consent_forms\n- \"Create a custom_appointment_field?\" -> POST /api/custom_appointment_fields\n- \"List all custom_appointment_fields?\" -> GET /api/custom_appointment_fields\n- \"Update a lab_order?\" -> PUT /api/lab_orders/{id}\n- \"Partially update a lab_order?\" -> PATCH /api/lab_orders/{id}\n- \"Get lab_order details?\" -> GET /api/lab_orders/{id}\n- \"Delete a lab_order?\" -> DELETE /api/lab_orders/{id}\n- \"Create a clinical_notes_list?\" -> POST /api/clinical_notes_list\n- \"List all clinical_notes_list?\" -> GET /api/clinical_notes_list\n- \"Get custom_vital details?\" -> GET /api/custom_vitals/{id}\n- \"Update a sublab?\" -> PUT /api/sublabs/{id}\n- \"Partially update a sublab?\" -> PATCH /api/sublabs/{id}\n- \"Get sublab details?\" -> GET /api/sublabs/{id}\n- \"Delete a sublab?\" -> DELETE /api/sublabs/{id}\n- \"List all qrda1?\" -> GET /api/patients/{id}/qrda1\n- \"Create a problem?\" -> POST /api/problems\n- \"List all problems?\" -> GET /api/problems\n- \"List all staff?\" -> GET /api/staff\n- \"Update a patient_message?\" -> PUT /api/patient_messages/{id}\n- \"Partially update a patient_message?\" -> PATCH /api/patient_messages/{id}\n- \"Get patient_message details?\" -> GET /api/patient_messages/{id}\n- \"List all eligibility_checks?\" -> GET /api/eligibility_checks\n- \"Update a doctor_work_schedule?\" -> PUT /api/doctor_work_schedule/{id}\n- \"Partially update a doctor_work_schedule?\" -> PATCH /api/doctor_work_schedule/{id}\n- \"Get doctor_work_schedule details?\" -> GET /api/doctor_work_schedule/{id}\n- \"Create a medication?\" -> POST /api/medications\n- \"List all medications?\" -> GET /api/medications\n- \"Create a custom_demographic?\" -> POST /api/custom_demographics\n- \"List all custom_demographics?\" -> GET /api/custom_demographics\n- \"Create a appointments_list?\" -> POST /api/appointments_list\n- \"List all appointments_list?\" -> GET /api/appointments_list\n- \"Create a appointment_profile?\" -> POST /api/appointment_profiles\n- \"List all appointment_profiles?\" -> GET /api/appointment_profiles\n- \"Create a patient_communication?\" -> POST /api/patient_communications\n- \"List all patient_communications?\" -> GET /api/patient_communications\n- \"List all patient_authorizations?\" -> GET /api/patient_authorizations\n- \"Update a appointment_profile?\" -> PUT /api/appointment_profiles/{id}\n- \"Partially update a appointment_profile?\" -> PATCH /api/appointment_profiles/{id}\n- \"Get appointment_profile details?\" -> GET /api/appointment_profiles/{id}\n- \"Delete a appointment_profile?\" -> DELETE /api/appointment_profiles/{id}\n- \"Create a message?\" -> POST /api/messages\n- \"List all messages?\" -> GET /api/messages\n- \"Update a clinical_note_field_value?\" -> PUT /api/clinical_note_field_values/{id}\n- \"Partially update a clinical_note_field_value?\" -> PATCH /api/clinical_note_field_values/{id}\n- \"Get clinical_note_field_value details?\" -> GET /api/clinical_note_field_values/{id}\n- \"Create a task_category?\" -> POST /api/task_categories\n- \"List all task_categories?\" -> GET /api/task_categories\n- \"List all fee_schedules_v2?\" -> GET /api/fee_schedules_v2\n- \"Get custom_insurance_plan_name details?\" -> GET /api/custom_insurance_plan_names/{id}\n- \"List all care_team_members?\" -> GET /api/care_team_members\n- \"Create a line_items_list?\" -> POST /api/line_items_list\n- \"List all line_items_list?\" -> GET /api/line_items_list\n- \"Create a unapply_from_appointment?\" -> POST /api/consent_forms/{id}/unapply_from_appointment\n- \"Create a apply_to_appointment?\" -> POST /api/consent_forms/{id}/apply_to_appointment\n- \"Create a consent_form?\" -> POST /api/consent_forms\n- \"List all consent_forms?\" -> GET /api/consent_forms\n- \"Update a reminder_profile?\" -> PUT /api/reminder_profiles/{id}\n- \"Partially update a reminder_profile?\" -> PATCH /api/reminder_profiles/{id}\n- \"Get reminder_profile details?\" -> GET /api/reminder_profiles/{id}\n- \"Delete a reminder_profile?\" -> DELETE /api/reminder_profiles/{id}\n- \"List all day_sheet_patient_payments?\" -> GET /api/day_sheet_patient_payments\n- \"Create a add_exam_room?\" -> POST /api/offices/{id}/add_exam_room\n- \"Get eligibility_check details?\" -> GET /api/eligibility_checks/{id}\n- \"Create a patients_list?\" -> POST /api/patients_list\n- \"List all patients_list?\" -> GET /api/patients_list\n- \"Create a patient_intervention?\" -> POST /api/patient_interventions\n- \"List all patient_interventions?\" -> GET /api/patient_interventions\n- \"Create a patient_message?\" -> POST /api/patient_messages\n- \"List all patient_messages?\" -> GET /api/patient_messages\n- \"Update a patient_physical_exam?\" -> PUT /api/patient_physical_exams/{id}\n- \"Partially update a patient_physical_exam?\" -> PATCH /api/patient_physical_exams/{id}\n- \"Get patient_physical_exam details?\" -> GET /api/patient_physical_exams/{id}\n- \"Create a clinical_note_field_value?\" -> POST /api/clinical_note_field_values\n- \"List all clinical_note_field_values?\" -> GET /api/clinical_note_field_values\n- \"Get inventory_vaccine details?\" -> GET /api/inventory_vaccines/{id}\n- \"Create a patient?\" -> POST /api/patients\n- \"List all patients?\" -> GET /api/patients\n- \"Get implantable_device details?\" -> GET /api/implantable_devices/{id}\n- \"Update a patient_communication?\" -> PUT /api/patient_communications/{id}\n- \"Partially update a patient_communication?\" -> PATCH /api/patient_communications/{id}\n- \"Get patient_communication details?\" -> GET /api/patient_communications/{id}\n- \"List all offices?\" -> GET /api/offices\n- \"Get prescription_message details?\" -> GET /api/prescription_messages/{id}\n- \"List all implantable_devices?\" -> GET /api/implantable_devices\n- \"Create a patient_risk_assessment?\" -> POST /api/patient_risk_assessments\n- \"List all patient_risk_assessments?\" -> GET /api/patient_risk_assessments\n- \"Update a task_statuse?\" -> PUT /api/task_statuses/{id}\n- \"Partially update a task_statuse?\" -> PATCH /api/task_statuses/{id}\n- \"Get task_statuse details?\" -> GET /api/task_statuses/{id}\n- \"Create a patients_summary?\" -> POST /api/patients_summary\n- \"List all patients_summary?\" -> GET /api/patients_summary\n- \"Update a document?\" -> PUT /api/documents/{id}\n- \"Partially update a document?\" -> PATCH /api/documents/{id}\n- \"Get document details?\" -> GET /api/documents/{id}\n- \"Delete a document?\" -> DELETE /api/documents/{id}\n- \"List all office_work_schedule?\" -> GET /api/office_work_schedule\n- \"Create a onpatient_access?\" -> POST /api/patients/{id}/onpatient_access\n- \"List all onpatient_access?\" -> GET /api/patients/{id}/onpatient_access\n- \"Create a comm_log?\" -> POST /api/comm_logs\n- \"List all comm_logs?\" -> GET /api/comm_logs\n- \"Update a lab_result?\" -> PUT /api/lab_results/{id}\n- \"Partially update a lab_result?\" -> PATCH /api/lab_results/{id}\n- \"Get lab_result details?\" -> GET /api/lab_results/{id}\n- \"Delete a lab_result?\" -> DELETE /api/lab_results/{id}\n- \"Update a medication?\" -> PUT /api/medications/{id}\n- \"Partially update a medication?\" -> PATCH /api/medications/{id}\n- \"Get medication details?\" -> GET /api/medications/{id}\n- \"List all day_sheet_credits?\" -> GET /api/day_sheet_credits\n- \"Create a task_template?\" -> POST /api/task_templates\n- \"List all task_templates?\" -> GET /api/task_templates\n- \"Create a transactions_list?\" -> POST /api/transactions_list\n- \"List all transactions_list?\" -> GET /api/transactions_list\n- \"Update a office_work_schedule?\" -> PUT /api/office_work_schedule/{id}\n- \"Partially update a office_work_schedule?\" -> PATCH /api/office_work_schedule/{id}\n- \"Get office_work_schedule details?\" -> GET /api/office_work_schedule/{id}\n- \"Update a patient_vaccine_record?\" -> PUT /api/patient_vaccine_records/{id}\n- \"Partially update a patient_vaccine_record?\" -> PATCH /api/patient_vaccine_records/{id}\n- \"Get patient_vaccine_record details?\" -> GET /api/patient_vaccine_records/{id}\n- \"Update a patient_flag_type?\" -> PUT /api/patient_flag_types/{id}\n- \"Partially update a patient_flag_type?\" -> PATCH /api/patient_flag_types/{id}\n- \"Get patient_flag_type details?\" -> GET /api/patient_flag_types/{id}\n- \"Get inventory_category details?\" -> GET /api/inventory_categories/{id}\n- \"Partially update a clinical_note_field_type?\" -> PATCH /api/clinical_note_field_types/{id}\n- \"Get clinical_note_field_type details?\" -> GET /api/clinical_note_field_types/{id}\n- \"Update a task?\" -> PUT /api/tasks/{id}\n- \"Partially update a task?\" -> PATCH /api/tasks/{id}\n- \"Get task details?\" -> GET /api/tasks/{id}\n- \"List all doctor_work_schedule?\" -> GET /api/doctor_work_schedule\n- \"List all doctor_options?\" -> GET /api/doctor_options\n- \"List all fee_schedules?\" -> GET /api/fee_schedules\n- \"Update a patient_risk_assessment?\" -> PUT /api/patient_risk_assessments/{id}\n- \"Partially update a patient_risk_assessment?\" -> PATCH /api/patient_risk_assessments/{id}\n- \"Get patient_risk_assessment details?\" -> GET /api/patient_risk_assessments/{id}\n- \"List all inventory_categories?\" -> GET /api/inventory_categories\n- \"Update a lab_document?\" -> PUT /api/lab_documents/{id}\n- \"Partially update a lab_document?\" -> PATCH /api/lab_documents/{id}\n- \"Get lab_document details?\" -> GET /api/lab_documents/{id}\n- \"Delete a lab_document?\" -> DELETE /api/lab_documents/{id}\n- \"Update a appointment_template?\" -> PUT /api/appointment_templates/{id}\n- \"Partially update a appointment_template?\" -> PATCH /api/appointment_templates/{id}\n- \"Get appointment_template details?\" -> GET /api/appointment_templates/{id}\n- \"Delete a appointment_template?\" -> DELETE /api/appointment_templates/{id}\n- \"Update a patient_intervention?\" -> PUT /api/patient_interventions/{id}\n- \"Partially update a patient_intervention?\" -> PATCH /api/patient_interventions/{id}\n- \"Get patient_intervention details?\" -> GET /api/patient_interventions/{id}\n- \"Create a task_statuse?\" -> POST /api/task_statuses\n- \"List all task_statuses?\" -> GET /api/task_statuses\n- \"Update a allergy?\" -> PUT /api/allergies/{id}\n- \"Partially update a allergy?\" -> PATCH /api/allergies/{id}\n- \"Get allergy details?\" -> GET /api/allergies/{id}\n- \"List all ccda?\" -> GET /api/patients/{id}/ccda\n- \"Get patient_payment details?\" -> GET /api/patient_payments/{id}\n- \"List all lab_orders_summary?\" -> GET /api/lab_orders_summary\n- \"Create a patient_payment?\" -> POST /api/patient_payments\n- \"List all patient_payments?\" -> GET /api/patient_payments\n- \"Create a clinical_note_field_values_list?\" -> POST /api/clinical_note_field_values_list\n- \"List all clinical_note_field_values_list?\" -> GET /api/clinical_note_field_values_list\n- \"Get care_plan details?\" -> GET /api/care_plans/{id}\n- \"List all billing_profiles?\" -> GET /api/billing_profiles\n- \"Get billing_profile details?\" -> GET /api/billing_profiles/{id}\n- \"List all availability?\" -> GET /api/availability\n- \"Update a task_template?\" -> PUT /api/task_templates/{id}\n- \"Partially update a task_template?\" -> PATCH /api/task_templates/{id}\n- \"Get task_template details?\" -> GET /api/task_templates/{id}\n- \"Get fee_schedule details?\" -> GET /api/fee_schedules/{id}\n- \"Update a appointment?\" -> PUT /api/appointments/{id}\n- \"Partially update a appointment?\" -> PATCH /api/appointments/{id}\n- \"Get appointment details?\" -> GET /api/appointments/{id}\n- \"Delete a appointment?\" -> DELETE /api/appointments/{id}\n- \"Create a telehealth_appointment?\" -> POST /api/telehealth_appointments\n- \"List all telehealth_appointments?\" -> GET /api/telehealth_appointments\n- \"List all care_plans?\" -> GET /api/care_plans\n- \"Create a patient_physical_exam?\" -> POST /api/patient_physical_exams\n- \"List all patient_physical_exams?\" -> GET /api/patient_physical_exams\n- \"List all line_item_deletions?\" -> GET /api/line_item_deletions\n- \"Get signed_consent_form details?\" -> GET /api/signed_consent_forms/{id}\n- \"Get clinical_note_template details?\" -> GET /api/clinical_note_templates/{id}\n- \"List all transactions?\" -> GET /api/transactions\n- \"Create a lab_result?\" -> POST /api/lab_results\n- \"List all lab_results?\" -> GET /api/lab_results\n- \"List all custom_insurance_plan_names?\" -> GET /api/custom_insurance_plan_names\n- \"Update a problem?\" -> PUT /api/problems/{id}\n- \"Partially update a problem?\" -> PATCH /api/problems/{id}\n- \"Get problem details?\" -> GET /api/problems/{id}\n- \"Create a amendment?\" -> POST /api/amendments\n- \"List all amendments?\" -> GET /api/amendments\n- \"Create a lab_order?\" -> POST /api/lab_orders\n- \"List all lab_orders?\" -> GET /api/lab_orders\n- \"Partially update a message_thread?\" -> PATCH /api/message_threads/{id}\n- \"Get message_thread details?\" -> GET /api/message_threads/{id}\n- \"Get doctor details?\" -> GET /api/doctors/{id}\n- \"Create a patient_flag_type?\" -> POST /api/patient_flag_types\n- \"List all patient_flag_types?\" -> GET /api/patient_flag_types\n- \"List all recurring_appointment_instances?\" -> GET /api/recurring_appointment_instances\n- \"List all day_sheet_totals?\" -> GET /api/day_sheet_totals\n- \"Update a custom_appointment_field?\" -> PUT /api/custom_appointment_fields/{id}\n- \"Partially update a custom_appointment_field?\" -> PATCH /api/custom_appointment_fields/{id}\n- \"Get custom_appointment_field details?\" -> GET /api/custom_appointment_fields/{id}\n- \"Create a eob?\" -> POST /api/eobs\n- \"List all eobs?\" -> GET /api/eobs\n- \"Get user details?\" -> GET /api/users/{id}\n- \"List all insurances?\" -> GET /api/insurances\n- \"Create a telehealth_appointment_history?\" -> POST /api/telehealth_appointment_history\n- \"List all telehealth_appointment_history?\" -> GET /api/telehealth_appointment_history\n- \"Create a task_note?\" -> POST /api/task_notes\n- \"List all task_notes?\" -> GET /api/task_notes\n- \"Create a task?\" -> POST /api/tasks\n- \"List all tasks?\" -> GET /api/tasks\n- \"Update a patients_summary?\" -> PUT /api/patients_summary/{id}\n- \"Partially update a patients_summary?\" -> PATCH /api/patients_summary/{id}\n- \"Get patients_summary details?\" -> GET /api/patients_summary/{id}\n- \"Delete a patients_summary?\" -> DELETE /api/patients_summary/{id}\n- \"Create a lab_document?\" -> POST /api/lab_documents\n- \"List all lab_documents?\" -> GET /api/lab_documents\n- \"Update a consent_form?\" -> PUT /api/consent_forms/{id}\n- \"Partially update a consent_form?\" -> PATCH /api/consent_forms/{id}\n- \"Get consent_form details?\" -> GET /api/consent_forms/{id}\n- \"Update a lab_test?\" -> PUT /api/lab_tests/{id}\n- \"Partially update a lab_test?\" -> PATCH /api/lab_tests/{id}\n- \"Get lab_test details?\" -> GET /api/lab_tests/{id}\n- \"Delete a lab_test?\" -> DELETE /api/lab_tests/{id}\n- \"Create a prescription_messages_list?\" -> POST /api/prescription_messages_list\n- \"List all prescription_messages_list?\" -> GET /api/prescription_messages_list\n- \"Update a patient?\" -> PUT /api/patients/{id}\n- \"Partially update a patient?\" -> PATCH /api/patients/{id}\n- \"Get patient details?\" -> GET /api/patients/{id}\n- \"Delete a patient?\" -> DELETE /api/patients/{id}\n- \"List all ccda_async?\" -> GET /api/patients/{id}/ccda_async\n- \"List all custom_vitals?\" -> GET /api/custom_vitals\n- \"List all user_groups?\" -> GET /api/user_groups\n- \"Get care_team_member details?\" -> GET /api/care_team_members/{id}\n- \"Get claim_billing_note details?\" -> GET /api/claim_billing_notes/{id}\n- \"Create a inventory_vaccine?\" -> POST /api/inventory_vaccines\n- \"List all inventory_vaccines?\" -> GET /api/inventory_vaccines\n- \"Get transaction details?\" -> GET /api/transactions/{id}\n- \"List all procedures?\" -> GET /api/procedures\n- \"Update a patient_lab_result?\" -> PUT /api/patient_lab_results/{id}\n- \"Partially update a patient_lab_result?\" -> PATCH /api/patient_lab_results/{id}\n- \"Get patient_lab_result details?\" -> GET /api/patient_lab_results/{id}\n- \"Delete a patient_lab_result?\" -> DELETE /api/patient_lab_results/{id}\n- \"Update a amendment?\" -> PUT /api/amendments/{id}\n- \"Partially update a amendment?\" -> PATCH /api/amendments/{id}\n- \"Get amendment details?\" -> GET /api/amendments/{id}\n- \"Delete a amendment?\" -> DELETE /api/amendments/{id}\n- \"Create a lab_test?\" -> POST /api/lab_tests\n- \"List all lab_tests?\" -> GET /api/lab_tests\n- \"Update a appointments_list?\" -> PUT /api/appointments_list/{id}\n- \"Partially update a appointments_list?\" -> PATCH /api/appointments_list/{id}\n- \"Get appointments_list details?\" -> GET /api/appointments_list/{id}\n- \"Delete a appointments_list?\" -> DELETE /api/appointments_list/{id}\n- \"Create a patient_lab_result?\" -> POST /api/patient_lab_results\n- \"List all patient_lab_results?\" -> GET /api/patient_lab_results\n- \"Update a task_category?\" -> PUT /api/task_categories/{id}\n- \"Partially update a task_category?\" -> PATCH /api/task_categories/{id}\n- \"Get task_category details?\" -> GET /api/task_categories/{id}\n- \"Get fee_schedules_v2 details?\" -> GET /api/fee_schedules_v2/{id}\n- \"Get insurance details?\" -> GET /api/insurances/{id}\n- \"List all clinical_notes?\" -> GET /api/clinical_notes\n- \"Create a eligibility_checks_list?\" -> POST /api/eligibility_checks_list\n- \"List all eligibility_checks_list?\" -> GET /api/eligibility_checks_list\n- \"Get telehealth_appointment_history details?\" -> GET /api/telehealth_appointment_history/{id}\n- \"Get clinical_note details?\" -> GET /api/clinical_notes/{id}\n- \"List all clinical_note_field_types?\" -> GET /api/clinical_note_field_types\n- \"Create a document?\" -> POST /api/documents\n- \"List all documents?\" -> GET /api/documents\n- \"Get staff details?\" -> GET /api/staff/{id}\n- \"List all users?\" -> GET /api/users\n- \"Get lab_orders_summary details?\" -> GET /api/lab_orders_summary/{id}\n- \"List all audit_log?\" -> GET /api/audit_log\n- \"Update a task_note?\" -> PUT /api/task_notes/{id}\n- \"Partially update a task_note?\" -> PATCH /api/task_notes/{id}\n- \"Get task_note details?\" -> GET /api/task_notes/{id}\n- \"Update a custom_demographic?\" -> PUT /api/custom_demographics/{id}\n- \"Partially update a custom_demographic?\" -> PATCH /api/custom_demographics/{id}\n- \"Get custom_demographic details?\" -> GET /api/custom_demographics/{id}\n- \"Update a message?\" -> PUT /api/messages/{id}\n- \"Partially update a message?\" -> PATCH /api/messages/{id}\n- \"Get message details?\" -> GET /api/messages/{id}\n- \"Delete a message?\" -> DELETE /api/messages/{id}\n- \"Get eob details?\" -> GET /api/eobs/{id}\n- \"Get doctor_option details?\" -> GET /api/doctor_options/{id}\n- \"Create a allergy?\" -> POST /api/allergies\n- \"List all allergies?\" -> GET /api/allergies\n- \"Create a appointment?\" -> POST /api/appointments\n- \"List all appointments?\" -> GET /api/appointments\n- \"Get procedure details?\" -> GET /api/procedures/{id}\n- \"List all clinical_note_templates?\" -> GET /api/clinical_note_templates\n- \"Update a line_item?\" -> PUT /api/line_items/{id}\n- \"Partially update a line_item?\" -> PATCH /api/line_items/{id}\n- \"Get line_item details?\" -> GET /api/line_items/{id}\n- \"Delete a line_item?\" -> DELETE /api/line_items/{id}\n- \"List all doctors?\" -> GET /api/doctors\n- \"Create a reminder_profile?\" -> POST /api/reminder_profiles\n- \"List all reminder_profiles?\" -> GET /api/reminder_profiles\n- \"List all patient_payment_log?\" -> GET /api/patient_payment_log\n- \"Update a office?\" -> PUT /api/offices/{id}\n- \"Partially update a office?\" -> PATCH /api/offices/{id}\n- \"Get office details?\" -> GET /api/offices/{id}\n- \"Get patient_payment_log details?\" -> GET /api/patient_payment_log/{id}\n- \"Create a appointment_template?\" -> POST /api/appointment_templates\n- \"List all appointment_templates?\" -> GET /api/appointment_templates\n- \"Create a patient_vaccine_record?\" -> POST /api/patient_vaccine_records\n- \"List all patient_vaccine_records?\" -> GET /api/patient_vaccine_records\n- \"Update a telehealth_appointment?\" -> PUT /api/telehealth_appointments/{id}\n- \"Partially update a telehealth_appointment?\" -> PATCH /api/telehealth_appointments/{id}\n- \"Get telehealth_appointment details?\" -> GET /api/telehealth_appointments/{id}\n- \"Update a comm_log?\" -> PUT /api/comm_logs/{id}\n- \"Partially update a comm_log?\" -> PATCH /api/comm_logs/{id}\n- \"Get comm_log details?\" -> GET /api/comm_logs/{id}\n- \"List all prescription_messages?\" -> GET /api/prescription_messages\n- \"Get user_group details?\" -> GET /api/user_groups/{id}\n- \"Create a line_item?\" -> POST /api/line_items\n- \"List all line_items?\" -> GET /api/line_items\n- \"Create a sublab?\" -> POST /api/sublabs\n- \"List all sublabs?\" -> GET /api/sublabs\n- \"List all message_threads?\" -> GET /api/message_threads\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Paginated endpoints accept limit/offset or cursor parameters\n- Create/update endpoints return the modified resource on success\n- Error responses include status codes and descriptions in the spec\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api openapi-schema\n@base https://app.drchrono.com\n@version v4 - Hunt Valley\n@auth OAuth2\n@endpoints 323\n@hint download_for_search\n@toc api(323)\n\n@endpoint GET /api/day_sheet_charges\n@desc Retrieve daysheet charges report for a given date range\n@required {start_date: str, end_date: str}\n@optional {charges_date_type: str, report_type: str, claim_type: str, patient_id: int, office_id: str, examroom_id: int, pg_mode: bool}\n\n@endpoint POST /api/claim_billing_notes\n@desc Create a new billing note\n@optional {appointment: int, doctor: int}\n@returns(201) {text: str, created_at: str, appointment: int, id: int, created_by: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/claim_billing_notes\n@desc Retrieve or search billing notes\n@optional {cursor: str, page_size: int, appointment: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/signed_consent_forms\n@desc signed_consent_forms Create\n@required {patient: int # ID of the patient to associate with the consent form, appointment: int # ID of the appointment to associate with the consent form, consent_form: int # ID of the consent form that was signed}\n@optional {signature_file: file # File containing the patient's signature}\n@returns(201) {date_signed: str, archived: bool, appointment: int, signature_file: str(binary), updated_at: str, patient: int, consent_form: int, id: int} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/signed_consent_forms\n@desc signed_consent_forms Update\n@required {id: int}\n@optional {patient: int # ID of the patient to filter by}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/signed_consent_forms\n@desc signed_consent_forms Get\n@required {appointment: int # ID of the appointment that the consent form is signed for, patient: int # ID of the patient who signed the consent form, consent_form: int # ID of the consent form that is signed}\n@optional {cursor: str, page_size: int, patient: int, doctor: int, date_signed: str # Date when the consent form is signed.  Automatically set when the record is created, archived: bool # Indicates that the consent form has been archived and should not be used, signature_file: str(binary) # File with the signature of the patient, updated_at: str # Date and time when the signature was last updated, id: int # ID consent form signature}\n@returns(200) {previous: str, results: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n@example_request {\"patient\":12345}\n\n@endpoint POST /api/custom_appointment_fields\n@desc Create custom appointment fields\n@optional {doctor: int}\n@returns(201) {archived: bool, doctor: str, created_at: str, updated_at: str, order: int, field_desc: str, field_name: str, id: int} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/custom_appointment_fields\n@desc Retrieve or search custom appointment fields\n@optional {cursor: str, page_size: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/lab_orders/{id}\n@desc Update an existing lab order\n@required {id: str}\n@optional {since: str, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/lab_orders/{id}\n@desc Update an existing lab order\n@required {id: str}\n@optional {since: str, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/lab_orders/{id}\n@desc Retrieve an existing lab order\n@required {id: str}\n@optional {since: str, doctor: int}\n@returns(200) {status: str, documents: [str], patient: int, doctor: int, timestamp: str, notes: str, accession_number: str, requisition_id: str, external_requisition_id: str, priority: str, icd10_codes: [map], sublab: int, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint DELETE /api/lab_orders/{id}\n@desc Delete an existing lab order\n@required {id: str}\n@optional {since: str, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/clinical_notes_list\n@desc Create clinical note list request.  Use the UUID returned in the response to retrieve the batch of records. Results returned in order of ID.\n@optional {order_by: str # Order results by a specific field. Valid options include [id, updated_at]. Default: id., page_size: int, page: int, patient: int # Patient ID filter, office: int # Office ID filter, doctor: int # Doctor ID filter, since: str # Inclusive lower bound on clinical note updated/created time., date_range: str # Inclusive bounded date range on appointment scheduled date, date: str # Filter on specific appointment scheduled date, verbose: bool # When `true` includes yellow notes}\n@returns(201) {status: str, uuid: str, description: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /api/clinical_notes_list\n@desc Retrieve or search clinical notes in batches. Results returned in order of ID.\n@optional {uuid: str # The UUID token for the batch of clinical notes.  This is returned in the response of the `create` endpoint.}\n@returns(200) {status: str, pagination: map{count: int, pages: int, page: int}, results: [map], uuid: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /api/custom_vitals/{id}\n@desc Retrieve an existing custom vital type\n@required {id: str}\n@optional {doctor: int}\n@returns(200) {archived: bool, description: str, data_type: str, doctor: str, is_fraction_field: bool, fraction_delimiter: str, allowed_values: [str], id: int, unit: str, name: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/sublabs/{id}\n@desc Update an existing sub vendor\n@required {id: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/sublabs/{id}\n@desc Update an existing sub vendor\n@required {id: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/sublabs/{id}\n@desc Retrieve an existing sub vendor\n@required {id: int}\n@returns(200) {vendor_name: str, facility_code: str, id: int, name: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint DELETE /api/sublabs/{id}\n@desc Delete an existing sub vendor\n@required {id: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patients/{id}/qrda1\n@desc Retrieve patient QRDA1\n@required {id: str}\n@optional {first_name: str, last_name: str, preferred_language: str, doctor: int, gender: str, since: str, date_of_birth: str, race: str, chart_id: str, email: str, ethnicity: str}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/problems\n@desc Create patient problems\n@optional {patient: int, doctor: int}\n@returns(201) {category: str, icd_code: str, icd_version: str, appointment: int, description: str, info_url: str, doctor: int, notes: str, verification_status: any, status: str, snomed_ct_code: str, abatement_date: str(date), date_onset: str, date_diagnosis: str, date_changed: str, patient: int, problem_type: str, id: int, name: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/problems\n@desc Retrieve or search patient problems\n@optional {cursor: str, page_size: int, patient: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/staff\n@optional {cursor: str, page_size: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/patient_messages/{id}\n@required {id: str}\n@optional {since: str, patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/patient_messages/{id}\n@required {id: str}\n@optional {since: str, patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patient_messages/{id}\n@required {id: str}\n@optional {since: str, patient: int, doctor: int, thread: int # Filter messages by message thread}\n@returns(200) {body: str, patient: int, attachments: [map], thread: int?, doctor: int, created_at: str, updated_at: str, message: str, id: int, subject: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/eligibility_checks\n@desc Retrieve or search past eligibility checks for patient\n@optional {cursor: str, page_size: int, appointment: int, appointment_date: str, doctor: int, query_date_range: str, appointment_date_range: str, query_date: str, patient: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/doctor_work_schedule/{id}\n@desc Update an existing doctor's entire work schedule\n@required {id: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/doctor_work_schedule/{id}\n@desc Update an existing doctor's work schedule\n@required {id: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/doctor_work_schedule/{id}\n@desc Retrieve a work schedule for the doctor (beta)\n@required {id: str}\n@returns(200) {work_days: [map], id: int, office: int, doctor: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/medications\n@desc Create patient medications\n@optional {patient: int, doctor: int}\n@returns(201) {dispense_quantity: num, prn: bool, pharmacy_note: str, number_refills: int, patient: int, id: int, dosage_quantity: str, doctor: int, date_started_taking: str, dosage_units: str, date_stopped_taking: str, order_status: str, status: str, appointment: int, daw: bool, rxnorm: str, date_prescribed: str, name: str, ndc: str, notes: str, frequency: str, indication: str, signature_note: str, route: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/medications\n@desc Retrieve or search patient medications\n@optional {cursor: str, page_size: int, patient: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/custom_demographics\n@desc Create custom demographics fields\n@optional {doctor: int}\n@returns(201) {archived: bool, description: str, doctor: int, template_name: str, allowed_values: str, id: int, name: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/custom_demographics\n@desc Retrieve or search custom demographics fields\n@optional {cursor: str, page_size: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/appointments_list\n@optional {status: str, patient: int, office: int, doctor: int, since: str, date_range: str, order_by: str # Order results by a specific field. Valid options include [scheduled_time, updated_at]. Default: scheduled_time., date: str, show_archived: bool # set to `true` or `1` to include deleted or archived appointments}\n@returns(201) {status: str, icd9_codes: [str], office: int, base_recurring_appointment: str, color: str, vitals: map{height_units: str, weight_units: str, pain: str, temperature: num, weight: num, smoking_status: str, head_circumference: num, bmi: str, head_circumference_units: str, blood_pressure_2: int, blood_pressure_1: int, height: num, pulse: int, oxygen_saturation: num, respiratory_rate: int, temperature_units: str}, first_billed_date: str, last_billed_date: str, billing_status: str, primary_insurer_payer_id: str, duration: int, is_membership_appointment: bool, appt_is_break: bool, id: str, custom_fields: [map], scheduled_time: str, secondary_insurer_name: str, doctor: int, recur_start_date: str, primary_insurance_id_number: str, created_by: str, ins2_status: str, first_edi_date: str, billing_notes: [map], is_walk_in: bool, billing_provider: str, reminder_profile: str, primary_insurer_name: str, profile: int, resubmit_claim_original_id: int, patient: int, recurrence_instance_key: str?, cloned_from: int, extended_updated_at: str, exam_room: int, updated_at: str, reason: str, last_edi_date: str, secondary_insurer_payer_id: str, allow_overlapping: bool, payment_profile: str, secondary_insurance_id_number: str, clinical_note: map{pdf: str, locked: bool, updated_at: str}, custom_vitals: [map], is_virtual_base: bool, recurring_appointment: bool, supervising_provider: str, recurring_days: [any], status_transitions: [map], created_at: str, reminders: [map], ins1_status: str, custom_status: str, recur_end_date: str, icd10_codes: [str], deleted_flag: bool, notes: str, recurs_every: int} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 409: Scheduled time overlaps with an existing appointment, 500: Internal Server Error}\n\n@endpoint GET /api/appointments_list\n@optional {cursor: str, page_size: int, status: str, patient: int, office: int, doctor: int, since: str, date_range: str, date: str, show_archived: bool # set to `true` or `1` to include deleted or archived appointments}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/appointment_profiles\n@desc Create appointment profiles for a doctor's calendar\n@optional {doctor: int}\n@returns(201) {archived: bool, name: str, doctor: int, color: str, reason: str, sort_order: int, duration: int, id: int, online_scheduling: bool} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/appointment_profiles\n@desc Retrieve or search appointment profiles for a doctor's calendar\n@optional {cursor: str, page_size: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/patient_communications\n@desc Create patient communication for CQM\n@optional {patient: int, doctor: int}\n@returns(201) {value_name: str, value_code_system: str, code: str, appointment: str, name: str, doctor: int, created_at: str, effective_time: str, value_code: str, patient: int, id: int, code_system: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patient_communications\n@desc Retrieve or search patient communications for CQM\n@optional {cursor: str, page_size: int, patient: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patient_authorizations\n@desc Retrieve or search patient authorizations\n@optional {cursor: str, page_size: int, patient: int, doctor: int, start_date: str, date_range: str, end_date: str}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/appointment_profiles/{id}\n@desc Update an existing appointment profile\n@required {id: str}\n@optional {doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/appointment_profiles/{id}\n@desc Update an existing appointment profile\n@required {id: str}\n@optional {doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/appointment_profiles/{id}\n@desc Retrieve an existing appointment profile\n@required {id: str}\n@optional {doctor: int}\n@returns(200) {archived: bool, name: str, doctor: int, color: str, reason: str, sort_order: int, duration: int, id: int, online_scheduling: bool} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint DELETE /api/appointment_profiles/{id}\n@desc Delete an existing appointment profile\n@required {id: str}\n@optional {doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/messages\n@desc Create messages in doctor's message center\n@optional {patient: int, doctor: int, responsible_user: int, updated_since: str, received_since: str, owner: int, type: str}\n@returns(201) {type_description: str, patient_middle_name: str, updated_at: str, owner: str, responsible_user_first_name: str, received_at: str, id: int, doctor_last_name: str, owner_first_name: str, archived: bool, doctor: int, owner_last_name: str, patient_first_name: str, attachment: str, outgoing_fax_recipient_fax_number: str, responsible_user_last_name: str, type: str, patient_last_name: str, patient: int, doctor_first_name: str, read: bool, responsible_user: str, workflow_step: str, outgoing_fax_recipient_name: str, doctor_middle_name: str, message_notes: [map], title: str, starred: bool} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/messages\n@desc Retrieve or search messages in doctor's message center\n@optional {cursor: str, page_size: int, patient: int, doctor: int, responsible_user: int, updated_since: str, received_since: str, owner: int, type: str}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/clinical_note_field_values/{id}\n@desc Update an existing clinical note field value\n@required {id: str}\n@optional {clinical_note_field: int, since: str, appointment: int, clinical_note_template: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/clinical_note_field_values/{id}\n@desc Update an existing clinical note field value\n@required {id: str}\n@optional {clinical_note_field: int, since: str, appointment: int, clinical_note_template: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/clinical_note_field_values/{id}\n@desc Retrieve an existing clinical note field value\n@required {id: str}\n@optional {clinical_note_field: int, since: str, appointment: int, clinical_note_template: int, doctor: int}\n@returns(200) {clinical_note_field: int, created_at: str, updated_at: str, value: str, appointment: int, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/task_categories\n@desc Create a task category\n@optional {since: str}\n@returns(201) {archived: bool, is_global: str, name: str, practice_group: int, created_at: str, updated_at: str, id: int} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/task_categories\n@desc Retrieve or search task categories\n@optional {cursor: str, page_size: int, since: str}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/fee_schedules_v2\n@optional {cursor: str, page_size: int, payer_id: str, plan_name: str, specialities: str, assignees: str, assignee_type: str, effective_date: str, ineffective_date: str}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/custom_insurance_plan_names/{id}\n@desc Retrieve an existing custom insurance plan name\n@required {id: str}\n@optional {since: str, user: int, name: str, doctor: int}\n@returns(200) {archived: bool, doctor: str, created_at: str, updated_at: str, insurance_plan_name: str, user: str, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/care_team_members\n@optional {cursor: str, page_size: int, patient: int, appointment: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/line_items_list\n@desc Create a billing line items list request\n@optional {order_by: str # Order results by a specific field. Valid options include [id, updated_at]. Default: id., page_size: int, posted_date: str, patient: int, office: int, doctor: int, since: str, appointment: int, service_date: str, service_date_range: str}\n@returns(201) {status: str, uuid: str, description: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/line_items_list\n@desc Retrieve the list of billing line items\n@optional {uuid: str # The UUID token for the batch of patients.  This is returned in the response of the create endpoint.}\n@returns(200) {status: str, results: [map], uuid: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/consent_forms/{id}/unapply_from_appointment\n@desc Unassign (unapply) a consent form from appointment\n@required {id: str}\n@optional {doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/consent_forms/{id}/apply_to_appointment\n@desc Assign (apply) a consent form to appointment\n@required {id: str}\n@optional {doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/consent_forms\n@desc Create a patient consent form\n@optional {doctor: int}\n@returns(201) {archived: bool, is_mandatory: bool, uri: str, doctor: int, updated_at: str, created_at: str, title: str, assign_by_default: bool, order: int, id: int} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/consent_forms\n@desc Retrieve or search patient consent forms\n@optional {cursor: str, page_size: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/reminder_profiles/{id}\n@desc Update an existing reminder profile\n@required {id: str}\n@optional {doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/reminder_profiles/{id}\n@desc Update an existing reminder profile\n@required {id: str}\n@optional {doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/reminder_profiles/{id}\n@desc Retrieve an existing reminder profile\n@required {id: str}\n@optional {doctor: int}\n@returns(200) {reminders: [map], id: int, name: str, doctor: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint DELETE /api/reminder_profiles/{id}\n@desc Delete an existing reminder profile\n@required {id: str}\n@optional {doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/day_sheet_patient_payments\n@desc Retrieve daysheet cash report for a given date range\n@required {start_date: str, end_date: str}\n@optional {charges_date_type: str, report_type: str, claim_type: str, patient_id: int, office: str, examroom_id: int, legacy: bool}\n\n@endpoint POST /api/offices/{id}/add_exam_room\n@desc Add an exam room to the office\n@required {id: str}\n@optional {doctor: int}\n@returns(201) {phone_number: str, city: str, archived: bool, office_work_schedule: map{work_days: [map], id: int, office: int, doctor: int}, name: str, doctor: str, country: str, start_time: str, fax_number: str, online_timeslots: [map], state: str, end_time: str, exam_rooms: str, address: str, tax_id_number_professional: str, zip_code: str, id: int, online_scheduling: bool} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/eligibility_checks/{id}\n@desc Retrieve an existing past eligibility check\n@required {id: str}\n@optional {appointment: int, appointment_date: str, doctor: int, query_date_range: str, appointment_date_range: str, query_date: str, patient: int}\n@returns(200) {coverage_subscriber: str, appointment: str, eligibility: str, payer_name: str, coverage_details: str, updated_at: str, query_date: str, service_type_description: str, patient: str, request_service_type: str, id: int, cob_level: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/patients_list\n@desc Submit patient list request.  Use the UUID returned in the response to retrieve the batch of patients.\n@optional {order_by: str # Order results by a specific field. Valid options include [id, updated_at]. Default: id., page_size: int, first_name: str, last_name: str, preferred_language: str, gender: str # Filter the list for the patient's gender., since: str # Filter the list for when the patient was created or updated.  The value should be a date in the format YYYY-MM-DD.  For example, to filter for patients created or updated on or after 2019-01-01, use the value 2019-01-01., date_of_birth: str # Filter the list for the patient's date of birth.  The value should be a date in the format YYYY-MM-DD.  For example, to filter for patients born on 2019-01-01, use the value 2019-01-01., race: str # Filter the list for the patients' race., chart_id: str # Filter the list for the patients' chart id., email: str # Filter the list for the patients' email., ethnicity: str # Filter the list for the patients' ethnicity., verbose: bool # when `true` include additional verbose fields in the response.}\n@returns(201) {status: str, uuid: str, description: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 500: Internal Server Error}\n\n@endpoint GET /api/patients_list\n@desc Retrieve or search patients in batches. This resource returns identical data to `GET /api/patients` but uses an asynchronous batch-based approach to data delivery. This is an efficient choice for large historical record loading use cases. Retrieve the results/status of a previously created patient_list request using the UUID returned in the response. Results are ordered by patient ID number.\n@required {uuid: str # The UUID token for submitted batch request. This is returned in the response of the create request.}\n@returns(200) {status: str, results: [map], uuid: str} # OK\n@errors {400: Bad Request., 401: Unauthorized, 403: Permission Denied, 404: Not Found. The UUID is not found, or, it has expired. UUIDs have a 1 hour lifetime., 500: Internal Server Error}\n\n@endpoint POST /api/patient_interventions\n@desc Create patient intervention for CQM\n@optional {patient: int, doctor: int}\n@returns(201) {value_name: str, value_code_system: str, code: str, appointment: str, name: str, doctor: int, created_at: str, effective_time: str, value_code: str, patient: int, id: int, code_system: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patient_interventions\n@desc Retrieve or search patient interventions for CQM\n@optional {cursor: str, page_size: int, patient: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/patient_messages\n@optional {since: str, patient: int, doctor: int}\n@returns(201) {body: str, patient: int, attachments: [map], thread: int?, doctor: int, created_at: str, updated_at: str, message: str, id: int, subject: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patient_messages\n@optional {cursor: str, page_size: int, since: str, patient: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/patient_physical_exams/{id}\n@desc Update an existing patient physical exam for CQM\n@required {id: str}\n@optional {patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/patient_physical_exams/{id}\n@desc Update an existing patient physical exam for CQM\n@required {id: str}\n@optional {patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patient_physical_exams/{id}\n@desc Retrieve an existing patient physical exam for CQM\n@required {id: str}\n@optional {patient: int, doctor: int}\n@returns(200) {value_name: str, value_code_system: str, code: str, appointment: str, name: str, doctor: int, created_at: str, effective_time: str, value_code: str, patient: int, id: int, code_system: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/clinical_note_field_values\n@desc Create clinical note field value\n@optional {clinical_note_field: int, since: str, appointment: int, clinical_note_template: int, doctor: int}\n@returns(201) {clinical_note_field: int, created_at: str, updated_at: str, value: str, appointment: int, id: int} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/clinical_note_field_values\n@desc Retrieve or search clinical note field values\n@optional {cursor: str, page_size: int, clinical_note_field: int, since: str, appointment: int, clinical_note_template: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/inventory_vaccines/{id}\n@desc Retrieve an existing vaccine inventory\n@required {id: str}\n@optional {status: str, cvx_code: str, since: str, doctor: int}\n@returns(200) {category: int, lot_number: str, manufacturer_code: str, name: str, original_quantity: int, doctor: int, created_at: str, status: str, updated_at: str, price_with_tax: num, expiry: str, note: str, sales_tax_applicable: bool, cost: num, price: num, vaccination_type: str, id: int, manufacturer: str, current_quantity: int, cvx_code: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/patients\n@desc Create patient\n@optional {first_name: str, last_name: str, preferred_language: str, doctor: int, gender: str, since: str, date_of_birth: str, race: str, chart_id: str, email: str, ethnicity: str, allow_duplicates: bool # Override duplicate check}\n@returns(201) {medication_history_consent: str, last_name: str, emergency_contact_phone: str, primary_care_physician: str, date_of_first_appointment: str, tertiary_insurance: map{insurance_group_name: str, insurance_id_number: str, insurance_claim_office_number: str, subscriber_address: str, subscriber_state: str, subscriber_social_security: str, photo_front: str, subscriber_last_name: str, subscriber_middle_name: str, subscriber_date_of_birth: str, insurance_company: str, is_subscriber_the_patient: bool, insurance_plan_name: str, patient_relationship_to_subscriber: str, subscriber_gender: str, photo_back: str, subscriber_suffix: str, subscriber_zip_code: str, subscriber_city: str, insurance_plan_type: str, insurance_payer_id: str, subscriber_country: str, subscriber_first_name: str, insurance_group_number: str}, patient_flags_attached: [map], updated_at: str, custom_demographics: [map], referring_source: str, responsible_party_relation: str, zip_code: str, id: int, employer_city: str, employer_state: str, city: str, first_name: str, middle_name: str, doctor: int, race_subcategories: [map], disable_sms_messages: bool, employer: str, preferred_language_description: str, patient_flags: [map], date_of_birth: str, ethnicity: str, home_phone: str, pronouns: str, patient_status: str, patient_photo_date: str, gender_identity_description: str, email: str, responsible_party_email: str, patient_photo: str, responsible_party_phone: str, state: str, secondary_insurance: map{insurance_group_name: str, insurance_id_number: str, insurance_claim_office_number: str, subscriber_address: str, subscriber_state: str, subscriber_social_security: str, photo_front: str, subscriber_last_name: str, subscriber_middle_name: str, subscriber_date_of_birth: str, insurance_company: str, is_subscriber_the_patient: bool, insurance_plan_name: str, patient_relationship_to_subscriber: str, subscriber_gender: str, photo_back: str, subscriber_suffix: str, subscriber_zip_code: str, subscriber_city: str, insurance_plan_type: str, insurance_payer_id: str, subscriber_country: str, subscriber_first_name: str, insurance_group_number: str}, date_of_last_appointment: str, preferred_language_code: str, patient_payment_profile: str, date_of_death: str, social_security_number: str, auto_accident_insurance: map{auto_accident_claim_rep_city: str, auto_accident_claim_rep_state: str, auto_accident_claim_rep_address: str, auto_accident_will_require_therapy_rec: str, auto_accident_subscriber_middle_name: str, auto_accident_still_under_care: bool, auto_accident_significant_injury_notes: str, auto_accident_subscriber_first_name: str, auto_accident_subscriber_address: str, auto_accident_disabled_from_date: str, auto_accident_company: str, auto_accident_disabled_to_date: str, auto_accident_similar_condition_date: str, auto_accident_case_number: str, auto_accident_claim_rep_is_insurer: bool, auto_accident_payer_address: str, auto_accident_subscriber_last_name: str, auto_accident_subscriber_social_security: str, auto_accident_subscriber_phone_number: str, auto_accident_subscriber_city: str, auto_accident_significant_injury: str, auto_accident_similar_condition_notes: str, auto_accident_payer_id: str, auto_accident_payer_state: str, auto_accident_subscriber_zip_code: str, auto_accident_payer_zip: str, auto_accident_payer_city: str, auto_accident_will_require_therapy: bool, auto_accident_date_of_accident: str, auto_accident_subscriber_date_of_birth: str, auto_accident_subscriber_suffix: str, auto_accident_subscriber_state: str, auto_accident_return_to_work_date: str, auto_accident_notes: str, auto_accident_policy_number: str, auto_accident_is_subscriber_the_patient: bool, auto_accident_claim_rep_zip: str, auto_accident_state_of_occurrence: str, auto_accident_treatment_duration: str, auto_accident_had_similar_condition: bool, auto_accident_patient_relationship_to_subscriber: str, auto_accident_claim_rep_name: str}, address: str, chart_id: str, referring_doctor: map{fax: str, last_name: str, middle_name: str, suffix: str, first_name: str, provider_number: str, specialty: str, provider_qualifier: str, phone: str, address: str, npi: str, email: str}, primary_insurance: map{insurance_group_name: str, insurance_id_number: str, insurance_claim_office_number: str, subscriber_address: str, subscriber_state: str, subscriber_social_security: str, photo_front: str, subscriber_last_name: str, subscriber_middle_name: str, subscriber_date_of_birth: str, insurance_company: str, is_subscriber_the_patient: bool, insurance_plan_name: str, patient_relationship_to_subscriber: str, subscriber_gender: str, photo_back: str, subscriber_suffix: str, subscriber_zip_code: str, subscriber_city: str, insurance_plan_type: str, insurance_payer_id: str, subscriber_country: str, subscriber_first_name: str, insurance_group_number: str}, preferred_language: str, responsible_party_name: str, nick_name: str, copay: str, created_at: str, emergency_contact_relation: str, gender_identity_code: str, office_phone: str, employer_address: str, race: str, offices: [int], preferred_pharmacies: [str], emergency_contact_name: str, gender: str, default_pharmacy: str, cell_phone: str, employer_zip_code: str, workers_comp_insurance: map{workers_comp_payer_city: str, workers_comp_payer_id: str, workers_comp_group_name: str, workers_comp_wcb: str, workers_comp_carrier_code: str, workers_comp_notes: str, property_and_casualty_agency_claim_number: str, workers_comp_state_of_occurrence: str, workers_comp_payer_zip: str, workers_comp_wcb_rating_code: str, workers_comp_case_number: str, workers_comp_group_number: str, workers_comp_company: str, workers_comp_payer_address: str, workers_comp_date_of_accident: str, workers_comp_payer_state: str}} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patients\n@desc Retrieve or search patients\n@optional {cursor: str, page_size: int, first_name: str, created_at: str, last_name: str, preferred_language: str, doctor: int, gender: str, since: str, date_of_birth: str, race: str, chart_id: str, email: str, ethnicity: str}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/implantable_devices/{id}\n@desc Retrieve an existing implantable device\n@required {id: str}\n@optional {mu_date: str, patient: int, mu_date_range: str, doctor: int}\n@returns(200) {status: str, lot_number: str, archived: bool, manufacturing_date: str, patient: str, expiration_date: str, created_at: str, brand_name: str, updated_at: str, gmdn_pt_name: str, version_or_model: str, serial_number: str, udi: str, id: int, procedure: str, company_name: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/patient_communications/{id}\n@desc Update an existing patient communication for CQM\n@required {id: str}\n@optional {patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/patient_communications/{id}\n@desc Update an existing patient communication for CQM\n@required {id: str}\n@optional {patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patient_communications/{id}\n@desc Retrieve an existing patient communication for CQM\n@required {id: str}\n@optional {patient: int, doctor: int}\n@returns(200) {value_name: str, value_code_system: str, code: str, appointment: str, name: str, doctor: int, created_at: str, effective_time: str, value_code: str, patient: int, id: int, code_system: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/offices\n@desc Retrieve or search offices\n@optional {cursor: str, page_size: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/prescription_messages/{id}\n@desc Retrieve an existing prescription message\n@required {id: str}\n@optional {parent_message: int, since: str, patient: int, doctor: int}\n@returns(200) {message_status: str, patient: int, doctor: int, message_type: str, created_at: str, parent_message: str, message_direction: str, pharmacy: str, json_data: str, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/implantable_devices\n@desc Retrieve or search implantable devices\n@optional {cursor: str, page_size: int, mu_date: str, patient: int, mu_date_range: str, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/patient_risk_assessments\n@optional {patient: int, doctor: int}\n@returns(201) {value_name: str, value_code_system: str, code: str, appointment: str, name: str, doctor: int, created_at: str, effective_time: str, value_code: str, patient: int, id: int, code_system: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patient_risk_assessments\n@optional {cursor: str, page_size: int, patient: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/task_statuses/{id}\n@desc Update an existing task status\n@required {id: str}\n@optional {since: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/task_statuses/{id}\n@desc Update an existing task status\n@required {id: str}\n@optional {since: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/task_statuses/{id}\n@desc Retrieve an existing task status\n@required {id: str}\n@optional {since: str}\n@returns(200) {archived: bool, name: str, status_category: str, practice_group: int, created_at: str, updated_at: str, id: int, task_category: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/patients_summary\n@optional {first_name: str, last_name: str, doctor: int, gender: str, since: str, date_of_birth: str}\n@returns(201) {medication_history_consent: str, last_name: str, emergency_contact_phone: str, primary_care_physician: str, date_of_first_appointment: str, tertiary_insurance: map{insurance_group_name: str, insurance_id_number: str, insurance_claim_office_number: str, subscriber_address: str, subscriber_state: str, subscriber_social_security: str, photo_front: str, subscriber_last_name: str, subscriber_middle_name: str, subscriber_date_of_birth: str, insurance_company: str, is_subscriber_the_patient: bool, insurance_plan_name: str, patient_relationship_to_subscriber: str, subscriber_gender: str, photo_back: str, subscriber_suffix: str, subscriber_zip_code: str, subscriber_city: str, insurance_plan_type: str, insurance_payer_id: str, subscriber_country: str, subscriber_first_name: str, insurance_group_number: str}, patient_flags_attached: [map], updated_at: str, custom_demographics: [map], referring_source: str, responsible_party_relation: str, zip_code: str, id: int, employer_city: str, employer_state: str, city: str, first_name: str, middle_name: str, doctor: int, race_subcategories: [map], disable_sms_messages: bool, employer: str, preferred_language_description: str, patient_flags: [map], date_of_birth: str, ethnicity: str, home_phone: str, pronouns: str, patient_status: str, patient_photo_date: str, gender_identity_description: str, email: str, responsible_party_email: str, patient_photo: str, responsible_party_phone: str, state: str, secondary_insurance: map{insurance_group_name: str, insurance_id_number: str, insurance_claim_office_number: str, subscriber_address: str, subscriber_state: str, subscriber_social_security: str, photo_front: str, subscriber_last_name: str, subscriber_middle_name: str, subscriber_date_of_birth: str, insurance_company: str, is_subscriber_the_patient: bool, insurance_plan_name: str, patient_relationship_to_subscriber: str, subscriber_gender: str, photo_back: str, subscriber_suffix: str, subscriber_zip_code: str, subscriber_city: str, insurance_plan_type: str, insurance_payer_id: str, subscriber_country: str, subscriber_first_name: str, insurance_group_number: str}, date_of_last_appointment: str, preferred_language_code: str, patient_payment_profile: str, date_of_death: str, social_security_number: str, auto_accident_insurance: map{auto_accident_claim_rep_city: str, auto_accident_claim_rep_state: str, auto_accident_claim_rep_address: str, auto_accident_will_require_therapy_rec: str, auto_accident_subscriber_middle_name: str, auto_accident_still_under_care: bool, auto_accident_significant_injury_notes: str, auto_accident_subscriber_first_name: str, auto_accident_subscriber_address: str, auto_accident_disabled_from_date: str, auto_accident_company: str, auto_accident_disabled_to_date: str, auto_accident_similar_condition_date: str, auto_accident_case_number: str, auto_accident_claim_rep_is_insurer: bool, auto_accident_payer_address: str, auto_accident_subscriber_last_name: str, auto_accident_subscriber_social_security: str, auto_accident_subscriber_phone_number: str, auto_accident_subscriber_city: str, auto_accident_significant_injury: str, auto_accident_similar_condition_notes: str, auto_accident_payer_id: str, auto_accident_payer_state: str, auto_accident_subscriber_zip_code: str, auto_accident_payer_zip: str, auto_accident_payer_city: str, auto_accident_will_require_therapy: bool, auto_accident_date_of_accident: str, auto_accident_subscriber_date_of_birth: str, auto_accident_subscriber_suffix: str, auto_accident_subscriber_state: str, auto_accident_return_to_work_date: str, auto_accident_notes: str, auto_accident_policy_number: str, auto_accident_is_subscriber_the_patient: bool, auto_accident_claim_rep_zip: str, auto_accident_state_of_occurrence: str, auto_accident_treatment_duration: str, auto_accident_had_similar_condition: bool, auto_accident_patient_relationship_to_subscriber: str, auto_accident_claim_rep_name: str}, address: str, chart_id: str, referring_doctor: map{fax: str, last_name: str, middle_name: str, suffix: str, first_name: str, provider_number: str, specialty: str, provider_qualifier: str, phone: str, address: str, npi: str, email: str}, primary_insurance: map{insurance_group_name: str, insurance_id_number: str, insurance_claim_office_number: str, subscriber_address: str, subscriber_state: str, subscriber_social_security: str, photo_front: str, subscriber_last_name: str, subscriber_middle_name: str, subscriber_date_of_birth: str, insurance_company: str, is_subscriber_the_patient: bool, insurance_plan_name: str, patient_relationship_to_subscriber: str, subscriber_gender: str, photo_back: str, subscriber_suffix: str, subscriber_zip_code: str, subscriber_city: str, insurance_plan_type: str, insurance_payer_id: str, subscriber_country: str, subscriber_first_name: str, insurance_group_number: str}, preferred_language: str, responsible_party_name: str, nick_name: str, copay: str, created_at: str, emergency_contact_relation: str, gender_identity_code: str, office_phone: str, employer_address: str, race: str, offices: [int], preferred_pharmacies: [str], emergency_contact_name: str, gender: str, default_pharmacy: str, cell_phone: str, employer_zip_code: str, workers_comp_insurance: map{workers_comp_payer_city: str, workers_comp_payer_id: str, workers_comp_group_name: str, workers_comp_wcb: str, workers_comp_carrier_code: str, workers_comp_notes: str, property_and_casualty_agency_claim_number: str, workers_comp_state_of_occurrence: str, workers_comp_payer_zip: str, workers_comp_wcb_rating_code: str, workers_comp_case_number: str, workers_comp_group_number: str, workers_comp_company: str, workers_comp_payer_address: str, workers_comp_date_of_accident: str, workers_comp_payer_state: str}} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patients_summary\n@optional {cursor: str, page_size: int, first_name: str, last_name: str, doctor: int, gender: str, since: str, date_of_birth: str}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/documents/{id}\n@desc Update an existing patient document\n@required {id: str}\n@optional {since: str, patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/documents/{id}\n@desc Update an existing patient document\n@required {id: str}\n@optional {since: str, patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/documents/{id}\n@desc Retrieve an existing patient document\n@required {id: str}\n@optional {since: str, patient: int, doctor: int}\n@returns(200) {archived: bool, patient: int, description: str, doctor: int, metatags: str, updated_at: str, date: str, document: str, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint DELETE /api/documents/{id}\n@desc Delete an existing appointment template\n@required {id: str}\n@optional {since: str, patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/office_work_schedule\n@desc Get the work schedule for the authed doctor's primary office (beta)\n@returns(200) {work_days: [map], id: int, office: int, doctor: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/patients/{id}/onpatient_access\n@desc Send new onpatient invite to patient\n@required {id: str}\n@optional {first_name: str, last_name: str, preferred_language: str, doctor: int, gender: str, since: str, date_of_birth: str, race: str, chart_id: str, email: str, ethnicity: str}\n@returns(201) {medication_history_consent: str, last_name: str, emergency_contact_phone: str, primary_care_physician: str, date_of_first_appointment: str, tertiary_insurance: map{insurance_group_name: str, insurance_id_number: str, insurance_claim_office_number: str, subscriber_address: str, subscriber_state: str, subscriber_social_security: str, photo_front: str, subscriber_last_name: str, subscriber_middle_name: str, subscriber_date_of_birth: str, insurance_company: str, is_subscriber_the_patient: bool, insurance_plan_name: str, patient_relationship_to_subscriber: str, subscriber_gender: str, photo_back: str, subscriber_suffix: str, subscriber_zip_code: str, subscriber_city: str, insurance_plan_type: str, insurance_payer_id: str, subscriber_country: str, subscriber_first_name: str, insurance_group_number: str}, patient_flags_attached: [map], updated_at: str, custom_demographics: [map], referring_source: str, responsible_party_relation: str, zip_code: str, id: int, employer_city: str, employer_state: str, city: str, first_name: str, middle_name: str, doctor: int, race_subcategories: [map], disable_sms_messages: bool, employer: str, preferred_language_description: str, patient_flags: [map], date_of_birth: str, ethnicity: str, home_phone: str, pronouns: str, patient_status: str, patient_photo_date: str, gender_identity_description: str, email: str, responsible_party_email: str, patient_photo: str, responsible_party_phone: str, state: str, secondary_insurance: map{insurance_group_name: str, insurance_id_number: str, insurance_claim_office_number: str, subscriber_address: str, subscriber_state: str, subscriber_social_security: str, photo_front: str, subscriber_last_name: str, subscriber_middle_name: str, subscriber_date_of_birth: str, insurance_company: str, is_subscriber_the_patient: bool, insurance_plan_name: str, patient_relationship_to_subscriber: str, subscriber_gender: str, photo_back: str, subscriber_suffix: str, subscriber_zip_code: str, subscriber_city: str, insurance_plan_type: str, insurance_payer_id: str, subscriber_country: str, subscriber_first_name: str, insurance_group_number: str}, date_of_last_appointment: str, preferred_language_code: str, patient_payment_profile: str, date_of_death: str, social_security_number: str, auto_accident_insurance: map{auto_accident_claim_rep_city: str, auto_accident_claim_rep_state: str, auto_accident_claim_rep_address: str, auto_accident_will_require_therapy_rec: str, auto_accident_subscriber_middle_name: str, auto_accident_still_under_care: bool, auto_accident_significant_injury_notes: str, auto_accident_subscriber_first_name: str, auto_accident_subscriber_address: str, auto_accident_disabled_from_date: str, auto_accident_company: str, auto_accident_disabled_to_date: str, auto_accident_similar_condition_date: str, auto_accident_case_number: str, auto_accident_claim_rep_is_insurer: bool, auto_accident_payer_address: str, auto_accident_subscriber_last_name: str, auto_accident_subscriber_social_security: str, auto_accident_subscriber_phone_number: str, auto_accident_subscriber_city: str, auto_accident_significant_injury: str, auto_accident_similar_condition_notes: str, auto_accident_payer_id: str, auto_accident_payer_state: str, auto_accident_subscriber_zip_code: str, auto_accident_payer_zip: str, auto_accident_payer_city: str, auto_accident_will_require_therapy: bool, auto_accident_date_of_accident: str, auto_accident_subscriber_date_of_birth: str, auto_accident_subscriber_suffix: str, auto_accident_subscriber_state: str, auto_accident_return_to_work_date: str, auto_accident_notes: str, auto_accident_policy_number: str, auto_accident_is_subscriber_the_patient: bool, auto_accident_claim_rep_zip: str, auto_accident_state_of_occurrence: str, auto_accident_treatment_duration: str, auto_accident_had_similar_condition: bool, auto_accident_patient_relationship_to_subscriber: str, auto_accident_claim_rep_name: str}, address: str, chart_id: str, referring_doctor: map{fax: str, last_name: str, middle_name: str, suffix: str, first_name: str, provider_number: str, specialty: str, provider_qualifier: str, phone: str, address: str, npi: str, email: str}, primary_insurance: map{insurance_group_name: str, insurance_id_number: str, insurance_claim_office_number: str, subscriber_address: str, subscriber_state: str, subscriber_social_security: str, photo_front: str, subscriber_last_name: str, subscriber_middle_name: str, subscriber_date_of_birth: str, insurance_company: str, is_subscriber_the_patient: bool, insurance_plan_name: str, patient_relationship_to_subscriber: str, subscriber_gender: str, photo_back: str, subscriber_suffix: str, subscriber_zip_code: str, subscriber_city: str, insurance_plan_type: str, insurance_payer_id: str, subscriber_country: str, subscriber_first_name: str, insurance_group_number: str}, preferred_language: str, responsible_party_name: str, nick_name: str, copay: str, created_at: str, emergency_contact_relation: str, gender_identity_code: str, office_phone: str, employer_address: str, race: str, offices: [int], preferred_pharmacies: [str], emergency_contact_name: str, gender: str, default_pharmacy: str, cell_phone: str, employer_zip_code: str, workers_comp_insurance: map{workers_comp_payer_city: str, workers_comp_payer_id: str, workers_comp_group_name: str, workers_comp_wcb: str, workers_comp_carrier_code: str, workers_comp_notes: str, property_and_casualty_agency_claim_number: str, workers_comp_state_of_occurrence: str, workers_comp_payer_zip: str, workers_comp_wcb_rating_code: str, workers_comp_case_number: str, workers_comp_group_number: str, workers_comp_company: str, workers_comp_payer_address: str, workers_comp_date_of_accident: str, workers_comp_payer_state: str}} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patients/{id}/onpatient_access\n@desc Retrieve or search existing onpatient access invites\n@required {id: str}\n@optional {first_name: str, last_name: str, preferred_language: str, doctor: int, gender: str, since: str, date_of_birth: str, race: str, chart_id: str, email: str, ethnicity: str}\n@returns(200) {medication_history_consent: str, last_name: str, emergency_contact_phone: str, primary_care_physician: str, date_of_first_appointment: str, tertiary_insurance: map{insurance_group_name: str, insurance_id_number: str, insurance_claim_office_number: str, subscriber_address: str, subscriber_state: str, subscriber_social_security: str, photo_front: str, subscriber_last_name: str, subscriber_middle_name: str, subscriber_date_of_birth: str, insurance_company: str, is_subscriber_the_patient: bool, insurance_plan_name: str, patient_relationship_to_subscriber: str, subscriber_gender: str, photo_back: str, subscriber_suffix: str, subscriber_zip_code: str, subscriber_city: str, insurance_plan_type: str, insurance_payer_id: str, subscriber_country: str, subscriber_first_name: str, insurance_group_number: str}, patient_flags_attached: [map], updated_at: str, custom_demographics: [map], referring_source: str, responsible_party_relation: str, zip_code: str, id: int, employer_city: str, employer_state: str, city: str, first_name: str, middle_name: str, doctor: int, race_subcategories: [map], disable_sms_messages: bool, employer: str, preferred_language_description: str, patient_flags: [map], date_of_birth: str, ethnicity: str, home_phone: str, pronouns: str, patient_status: str, patient_photo_date: str, gender_identity_description: str, email: str, responsible_party_email: str, patient_photo: str, responsible_party_phone: str, state: str, secondary_insurance: map{insurance_group_name: str, insurance_id_number: str, insurance_claim_office_number: str, subscriber_address: str, subscriber_state: str, subscriber_social_security: str, photo_front: str, subscriber_last_name: str, subscriber_middle_name: str, subscriber_date_of_birth: str, insurance_company: str, is_subscriber_the_patient: bool, insurance_plan_name: str, patient_relationship_to_subscriber: str, subscriber_gender: str, photo_back: str, subscriber_suffix: str, subscriber_zip_code: str, subscriber_city: str, insurance_plan_type: str, insurance_payer_id: str, subscriber_country: str, subscriber_first_name: str, insurance_group_number: str}, date_of_last_appointment: str, preferred_language_code: str, patient_payment_profile: str, date_of_death: str, social_security_number: str, auto_accident_insurance: map{auto_accident_claim_rep_city: str, auto_accident_claim_rep_state: str, auto_accident_claim_rep_address: str, auto_accident_will_require_therapy_rec: str, auto_accident_subscriber_middle_name: str, auto_accident_still_under_care: bool, auto_accident_significant_injury_notes: str, auto_accident_subscriber_first_name: str, auto_accident_subscriber_address: str, auto_accident_disabled_from_date: str, auto_accident_company: str, auto_accident_disabled_to_date: str, auto_accident_similar_condition_date: str, auto_accident_case_number: str, auto_accident_claim_rep_is_insurer: bool, auto_accident_payer_address: str, auto_accident_subscriber_last_name: str, auto_accident_subscriber_social_security: str, auto_accident_subscriber_phone_number: str, auto_accident_subscriber_city: str, auto_accident_significant_injury: str, auto_accident_similar_condition_notes: str, auto_accident_payer_id: str, auto_accident_payer_state: str, auto_accident_subscriber_zip_code: str, auto_accident_payer_zip: str, auto_accident_payer_city: str, auto_accident_will_require_therapy: bool, auto_accident_date_of_accident: str, auto_accident_subscriber_date_of_birth: str, auto_accident_subscriber_suffix: str, auto_accident_subscriber_state: str, auto_accident_return_to_work_date: str, auto_accident_notes: str, auto_accident_policy_number: str, auto_accident_is_subscriber_the_patient: bool, auto_accident_claim_rep_zip: str, auto_accident_state_of_occurrence: str, auto_accident_treatment_duration: str, auto_accident_had_similar_condition: bool, auto_accident_patient_relationship_to_subscriber: str, auto_accident_claim_rep_name: str}, address: str, chart_id: str, referring_doctor: map{fax: str, last_name: str, middle_name: str, suffix: str, first_name: str, provider_number: str, specialty: str, provider_qualifier: str, phone: str, address: str, npi: str, email: str}, primary_insurance: map{insurance_group_name: str, insurance_id_number: str, insurance_claim_office_number: str, subscriber_address: str, subscriber_state: str, subscriber_social_security: str, photo_front: str, subscriber_last_name: str, subscriber_middle_name: str, subscriber_date_of_birth: str, insurance_company: str, is_subscriber_the_patient: bool, insurance_plan_name: str, patient_relationship_to_subscriber: str, subscriber_gender: str, photo_back: str, subscriber_suffix: str, subscriber_zip_code: str, subscriber_city: str, insurance_plan_type: str, insurance_payer_id: str, subscriber_country: str, subscriber_first_name: str, insurance_group_number: str}, preferred_language: str, responsible_party_name: str, nick_name: str, copay: str, created_at: str, emergency_contact_relation: str, gender_identity_code: str, office_phone: str, employer_address: str, race: str, offices: [int], preferred_pharmacies: [str], emergency_contact_name: str, gender: str, default_pharmacy: str, cell_phone: str, employer_zip_code: str, workers_comp_insurance: map{workers_comp_payer_city: str, workers_comp_payer_id: str, workers_comp_group_name: str, workers_comp_wcb: str, workers_comp_carrier_code: str, workers_comp_notes: str, property_and_casualty_agency_claim_number: str, workers_comp_state_of_occurrence: str, workers_comp_payer_zip: str, workers_comp_wcb_rating_code: str, workers_comp_case_number: str, workers_comp_group_number: str, workers_comp_company: str, workers_comp_payer_address: str, workers_comp_date_of_accident: str, workers_comp_payer_state: str}} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint DELETE /api/patients/{id}/onpatient_access\n@desc Revoke sent onpatient invites\n@required {id: str}\n@optional {first_name: str, last_name: str, preferred_language: str, doctor: int, gender: str, since: str, date_of_birth: str, race: str, chart_id: str, email: str, ethnicity: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/comm_logs\n@desc Create communication (phone call) logs\n@optional {since: str, patient: int, doctor: int}\n@returns(201) {scheduled_time: str, archived: bool, appointment: int, doctor: int, title: str, created_at: str, author: str, updated_at: str, cash_charged: num, duration: int, patient: int, message: str, type: str, id: int} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/comm_logs\n@desc Retrieve or search communicatioin (phone call) logs\n@optional {cursor: str, page_size: int, since: str, patient: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/lab_results/{id}\n@desc Update an existing lab result\n@required {id: str}\n@optional {order: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/lab_results/{id}\n@desc Update an existing lab result\n@required {id: str}\n@optional {order: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/lab_results/{id}\n@desc Retrieve an existing lab result\n@required {id: str}\n@optional {order: int, doctor: int}\n@returns(200) {status: str, group_code: str, observation_description: str, is_abnormal: str, observation_code: str, specimen_received: str, comments: str, normal_range: str, test_performed: str, value: str, abnormal_status: str, lab_order: str, value_is_numeric: bool, document: int, lab_test: int, id: int, unit: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint DELETE /api/lab_results/{id}\n@desc Delete an existing lab result\n@required {id: str}\n@optional {order: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/medications/{id}\n@desc Update an existing patient medications\n@required {id: str}\n@optional {patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/medications/{id}\n@desc Update an existing patient medications\n@required {id: str}\n@optional {patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/medications/{id}\n@desc Retrieve an existing patient medications\n@required {id: str}\n@optional {patient: int, doctor: int}\n@returns(200) {dispense_quantity: num, prn: bool, pharmacy_note: str, number_refills: int, patient: int, id: int, dosage_quantity: str, doctor: int, date_started_taking: str, dosage_units: str, date_stopped_taking: str, order_status: str, status: str, appointment: int, daw: bool, rxnorm: str, date_prescribed: str, name: str, ndc: str, notes: str, frequency: str, indication: str, signature_note: str, route: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/day_sheet_credits\n@desc Retrieve daysheet credits/adjustments report for a given date range\n@required {start_date: str, end_date: str}\n@optional {credits_date_type: str, report_type: str, claim_type: str, patient_id: int, office_id: str, examroom_id: int, pg_mode: bool}\n\n@endpoint POST /api/task_templates\n@desc Create a task template\n@optional {assignee_user: int, status: int, assignee_group: int, since: str, category: int}\n@returns(201) {archived: bool, name: str, practice_group: str, default_category: int, updated_at: str, default_title: str, default_note: str, default_status: int, id: int, default_assignee_group: int, default_assignee_user: str, default_due_date_offset: str, created_at: str, default_priority: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/task_templates\n@desc Retrieve or search task templates\n@optional {cursor: str, page_size: int, assignee_user: int, status: int, assignee_group: int, since: str, category: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/transactions_list\n@desc Create transactions list request.  Use the UUID returned in the response to retrieve the batch of records. Results returned in order of id or updated_at.\n@optional {order_by: str # Order results by a specific field. Valid options include [id, updated_at]. Default: id., page_size: int # Number of results to return per page. Value between 1 and 1000., page: int # Number of page to return. Value between 1 and max number of pages in result set., line_item: int # Line item ID, posted_date: str # Posted date, appointment: int # appointment, since: str # since, doctor: int # doctor, verbose: bool # When True includes full details}\n@returns(201) {status: str, uuid: str, description: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /api/transactions_list\n@desc Retrieve or search transactions in batches. Results returned in order of ID or updated_at.\n@required {uuid: str # The UUID token for the batch of transactions.  This is returned in the response of the `create` endpoint.}\n@returns(200) {status: str, pagination: map{count: int, pages: int, page: int}, results: [map], uuid: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /api/medications/{id}/append_to_pharmacy_note\n@desc Append a message to the \"pharmacy_note\" section of the prescription, in a new paragraph\n@required {id: str}\n@optional {patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/office_work_schedule/{id}\n@desc Update an existing office's entire work schedule\n@required {id: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/office_work_schedule/{id}\n@desc Update an existing office's work schedule\n@required {id: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/office_work_schedule/{id}\n@desc Retrieve a work schedule (beta)\n@required {id: str}\n@returns(200) {work_days: [map], id: int, office: int, doctor: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/patient_vaccine_records/{id}\n@desc Update an existing patient vaccine records\n@required {id: str}\n@optional {cvx_code: str, patient: int, since: str, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/patient_vaccine_records/{id}\n@desc Update an existing patient vaccine records\n@required {id: str}\n@optional {cvx_code: str, patient: int, since: str, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patient_vaccine_records/{id}\n@desc Retrieve an existing patient vaccine records\n@required {id: str}\n@optional {cvx_code: str, patient: int, since: str, doctor: int}\n@returns(200) {lot_number: str, site: str, ordering_doctor: int, doses: [map], id: int, next_dose_date: str, cpt_code: str, completion_status: str, administered_at: int, comments: str, funding_eligibility: str, units: str, entered_by: str, patient: int, administration_start: str, record_source: str, updated_at: str, consent_form: int, manufacturer: str, administered_by: str, name: str, vis: str, created_at: str, observed_immunity: str, amount: num, vaccine_inventory: int, route: str, cvx_code: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/patient_flag_types/{id}\n@desc Update an existing patient flag type\n@required {id: str}\n@optional {doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/patient_flag_types/{id}\n@desc Update an existing patient flag type\n@required {id: str}\n@optional {doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patient_flag_types/{id}\n@desc Retrieve an existing patient flag type\n@required {id: str}\n@optional {doctor: int}\n@returns(200) {archived: bool, name: str, doctor: int, color: str, created_at: str, updated_at: str, priority: int, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/inventory_categories/{id}\n@desc Retrieve an existing inventory category\n@required {id: str}\n@optional {since: str, doctor: int}\n@returns(200) {archived: bool, name: str, doctor: str, created_at: str, updated_at: str, category_type: str, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/clinical_note_field_types/{id}\n@desc Update the `freedraw_image_size` of an existing clinical note FreeDraw Field\n@required {id: str}\n@optional {freedraw_image_size: str(/150x300/300x600/450x900/600x1200/750x1500) # Size setting for the free-draw image field:   - \"\" = Actual size (native resolution)   - \"150x300\" = Extra Small   - \"300x600\" = Small   - \"450x900\" = Medium   - \"600x1200\" = Large   - \"750x1500\" = Extra Large}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/clinical_note_field_types/{id}\n@desc Retrieve an existing clinial note field type\n@required {id: str}\n@optional {clinical_note_template: int, doctor: int}\n@returns(200) {comment: str, archived: bool, clinical_note_template: str, data_type: str, required: bool, allowed_values: [str], id: int, name: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/tasks/{id}\n@desc Update an existing task\n@required {id: str}\n@optional {status: int, category: int, due_at_date: str, due_at_unknown: str, since: str, due_at_since: str, assignee_user: int, assignee_group: int, due_at_range: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/tasks/{id}\n@desc Update an existing task\n@required {id: str}\n@optional {status: int, category: int, due_at_date: str, due_at_unknown: str, since: str, due_at_since: str, assignee_user: int, assignee_group: int, due_at_range: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/tasks/{id}\n@desc Retrieve an existing task\n@required {id: str}\n@optional {status: int, category: int, due_at_date: str, due_at_unknown: str, since: str, due_at_since: str, assignee_user: int, assignee_group: int, due_at_range: str}\n@returns(200) {category: int, due_date: map{time: str}, archived: bool, associated_items: [map], assigned_by: str, assignee_user: str, created_at: str, assignee_group: int, updated_at: str, created_by: str, priority: str, status: int, notes: [map], title: str, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/doctor_work_schedule\n@desc Get the work schedule for the authed doctor's primary office (beta)\n@returns(200) {work_days: [map], id: int, office: int, doctor: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/doctor_options\n@desc Retrieve or search doctor options within practice group\n@optional {cursor: str, page_size: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/fee_schedules\n@optional {cursor: str, page_size: int, code: str, code_type: str, since: str, payer_id: str, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/patient_risk_assessments/{id}\n@required {id: str}\n@optional {patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/patient_risk_assessments/{id}\n@required {id: str}\n@optional {patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patient_risk_assessments/{id}\n@required {id: str}\n@optional {patient: int, doctor: int}\n@returns(200) {value_name: str, value_code_system: str, code: str, appointment: str, name: str, doctor: int, created_at: str, effective_time: str, value_code: str, patient: int, id: int, code_system: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/inventory_categories\n@desc Retrieve or search inventory categories\n@optional {cursor: str, page_size: int, since: str, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/lab_documents/{id}\n@desc Update an existing lab order document\n@required {id: str}\n@optional {since: str, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/lab_documents/{id}\n@desc Update an existing lab order document\n@required {id: str}\n@optional {since: str, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/lab_documents/{id}\n@desc Retrieve an existing appointment template\n@required {id: str}\n@optional {since: str, doctor: int}\n@returns(200) {hl7: str, timestamp: str, lab_order: int, document: str, type: str, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint DELETE /api/lab_documents/{id}\n@desc Delete an existing lab order document\n@required {id: str}\n@optional {since: str, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/appointment_templates/{id}\n@desc Update an existing appointment template\n@required {id: str}\n@optional {profile: int, office: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/appointment_templates/{id}\n@desc Update an existing appointment template\n@required {id: str}\n@optional {profile: int, office: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/appointment_templates/{id}\n@desc Retrieve an existing appointment template\n@required {id: str}\n@optional {profile: int, office: int, doctor: int}\n@returns(200) {profile: int, scheduled_time: str, archived: bool, week_days: [int], office: int, open_slots: [map], date_end: str, date_start: str, exam_room: int, duration: int, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint DELETE /api/appointment_templates/{id}\n@desc Delete an existing appointment template\n@required {id: str}\n@optional {profile: int, office: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/patient_interventions/{id}\n@desc Update an existing patient intervention for CQM\n@required {id: str}\n@optional {patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/patient_interventions/{id}\n@desc Update an existing patient intervention for CQM\n@required {id: str}\n@optional {patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patient_interventions/{id}\n@desc Retrieve an existing patient intervention for CQM\n@required {id: str}\n@optional {patient: int, doctor: int}\n@returns(200) {value_name: str, value_code_system: str, code: str, appointment: str, name: str, doctor: int, created_at: str, effective_time: str, value_code: str, patient: int, id: int, code_system: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/task_statuses\n@desc Create a task status\n@optional {since: str}\n@returns(201) {archived: bool, name: str, status_category: str, practice_group: int, created_at: str, updated_at: str, id: int, task_category: int} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/task_statuses\n@desc Retrieve or search task statuses\n@optional {cursor: str, page_size: int, since: str}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/allergies/{id}\n@desc Update an existing patient allergy\n@required {id: str}\n@optional {patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/allergies/{id}\n@desc Update an existing patient allergy\n@required {id: str}\n@optional {patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/allergies/{id}\n@desc Retrieve an existing patient allergy\n@required {id: str}\n@optional {patient: int, doctor: int}\n@returns(200) {status: str, reaction: str, patient: int, description: str, doctor: int, snomed_reaction: str, notes: str, verification_status: str, snomed_code: str, rxnorm: str, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patients/{id}/ccda\n@desc Retrieve patient CCDA\n@required {id: str}\n@optional {first_name: str, last_name: str, preferred_language: str, doctor: int, gender: str, since: str, date_of_birth: str, race: str, chart_id: str, email: str, ethnicity: str}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patient_payments/{id}\n@desc Retrieve an existing patient payment\n@required {id: str}\n@optional {since: str, patient: int, doctor: int}\n@returns(200) {line_item: int, posted_date: str, appointment: int, doctor: int, payment_method: str, created_at: str, payment_transaction_type: str, created_by: str, updated_at: str, amount: num, notes: str, trace_number: str, patient: int, id: int, received_date: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/lab_orders_summary\n@optional {cursor: str, page_size: int, since: str, patient: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/patient_payments\n@desc Create patient payment\n@optional {since: str, patient: int, doctor: int}\n@returns(201) {line_item: int, posted_date: str, appointment: int, doctor: int, payment_method: str, created_at: str, payment_transaction_type: str, created_by: str, updated_at: str, amount: num, notes: str, trace_number: str, patient: int, id: int, received_date: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patient_payments\n@desc Retrieve or search patient payments\n@optional {cursor: str, page_size: int, since: str, posted_date: str, patient: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/clinical_note_field_values_list\n@desc Create clinical note field value list request.  Use the UUID returned in the response to retrieve the batch of records. Results returned in order of ID.\n@optional {order_by: str # Order results by a specific field. Valid options include [id, updated_at]. Default: id., page_size: int, page: int, since: str, appointment: int, clinical_note_template: int}\n@returns(201) {status: str, uuid: str, description: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /api/clinical_note_field_values_list\n@desc Retrieve or search clinical note values (soap notes) in batches. Results returned in order of ID or by updated_at.\n@optional {uuid: str # The UUID token for the batch of requested data. This is returned in the response of the `create` endpoint.}\n@returns(200) {status: str, pagination: map{count: int, pages: int, page: int}, results: [map], uuid: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /api/care_plans/{id}\n@desc Retrieve an existing care plan\n@required {id: str}\n@optional {patient: int, plan_type: int, doctor: int}\n@returns(200) {code: str, appointment: str, description: str, title: str, created_at: str, plan_type: str, updated_at: str, scheduled_date: str, patient: str, id: int, code_system: str, instructions: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/billing_profiles\n@desc Retrieve or search billing profiles\n@optional {cursor: str, page_size: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/billing_profiles/{id}\n@desc Retrieve an existing billing profiles\n@required {id: str}\n@optional {doctor: int}\n@returns(200) {cpt_codes: [map], archived: bool, icd9_codes: [str], name: str, hcpcs_codes: [map], created_at: str, doctor: str, updated_at: str, custom_procedure_codes: [map], icd10_codes: [str], id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/availability\n@desc Retrieve availability slots for the given date and office, doctor, or exam room.\n@optional {office: int # Office ID to filter availability., doctor: int # Doctor ID to filter availability., date: str # Date for which to retrieve availability (YYYY-MM-DD)., date_range: str # Date range for which to retrieve availability (YYYY-MM-DD/YYYY-MM-DD)., duration: int # Duration of the appointment in minutes., exam_room: int # Exam room ID to filter availability. If not specified, availability for all exam rooms will be included.}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/task_templates/{id}\n@desc Update an existing task template\n@required {id: str}\n@optional {assignee_user: int, status: int, assignee_group: int, since: str, category: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/task_templates/{id}\n@desc Update an existing task template\n@required {id: str}\n@optional {assignee_user: int, status: int, assignee_group: int, since: str, category: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/task_templates/{id}\n@desc Retrieve an existing task template\n@required {id: str}\n@optional {assignee_user: int, status: int, assignee_group: int, since: str, category: int}\n@returns(200) {archived: bool, name: str, practice_group: str, default_category: int, updated_at: str, default_title: str, default_note: str, default_status: int, id: int, default_assignee_group: int, default_assignee_user: str, default_due_date_offset: str, created_at: str, default_priority: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/fee_schedules/{id}\n@required {id: str}\n@optional {code: str, code_type: str, since: str, payer_id: str, doctor: int}\n@returns(200) {code_type: str, insured_out_of_network_price: num, office: int, updated_at: str, code: str, billing_description: str, id: int, picklist_category: str, allowed_amount: num, ndc_quantity: num, cash_price: num, plan_name: str, description: str, ndc_units: str, ndc_code: str, payer_id: str, cpt_hcpcs_modifier2: str, cpt_hcpcs_modifier3: str, cpt_hcpcs_modifier1: str, cpt_hcpcs_modifier4: str, created_at: str, doctor: int, insured_price: num, base_price: num} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/appointments/{id}\n@desc Update an existing appointment or break\n@required {id: str # Appointment ID, office: int # Office ID, scheduled_time: str # The starting time of the appointment, doctor: int # Doctor ID, patient: int # ID of this appointment's patient. Breaks have a null patient field., exam_room: int # Index of the exam room that this appointment occurs in. See `/api/offices`}\n@optional {status: str(/Arrived/Checked In/Checked In Online/In Room/In Session/Complete/Confirmed/Not Confirmed/Rescheduled/Cancelled/No Show) # One of ``, `Arrived`, `Checked In`, `In Room`, `Cancelled`, `Complete`, `Confirmed`, `In Session`, `No Show`, `Not Confirmed`, or `Rescheduled`. Or one of the custom statuses., icd9_codes: [str], base_recurring_appointment: str # ID of base appointment of a recurring series, color: str, vitals: map{height_units: str, weight_units: str, pain: str, temperature: num, weight: num, smoking_status: str, head_circumference: num, bmi: str, head_circumference_units: str, blood_pressure_2: int, blood_pressure_1: int, height: num, pulse: int, oxygen_saturation: num, respiratory_rate: int, temperature_units: str} # Clinical vitals associated with the appointment, first_billed_date: str, last_billed_date: str, billing_status: str # Should be one of `Auto Accident Claim`, `Balance Due`, `Bill Insurance`, `Bill Secondary Insurance`, `Durable Medical Equipment Claim`, `Internal Review`, `Paid In Full`, `Settled`, `Worker's Comp Claim` or one of the custom billing status, primary_insurer_payer_id: str, duration: int # Length of the appointment in minutes. Optional if `profile` is provided., is_membership_appointment: bool # Whether the appointment is a membership plan charge rather than a real visit. DrChrono creates one future dated placeholder appointment per billing cycle of a patient's membership plan so the charge has something to attach to. They are hidden from the DrChrono calendar and never trigger DrChrono reminders, so appointment reminder integrations should skip them, or pass `exclude_membership=true` to leave them out of the response., appt_is_break: bool, id: str # Unique identifier. Usually numeric, but not always, custom_fields: [map{field_type: int, created_at: str, updated_at: str, field_value: str}] # Custom appointment fields, secondary_insurer_name: str, recur_start_date: str # For recurring appointments, the start date of the recurring series, primary_insurance_id_number: str, created_by: str, ins2_status: str(/Incomplete Information/In Process Emdeon/Rejected Emdeon/Rejected EPS/Rejected Jopari/In Process Payor/Rejected Waystar Professional/Rejected Waystar Institutional/In Process Payer/Payer Acknowledged/Rejected Payor/Rejected Payer/Paid in Full/Partially Paid/Coordination of Benefits/ERA Received/ERA Denied/HCFA Form Faxed) # Billing status of secondary insurer, first_edi_date: str, billing_notes: [map{text: str, created_at: str, appointment: int, id: int, created_by: str}] # Billing notes of the appointment. For writing, check `/api/claim_billing_notes`, is_walk_in: bool # Whether the appointment is a walk-in appointment, billing_provider: str, reminder_profile: str # Write-only. ID of an `/api/reminder_profiles` instance. Set this to apply a reminder profile to the appointment. Cannot be applied to an appointment with reminders., primary_insurer_name: str, profile: int # ID of an `/api/appointment_profiles` instance. The profile sets default values for `color`, `duration`, and `reason` on creation, which can be overriden by setting these values explicitly., resubmit_claim_original_id: int # ID of this claim id., recurrence_instance_key: str # A stable identifier for a recurring appointment instance, in the format `{rootSeriesId}_{YYYYMMDD}` where `YYYYMMDD` is the original occurrence date, not the current scheduled date. This value remains consistent across materialization, series splits, and rescheduling, so it should be treated as an opaque identifier rather than a source for display dates. Returns null for non-recurring appointments. Only present when the `consistent_recurrence_id` feature flag is enabled., cloned_from: int # ID of the original appointment which this appointment cloned from. Will be null if the appointment is not cloned., extended_updated_at: str # The most recent update time among appointment itself, its vitals and its custom vitals, updated_at: str, reason: str # Default to `\"\"`, last_edi_date: str, secondary_insurer_payer_id: str, allow_overlapping: bool # Bypass overlap check., payment_profile: str # Appointment Payment Profile, secondary_insurance_id_number: str, clinical_note: map{pdf: str, locked: bool, updated_at: str} # Associated clinical note object, custom_vitals: [map{value: str, vital_type: int}] # Custom vitals associated with this appointment., is_virtual_base: bool, recurring_appointment: bool # Whether the appointment is a recurring appointment or not, supervising_provider: str # Supervising provider of appointment if set., recurring_days: [any] # For recurring appointments, the days of the week on which the appointment recurs. Can include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday or Sunday, status_transitions: [map{appointment: str, to_status: str, from_status: str, datetime: str}], created_at: str, reminders: [map{scheduled_time: str, type: str, id: int}] # Scheduled reminders of the appointment, ins1_status: str(/Incomplete Information/In Process Emdeon/Rejected Emdeon/Rejected EPS/Rejected Jopari/In Process Payor/Rejected Waystar Professional/Rejected Waystar Institutional/In Process Payer/Payer Acknowledged/Rejected Payor/Rejected Payer/Paid in Full/Partially Paid/Coordination of Benefits/ERA Received/ERA Denied/HCFA Form Faxed) # Billing status of primary insurer, custom_status: str # AppointmentStatus Name, recur_end_date: str # For recurring appointments, the end date of the recurring series, icd10_codes: [str], deleted_flag: bool # Whether the appointment is deleted., notes: str, recurs_every: int # For recurring appointments, the number of weeks between recurrences. For example, if this is 2, the appointment recurs every other week.}\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 409: Scheduled time overlaps with an existing appointment, 500: Internal Server Error}\n\n@endpoint PATCH /api/appointments/{id}\n@desc Update an existing appointment or break\n@required {id: str # Appointment ID, office: int # Office ID, scheduled_time: str # The starting time of the appointment, doctor: int # Doctor ID, patient: int # ID of this appointment's patient. Breaks have a null patient field., exam_room: int # Index of the exam room that this appointment occurs in. See `/api/offices`}\n@optional {status: str(/Arrived/Checked In/Checked In Online/In Room/In Session/Complete/Confirmed/Not Confirmed/Rescheduled/Cancelled/No Show) # One of ``, `Arrived`, `Checked In`, `In Room`, `Cancelled`, `Complete`, `Confirmed`, `In Session`, `No Show`, `Not Confirmed`, or `Rescheduled`. Or one of the custom statuses., icd9_codes: [str], base_recurring_appointment: str # ID of base appointment of a recurring series, color: str, vitals: map{height_units: str, weight_units: str, pain: str, temperature: num, weight: num, smoking_status: str, head_circumference: num, bmi: str, head_circumference_units: str, blood_pressure_2: int, blood_pressure_1: int, height: num, pulse: int, oxygen_saturation: num, respiratory_rate: int, temperature_units: str} # Clinical vitals associated with the appointment, first_billed_date: str, last_billed_date: str, billing_status: str # Should be one of `Auto Accident Claim`, `Balance Due`, `Bill Insurance`, `Bill Secondary Insurance`, `Durable Medical Equipment Claim`, `Internal Review`, `Paid In Full`, `Settled`, `Worker's Comp Claim` or one of the custom billing status, primary_insurer_payer_id: str, duration: int # Length of the appointment in minutes. Optional if `profile` is provided., is_membership_appointment: bool # Whether the appointment is a membership plan charge rather than a real visit. DrChrono creates one future dated placeholder appointment per billing cycle of a patient's membership plan so the charge has something to attach to. They are hidden from the DrChrono calendar and never trigger DrChrono reminders, so appointment reminder integrations should skip them, or pass `exclude_membership=true` to leave them out of the response., appt_is_break: bool, id: str # Unique identifier. Usually numeric, but not always, custom_fields: [map{field_type: int, created_at: str, updated_at: str, field_value: str}] # Custom appointment fields, secondary_insurer_name: str, recur_start_date: str # For recurring appointments, the start date of the recurring series, primary_insurance_id_number: str, created_by: str, ins2_status: str(/Incomplete Information/In Process Emdeon/Rejected Emdeon/Rejected EPS/Rejected Jopari/In Process Payor/Rejected Waystar Professional/Rejected Waystar Institutional/In Process Payer/Payer Acknowledged/Rejected Payor/Rejected Payer/Paid in Full/Partially Paid/Coordination of Benefits/ERA Received/ERA Denied/HCFA Form Faxed) # Billing status of secondary insurer, first_edi_date: str, billing_notes: [map{text: str, created_at: str, appointment: int, id: int, created_by: str}] # Billing notes of the appointment. For writing, check `/api/claim_billing_notes`, is_walk_in: bool # Whether the appointment is a walk-in appointment, billing_provider: str, reminder_profile: str # Write-only. ID of an `/api/reminder_profiles` instance. Set this to apply a reminder profile to the appointment. Cannot be applied to an appointment with reminders., primary_insurer_name: str, profile: int # ID of an `/api/appointment_profiles` instance. The profile sets default values for `color`, `duration`, and `reason` on creation, which can be overriden by setting these values explicitly., resubmit_claim_original_id: int # ID of this claim id., recurrence_instance_key: str # A stable identifier for a recurring appointment instance, in the format `{rootSeriesId}_{YYYYMMDD}` where `YYYYMMDD` is the original occurrence date, not the current scheduled date. This value remains consistent across materialization, series splits, and rescheduling, so it should be treated as an opaque identifier rather than a source for display dates. Returns null for non-recurring appointments. Only present when the `consistent_recurrence_id` feature flag is enabled., cloned_from: int # ID of the original appointment which this appointment cloned from. Will be null if the appointment is not cloned., extended_updated_at: str # The most recent update time among appointment itself, its vitals and its custom vitals, updated_at: str, reason: str # Default to `\"\"`, last_edi_date: str, secondary_insurer_payer_id: str, allow_overlapping: bool # Bypass overlap check., payment_profile: str # Appointment Payment Profile, secondary_insurance_id_number: str, clinical_note: map{pdf: str, locked: bool, updated_at: str} # Associated clinical note object, custom_vitals: [map{value: str, vital_type: int}] # Custom vitals associated with this appointment., is_virtual_base: bool, recurring_appointment: bool # Whether the appointment is a recurring appointment or not, supervising_provider: str # Supervising provider of appointment if set., recurring_days: [any] # For recurring appointments, the days of the week on which the appointment recurs. Can include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday or Sunday, status_transitions: [map{appointment: str, to_status: str, from_status: str, datetime: str}], created_at: str, reminders: [map{scheduled_time: str, type: str, id: int}] # Scheduled reminders of the appointment, ins1_status: str(/Incomplete Information/In Process Emdeon/Rejected Emdeon/Rejected EPS/Rejected Jopari/In Process Payor/Rejected Waystar Professional/Rejected Waystar Institutional/In Process Payer/Payer Acknowledged/Rejected Payor/Rejected Payer/Paid in Full/Partially Paid/Coordination of Benefits/ERA Received/ERA Denied/HCFA Form Faxed) # Billing status of primary insurer, custom_status: str # AppointmentStatus Name, recur_end_date: str # For recurring appointments, the end date of the recurring series, icd10_codes: [str], deleted_flag: bool # Whether the appointment is deleted., notes: str, recurs_every: int # For recurring appointments, the number of weeks between recurrences. For example, if this is 2, the appointment recurs every other week.}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 409: Scheduled time overlaps with an existing appointment, 500: Internal Server Error}\n\n@endpoint GET /api/appointments/{id}\n@desc Retrieve an existing appointment or break\n@required {id: str}\n@returns(200) {status: str, icd9_codes: [str], office: int, base_recurring_appointment: str, color: str, vitals: map{height_units: str, weight_units: str, pain: str, temperature: num, weight: num, smoking_status: str, head_circumference: num, bmi: str, head_circumference_units: str, blood_pressure_2: int, blood_pressure_1: int, height: num, pulse: int, oxygen_saturation: num, respiratory_rate: int, temperature_units: str}, first_billed_date: str, last_billed_date: str, billing_status: str, primary_insurer_payer_id: str, duration: int, is_membership_appointment: bool, appt_is_break: bool, id: str, custom_fields: [map], scheduled_time: str, secondary_insurer_name: str, doctor: int, recur_start_date: str, primary_insurance_id_number: str, created_by: str, ins2_status: str, first_edi_date: str, billing_notes: [map], is_walk_in: bool, billing_provider: str, reminder_profile: str, primary_insurer_name: str, profile: int, resubmit_claim_original_id: int, patient: int, recurrence_instance_key: str?, cloned_from: int, extended_updated_at: str, exam_room: int, updated_at: str, reason: str, last_edi_date: str, secondary_insurer_payer_id: str, allow_overlapping: bool, payment_profile: str, secondary_insurance_id_number: str, clinical_note: map{pdf: str, locked: bool, updated_at: str}, custom_vitals: [map], is_virtual_base: bool, recurring_appointment: bool, supervising_provider: str, recurring_days: [any], status_transitions: [map], created_at: str, reminders: [map], ins1_status: str, custom_status: str, recur_end_date: str, icd10_codes: [str], deleted_flag: bool, notes: str, recurs_every: int} # OK\n@errors {401: Unauthorized, 403: Permission Denied, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /api/appointments/{id}\n@desc Delete an existing appointment or break\n@required {id: str # Appointment ID. Can be in the form of date_id where date is the day of the appointment and ID is the recurring appointment ID. If not recurring this is just the ID number.}\n@errors {401: Unauthorized, 403: Permission Denied, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /api/telehealth_appointments\n@optional {appointment: int, doctor: int}\n@returns(201) {sent_patient_email: any, appointment: int, created_at: str, updated_at: str, overlapping_duration: str, duration: int, telehealth_url: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/telehealth_appointments\n@optional {cursor: str, page_size: int, appointment: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/care_plans\n@desc Retrieve or search care plans\n@optional {cursor: str, page_size: int, patient: int, plan_type: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/patient_physical_exams\n@desc Create patient physical exam for CQM\n@optional {patient: int, doctor: int}\n@returns(201) {value_name: str, value_code_system: str, code: str, appointment: str, name: str, doctor: int, created_at: str, effective_time: str, value_code: str, patient: int, id: int, code_system: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patient_physical_exams\n@desc Retrieve or search patient physical exams for CQM\n@optional {cursor: str, page_size: int, patient: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/line_item_deletions\n@desc Retrieve or search billing line item deletions. When a billing line item is deleted, a record of its original ID and the appointment it was attached to will be logged and is accessible from this resource.\n@optional {since: str, appointment_id: int}\n@returns(200) {previous: str, results: [map], next: str}\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/signed_consent_forms/{id}\n@desc signed_consent_forms Read\n@required {id: str}\n@returns(200) {date_signed: str, archived: bool, appointment: int, signature_file: str(binary), updated_at: str, patient: int, consent_form: int, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/clinical_note_templates/{id}\n@desc Retrieve an existing clinical note tempalte\n@required {id: str}\n@optional {doctor: int}\n@returns(200) {archived: bool, workflow_key: str, name: str, doctor: str, updated_at: str, is_persistent: bool, clinical_note_fields: [map], is_onpatient: bool, order: map{on_complete_note: int, on_ipad: int}, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/transactions\n@desc Retrieve or search insurance transactions associated with billing line items\n@optional {cursor: str, page_size: int, line_item: int, posted_date: str, appointment: int, since: str, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/lab_results\n@desc Create lab results. An example lab workflow is as following:\n@optional {order: int, doctor: int}\n@returns(201) {status: str, group_code: str, observation_description: str, is_abnormal: str, observation_code: str, specimen_received: str, comments: str, normal_range: str, test_performed: str, value: str, abnormal_status: str, lab_order: str, value_is_numeric: bool, document: int, lab_test: int, id: int, unit: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/lab_results\n@desc Retrieve or search lab results\n@optional {cursor: str, page_size: int, order: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/custom_insurance_plan_names\n@desc Retrieve or search custom insurance plan names\n@optional {cursor: str, page_size: int, since: str, user: int, name: str, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/problems/{id}\n@desc Update an existing patient problems\n@required {id: str}\n@optional {patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/problems/{id}\n@desc Update an existing patient problems\n@required {id: str}\n@optional {patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/problems/{id}\n@desc Retrieve an existing patient problems\n@required {id: str}\n@optional {patient: int, doctor: int}\n@returns(200) {category: str, icd_code: str, icd_version: str, appointment: int, description: str, info_url: str, doctor: int, notes: str, verification_status: any, status: str, snomed_ct_code: str, abatement_date: str(date), date_onset: str, date_diagnosis: str, date_changed: str, patient: int, problem_type: str, id: int, name: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/amendments\n@desc Create patient amendments to a patient's clinical records\n@optional {appointment: int, patient: int, doctor: int}\n@returns(201) {amendment_name: str, appointment: int, doctor: int, comments: str, amendment_file: str, patient: int, id: int} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/amendments\n@desc Retrieve or search patient amendments. You can only interact with amendments created by your API application\n@optional {cursor: str, page_size: int, appointment: int, patient: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/lab_orders\n@desc Create lab orders. An example lab workflow is as following:\n@optional {since: str, doctor: int}\n@returns(201) {status: str, documents: [str], patient: int, doctor: int, timestamp: str, notes: str, accession_number: str, requisition_id: str, external_requisition_id: str, priority: str, icd10_codes: [map], sublab: int, id: int} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/lab_orders\n@desc Retrieve or search lab orders\n@optional {cursor: str, page_size: int, patient: int, since: str, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/message_threads/{id}\n@desc Partially update a message thread.\n@required {id: str}\n@optional {doctor: int, practice_group: int, patient: int, message_type: str, archived: str, starred: str, unread_count: int, updated_since: str, assigned_groups: [int] # Array of user group IDs to assign to this thread, archived: bool # Whether the thread is archived, starred: bool # Whether the thread is starred, assigned_user_profiles: [int] # Array of user profile IDs to assign to this thread}\n@returns(200) {assigned_groups: [int], archived: bool, first_message: int, patient: int, doctor: int, last_message: int, practice_group: int, created_at: str(date-time), updated_at: str(date-time), assigned_user_profiles: [int], message_count: int, unread_count: int, last_message_at: str(date-time), owners: [int], starred: bool, message_type: str, id: int, subject: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n@example_request {\"assigned_groups\":[],\"archived\":true,\"starred\":false,\"assigned_user_profiles\":[]}\n\n@endpoint GET /api/message_threads/{id}\n@desc Retrieve a single message thread by ID (beta)\n@required {id: int}\n@optional {doctor: int, practice_group: int, patient: int, message_type: str, archived: bool, starred: bool, unread_count: int, updated_since: str}\n@returns(200) {assigned_groups: [int], archived: bool, first_message: int, patient: int, doctor: int, last_message: int, practice_group: int, created_at: str(date-time), updated_at: str(date-time), assigned_user_profiles: [int], message_count: int, unread_count: int, last_message_at: str(date-time), owners: [int], starred: bool, message_type: str, id: int, subject: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/doctors/{id}\n@desc Retrieve an existing doctor\n@required {id: str}\n@optional {doctor: int}\n@returns(200) {website: str, doctor_work_schedule: map{work_days: [map], id: int, office: int, doctor: int}, first_name: str, last_name: str, suffix: str, profile_picture: str, country: str, practice_group_name: str, specialty: str, is_account_suspended: bool, id: int, office_phone: str, npi_number: str, group_npi_number: str, home_phone: str, practice_group: str, timezone: str, cell_phone: str, email: str, job_title: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/patient_flag_types\n@desc Create patient flag types\n@optional {doctor: int}\n@returns(201) {archived: bool, name: str, doctor: int, color: str, created_at: str, updated_at: str, priority: int, id: int} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patient_flag_types\n@desc Retrieve or search patient flag types\n@optional {cursor: str, page_size: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/recurring_appointment_instances\n@desc List all instances (materialized and virtual) within a recurring\n@required {base_recurring_appointment: int}\n@optional {start_date: str(date), end_date: str(date), fields: str, verbose: bool}\n@returns(200)\n@errors {400: base_recurring_appointment is required or invalid.}\n\n@endpoint GET /api/day_sheet_totals\n@desc Retrieve daysheet totals report for a given date range\n@required {start_date: str, end_date: str}\n@optional {charges_date_type: str, report_type: str, credits_date_type: str, group_by: str, sub_group_by: str, tertiary_group_by: str, cash_view_type: str, patient_id: int, office_id: str, examroom_id: int, pg_mode: bool}\n\n@endpoint PUT /api/custom_appointment_fields/{id}\n@desc Update an existing custom appointment field\n@required {id: str}\n@optional {doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/custom_appointment_fields/{id}\n@desc Update an existing custom appointment field\n@required {id: str}\n@optional {doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/custom_appointment_fields/{id}\n@desc Retrieve an existing custom appointment field\n@required {id: str}\n@optional {doctor: int}\n@returns(200) {archived: bool, doctor: str, created_at: str, updated_at: str, order: int, field_desc: str, field_name: str, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/eobs\n@desc Create EOB object\n@optional {doctor: int}\n@returns(201) {posted_date: str, insurance_payer_name: str, doctor: int, payment_method: str, deposit_date: str, updated_at: str, insurance_payer_id: str, scanned_eob: str, insurance_payer_trace_number: str, total_paid: num, check_date: str, id: int} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/eobs\n@desc Retrieve or search EOB objects\n@optional {cursor: str, page_size: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/users/{id}\n@desc Retrieve an existing user, `/api/users/current` can be used to identify logged in user, it will redirect to `/api/users/{current_user_id}`\n@required {id: str}\n@optional {doctor: int}\n@returns(200) {username: str, doctor: str, practice_group: str, is_doctor: str, is_staff: str, staff: int?, id: str, permissions: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/insurances\n@required {payer_type: str # One of `\"emdeon\"`, `\"gateway\"`, `\"ihcfa\"`}\n@optional {cursor: str, page_size: int, term: str # Search term, which can be either a partial name, partial ID or the state.}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/telehealth_appointment_history\n@optional {doctor: int}\n@returns(201) {timestamp: str, description: str, event_type: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/telehealth_appointment_history\n@optional {cursor: str, page_size: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/task_notes\n@desc Create a task note\n@optional {task: int, since: str}\n@returns(201) {archived: bool, task: int, text: str, created_at: str, updated_at: str, created_by: str, id: int} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/task_notes\n@desc Retrieve or search task notes\n@optional {cursor: str, page_size: int, task: int, since: str}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/tasks\n@desc Create a task\n@optional {status: int, category: int, due_at_date: str, due_at_unknown: str, since: str, due_at_since: str, assignee_user: int, assignee_group: int, due_at_range: str}\n@returns(201) {category: int, due_date: map{time: str}, archived: bool, associated_items: [map], assigned_by: str, assignee_user: str, created_at: str, assignee_group: int, updated_at: str, created_by: str, priority: str, status: int, notes: [map], title: str, id: int} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/tasks\n@desc Retrieve or search tasks\n@optional {cursor: str, page_size: int, status: int, category: int, due_at_date: str, due_at_unknown: str, since: str, due_at_since: str, assignee_user: int, assignee_group: int, due_at_range: str}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/patients_summary/{id}\n@required {id: str}\n@optional {first_name: str, last_name: str, doctor: int, gender: str, since: str, date_of_birth: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/patients_summary/{id}\n@required {id: str}\n@optional {first_name: str, last_name: str, doctor: int, gender: str, since: str, date_of_birth: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patients_summary/{id}\n@required {id: str}\n@optional {first_name: str, last_name: str, doctor: int, gender: str, since: str, date_of_birth: str}\n@returns(200) {medication_history_consent: str, last_name: str, emergency_contact_phone: str, primary_care_physician: str, date_of_first_appointment: str, tertiary_insurance: map{insurance_group_name: str, insurance_id_number: str, insurance_claim_office_number: str, subscriber_address: str, subscriber_state: str, subscriber_social_security: str, photo_front: str, subscriber_last_name: str, subscriber_middle_name: str, subscriber_date_of_birth: str, insurance_company: str, is_subscriber_the_patient: bool, insurance_plan_name: str, patient_relationship_to_subscriber: str, subscriber_gender: str, photo_back: str, subscriber_suffix: str, subscriber_zip_code: str, subscriber_city: str, insurance_plan_type: str, insurance_payer_id: str, subscriber_country: str, subscriber_first_name: str, insurance_group_number: str}, patient_flags_attached: [map], updated_at: str, custom_demographics: [map], referring_source: str, responsible_party_relation: str, zip_code: str, id: int, employer_city: str, employer_state: str, city: str, first_name: str, middle_name: str, doctor: int, race_subcategories: [map], disable_sms_messages: bool, employer: str, preferred_language_description: str, patient_flags: [map], date_of_birth: str, ethnicity: str, home_phone: str, pronouns: str, patient_status: str, patient_photo_date: str, gender_identity_description: str, email: str, responsible_party_email: str, patient_photo: str, responsible_party_phone: str, state: str, secondary_insurance: map{insurance_group_name: str, insurance_id_number: str, insurance_claim_office_number: str, subscriber_address: str, subscriber_state: str, subscriber_social_security: str, photo_front: str, subscriber_last_name: str, subscriber_middle_name: str, subscriber_date_of_birth: str, insurance_company: str, is_subscriber_the_patient: bool, insurance_plan_name: str, patient_relationship_to_subscriber: str, subscriber_gender: str, photo_back: str, subscriber_suffix: str, subscriber_zip_code: str, subscriber_city: str, insurance_plan_type: str, insurance_payer_id: str, subscriber_country: str, subscriber_first_name: str, insurance_group_number: str}, date_of_last_appointment: str, preferred_language_code: str, patient_payment_profile: str, date_of_death: str, social_security_number: str, auto_accident_insurance: map{auto_accident_claim_rep_city: str, auto_accident_claim_rep_state: str, auto_accident_claim_rep_address: str, auto_accident_will_require_therapy_rec: str, auto_accident_subscriber_middle_name: str, auto_accident_still_under_care: bool, auto_accident_significant_injury_notes: str, auto_accident_subscriber_first_name: str, auto_accident_subscriber_address: str, auto_accident_disabled_from_date: str, auto_accident_company: str, auto_accident_disabled_to_date: str, auto_accident_similar_condition_date: str, auto_accident_case_number: str, auto_accident_claim_rep_is_insurer: bool, auto_accident_payer_address: str, auto_accident_subscriber_last_name: str, auto_accident_subscriber_social_security: str, auto_accident_subscriber_phone_number: str, auto_accident_subscriber_city: str, auto_accident_significant_injury: str, auto_accident_similar_condition_notes: str, auto_accident_payer_id: str, auto_accident_payer_state: str, auto_accident_subscriber_zip_code: str, auto_accident_payer_zip: str, auto_accident_payer_city: str, auto_accident_will_require_therapy: bool, auto_accident_date_of_accident: str, auto_accident_subscriber_date_of_birth: str, auto_accident_subscriber_suffix: str, auto_accident_subscriber_state: str, auto_accident_return_to_work_date: str, auto_accident_notes: str, auto_accident_policy_number: str, auto_accident_is_subscriber_the_patient: bool, auto_accident_claim_rep_zip: str, auto_accident_state_of_occurrence: str, auto_accident_treatment_duration: str, auto_accident_had_similar_condition: bool, auto_accident_patient_relationship_to_subscriber: str, auto_accident_claim_rep_name: str}, address: str, chart_id: str, referring_doctor: map{fax: str, last_name: str, middle_name: str, suffix: str, first_name: str, provider_number: str, specialty: str, provider_qualifier: str, phone: str, address: str, npi: str, email: str}, primary_insurance: map{insurance_group_name: str, insurance_id_number: str, insurance_claim_office_number: str, subscriber_address: str, subscriber_state: str, subscriber_social_security: str, photo_front: str, subscriber_last_name: str, subscriber_middle_name: str, subscriber_date_of_birth: str, insurance_company: str, is_subscriber_the_patient: bool, insurance_plan_name: str, patient_relationship_to_subscriber: str, subscriber_gender: str, photo_back: str, subscriber_suffix: str, subscriber_zip_code: str, subscriber_city: str, insurance_plan_type: str, insurance_payer_id: str, subscriber_country: str, subscriber_first_name: str, insurance_group_number: str}, preferred_language: str, responsible_party_name: str, nick_name: str, copay: str, created_at: str, emergency_contact_relation: str, gender_identity_code: str, office_phone: str, employer_address: str, race: str, offices: [int], preferred_pharmacies: [str], emergency_contact_name: str, gender: str, default_pharmacy: str, cell_phone: str, employer_zip_code: str, workers_comp_insurance: map{workers_comp_payer_city: str, workers_comp_payer_id: str, workers_comp_group_name: str, workers_comp_wcb: str, workers_comp_carrier_code: str, workers_comp_notes: str, property_and_casualty_agency_claim_number: str, workers_comp_state_of_occurrence: str, workers_comp_payer_zip: str, workers_comp_wcb_rating_code: str, workers_comp_case_number: str, workers_comp_group_number: str, workers_comp_company: str, workers_comp_payer_address: str, workers_comp_date_of_accident: str, workers_comp_payer_state: str}} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint DELETE /api/patients_summary/{id}\n@required {id: str}\n@optional {first_name: str, last_name: str, doctor: int, gender: str, since: str, date_of_birth: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/lab_documents\n@desc Create lab order documents. An example lab workflow is as following:\n@optional {since: str, doctor: int}\n@returns(201) {hl7: str, timestamp: str, lab_order: int, document: str, type: str, id: int} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/lab_documents\n@desc Retrieve or search lab order documents\n@optional {cursor: str, page_size: int, patient: int, since: str, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/consent_forms/{id}\n@desc Update an existing patient consent form\n@required {id: str}\n@optional {doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/consent_forms/{id}\n@desc Update an existing patient consent form\n@required {id: str}\n@optional {doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/consent_forms/{id}\n@desc Retrieve an existing patient consent form\n@required {id: str}\n@optional {doctor: int}\n@returns(200) {archived: bool, is_mandatory: bool, uri: str, doctor: int, updated_at: str, created_at: str, title: str, assign_by_default: bool, order: int, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/lab_tests/{id}\n@desc Update an existing lab test\n@required {id: str}\n@optional {order: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/lab_tests/{id}\n@desc Update an existing lab test\n@required {id: str}\n@optional {order: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/lab_tests/{id}\n@desc Retrieve an existing lab test\n@required {id: str}\n@optional {order: int, doctor: int}\n@returns(200) {report_notes: str, status: str, code: str, description: str, specimen_condition: str, collection_date: str, internal_notes: str, specimen_total_volume: num, specimen_source: str, lab_order: int, id: int, name: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint DELETE /api/lab_tests/{id}\n@desc Delete an existing lab test\n@required {id: str}\n@optional {order: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/prescription_messages_list\n@desc Create prescription messages list request.  Use the UUID returned in the response to retrieve the batch of records. Results returned in order of id or updated_at.\n@optional {order_by: str # Order results by a specific field. Valid options include [id, updated_at]. Default: id., page_size: int # Number of results to return per page. Value between 1 and 1000., page: int # Number of page to return. Value between 1 and max number of pages in result set., since: str # Inclusive lower bound on record updated/created time, patient: int # Patient ID filter, doctor: int # Prescribing doctor ID filter, created_at: str # Filter on specific creation date, parent_message: int # Filter on associated parent prescription message ID}\n@returns(201) {status: str, uuid: str, description: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /api/prescription_messages_list\n@desc Retrieve or search prescription messages in batches. Results returned in order of ID or updated_at.\n@optional {uuid: str # The UUID token for the batch of prescription messages.  This is returned in the response of the `create` endpoint.}\n@returns(200) {status: str, pagination: map{count: int, pages: int, page: int}, results: [map], uuid: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PUT /api/patients/{id}\n@desc Update an existing patient\n@required {id: str}\n@optional {first_name: str, last_name: str, preferred_language: str, doctor: int, gender: str, since: str, date_of_birth: str, race: str, chart_id: str, email: str, ethnicity: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/patients/{id}\n@desc Update an existing patient\n@required {id: str}\n@optional {first_name: str, last_name: str, preferred_language: str, doctor: int, gender: str, since: str, date_of_birth: str, race: str, chart_id: str, email: str, ethnicity: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patients/{id}\n@desc Retrieve an existing patient\n@required {id: str}\n@optional {first_name: str, last_name: str, preferred_language: str, doctor: int, gender: str, since: str, date_of_birth: str, race: str, chart_id: str, email: str, ethnicity: str}\n@returns(200) {medication_history_consent: str, last_name: str, emergency_contact_phone: str, primary_care_physician: str, date_of_first_appointment: str, tertiary_insurance: map{insurance_group_name: str, insurance_id_number: str, insurance_claim_office_number: str, subscriber_address: str, subscriber_state: str, subscriber_social_security: str, photo_front: str, subscriber_last_name: str, subscriber_middle_name: str, subscriber_date_of_birth: str, insurance_company: str, is_subscriber_the_patient: bool, insurance_plan_name: str, patient_relationship_to_subscriber: str, subscriber_gender: str, photo_back: str, subscriber_suffix: str, subscriber_zip_code: str, subscriber_city: str, insurance_plan_type: str, insurance_payer_id: str, subscriber_country: str, subscriber_first_name: str, insurance_group_number: str}, patient_flags_attached: [map], updated_at: str, custom_demographics: [map], referring_source: str, responsible_party_relation: str, zip_code: str, id: int, employer_city: str, employer_state: str, city: str, first_name: str, middle_name: str, doctor: int, race_subcategories: [map], disable_sms_messages: bool, employer: str, preferred_language_description: str, patient_flags: [map], date_of_birth: str, ethnicity: str, home_phone: str, pronouns: str, patient_status: str, patient_photo_date: str, gender_identity_description: str, email: str, responsible_party_email: str, patient_photo: str, responsible_party_phone: str, state: str, secondary_insurance: map{insurance_group_name: str, insurance_id_number: str, insurance_claim_office_number: str, subscriber_address: str, subscriber_state: str, subscriber_social_security: str, photo_front: str, subscriber_last_name: str, subscriber_middle_name: str, subscriber_date_of_birth: str, insurance_company: str, is_subscriber_the_patient: bool, insurance_plan_name: str, patient_relationship_to_subscriber: str, subscriber_gender: str, photo_back: str, subscriber_suffix: str, subscriber_zip_code: str, subscriber_city: str, insurance_plan_type: str, insurance_payer_id: str, subscriber_country: str, subscriber_first_name: str, insurance_group_number: str}, date_of_last_appointment: str, preferred_language_code: str, patient_payment_profile: str, date_of_death: str, social_security_number: str, auto_accident_insurance: map{auto_accident_claim_rep_city: str, auto_accident_claim_rep_state: str, auto_accident_claim_rep_address: str, auto_accident_will_require_therapy_rec: str, auto_accident_subscriber_middle_name: str, auto_accident_still_under_care: bool, auto_accident_significant_injury_notes: str, auto_accident_subscriber_first_name: str, auto_accident_subscriber_address: str, auto_accident_disabled_from_date: str, auto_accident_company: str, auto_accident_disabled_to_date: str, auto_accident_similar_condition_date: str, auto_accident_case_number: str, auto_accident_claim_rep_is_insurer: bool, auto_accident_payer_address: str, auto_accident_subscriber_last_name: str, auto_accident_subscriber_social_security: str, auto_accident_subscriber_phone_number: str, auto_accident_subscriber_city: str, auto_accident_significant_injury: str, auto_accident_similar_condition_notes: str, auto_accident_payer_id: str, auto_accident_payer_state: str, auto_accident_subscriber_zip_code: str, auto_accident_payer_zip: str, auto_accident_payer_city: str, auto_accident_will_require_therapy: bool, auto_accident_date_of_accident: str, auto_accident_subscriber_date_of_birth: str, auto_accident_subscriber_suffix: str, auto_accident_subscriber_state: str, auto_accident_return_to_work_date: str, auto_accident_notes: str, auto_accident_policy_number: str, auto_accident_is_subscriber_the_patient: bool, auto_accident_claim_rep_zip: str, auto_accident_state_of_occurrence: str, auto_accident_treatment_duration: str, auto_accident_had_similar_condition: bool, auto_accident_patient_relationship_to_subscriber: str, auto_accident_claim_rep_name: str}, address: str, chart_id: str, referring_doctor: map{fax: str, last_name: str, middle_name: str, suffix: str, first_name: str, provider_number: str, specialty: str, provider_qualifier: str, phone: str, address: str, npi: str, email: str}, primary_insurance: map{insurance_group_name: str, insurance_id_number: str, insurance_claim_office_number: str, subscriber_address: str, subscriber_state: str, subscriber_social_security: str, photo_front: str, subscriber_last_name: str, subscriber_middle_name: str, subscriber_date_of_birth: str, insurance_company: str, is_subscriber_the_patient: bool, insurance_plan_name: str, patient_relationship_to_subscriber: str, subscriber_gender: str, photo_back: str, subscriber_suffix: str, subscriber_zip_code: str, subscriber_city: str, insurance_plan_type: str, insurance_payer_id: str, subscriber_country: str, subscriber_first_name: str, insurance_group_number: str}, preferred_language: str, responsible_party_name: str, nick_name: str, copay: str, created_at: str, emergency_contact_relation: str, gender_identity_code: str, office_phone: str, employer_address: str, race: str, offices: [int], preferred_pharmacies: [str], emergency_contact_name: str, gender: str, default_pharmacy: str, cell_phone: str, employer_zip_code: str, workers_comp_insurance: map{workers_comp_payer_city: str, workers_comp_payer_id: str, workers_comp_group_name: str, workers_comp_wcb: str, workers_comp_carrier_code: str, workers_comp_notes: str, property_and_casualty_agency_claim_number: str, workers_comp_state_of_occurrence: str, workers_comp_payer_zip: str, workers_comp_wcb_rating_code: str, workers_comp_case_number: str, workers_comp_group_number: str, workers_comp_company: str, workers_comp_payer_address: str, workers_comp_date_of_accident: str, workers_comp_payer_state: str}} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint DELETE /api/patients/{id}\n@desc Delete an existing patient\n@required {id: str}\n@optional {first_name: str, last_name: str, preferred_language: str, doctor: int, gender: str, since: str, date_of_birth: str, race: str, chart_id: str, email: str, ethnicity: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patients/{id}/ccda_async\n@desc Retrieve patient CCDA async.\n@required {id: str}\n@optional {first_name: str, last_name: str, preferred_language: str, doctor: int, gender: str, created_at: str, since: str, date_of_birth: str, race: str, chart_id: str, email: str, ethnicity: str}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/custom_vitals\n@desc Retrieve or search custom vital types\n@optional {cursor: str, page_size: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/user_groups\n@desc Retrieve or search user groups\n@optional {cursor: str, page_size: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/care_team_members/{id}\n@required {id: str}\n@optional {patient: int, appointment: int, doctor: int}\n@returns(200) {patient: str, created_at: str, appointment: str, id: int, user: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/claim_billing_notes/{id}\n@desc Retrieve an existing billing note\n@required {id: str}\n@optional {appointment: int, doctor: int}\n@returns(200) {text: str, created_at: str, appointment: int, id: int, created_by: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/inventory_vaccines\n@desc Create vaccine inventory\n@optional {status: str, cvx_code: str, since: str, doctor: int}\n@returns(201) {category: int, lot_number: str, manufacturer_code: str, name: str, original_quantity: int, doctor: int, created_at: str, status: str, updated_at: str, price_with_tax: num, expiry: str, note: str, sales_tax_applicable: bool, cost: num, price: num, vaccination_type: str, id: int, manufacturer: str, current_quantity: int, cvx_code: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/inventory_vaccines\n@desc Retrieve or search vaccine inventories\n@optional {cursor: str, page_size: int, status: str, cvx_code: str, since: str, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/transactions/{id}\n@desc Retrieve an existing insurance transaction\n@required {id: str}\n@optional {line_item: int, posted_date: str, appointment: int, since: str, doctor: int}\n@returns(200) {insurance: map{id_number: str, message: str, name: str}, ins_paid: num, posted_date: str, appointment: int, ins_name: int, doctor: int, adjustment_group_code: str, updated_at: str, id: int, line_item: int, claim_status: str, check_date: str, trace_number: str, adjustment_reason: str, patient: int, adjustment: num, created_at: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/procedures\n@optional {cursor: str, page_size: int, mu_date: str, patient: int, doctor: int, mu_date_range: str, appointment: int, service_date: str}\n@returns(200) {previous: str, data: [any], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/patient_lab_results/{id}\n@required {id: str}\n@optional {ordering_doctor: int, since: str, patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/patient_lab_results/{id}\n@required {id: str}\n@optional {ordering_doctor: int, since: str, patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patient_lab_results/{id}\n@required {id: str}\n@optional {ordering_doctor: int, since: str, patient: int, doctor: int}\n@returns(200) {doctor_signoff: bool, loinc_code: str, patient: int, ordering_doctor: int, lab_abnormal_flag: str, lab_normal_range_units: str, created_at: str, lab_normal_range: str, doctor_comments: str, date_test_performed: str, updated_at: str, lab_result_value: str, lab_result_value_as_float: num, scanned_in_result: str, title: str, lab_order_status: str, lab_imported_from_ccr: str, id: int, lab_result_value_units: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint DELETE /api/patient_lab_results/{id}\n@required {id: str}\n@optional {ordering_doctor: int, since: str, patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/amendments/{id}\n@desc Update an existing patient amendment, you can only interact with amendments created by your API application\n@required {id: str}\n@optional {appointment: int, patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/amendments/{id}\n@desc Update an existing patient amendment, you can only interact with amendments created by your API application\n@required {id: str}\n@optional {appointment: int, patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/amendments/{id}\n@desc Retrieve an existing patient amendment, you can only interact with amendments created by your API application\n@required {id: str}\n@optional {appointment: int, patient: int, doctor: int}\n@returns(200) {amendment_name: str, appointment: int, doctor: int, comments: str, amendment_file: str, patient: int, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint DELETE /api/amendments/{id}\n@desc Delete an existing patient amendment, you can only interact with amendments created by your API application\n@required {id: str}\n@optional {appointment: int, patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/lab_tests\n@desc Create lab tests. An example lab workflow is as following:\n@optional {order: int, doctor: int}\n@returns(201) {report_notes: str, status: str, code: str, description: str, specimen_condition: str, collection_date: str, internal_notes: str, specimen_total_volume: num, specimen_source: str, lab_order: int, id: int, name: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/lab_tests\n@desc Retrieve or search lab tests\n@optional {cursor: str, page_size: int, order: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/appointments_list/{id}\n@required {id: str}\n@optional {status: str, patient: int, office: int, doctor: int, since: str, date_range: str, date: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 409: Scheduled time overlaps with an existing appointment, 500: Internal Server Error}\n\n@endpoint PATCH /api/appointments_list/{id}\n@required {id: str}\n@optional {status: str, patient: int, office: int, doctor: int, since: str, date_range: str, date: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 409: Scheduled time overlaps with an existing appointment, 500: Internal Server Error}\n\n@endpoint GET /api/appointments_list/{id}\n@required {id: str}\n@optional {status: str, patient: int, office: int, doctor: int, since: str, date_range: str, date: str}\n@returns(200) {status: str, icd9_codes: [str], office: int, base_recurring_appointment: str, color: str, vitals: map{height_units: str, weight_units: str, pain: str, temperature: num, weight: num, smoking_status: str, head_circumference: num, bmi: str, head_circumference_units: str, blood_pressure_2: int, blood_pressure_1: int, height: num, pulse: int, oxygen_saturation: num, respiratory_rate: int, temperature_units: str}, first_billed_date: str, last_billed_date: str, billing_status: str, primary_insurer_payer_id: str, duration: int, is_membership_appointment: bool, appt_is_break: bool, id: str, custom_fields: [map], scheduled_time: str, secondary_insurer_name: str, doctor: int, recur_start_date: str, primary_insurance_id_number: str, created_by: str, ins2_status: str, first_edi_date: str, billing_notes: [map], is_walk_in: bool, billing_provider: str, reminder_profile: str, primary_insurer_name: str, profile: int, resubmit_claim_original_id: int, patient: int, recurrence_instance_key: str?, cloned_from: int, extended_updated_at: str, exam_room: int, updated_at: str, reason: str, last_edi_date: str, secondary_insurer_payer_id: str, allow_overlapping: bool, payment_profile: str, secondary_insurance_id_number: str, clinical_note: map{pdf: str, locked: bool, updated_at: str}, custom_vitals: [map], is_virtual_base: bool, recurring_appointment: bool, supervising_provider: str, recurring_days: [any], status_transitions: [map], created_at: str, reminders: [map], ins1_status: str, custom_status: str, recur_end_date: str, icd10_codes: [str], deleted_flag: bool, notes: str, recurs_every: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint DELETE /api/appointments_list/{id}\n@required {id: str}\n@optional {status: str, patient: int, office: int, doctor: int, since: str, date_range: str, date: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/patient_lab_results\n@optional {ordering_doctor: int, since: str, patient: int, doctor: int}\n@returns(201) {doctor_signoff: bool, loinc_code: str, patient: int, ordering_doctor: int, lab_abnormal_flag: str, lab_normal_range_units: str, created_at: str, lab_normal_range: str, doctor_comments: str, date_test_performed: str, updated_at: str, lab_result_value: str, lab_result_value_as_float: num, scanned_in_result: str, title: str, lab_order_status: str, lab_imported_from_ccr: str, id: int, lab_result_value_units: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patient_lab_results\n@optional {cursor: str, page_size: int, ordering_doctor: int, since: str, patient: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/task_categories/{id}\n@desc Update an existing task category\n@required {id: str}\n@optional {since: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/task_categories/{id}\n@desc Update an existing task category\n@required {id: str}\n@optional {since: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/task_categories/{id}\n@desc Retrieve an existing task category\n@required {id: str}\n@optional {since: str}\n@returns(200) {archived: bool, is_global: str, name: str, practice_group: int, created_at: str, updated_at: str, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/fee_schedules_v2/{id}\n@required {id: str}\n@returns(200) {ineffective_date: str, assignees: [any], items: [any], created_at: str, payer_id: str, updated_at: str, assignee_type: str, specialities: [any], effective_date: str, plan_name: str, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/insurances/{id}\n@required {id: str, payer_type: str # One of `\"emdeon\"`, `\"gateway\"`, `\"ihcfa\"`}\n@optional {term: str # Search term, which can be either a partial name, partial ID or the state.}\n@returns(200) {payer_name: str, state: str, payer_id: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/clinical_notes\n@optional {cursor: str, page_size: int, patient: int, office: int, doctor: int, created_at: str, since: str, date_range: str, date: str}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/eligibility_checks_list\n@desc 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.\n@optional {order_by: str # Order results by a specific field. Valid options include [id, updated_at]. Default: id., page_size: int # Number of results to return per page. Value between 1 and 1000., page: int # Number of page to return. Value between 1 and max number of pages in result set., since: str # Inclusive lower bound on record updated/created time, patient: int # Patient ID filter, appointment_date_range: str # Inclusive bounded date range on appointment scheduled date, appointment_date: str # Filter on specific appointment scheduled date, query_date_range: str # Inclusive bounded date range on eligibility check date, query_date: str # Filter on specific eligibility check date, service_types: str # Filter for checks included within a comma-separated list of service type codes (STCs), verbose: bool # When True includes full coverage details}\n@returns(201) {status: str, uuid: str, description: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /api/eligibility_checks_list\n@desc Retrieve or search eligibility checks in batches. Results returned in order of ID or updated_at.\n@optional {uuid: str # The UUID token for the batch of eligibility checks.  This is returned in the response of the `create` endpoint.}\n@returns(200) {status: str, pagination: map{count: int, pages: int, page: int}, results: [map], uuid: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /api/telehealth_appointment_history/{id}\n@required {id: str}\n@optional {doctor: int}\n@returns(200) {timestamp: str, description: str, event_type: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/clinical_notes/{id}\n@required {id: str}\n@optional {patient: int, office: int, doctor: int, since: str, date_range: str, date: str}\n@returns(200) {patient: str, archived: bool, clinical_note_sections: [map], appointment: str, signee: map{locked_by: str, supervisor_locked_by: str}} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/clinical_note_field_types\n@desc Retrieve or search clinical note field types\n@optional {cursor: str, page_size: int, clinical_note_template: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/documents\n@desc Create documents\n@optional {since: str, patient: int, doctor: int}\n@returns(201) {archived: bool, patient: int, description: str, doctor: int, metatags: str, updated_at: str, date: str, document: str, id: int} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/documents\n@desc Retrieve or search documents\n@optional {cursor: str, page_size: int, since: str, patient: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/staff/{id}\n@required {id: str}\n@optional {doctor: int}\n@returns(200) {username: str, first_name: str, last_name: str, user_id: str, doctor: str, created_at: str, updated_at: str, id: int, home_phone: str, active: str, cell_phone: str, email: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/users\n@desc Retrieve or search users, `/api/users/current` can be used to identify logged in user, it will redirect to `/api/users/{current_user_id}`\n@optional {cursor: str, page_size: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/lab_orders_summary/{id}\n@required {id: str}\n@optional {since: str, patient: int, doctor: int}\n@returns(200) {status: str, documents: [str], patient: int, doctor: int, timestamp: str, notes: str, accession_number: str, requisition_id: str, external_requisition_id: str, priority: str, icd10_codes: [map], sublab: int, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/audit_log\n@desc Retrieve or search audit logs.\n@optional {cursor: str, page_size: int, since: str, date_range: str, date: str, patient: int, doctor: int, user: int, appointment: int, type: str, action: str}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/task_notes/{id}\n@desc Update an existing task note\n@required {id: str}\n@optional {task: int, since: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/task_notes/{id}\n@desc Update an existing task note\n@required {id: str}\n@optional {task: int, since: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/task_notes/{id}\n@desc Retrieve an existing task note\n@required {id: str}\n@optional {task: int, since: str}\n@returns(200) {archived: bool, task: int, text: str, created_at: str, updated_at: str, created_by: str, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/custom_demographics/{id}\n@desc Update an existing custom demographics field\n@required {id: str}\n@optional {doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/custom_demographics/{id}\n@desc Update an existing custom demographics field\n@required {id: str}\n@optional {doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/custom_demographics/{id}\n@desc Retrieve an existing custom demographics field\n@required {id: str}\n@optional {doctor: int}\n@returns(200) {archived: bool, description: str, doctor: int, template_name: str, allowed_values: str, id: int, name: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/messages/{id}\n@desc Update an existing message in doctor's message center\n@required {id: str}\n@optional {patient: int, doctor: int, responsible_user: int, updated_since: str, received_since: str, owner: int, type: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/messages/{id}\n@desc Update an existing message in doctor's message center\n@required {id: str}\n@optional {patient: int, doctor: int, responsible_user: int, updated_since: str, received_since: str, owner: int, type: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/messages/{id}\n@desc Retrieve an existing message in doctor's message center\n@required {id: str}\n@optional {patient: int, doctor: int, responsible_user: int, updated_since: str, received_since: str, owner: int, type: str}\n@returns(200) {type_description: str, patient_middle_name: str, updated_at: str, owner: str, responsible_user_first_name: str, received_at: str, id: int, doctor_last_name: str, owner_first_name: str, archived: bool, doctor: int, owner_last_name: str, patient_first_name: str, attachment: str, outgoing_fax_recipient_fax_number: str, responsible_user_last_name: str, type: str, patient_last_name: str, patient: int, doctor_first_name: str, read: bool, responsible_user: str, workflow_step: str, outgoing_fax_recipient_name: str, doctor_middle_name: str, message_notes: [map], title: str, starred: bool} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint DELETE /api/messages/{id}\n@desc Delete an existing message in doctor's message center\n@required {id: str}\n@optional {patient: int, doctor: int, responsible_user: int, updated_since: str, received_since: str, owner: int, type: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/eobs/{id}\n@desc Retrieve an existing EOB object\n@required {id: str}\n@optional {doctor: int}\n@returns(200) {posted_date: str, insurance_payer_name: str, doctor: int, payment_method: str, deposit_date: str, updated_at: str, insurance_payer_id: str, scanned_eob: str, insurance_payer_trace_number: str, total_paid: num, check_date: str, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/doctor_options/{id}\n@desc Retrieve existing options for a doctor\n@required {id: str}\n@returns(200) {default_supervising_provider: int, doctor: int, updated_at: str, patient_statement_office: int, allowed_payment_methods: [any], default_report: int, default_billing_provider: int, default_reminder_profile: int, enable_everhealth_scribe: bool, office_for_lab_results: int, erx_supervising_providers: [int], iframe_apps: [str], id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/allergies\n@desc Create patient allergy\n@optional {patient: int, doctor: int}\n@returns(201) {status: str, reaction: str, patient: int, description: str, doctor: int, snomed_reaction: str, notes: str, verification_status: str, snomed_code: str, rxnorm: str, id: int} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/allergies\n@desc Retrieve or search patient allergies\n@optional {cursor: str, page_size: int, patient: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/appointments\n@desc Create a new appointment or break on doctor's calendar\n@required {office: int # Office ID, scheduled_time: str # The starting time of the appointment, doctor: int # Doctor ID, patient: int # ID of this appointment's patient. Breaks have a null patient field., exam_room: int # Index of the exam room that this appointment occurs in. See `/api/offices`}\n@optional {status: str(/Arrived/Checked In/Checked In Online/In Room/In Session/Complete/Confirmed/Not Confirmed/Rescheduled/Cancelled/No Show) # One of ``, `Arrived`, `Checked In`, `In Room`, `Cancelled`, `Complete`, `Confirmed`, `In Session`, `No Show`, `Not Confirmed`, or `Rescheduled`. Or one of the custom statuses., icd9_codes: [str], base_recurring_appointment: str # ID of base appointment of a recurring series, color: str, vitals: map{height_units: str, weight_units: str, pain: str, temperature: num, weight: num, smoking_status: str, head_circumference: num, bmi: str, head_circumference_units: str, blood_pressure_2: int, blood_pressure_1: int, height: num, pulse: int, oxygen_saturation: num, respiratory_rate: int, temperature_units: str} # Clinical vitals associated with the appointment, first_billed_date: str, last_billed_date: str, billing_status: str # Should be one of `Auto Accident Claim`, `Balance Due`, `Bill Insurance`, `Bill Secondary Insurance`, `Durable Medical Equipment Claim`, `Internal Review`, `Paid In Full`, `Settled`, `Worker's Comp Claim` or one of the custom billing status, primary_insurer_payer_id: str, duration: int # Length of the appointment in minutes. Optional if `profile` is provided., is_membership_appointment: bool # Whether the appointment is a membership plan charge rather than a real visit. DrChrono creates one future dated placeholder appointment per billing cycle of a patient's membership plan so the charge has something to attach to. They are hidden from the DrChrono calendar and never trigger DrChrono reminders, so appointment reminder integrations should skip them, or pass `exclude_membership=true` to leave them out of the response., appt_is_break: bool, id: str # Unique identifier. Usually numeric, but not always, custom_fields: [map{field_type: int, created_at: str, updated_at: str, field_value: str}] # Custom appointment fields, secondary_insurer_name: str, recur_start_date: str # For recurring appointments, the start date of the recurring series, primary_insurance_id_number: str, created_by: str, ins2_status: str(/Incomplete Information/In Process Emdeon/Rejected Emdeon/Rejected EPS/Rejected Jopari/In Process Payor/Rejected Waystar Professional/Rejected Waystar Institutional/In Process Payer/Payer Acknowledged/Rejected Payor/Rejected Payer/Paid in Full/Partially Paid/Coordination of Benefits/ERA Received/ERA Denied/HCFA Form Faxed) # Billing status of secondary insurer, first_edi_date: str, billing_notes: [map{text: str, created_at: str, appointment: int, id: int, created_by: str}] # Billing notes of the appointment. For writing, check `/api/claim_billing_notes`, is_walk_in: bool # Whether the appointment is a walk-in appointment, billing_provider: str, reminder_profile: str # Write-only. ID of an `/api/reminder_profiles` instance. Set this to apply a reminder profile to the appointment. Cannot be applied to an appointment with reminders., primary_insurer_name: str, profile: int # ID of an `/api/appointment_profiles` instance. The profile sets default values for `color`, `duration`, and `reason` on creation, which can be overriden by setting these values explicitly., resubmit_claim_original_id: int # ID of this claim id., recurrence_instance_key: str # A stable identifier for a recurring appointment instance, in the format `{rootSeriesId}_{YYYYMMDD}` where `YYYYMMDD` is the original occurrence date, not the current scheduled date. This value remains consistent across materialization, series splits, and rescheduling, so it should be treated as an opaque identifier rather than a source for display dates. Returns null for non-recurring appointments. Only present when the `consistent_recurrence_id` feature flag is enabled., cloned_from: int # ID of the original appointment which this appointment cloned from. Will be null if the appointment is not cloned., extended_updated_at: str # The most recent update time among appointment itself, its vitals and its custom vitals, updated_at: str, reason: str # Default to `\"\"`, last_edi_date: str, secondary_insurer_payer_id: str, allow_overlapping: bool # Bypass overlap check., payment_profile: str # Appointment Payment Profile, secondary_insurance_id_number: str, clinical_note: map{pdf: str, locked: bool, updated_at: str} # Associated clinical note object, custom_vitals: [map{value: str, vital_type: int}] # Custom vitals associated with this appointment., is_virtual_base: bool, recurring_appointment: bool # Whether the appointment is a recurring appointment or not, supervising_provider: str # Supervising provider of appointment if set., recurring_days: [any] # For recurring appointments, the days of the week on which the appointment recurs. Can include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday or Sunday, status_transitions: [map{appointment: str, to_status: str, from_status: str, datetime: str}], created_at: str, reminders: [map{scheduled_time: str, type: str, id: int}] # Scheduled reminders of the appointment, ins1_status: str(/Incomplete Information/In Process Emdeon/Rejected Emdeon/Rejected EPS/Rejected Jopari/In Process Payor/Rejected Waystar Professional/Rejected Waystar Institutional/In Process Payer/Payer Acknowledged/Rejected Payor/Rejected Payer/Paid in Full/Partially Paid/Coordination of Benefits/ERA Received/ERA Denied/HCFA Form Faxed) # Billing status of primary insurer, custom_status: str # AppointmentStatus Name, recur_end_date: str # For recurring appointments, the end date of the recurring series, icd10_codes: [str], deleted_flag: bool # Whether the appointment is deleted., notes: str, recurs_every: int # For recurring appointments, the number of weeks between recurrences. For example, if this is 2, the appointment recurs every other week.}\n@returns(201) {status: str, icd9_codes: [str], office: int, base_recurring_appointment: str, color: str, vitals: map{height_units: str, weight_units: str, pain: str, temperature: num, weight: num, smoking_status: str, head_circumference: num, bmi: str, head_circumference_units: str, blood_pressure_2: int, blood_pressure_1: int, height: num, pulse: int, oxygen_saturation: num, respiratory_rate: int, temperature_units: str}, first_billed_date: str, last_billed_date: str, billing_status: str, primary_insurer_payer_id: str, duration: int, is_membership_appointment: bool, appt_is_break: bool, id: str, custom_fields: [map], scheduled_time: str, secondary_insurer_name: str, doctor: int, recur_start_date: str, primary_insurance_id_number: str, created_by: str, ins2_status: str, first_edi_date: str, billing_notes: [map], is_walk_in: bool, billing_provider: str, reminder_profile: str, primary_insurer_name: str, profile: int, resubmit_claim_original_id: int, patient: int, recurrence_instance_key: str?, cloned_from: int, extended_updated_at: str, exam_room: int, updated_at: str, reason: str, last_edi_date: str, secondary_insurer_payer_id: str, allow_overlapping: bool, payment_profile: str, secondary_insurance_id_number: str, clinical_note: map{pdf: str, locked: bool, updated_at: str}, custom_vitals: [map], is_virtual_base: bool, recurring_appointment: bool, supervising_provider: str, recurring_days: [any], status_transitions: [map], created_at: str, reminders: [map], ins1_status: str, custom_status: str, recur_end_date: str, icd10_codes: [str], deleted_flag: bool, notes: str, recurs_every: int} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 409: Scheduled time overlaps with an existing appointment, 500: Internal Server Error}\n\n@endpoint GET /api/appointments\n@desc Retrieve or search appointment or breaks.\n@optional {cursor: str, page_size: int, status: str # Appointment status name, patient: int # Patient ID, office: int # Office ID, doctor: int # Doctor ID, since: str # Lower bound inclusive date filter for appointment updated/created date, occurred_since: str # Filter appointments based on scheduled time, date_range: str # Inclusive upper and lower bound filter for appointment scheduled date. Format: yyyy-mm-dd/yyyy-mm-dd. Max window size 190 days, verbose: bool # set to `true` to include clinical_note, custom_fields, custom_vitals, extended_updated_at, reminders, status_transitions, vitals but limit page_size to 25, date: str # Specific date filter for appointment scheduled date, ignore_virtual: bool # set to `true` to ignore virtual appointments that have not yet been materialized, show_archived: bool # set to `true` or `1` to include deleted or archived appointments, exclude_membership: bool # set to `true` or `1` to leave out membership plan charge appointments, which are internal placeholders rather than real visits. See `is_membership_appointment`}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 500: Internal Server Error}\n\n@endpoint GET /api/procedures/{id}\n@required {id: str}\n@optional {mu_date: str, patient: int, doctor: int, mu_date_range: str, appointment: int, service_date: str}\n@returns(200) {status: str, code: str, patient: int, description: str, doctor: int, created_at: str, updated_at: str, procedure_type: str, date: str, appointment: int, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/clinical_note_templates\n@desc Retrieve or search clinical note templates\n@optional {cursor: str, page_size: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/line_items/{id}\n@required {id: str}\n@optional {posted_date: str, patient: int, office: int, doctor: int, since: str, appointment: int, service_date: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/line_items/{id}\n@required {id: str}\n@optional {posted_date: str, patient: int, office: int, doctor: int, since: str, appointment: int, service_date: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/line_items/{id}\n@desc Retrieve an existing billing line item\n@required {id: str}\n@optional {posted_date: str, patient: int, office: int, doctor: int, since: str, appointment: int, service_date: str, service_date_range: str}\n@returns(200) {code: str, ins3_paid: num, updated_at: str, posted_date: str, billing_status: str, pt_paid: num, allowed: num, patient: str, adjustment: num, id: int, doctor: str, balance_pt: num, units: str, balance_ins: num, paid_total: str, diagnosis_pointers: [str], appointment: int, description: str, balance_total: str, price: num, expected_reimbursement: num, ins2_paid: num, ins1_paid: num, insurance_status: str, billed: num, modifiers: [str], denied_flag: bool, ins_total: str, procedure_type: str, service_date: str, quantity: num} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint DELETE /api/line_items/{id}\n@required {id: str}\n@optional {posted_date: str, patient: int, office: int, doctor: int, since: str, appointment: int, service_date: str}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/doctors\n@desc Retrieve or search doctors within practice group\n@optional {cursor: str, page_size: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/reminder_profiles\n@desc Create reminder profile\n@optional {doctor: int}\n@returns(201) {reminders: [map], id: int, name: str, doctor: int} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/reminder_profiles\n@desc Retrieve or search reminder profiles\n@optional {cursor: str, page_size: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patient_payment_log\n@desc Retrieve or search patient payment logs\n@optional {cursor: str, page_size: int, since: str, office: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/offices/{id}\n@desc Update an existing office\n@required {id: str}\n@optional {doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/offices/{id}\n@desc Update an existing office\n@required {id: str}\n@optional {doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/offices/{id}\n@desc Retrieve an existing office\n@required {id: str}\n@optional {doctor: int}\n@returns(200) {phone_number: str, city: str, archived: bool, office_work_schedule: map{work_days: [map], id: int, office: int, doctor: int}, name: str, doctor: str, country: str, start_time: str, fax_number: str, online_timeslots: [map], state: str, end_time: str, exam_rooms: str, address: str, tax_id_number_professional: str, zip_code: str, id: int, online_scheduling: bool} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patient_payment_log/{id}\n@desc Retrieve an existing patient payment log\n@required {id: str}\n@optional {since: str, office: int, doctor: int}\n@returns(200) {appointment: str, doctor: str, payment_method: str, updated_at: str, created_by: str, source: str, amount: num, action: str, patient: str, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/appointment_templates\n@desc Create appointment templates for a doctor's calendar\n@optional {profile: int, office: int, doctor: int}\n@returns(201) {profile: int, scheduled_time: str, archived: bool, week_days: [int], office: int, open_slots: [map], date_end: str, date_start: str, exam_room: int, duration: int, id: int} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/appointment_templates\n@desc Retrieve or search appointment templates for a doctor's calendar\n@optional {available: str, week_days: [int], cursor: str, page_size: int, profile: int, office: int, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/patient_vaccine_records\n@desc Create patient vaccine records\n@optional {cvx_code: str, patient: int, since: str, doctor: int}\n@returns(201) {lot_number: str, site: str, ordering_doctor: int, doses: [map], id: int, next_dose_date: str, cpt_code: str, completion_status: str, administered_at: int, comments: str, funding_eligibility: str, units: str, entered_by: str, patient: int, administration_start: str, record_source: str, updated_at: str, consent_form: int, manufacturer: str, administered_by: str, name: str, vis: str, created_at: str, observed_immunity: str, amount: num, vaccine_inventory: int, route: str, cvx_code: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/patient_vaccine_records\n@desc Retrieve or search patient vaccine records\n@optional {cursor: str, page_size: int, cvx_code: str, patient: int, since: str, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/telehealth_appointments/{id}\n@required {id: str}\n@optional {appointment: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/telehealth_appointments/{id}\n@required {id: str}\n@optional {appointment: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/telehealth_appointments/{id}\n@required {id: str}\n@optional {appointment: int, doctor: int}\n@returns(200) {sent_patient_email: any, appointment: int, created_at: str, updated_at: str, overlapping_duration: str, duration: int, telehealth_url: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PUT /api/comm_logs/{id}\n@desc Update an existing communication (phone call) logs\n@required {id: str}\n@optional {since: str, patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint PATCH /api/comm_logs/{id}\n@desc Update an existing communication (phone call) logs\n@required {id: str}\n@optional {since: str, patient: int, doctor: int}\n@returns(204) No Content\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/comm_logs/{id}\n@desc Retrieve an existing communication (phone call) logs\n@required {id: str}\n@optional {since: str, patient: int, doctor: int}\n@returns(200) {scheduled_time: str, archived: bool, appointment: int, doctor: int, title: str, created_at: str, author: str, updated_at: str, cash_charged: num, duration: int, patient: int, message: str, type: str, id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/prescription_messages\n@desc Retrieve or search prescription messages\n@optional {cursor: str, page_size: int, parent_message: int, since: str, patient: int, created_at: str, doctor: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/user_groups/{id}\n@desc Retrieve an existing user group\n@required {id: str}\n@optional {doctor: int}\n@returns(200) {archived: bool, name: str, practice_group: str, created_at: str, updated_at: str, members: [str], id: int} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/line_items\n@desc Create billing line item for appointments\n@optional {posted_date: str, patient: int, office: int, doctor: int, since: str, appointment: int, service_date: str, use_fee_schedule_defaults: bool # When true, resolves price and modifiers from the fee schedule before creating the line item. Only applies to CPT (C) and HCPCS (H) procedure types. Caller-supplied price and modifiers take precedence over fee schedule values.}\n@returns(201) {code: str, ins3_paid: num, updated_at: str, posted_date: str, billing_status: str, pt_paid: num, allowed: num, patient: str, adjustment: num, id: int, doctor: str, balance_pt: num, units: str, balance_ins: num, paid_total: str, diagnosis_pointers: [str], appointment: int, description: str, balance_total: str, price: num, expected_reimbursement: num, ins2_paid: num, ins1_paid: num, insurance_status: str, billed: num, modifiers: [str], denied_flag: bool, ins_total: str, procedure_type: str, service_date: str, quantity: num} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/line_items\n@desc Retrieve or search billing line items\n@optional {cursor: str, page_size: int, posted_date: str, patient: int, office: int, doctor: int, since: str, appointment: int, service_date: str}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /api/sublabs\n@desc Create sub-vendors\n@returns(201) {vendor_name: str, facility_code: str, id: int, name: str} # Created\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/sublabs\n@desc Retrieve or search sub vendors\n@optional {cursor: str, page_size: int}\n@returns(200) {previous: str, data: [map], next: str} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint GET /api/message_threads\n@desc Retrieve or search message threads in doctor's message center. (beta)\n@optional {cursor: str, page_size: int, doctor: int # Filter by doctor ID, practice_group: int # Filter by practice group ID, patient: int # Filter by patient ID, message_type: str # Filter by message type (e.g., \"GP\", \"GC\", \"MC\", \"IF\", \"OF\", etc.), archived: bool # Filter by archived status (true/false), starred: bool # Filter by starred status (true/false), unread_count: int # Filter threads with unread messages (pass any positive integer to get threads with unread_count > 0), updated_since: str # Filter by threads updated since this datetime (ISO 8601 format)}\n@returns(200) {previous: str?, data: [map], next: str?} # OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Permission Denied, 404: Not Found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@end\n"}}