154 lines
33 KiB
Markdown
154 lines
33 KiB
Markdown
### Provider Tools (147 tools)
|
|
|
|
*All provider tools require provider authentication (Sanctum token) for HIPAA-compliant access to clinical data.*
|
|
|
|
| Tool Name | Method | Endpoint | Description | Key Parameters |
|
|
| --------- | ------ | -------- | ----------- | -------------- |
|
|
| `provider_create_get_assemblyai_token` | POST | `/get-asseblyai-token` | Get AssemblyAI token | No parameters |
|
|
| `provider_get_create_meeting` | GET | `/create-meeting/{meeting_id}` | Show meeting details | **Required:** meeting_id (string) - Meeting ID |
|
|
| `provider_get_join_meeting` | GET | `/join-meeting/{meeting_id}` | Join a meeting | **Required:** meeting_id (string) - Meeting ID |
|
|
| `provider_create_start_call` | POST | `/api/start-call/{patient_id}/{agent_id}/{appointment_id}` | Start a call | **Required:** patient_id (integer) - Patient ID, **Required:** agent_id (integer) - Agent ID, **Required:** appointment_id (integer) - Appointment ID, **Optional:** title (string) - title property |
|
|
| `provider_get_get_realtime_questions` | GET | `/get-realtime-questions/{appointmentId}` | Get real-time questions | **Required:** appointmentId (integer) - Appointment ID |
|
|
| `provider_create_end_call` | POST | `/api/end-call/{patient_id}/{appointment_id}` | End a call | **Required:** patient_id (integer) - Patient ID, **Required:** appointment_id (integer) - Appointment ID |
|
|
| `provider_search_labs_search` | POST | `/api/labs/search` | Search labs by address | **Required:** address (string) - address property |
|
|
| `provider_create_book_appointment` | POST | `/api/book-appointment` | Book an appointment | **Required:** telemed_pros_id (integer) - telemed_pros_id property, **Required:** patient_id (integer) - patient_id property, **Required:** doctor_id (integer) - doctor_id property, **Required:** appointment_id (integer) - appointment_id property, **Required:** appointment_time (string) - appointment_time property |
|
|
| `provider_update_update_patient_info` | POST | `/api/update-patient-info/{patientId}` | Update patient information | **Required:** patientId (integer) - Patient ID, **Optional:** city (string) - city property, **Optional:** state (string) - state property, **Optional:** address (string) - address property, **Optional:** zip_code (string) - zip_code property, **Optional:** dob (string) - dob property |
|
|
| `provider_create_get_patient_info` | POST | `/api/get-patient-info/{patientId}` | Get patient information | **Required:** patientId (integer) - Patient ID |
|
|
| `provider_create_get_doctors_list` | POST | `/api/get-doctors-list` | Get doctors list | No parameters |
|
|
| `provider_create_get_appointment_list` | POST | `/api/get-appointment-list` | Get appointments list | No parameters |
|
|
| `provider_create_get_doctors_appointment_list` | POST | `/api/get-doctors-appointment-list` | Get doctor appointments list | No parameters |
|
|
| `provider_create_available_slots` | POST | `/api/available-slots/{date}` | Get available appointment slots | **Required:** date (string) - Date (YYYY-MM-DD) |
|
|
| `provider_create_appointment_detail` | POST | `/api/appointment-detail/{appointment}` | Get appointment details | **Required:** appointment (integer) - Appointment ID |
|
|
| `provider_get_lab_detail` | GET | `/api/lab-detail/{appointment}` | Get lab details for an appointment | **Required:** appointment (integer) - Appointment ID |
|
|
| `provider_create_add_note_patient` | POST | `/api/add-note-patient` | Add a note for patient | **Required:** note (string) - note property, **Required:** note_type (string) - note_type property |
|
|
| `provider_get_get_note_patient` | GET | `/api/get-note-patient` | Get patient notes | No parameters |
|
|
| `provider_update_appointment_status` | PUT | `/appointment-status/{id}/{status}` | Update appointment status | **Required:** id (integer) - Appointment ID, **Required:** status (string) - New status for the appointment |
|
|
| `provider_get_patient_data` | GET | `/api/patient-data/{id}` | Get patient data | **Required:** id (integer) - Patient ID |
|
|
| `provider_get_get_patient_forms_list` | GET | `/api/get-patient-forms-list/{pid}` | Get patient intake simple forms list | **Required:** pid (integer) - Patient ID |
|
|
| `provider_get_get_all_forms` | GET | `/api/get-all-forms` | Get all forms | No parameters |
|
|
| `provider_get_get_prescription_list` | GET | `/api/get-prescription-list/{patient_id}` | Get patient prescription list | **Required:** patient_id (integer) - Patient ID |
|
|
| `provider_create_assistant_store_intake_form_data` | POST | `/api/assistant/store-intake-form-data` | Store intake form data | No parameters |
|
|
| `provider_create_assistant_store_form` | POST | `/api/assistant/store-form` | Store form data | **Required:** type (string) - type property, **Required:** data (object) - Form structure and fields, **Required:** name (string) - name property |
|
|
| `provider_create_store_company` | POST | `/api/store-company` | Update company information | No parameters |
|
|
| `provider_update_assistant_update_form` | PUT | `/api/assistant/update-form/{id}` | Update form | **Required:** id (integer) - Form ID, **Required:** type (string) - type property, **Required:** data (object) - Form structure and fields, **Required:** name (string) - name property |
|
|
| `provider_create_save_category` | POST | `/api/save-category` | Store product category | **Required:** name (string) - name property, **Optional:** description (string) - description property |
|
|
| `provider_update_update_category` | POST | `/api/update-category/{id}` | Update product category | **Required:** id (integer) - Category ID, **Required:** name (string) - name property, **Optional:** description (string) - description property |
|
|
| `provider_create_save_product` | POST | `/api/save-product` | Save product | **Required:** name (string) - name property, **Optional:** description (string) - description property, **Required:** price (number) - price property, **Required:** category_id (integer) - category_id property, **Optional:** sku (string) - sku property |
|
|
| `provider_update_update_product` | POST | `/api/update-product/{id}` | Update product | **Required:** id (integer) - Product ID, **Required:** name (string) - name property, **Optional:** description (string) - description property, **Required:** price (number) - price property, **Required:** category_id (integer) - category_id property, **Optional:** sku (string) - sku property |
|
|
| `provider_create_assistant_save_signature` | POST | `/api/assistant/save-signature` | Store signature | **Required:** signature_data (string) - Base64 encoded signature image, **Optional:** provider_id (integer) - provider_id property |
|
|
| `provider_create_save_payment_method` | POST | `/api/save-payment-method` | Store payment method configuration | **Required:** payment_method (string) - payment_method property, **Optional:** api_key (string) - api_key property, **Optional:** secret_key (string) - secret_key property, **Optional:** is_active (boolean) - is_active property |
|
|
| `provider_update_company_complete_setup` | PUT | `/api/company/complete/setup/{status}` | Complete company setup | **Required:** status (string) - Setup status (complete or incomplete) |
|
|
| `provider_create_get_appointment_list_date` | POST | `/api/get-appointment-list-date` | Get appointment list by date | **Optional:** date (string) - date property, **Optional:** practitioner_id (integer) - practitioner_id property |
|
|
| `provider_create_get_appointment_by_id` | POST | `/api/get-appointment-by-id` | Get appointment by ID | **Required:** appointment_id (integer) - appointment_id property |
|
|
| `provider_update_update_intake_form_data` | POST | `/api/update-intake-form-data` | Update intake form data | **Required:** form_id (integer) - form_id property, **Required:** pid (integer) - pid property, **Required:** data (object) - data property |
|
|
| `provider_create_form_pdf_save` | POST | `/api/form-pdf-save` | Save form file | **Required:** form_id (integer) - form_id property, **Required:** pdf_data (string) - Base64 encoded PDF data |
|
|
| `provider_create_provider_add_availability` | POST | `/api/provider-add-availability` | Store provider availability | **Required:** title (string) - title property, **Required:** start (string) - start property, **Required:** end (string) - end property, **Required:** type (string) - availability or event, **Optional:** comment (string) - comment property |
|
|
| `provider_get_assistant_practitioners_list` | GET | `/api/assistant/practitioners-list` | Get practitioners list via assistant | No parameters |
|
|
| `provider_create_save_payment_method` | POST | `/save-payment-method` | Save payment method configuration | **Required:** name (string) - name property, **Required:** config (object) - config property |
|
|
| `provider_get_provider_wizard_setup` | GET | `/emr-api/provider-wizard-setup` | Get provider setup counts | No parameters |
|
|
| `provider_update_company_complete_setup` | PUT | `/emr-api/company/complete/setup/{status}` | Complete provider setup | **Required:** status (integer) - Setup status (1 for complete, 0 for incomplete) |
|
|
| `provider_get_company_status` | GET | `/emr-api/company/status` | Get company status | No parameters |
|
|
| `provider_create_store_company` | POST | `/emr-api/store-company` | Update company information | No parameters |
|
|
| `provider_get_get_company` | GET | `/emr-api/get-company` | Get company information | No parameters |
|
|
| `provider_create_save_signature` | POST | `/api/save-signature` | Save provider signature | **Required:** signature (string) - signature property |
|
|
| `provider_get_provider_practitioners_list` | GET | `/api/provider/practitioners-list` | Get practitioners list | No parameters |
|
|
| `provider_create_provider_auth_logout` | POST | `/api/provider/auth/logout` | Logout provider | No parameters |
|
|
| `provider_create_appointment_cancel` | POST | `/api/emr/appointment/{id}/cancel` | Cancel an appointment | **Required:** id (integer) - Appointment ID |
|
|
| `provider_get_appointment_order` | GET | `/api/emr/appointment/{appointment_id}/order` | Get appointment order details | **Required:** appointment_id (integer) - Appointment ID |
|
|
| `provider_get_appointment_list_by_date` | GET | `/api/emr/appointment/list-by-date` | Get appointments by date range | **Required:** start_date (string) - Start date (YYYY-MM-DD), **Required:** end_date (string) - End date (YYYY-MM-DD) |
|
|
| `provider_get_appointment_transcribe` | GET | `/api/emr/appointment/transcribe/{patient_id}` | Get appointment transcriptions | **Required:** patient_id (integer) - Patient ID |
|
|
| `provider_get_appointment_patient_list` | GET | `/api/emr/appointment/patient/{patient_id}/list` | Get patient appointment list | **Required:** patient_id (integer) - Patient ID |
|
|
| `provider_get_appointment_detail` | GET | `/api/emr/appointment/{appointment}/detail` | Get appointment details | **Required:** appointment (integer) - Appointment ID |
|
|
| `provider_create_appointment_queue` | POST | `/api/emr/appointment/queue/{patientId}` | Add patient to queue | **Required:** patientId (integer) - Patient ID |
|
|
| `provider_get_appointment_doctor_patient` | GET | `/api/emr/appointment/doctor/patient/{patientId}` | Get doctor appointments by patient ID | **Required:** patientId (integer) - Patient ID |
|
|
| `provider_get_appointment_patient_carts_items` | GET | `/api/emr/appointment/patient/carts-items` | Get patient appointments with carts and items | No parameters |
|
|
| `provider_get_appointment_report_last_30_days` | GET | `/api/emr/appointment/report/last-30-days` | Get appointment data for last 30 days | **Required:** start_date (string) - Start date (YYYY-MM-DD), **Required:** end_date (string) - End date (YYYY-MM-DD), **Optional:** provider (string) - Provider ID or 'all' for all providers |
|
|
| `provider_get_appointment_agent` | GET | `/api/emr/appointment/agent/{appointment}` | Get agent appointment details | **Required:** appointment (integer) - Appointment ID |
|
|
| `provider_update_appointment_update_meeting_analysis` | POST | `/api/emr/appointment/{appointment}/update-meeting-analysis` | Update meeting analysis | **Required:** appointment (integer) - Appointment ID, **Optional:** data (object) - Meeting analytics data |
|
|
| `provider_get_document_download` | GET | `/api/document/download/{rowId}/{key}` | Download a patient document | **Required:** rowId (integer) - ID of the intake form record, **Required:** key (string) - Key identifier for the document in the form data |
|
|
| `provider_get_render_pdf` | GET | `/api/render/pdf/{rowId}` | Render a PDF document | **Required:** rowId (integer) - ID of the intake form record |
|
|
| `provider_create_add_email` | POST | `/api/add-email/{patient_id}` | Add a new email for a patient | **Required:** patient_id (integer) - ID of the patient, **Optional:** practitioner (integer) - User ID of the practitioner, **Required:** messageText (string) - messageText property, **Required:** to_email (string) - to_email property, **Optional:** from_email (string) - from_email property, **Optional:** emailTemplate (string) - Template name used for the email |
|
|
| `provider_get_get_email_list` | GET | `/api/get-email-list/{patient_id}` | Get email list for a patient | **Required:** patient_id (integer) - ID of the patient, **Optional:** draw (integer) - DataTables draw counter, **Optional:** start (integer) - DataTables start offset, **Optional:** length (integer) - DataTables page length, **Optional:** search[value] (string) - DataTables search value, **Optional:** order[0][column] (integer) - DataTables column index for ordering, **Optional:** order[0][dir] (string) - DataTables order direction (asc/desc) |
|
|
| `provider_get_get_email` | GET | `/api/get-email/{id}` | Get an email by ID | **Required:** id (integer) - ID of the email to retrieve |
|
|
| `provider_get_get_forms` | GET | `/api/get-forms/{type}` | Get forms by type | **Required:** type (string) - Form type (simple-forms, consent-forms, charting-forms, etc.) |
|
|
| `provider_get_get_form` | GET | `/api/get-form/{id}` | Get form by ID | **Required:** id (integer) - Form ID |
|
|
| `provider_update_update_form` | PUT | `/api/update-form/{id}` | Update form | **Required:** id (integer) - Form ID, **Required:** type (string) - Form type (simple-forms, consent-forms, charting-forms, etc.), **Required:** data (object) - Form structure and fields, **Required:** name (string) - name property |
|
|
| `provider_delete_delete_form` | DELETE | `/api/delete-form/{id}` | Delete form | **Required:** id (integer) - Form ID |
|
|
| `provider_get_get_patient_intake_form_data` | GET | `/api/get-patient-intake-form-data/{form_id}/{pid}/{rowId}` | Get patient intake form data | **Required:** form_id (integer) - Form ID, **Required:** pid (integer) - Patient ID, **Required:** rowId (integer) - Row ID of the specific form submission |
|
|
| `provider_get_get_patient_intake_form_latest_data` | GET | `/api/get-patient-intake-form-latest-data/{form_id}/{pid}` | Get latest intake form data | **Required:** form_id (integer) - Form ID, **Required:** pid (integer) - Patient ID |
|
|
| `provider_get_get_patient_submitted_intake_forms` | GET | `/api/get-patient-submitted-intake-forms/{pid}` | Get all submitted forms for a patient | **Required:** pid (integer) - Patient ID |
|
|
| `provider_get_get_patient_intake_form_list` | GET | `/api/get-patient-intake-form-list/{type}/{pid}` | Get patient intake forms by type | **Required:** type (string) - Form type (simple-forms, consent-forms, charting-forms, etc.), **Required:** pid (integer) - Patient ID |
|
|
| `provider_update_update_form_status` | PUT | `/api/update-form-status` | Update form request status | **Required:** form_id (integer) - form_id property, **Required:** patient_id (integer) - patient_id property, **Required:** status (string) - status property |
|
|
| `provider_get_get_intake_forms_list` | GET | `/api/get-intake-forms-list` | Get intake forms list | No parameters |
|
|
| `provider_create_store_patient_consent_form` | POST | `/api/store-patient-consent-form` | Store patient consent form | **Required:** form_id (integer) - form_id property, **Required:** pid (integer) - pid property, **Required:** data (object) - data property, **Required:** name (string) - name property, **Required:** signature (string) - signature property |
|
|
| `provider_create_store_form` | POST | `/api/store-form` | Store a new form | **Required:** type (string) - Form type (simple-forms, consent-forms, charting-forms, etc.), **Required:** data (object) - Form structure and fields, **Required:** name (string) - name property |
|
|
| `provider_delete_delete_intake_question` | DELETE | `/api/delete-intake-question/{form_id}` | Delete intake question | **Required:** form_id (integer) - Intake question ID |
|
|
| `provider_get_get_intake_forms_data` | GET | `/api/get-intake-forms-data/{form_id}` | Get intake form data by ID | **Required:** form_id (integer) - Form ID |
|
|
| `provider_get_get_document_vue` | GET | `/api/get-document-vue/{patient_id}` | Get documents for Vue component | **Required:** patient_id (integer) - Patient ID |
|
|
| `provider_get_get_patient_forms` | GET | `/api/get-patient-forms/{pid}` | Get all forms for a patient | **Required:** pid (integer) - Patient ID |
|
|
| `provider_get_get_patient_questionnaire_form_list` | GET | `/api/get-patient-questionnaire-form-list/{pid}` | Get patient questionnaire forms | **Required:** pid (integer) - Patient ID |
|
|
| `provider_get_get_questioner_forms_data` | GET | `/api/get-questioner-forms-data/{form_id}` | Get questionnaire form data | **Required:** form_id (integer) - Form ID |
|
|
| `provider_get_get_questioner_question` | GET | `/api/get-questioner-question/{id}` | Get questionnaire question by ID | **Required:** id (integer) - Question ID |
|
|
| `provider_get_get_insurance` | GET | `/get-insurance/{patientId}` | Get insurance information for a patient | **Required:** patientId (integer) - ID of the patient |
|
|
| `provider_create_store_insurance` | POST | `/store-insurance/{patientId}` | Store insurance information for a patient | **Required:** patientId (integer) - ID of the patient, **Optional:** insurance (string) - insurance property, **Required:** insuredPlanOrProgramName (string) - insuredPlanOrProgramName property, **Required:** insuredIDNumber (string) - insuredIDNumber property, **Optional:** insuredGroupNameNo (string) - insuredGroupNameNo property, **Optional:** employersSchoolName (string) - employersSchoolName property |
|
|
| `provider_update_update_insurance` | PUT | `/update-insurance/{patientId}` | Update insurance information for a patient | **Required:** patientId (integer) - ID of the patient, **Required:** insuredPlanOrProgramName (string) - insuredPlanOrProgramName property, **Required:** insuredIDNumber (string) - insuredIDNumber property, **Optional:** insuredGroupNameNo (string) - insuredGroupNameNo property, **Required:** relationshiptoInsured (string) - relationshiptoInsured property, **Required:** insuredDateOfBirth (string) - insuredDateOfBirth property |
|
|
| `provider_get_inventory` | GET | `/inventory` | Get inventory list | No parameters |
|
|
| `provider_get_get_inventory` | GET | `/get-inventory/{id}` | Get inventory item by ID | **Required:** id (integer) - ID of the inventory item |
|
|
| `provider_create_add_inventory` | POST | `/add-inventory` | Add new inventory item | **Optional:** inventoryType (string) - inventoryType property, **Optional:** item_name (string) - item_name property, **Optional:** price (number) - price property, **Optional:** expirationDate (string) - expirationDate property |
|
|
| `provider_update_update_inventory` | PUT | `/update-inventory/{id}` | Update inventory item | **Required:** id (integer) - ID of the inventory item to update, **Optional:** inventoryType (string) - inventoryType property, **Optional:** item_name (string) - item_name property, **Optional:** price (number) - price property, **Optional:** expirationDate (string) - expirationDate property |
|
|
| `provider_delete_delete_inventory` | DELETE | `/delete-inventory/{id}` | Delete inventory item | **Required:** id (integer) - ID of the inventory item to delete |
|
|
| `provider_get_locations` | GET | `/api/locations` | Get all locations | **Optional:** draw (integer) - DataTables draw counter, **Optional:** start (integer) - DataTables start offset, **Optional:** length (integer) - DataTables page length, **Optional:** search[value] (string) - DataTables search value, **Optional:** order[0][column] (integer) - DataTables column index for ordering, **Optional:** order[0][dir] (string) - DataTables order direction (asc/desc) |
|
|
| `provider_get_location` | GET | `/api/location/{id}` | Get a location by ID | **Required:** id (integer) - ID of the location to retrieve |
|
|
| `provider_get_get_location` | GET | `/api/get-location/{uuid}` | Get a location by UUID | **Required:** uuid (string) - UUID of the location to retrieve |
|
|
| `provider_create_add_location` | POST | `/api/add-location` | Add a new location | **Required:** name (string) - name property, **Required:** npiNumber (string) - npiNumber property, **Required:** phoneNumber (string) - phoneNumber property, **Required:** address (string) - address property, **Required:** city (string) - city property |
|
|
| `provider_update_update_location` | PUT | `/api/update-location/{id}` | Update a location by ID | **Required:** id (integer) - ID of the location to update, **Required:** name (string) - name property, **Required:** npiNumber (string) - npiNumber property, **Required:** phoneNumber (string) - phoneNumber property, **Required:** address (string) - address property, **Required:** city (string) - city property |
|
|
| `provider_update_update_location` | PUT | `/api/update-location/{uuid}` | Update a location by UUID | **Required:** uuid (string) - UUID of the location to update, **Required:** name (string) - name property, **Required:** npiNumber (string) - npiNumber property, **Required:** phoneNumber (string) - phoneNumber property, **Required:** address (string) - address property, **Required:** city (string) - city property |
|
|
| `provider_create_medical_problems_store` | POST | `/api/medical-problems-store/{pid}` | Add a new medical problem for a patient | **Required:** pid (integer) - ID of the patient, **Required:** name (string) - name property, **Required:** lastDate (string) - lastDate property, **Required:** nextDate (string) - nextDate property, **Required:** screeningDetails (string) - screeningDetails property, **Required:** flag (string) - Status flag for the medical problem |
|
|
| `provider_update_medical_problems_update` | PUT | `/api/medical-problems-update/{id}` | Update an existing medical problem | **Required:** id (integer) - ID of the medical problem to update, **Required:** name (string) - name property, **Required:** lastDate (string) - lastDate property, **Required:** nextDate (string) - nextDate property, **Required:** screeningDetails (string) - screeningDetails property, **Required:** flag (string) - Status flag for the medical problem |
|
|
| `provider_get_medical_problem` | GET | `/api/medical-problem/{id}` | Get a medical problem by ID | **Required:** id (integer) - ID of the medical problem to retrieve |
|
|
| `provider_create_add_phone_log` | POST | `/add-phone-log/{patient_id}` | Add a new phone log for a patient | **Required:** patient_id (integer) - ID of the patient, **Required:** provider (string) - Name of the provider who made/received the call, **Required:** message (string) - Details about the phone call, **Required:** user_id (integer) - ID of the user who logged the call |
|
|
| `provider_get_phone_log_list` | GET | `/phone-log-list/{patient_id}` | Get phone logs for a patient | **Required:** patient_id (integer) - ID of the patient, **Optional:** draw (integer) - Draw counter for DataTables, **Optional:** start (integer) - Paging first record indicator for DataTables, **Optional:** length (integer) - Number of records per page for DataTables |
|
|
| `provider_create_plans_product_sync` | POST | `/api/plans-product-sync` | Save multiple products | **Required:** builder_id (string) - Base64 encoded builder ID, **Required:** products (array) - products property |
|
|
| `provider_create_plans_product_update` | POST | `/api/plans-product-update` | Update product on publish | **Required:** builder_id (string) - Base64 encoded builder ID, **Required:** product_id (integer) - product_id property, **Required:** product_name (string) - product_name property, **Required:** product_price (number) - product_price property, **Required:** product_slug (string) - product_slug property |
|
|
| `provider_create_tags_store` | POST | `/tags/store/{pid}` | Store tags for a patient | **Required:** pid (integer) - Patient ID, **Required:** tags (array) - Array of tag names to be associated with the patient |
|
|
| `provider_create_store_tags` | POST | `/store-tags/{patientId}` | Store tags for a patient (alternate endpoint) | **Required:** patientId (integer) - Patient ID, **Required:** tags (array) - Array of tag names to be associated with the patient |
|
|
| `provider_get_tags_list` | GET | `/tags/list/{pid}` | Get tags for a patient | **Required:** pid (integer) - Patient ID |
|
|
| `provider_create_add_task` | POST | `/api/add-task/{patient_id}` | Add a new task for a patient | **Required:** patient_id (integer) - ID of the patient, **Required:** task_title (string) - task_title property, **Required:** task_body (string) - task_body property, **Required:** task_due_date (string) - task_due_date property, **Required:** task_assigned_to (integer) - task_assigned_to property, **Optional:** task_watchers (array) - task_watchers property |
|
|
| `provider_update_update_task` | PUT | `/api/update-task/{task_id}` | Update an existing task | **Required:** task_id (integer) - ID of the task to update, **Optional:** task_title (string) - task_title property, **Optional:** task_body (string) - task_body property, **Optional:** task_due_date (string) - task_due_date property, **Optional:** task_assigned_to (integer) - task_assigned_to property, **Optional:** task_watchers (array) - task_watchers property |
|
|
| `provider_get_task` | GET | `/api/task/{id}` | Get a task by ID | **Required:** id (integer) - ID of the task to retrieve |
|
|
| `provider_get_tasks` | GET | `/api/tasks/{patient_id}` | Get all tasks for a patient | **Required:** patient_id (integer) - ID of the patient, **Optional:** draw (integer) - DataTables draw counter, **Optional:** start (integer) - DataTables start offset, **Optional:** length (integer) - DataTables page length, **Optional:** search[value] (string) - DataTables search value, **Optional:** order[0][column] (integer) - DataTables column index for ordering, **Optional:** order[0][dir] (string) - DataTables order direction (asc/desc) |
|
|
| `provider_get_user_list` | GET | `/api/user-list` | Get list of users | No parameters |
|
|
| `provider_get_user_list` | GET | `/api/user-list/{id}` | Get user by ID | **Required:** id (integer) - User ID |
|
|
| `provider_update_update_user` | POST | `/api/update-user/{id}` | Update user | **Required:** id (integer) - User ID, **Required:** firstName (string) - firstName property, **Required:** lastName (string) - lastName property, **Required:** textMessageNumber (string) - textMessageNumber property, **Required:** timezone (string) - timezone property, **Optional:** dateOfBirth (string) - dateOfBirth property |
|
|
| `provider_create_user_create` | POST | `/api/user/create` | Create new user from admin | No parameters |
|
|
| `provider_create_add_user` | POST | `/api/add-user` | Add new user (legacy method) | No parameters |
|
|
| `provider_get_practitioners_list` | GET | `/api/practitioners-list` | Get practitioners list | No parameters |
|
|
| `provider_get_patient_me` | GET | `/patient/me` | Get patient details by access token | No parameters |
|
|
| `provider_get_provider_me` | GET | `/provider/me` | Get provider details by access token | No parameters |
|
|
| `provider_get_patients` | GET | `/api/patients` | Get a list of patients | **Optional:** firstName (string) - Filter by patient's first name, **Optional:** lastName (string) - Filter by patient's last name, **Optional:** dateOfBirth (string) - Filter by patient's date of birth (YYYY-MM-DD), **Optional:** email (string) - Filter by patient's email |
|
|
| `provider_auth_patient_register_patient` | POST | `/api/patient/register-patient` | Register a new patient | **Required:** first_name (string) - first_name property, **Required:** last_name (string) - last_name property, **Required:** email (string) - email property, **Required:** phone_no (string) - phone_no property, **Required:** dob (string) - dob property |
|
|
| `provider_update_update_password` | POST | `/api/update-password` | Update patient password | **Required:** new_password (string) - new_password property |
|
|
| `provider_create_store_document` | POST | `/api/store-document/{patientId}` | Store patient documents | **Required:** patientId (integer) - Patient ID |
|
|
| `provider_get_get_document` | GET | `/api/get-document/{patientId}` | Get patient documents | **Required:** patientId (integer) - Patient ID |
|
|
| `provider_get_get_document_by_id` | GET | `/api/get-document-by-id/{patientId}/{did}` | Get a specific patient document by ID | **Required:** patientId (integer) - Patient ID, **Required:** did (integer) - Document ID |
|
|
| `provider_create_add_vital` | POST | `/api/add-vital/{patientId}` | Add vital signs for a patient | **Required:** patientId (integer) - Patient ID, **Required:** provider_id (integer) - provider_id property, **Optional:** blood_presssure (string) - blood_presssure property, **Optional:** diastolic (string) - diastolic property, **Optional:** weight_lbs (number) - weight_lbs property, **Optional:** height_ft (integer) - height_ft property |
|
|
| `provider_get_get_stored_methods` | GET | `/api/get-stored-methods/{id}` | Get stored payment methods | **Required:** id (integer) - Patient ID |
|
|
| `provider_get_patient_medical_problem` | GET | `/api/patient/medical-problem/{id}` | Get medical problem by ID | **Required:** id (integer) - Medical problem ID |
|
|
| `provider_update_patient_medical_problem` | PUT | `/api/patient/medical-problem/{id}` | Update medical problem | **Required:** id (integer) - Medical problem ID, **Optional:** description (string) - description property, **Optional:** date_of_onset (string) - date_of_onset property, **Optional:** status (string) - status property |
|
|
| `provider_get_patient_history` | GET | `/api/patient/history/{patientId}` | Get patient history | **Required:** patientId (integer) - Patient ID |
|
|
| `provider_create_patient_medical_problem` | POST | `/api/patient/medical-problem/{pid}` | Store medical problem | **Required:** pid (integer) - Patient ID, **Optional:** description (string) - description property, **Optional:** date_of_onset (string) - date_of_onset property, **Optional:** status (string) - status property |
|
|
| `provider_create_patient_profile_picture` | POST | `/api/patient/profile-picture` | Upload profile picture | No parameters |
|
|
| `provider_get_patient_prescription` | GET | `/api/patient/prescription` | Get patient prescriptions | No parameters |
|
|
| `provider_get_patient_session_history` | GET | `/api/patient/session-history` | Get patient session history | No parameters |
|
|
| `provider_get_patient_notifications` | GET | `/api/patient/notifications` | Get patient notifications | No parameters |
|
|
| `provider_get_patient_data` | GET | `/api/patient/data` | Get patient data | No parameters |
|
|
| `provider_get_patient_subscriptions` | GET | `/api/patient/subscriptions` | Get patient subscription list | No parameters |
|
|
| `provider_create_patient_subscription_cancel` | POST | `/api/patient/subscription/{subscription}/cancel` | Cancel subscription | **Required:** subscription (integer) - Subscription ID, **Optional:** reason (string) - reason property, **Optional:** feedback (string) - feedback property |
|
|
| `provider_create_patient_process_payment` | POST | `/api/patient/process-payment` | Process payment | **Required:** amount (number) - amount property, **Required:** payment_method (string) - payment_method property, **Required:** currency (string) - currency property, **Optional:** payment_method_id (string) - payment_method_id property, **Optional:** description (string) - description property |
|
|
| `provider_create_token_generate_temporary` | POST | `/api/token/generate-temporary` | Generate a temporary API token | **Required:** user_id (integer) - user_id property, **Required:** expires_in_hours (integer) - expires_in_hours property, **Optional:** abilities (array) - abilities property |
|
|
| `provider_get_token_list` | GET | `/api/token/list/{userId}` | List all tokens for a user | **Required:** userId (integer) - User ID |
|
|
| `provider_delete_token_revoke` | DELETE | `/api/token/revoke` | Revoke a specific token | **Required:** token_id (integer) - token_id property |
|
|
| `provider_delete_token_revoke_all` | DELETE | `/api/token/revoke-all/{userId}` | Revoke all tokens for a user | **Required:** userId (integer) - User ID |
|
|
| `provider_create_token_create_with_abilities` | POST | `/api/token/create-with-abilities` | Create a token with specific abilities | **Required:** user_id (integer) - user_id property, **Required:** token_name (string) - token_name property, **Required:** abilities (array) - abilities property, **Optional:** expires_in_hours (integer) - expires_in_hours property |
|
|
| `provider_create_token_refresh` | POST | `/api/token/refresh` | Refresh current token | No parameters |
|