first
This commit is contained in:
nasir@endelospay.com
412
MCP-TOOLS-REFERENCE.md
Normal file
412
MCP-TOOLS-REFERENCE.md
Normal file
@@ -0,0 +1,412 @@
|
||||
# Laravel Healthcare MCP Server - Complete Tools Reference
|
||||
|
||||
## Overview
|
||||
|
||||
This document provides a comprehensive reference for all MCP (Model Context Protocol) tools available in the Laravel Healthcare MCP Server. The server provides **318** tools organized by authentication type and functionality (updated 2025-07-10).
|
||||
|
||||
## Authentication Types
|
||||
|
||||
- **PUBLIC**: No authentication required (login, registration, public data)
|
||||
- **PROVIDER**: Provider authentication required (clinical data, EMR operations)
|
||||
- **PATIENT**: Patient authentication required (patient portal operations)
|
||||
- **PARTNER**: Partner authentication required (business operations)
|
||||
- **AFFILIATE**: Affiliate authentication required (affiliate management)
|
||||
- **NETWORK**: Network authentication required (network operations)
|
||||
|
||||
## Tool Naming Convention
|
||||
|
||||
All tools follow the pattern: `{auth_type}_{method}_{resource}`
|
||||
|
||||
- **auth_type**: Authentication type (public, provider, patient, etc.)
|
||||
- **method**: HTTP method (get, post, put, delete)
|
||||
- **resource**: API resource or endpoint identifier
|
||||
|
||||
---
|
||||
|
||||
## Public Tools (77 tools)
|
||||
|
||||
_No authentication required. These tools handle login, registration, password management, and public data access._
|
||||
|
||||
| Tool Name | Method | Endpoint | Description | Key Parameters |
|
||||
| ------------------------------------------------- | ------ | ----------------------------------------------- | ------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `public_create_login` | POST | `/api/login` | General login (uses username field) | **Required:** username (string), password (string) |
|
||||
| `public_create_patient_login_api` | POST | `/api/patient-login-api` | Patient login API | **Required:** email (string), password (string) |
|
||||
| `public_create_login_partner_api` | POST | `/api/login-partner-api` | Partner login | **Required:** email (string), password (string) |
|
||||
| `public_create_affiliate_login_api` | POST | `/api/affiliate-login-api` | Affiliate login | **Required:** email (string), password (string) |
|
||||
| `public_create_network_login` | POST | `/api/network/login` | Network login | **Required:** email (string), password (string) |
|
||||
| `public_create_admin_login` | POST | `/api/admin/login` | Super admin login | **Required:** email (string), password (string) |
|
||||
| `public_create_frontend_login` | POST | `/api/frontend/login` | Patient portal login | **Required:** email (string), password (string) |
|
||||
| `public_create_register_patients` | POST | `/api/register-patients` | Register patient with actual parameter names from patient/register.vue | **Required:** first_name (string), first_name (string), last_name (string), email (string), phone_no (string), dob (string), gender (string), provider_id (integer), last_name (string), preferredPhone (string), email (string), dob (string), gender (string), password (string), **Optional:** username (string), isportalAccess (boolean) |
|
||||
| `public_create_partner_register_api` | POST | `/api/partner-register-api` | Partner registration with actual parameter names from partner/register.vue | **Required:** first_name (string), last_name (string), phone_no (string), email (string), dob (string), gender (string), password (string) |
|
||||
| `public_create_affiliate_register_api` | POST | `/api/affiliate-register-api` | Affiliate registration with actual parameter names from affiliate/register.vue | **Required:** first_name (string), last_name (string), phone_no (string), email (string), dob (string), gender (string), partner_email (string) |
|
||||
| `public_create_network_register` | POST | `/api/network/register` | Network registration with actual parameter names from network/register.vue | **Required:** first_name (string), last_name (string), phone_no (string), email (string), dob (string), gender (string), password (string), partner_id (string) |
|
||||
| `public_create_emr_provider_register` | POST | `/api/emr/provider/register` | Provider registration (public access) | **Required:** firstName (string), lastName (string), emailAddress (string), username (string), newUserPassword (string), confirm_password (string), **Optional:** textMessageNumber (string), accessRights (object), company_name (string), on_your_domain (boolean), dummy (string) |
|
||||
| `public_create_emr_set_password` | POST | `/api/emr/set-password` | Create password | **Required:** password (string), password_confirmation (string), token (string) |
|
||||
| `public_create_set_password` | POST | `/api/set-password` | Save provider password | **Required:** password (string), password_confirmation (string), token (string) |
|
||||
| `public_create_affiliate_set_password` | POST | `/api/affiliate/set-password` | Save affiliate password | **Required:** password (string), password_confirmation (string), token (string) |
|
||||
| `public_create_frontend_forgot_password` | POST | `/api/frontend/forgot-password` | Patient forgot password | **Required:** email (string) |
|
||||
| `public_create_frontend_reset_password` | POST | `/api/frontend/reset-password` | Patient reset password | **Required:** email (string), password (string), password_confirmation (string), token (string) |
|
||||
| `public_create_emr_provider_forgot_password` | POST | `/api/emr/provider/forgot-password` | Provider forgot password | **Required:** email (string) |
|
||||
| `public_create_emr_provider_reset_password` | POST | `/api/emr/provider/reset-password` | Provider reset password | **Required:** email (string), password (string), password_confirmation (string), token (string) |
|
||||
| `public_create_public_manage_verify_email` | POST | `/api/public-manage-verify-email` | Email verification | **Required:** token (string), email (string) |
|
||||
| `public_create_public_manage_resend_verification` | POST | `/api/public-manage-resend-verification` | Resend verification email | **Required:** email (string) |
|
||||
| `public_get_get_pdf_url_id` | GET | `/api/get-pdf-url/{document_id}` | Get PDF URL | **Required:** document_id (string) |
|
||||
| `public_get_appointment_verify_id` | GET | `/api/appointment/verify/{appointmentId}` | Verify appointment access and redirect | **Required:** appointmentId (string) |
|
||||
| `public_get_appointment_participants_id` | GET | `/api/appointment-participants/{appointmentId}` | Get appointment participants | **Required:** appointmentId (string) |
|
||||
| `public_get_user_list_profile_skipauth_id` | GET | `/api/user-list-profile-skipauth/{id}` | Get user profile by ID without authentication | **Required:** id (string) |
|
||||
| `public_get_generate_permanent_token_id` | GET | `/api/generate-permanent-token/{userId}` | Generate permanent token for user | **Required:** userId (string) |
|
||||
| `public_create__room_joined_event` | POST | `/room-joined/event` | LiveKit webhook handler | **Optional:** event (string), event (string), room (object), egressInfo (object), room (object), egressInfo (object) |
|
||||
| `public_create__room_joined_event_transcription` | POST | `/room-joined/event-transcription` | Get recording URL | **Optional:** egressInfo (object) |
|
||||
| `public_create_check_user` | POST | `/api/check-user` | Check if provider exists | **Required:** email (string) |
|
||||
| `public_get_get_patient_summary_id` | GET | `/api/get-patient-summary/{patientId}` | Get patient summary | **Required:** patientId (string) |
|
||||
| `public_create_update_patient_summary_id` | POST | `/api/update-patient-summary/{patientId}` | Update patient summary | **Required:** patientId (string), summary (string) |
|
||||
| `public_get_generate_patient_summary_id` | GET | `/api/generate-patient-summary/{patientId}` | Generate AI summary for patient | **Required:** patientId (string) |
|
||||
| `public_get_get_patient_full_details_id` | GET | `/api/get-patient-full-details/{patientId}` | Get comprehensive patient details | **Required:** patientId (string) |
|
||||
| `public_get_get_patient_forms_list_id` | GET | `/api/get-patient-forms-list/{patientId}` | Get patient forms list | **Required:** patientId (string) |
|
||||
| `public_get_download_pdf_id_id` | GET | `/api/download/pdf/{id}/{type}` | Download or view PDF file | **Required:** id (string), type (string) |
|
||||
| `public_create__emr_api_provider_register` | POST | `/emr-api/provider-register` | Register a new provider | **Required:** firstName (string), firstName (string), lastName (string), username (string), emailAddress (string), textMessageNumber (string), newUserPassword (string), company_name (string), firstName (string), lastName (string), username (string), emailAddress (string), textMessageNumber (string), newUserPassword (string), company_name (string), lastName (string), emailAddress (string), username (string), newUserPassword (string), **Optional:** on_your_domain (boolean), on_your_domain (boolean) |
|
||||
| `public_get_get_document_id_id_id` | GET | `/api/get/document/{userId}/{rowId}/{key}` | Create a public link to access a document | **Required:** userId (string), rowId (string), key (string) |
|
||||
| `public_get_get_form_without_auth_id` | GET | `/api/get-form-without-auth/{id}` | Get form by ID without authentication | **Required:** id (string) |
|
||||
| `public_create_store_intake_form_data` | POST | `/api/store-intake-form-data` | Store intake form data | **Required:** form_data (object), form_id (integer), pid (integer), schema (string), orginal_form_schema (string), **Optional:** practitioner_id (integer), signatureMetaData (string), file_field_name (file) |
|
||||
| `public_create_update_intake_form_data_id` | POST | `/api/update-intake-form-data/{id}` | Update intake form data | **Required:** id (string), form_data (object) |
|
||||
| `public_get_get_signed_patient_data_id` | GET | `/api/get-signed-patient-data/{id}` | Get signed patient form data | **Required:** id (string) |
|
||||
| `public_get_get_pdf_url_id` | GET | `/api/get-pdf-url/{id}` | Get PDF URL | **Required:** id (string) |
|
||||
| `public_get_user_list_profile_id` | GET | `/api/user-list-profile/{id}` | Get user profile by ID | **Required:** id (string) |
|
||||
| `public_create_user_set_password_id` | POST | `/api/user/set-password/{token}` | Set user password | **Required:** token (string), password (string) |
|
||||
| `public_create_patient_refresh_token` | POST | `/api/patient/refresh-token` | Refresh patient authentication token | **Required:** refresh_token (string) |
|
||||
| `public_create_register_patients` | POST | `/api/register-patients` | Register a new patient without authentication | **Required:** first_name (string), last_name (string), email (string), password (string), dob (string), phone_no (string), gender (string) |
|
||||
| `public_create_patient_login_api` | POST | `/api/patient-login-api` | Patient login without authentication | **Required:** email (string), password (string) |
|
||||
| `public_create_patient_order_create` | POST | `/api/patient-order-create` | Create a patient order | **Required:** patient_id (string), patient_id (integer), shipping_address1 (string), shipping_city (string), shipping_state (string), shipping_zipcode (string), shipping_country (string), shipping_amount (number), total_amount (number), provider_id (integer), items (array), order_items (array), **Optional:** shipping_address2 (string), practitioner_fee (number), affiliate_email (string), appointment_id (integer), pending_task (boolean), builder_id (integer), discount_amount (number), coupon_code (string) |
|
||||
| `public_create_patient_book_appointment` | POST | `/api/patient-book-appointment` | Book a patient appointment | **Required:** patient_id (string), start_time (string), end_time (string), practitioner_id (integer), practitioner_id (string), appointment_date (string), appointment_time (string), **Optional:** notes (string), order_id (integer), affiliate_email (string) |
|
||||
| `public_get_redirect_with_auth_id` | GET | `/api/redirect-with-auth/{pid}` | Get authentication token for redirect | **Required:** pid (string) |
|
||||
| `public_create_patient_available_slots_id` | POST | `/api/patient/available-slots/{date}` | Get available appointment slots for a specific date | **Required:** date (string) |
|
||||
| `public_create_check_email` | POST | `/api/check-email` | Check email availability | **Required:** email (string) |
|
||||
| `public_get_generate_permanent_token_id` | GET | `/api/generate-permanent-token/{userId}` | Generate a permanent API token for a user | **Required:** userId (string) |
|
||||
| `public_get_download_pdf_id_id` | GET | `/api/download/pdf/{id}/{type}` | Download or view PDF file | **Required:** id (integer), type (string) |
|
||||
| `public_create_forgot_password` | POST | `/api/forgot-password` | Forgot password functionality | **Required:** email (string) |
|
||||
| `public_get_generate_patient_summary_id` | GET | `/api/generate-patient-summary/{patientId}` | Generate AI summary for patient | **Required:** patientId (integer) |
|
||||
| `public_get_generate_permanent_token_id` | GET | `/api/generate-permanent-token/{userId}` | Generate a permanent API token for a user | **Required:** userId (integer) |
|
||||
| `public_get_get_form_without_auth_id` | GET | `/api/get-form-without-auth/{id}` | Get form by ID without authentication | **Required:** id (integer) |
|
||||
| `public_get_get_patient_forms_list_id` | GET | `/api/get-patient-forms-list/{patientId}` | Get patient forms list | **Required:** patientId (integer) |
|
||||
| `public_get_get_patient_full_details_id` | GET | `/api/get-patient-full-details/{patientId}` | Get comprehensive patient details | **Required:** patientId (integer) |
|
||||
| `public_get_get_patient_summary_id` | GET | `/api/get-patient-summary/{patientId}` | Get patient summary | **Required:** patientId (integer) |
|
||||
| `public_get_get_pdf_url_id` | GET | `/api/get-pdf-url/{id}` | Get PDF URL | **Required:** id (integer) |
|
||||
| `public_get_get_signed_patient_data_id` | GET | `/api/get-signed-patient-data/{id}` | Get signed patient form data | **Required:** id (integer), signature (string), expires (integer) |
|
||||
| `public_get_get_document_id_id_id` | GET | `/api/get/document/{userId}/{rowId}/{key}` | Create a public link to access a document | **Required:** userId (integer), rowId (integer), key (string) |
|
||||
| `public_create_login_patient` | POST | `/api/login-patient` | Patient login | **Required:** email (string), password (string) |
|
||||
| `public_create_password_reset` | POST | `/api/password-reset` | Reset password functionality | **Required:** token (string), email (string), password (string), password_confirmation (string) |
|
||||
| `public_create_patient_available_slots_id` | POST | `/api/patient/available-slots/{date}` | Get available appointment slots for a specific date | **Required:** date (string) |
|
||||
| `public_create_patient_login` | POST | `/api/patient/login` | Patient login without authentication middleware | **Required:** email (string), password (string) |
|
||||
| `public_get_redirect_with_auth_id` | GET | `/api/redirect-with-auth/{pid}` | Get authentication token for redirect | **Required:** pid (integer) |
|
||||
| `public_create_register_patient` | POST | `/api/register-patient` | Register patient without authentication | **Required:** firstName (string), lastName (string), email (string), password (string), dateOfBirth (string), gender (string), phone (string), username (string), **Optional:** provider_id (integer) |
|
||||
| `public_create_set_password_id` | POST | `/api/set-password/{token}` | Set password for patient account | **Required:** token (string), password (string), password_confirmation (string) |
|
||||
| `public_create_update_intake_form_data_id` | POST | `/api/update-intake-form-data/{id}` | Update intake form data | **Required:** id (integer), form_id (integer), pid (integer), schema (string), orginal_form_schema (string), **Optional:** practitioner_id (integer), signatureMetaData (string), file_field_name (file) |
|
||||
| `public_create_update_patient_summary_id` | POST | `/api/update-patient-summary/{patientId}` | Update patient summary | **Required:** patientId (integer), summary (string) |
|
||||
| `public_get_user_list_profile_id` | GET | `/api/user-list-profile/{id}` | Get user profile by ID | **Required:** id (integer) |
|
||||
| `public_create_user_set_password_id` | POST | `/api/user/set-password/{token}` | Set user password | **Required:** token (string), password (string) |
|
||||
| `public_create_patient_register_patient` | POST | `/api/patient/register-patient` | Register a new patient | **Required:** first_name (string), last_name (string), email (string), password (string), **Optional:** phone (string), date_of_birth (string), gender (string), address (string), city (string), state (string), zip_code (string) |
|
||||
| `public_create_reset_password` | POST | `/api/reset-password` | Reset user password | **Required:** email (string), token (string), password (string), password_confirmation (string) |
|
||||
|
||||
---
|
||||
|
||||
## Provider Tools (199 tools)
|
||||
|
||||
_Provider authentication required. These tools handle clinical data, EMR operations, and healthcare data requiring HIPAA compliance._
|
||||
|
||||
| Tool Name | Method | Endpoint | Description | Key Parameters |
|
||||
| ------------------------------------------------------------ | ------ | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `provider_get_emr_patients_list` | GET | `/api/emr/patients-list` | Patient datatable with DataTable server-side parameters | **Optional:** draw (number), columns (array), order (array), start (number), length (number), search (object), page (number), itemsPerPage (number), sortBy (array), filters (object) |
|
||||
| `provider_get_emr_patient_data_id` | GET | `/api/emr/patient-data/{patient_id}` | Get single patient by ID | **Required:** patient_id (string) |
|
||||
| `provider_get_emr_get_patient_data_id` | GET | `/api/emr/get-patient-data/{patient_id}` | Get single patient data by ID | **Required:** patient_id (string) |
|
||||
| `provider_create_emr_register_patients` | POST | `/api/emr/register-patients` | Register patient (EMR) with complete demographic data | **Required:** firstName (string), lastName (string), email (string), dateOfBirth (string), **Optional:** middleName (string), preferredName (string), contactMethod (string), personalID (string), sexatBirth (string), genderIdentity (string), race (string), pronoun (string), ageGroup (string), timezone (string), preferredPhone (string), alternativePhone (string), textmsgNumber (string), address (string), city (string), state (string), zipcode (string), primaryPractitioner (string), primaryCarePhysician (string), guardian (string), emergencyContactNumber (string), emergencyContactNameRelation (string), patientMaritalStatus (string), occupation (string), referredBy (string), patientNote (string), password (string), status (string), isportalAccess (boolean) |
|
||||
| `provider_create_emr_update_patient_id` | POST | `/api/emr/update-patient/{patient_id}` | Update patient with complete demographic data | **Required:** patient_id (string), **Optional:** firstName (string), lastName (string), fullName (string), middleName (string), preferredName (string), email (string), contactMethod (string), personalID (string), dateOfBirth (string), sexatBirth (string), genderIdentity (string), race (string), pronoun (string), ageGroup (string), timezone (string), preferredPhone (string), alternativePhone (string), textmsgNumber (string), address (string), city (string), state (string), zipcode (string), primaryPractitioner (string), primaryCarePhysician (string), guardian (string), emergencyContactNumber (string), emergencyContactNameRelation (string), patientMaritalStatus (string), occupation (string), referredBy (string), patientNote (string), password (string), status (string), isportalAccess (boolean), profilePicture (file), avatar (file) |
|
||||
| `provider_create_emr_prescription_store_id` | POST | `/api/emr/prescription/store/{patient_id}` | Store medication with actual API parameter names | **Required:** patient_id (string), medication_data (object) |
|
||||
| `provider_get_emr_prescriptions_id` | GET | `/api/emr/prescriptions/{patient_id}` | Get patient medication data with filters | **Required:** patient_id (string), **Optional:** src (string), status (string) |
|
||||
| `provider_update_emr_prescriptions_update_id` | PUT | `/api/emr/prescriptions/update/{prescription_id}` | Update prescription status with actual API parameter names from medicationService.js | **Required:** prescription_id (string), **Optional:** status (string), signature (string), note (string), tracking_id (string), needs_followup (boolean), followup_days (number) |
|
||||
| `provider_get_get_forms` | GET | `/api/get-forms` | Get forms | No parameters |
|
||||
| `provider_create_store_form` | POST | `/api/store-form` | Store form | **Required:** form_data (object), type (string), data (object), name (string) |
|
||||
| `provider_update_update_form_id` | PUT | `/api/update-form/{form_id}` | Update form | **Required:** form_id (string), form_data (object) |
|
||||
| `provider_delete_delete_form_id` | DELETE | `/api/delete-form/{form_id}` | Delete form | **Required:** form_id (string) |
|
||||
| `provider_get_emr_get_consent_forms` | GET | `/api/emr/get-consent-forms` | Get consent forms | No parameters |
|
||||
| `provider_create_store_consent_form` | POST | `/api/store-consent-form` | Store consent form | **Required:** form_data (object) |
|
||||
| `provider_get_get_consent_form_id` | GET | `/api/get-consent-form/{form_id}` | Get consent form by ID | **Required:** form_id (string) |
|
||||
| `provider_update_update_consent_form_id` | PUT | `/api/update-consent-form/{form_id}` | Update consent form | **Required:** form_id (string), form_data (object) |
|
||||
| `provider_delete_delete_consent_form_id` | DELETE | `/api/delete-consent-form/{form_id}` | Delete consent form | **Required:** form_id (string) |
|
||||
| `provider_get_get_labdiagonostics` | GET | `/api/get-labdiagonostics` | Get lab diagnostics | No parameters |
|
||||
| `provider_create_store_labdiagonostics` | POST | `/api/store-labdiagonostics` | Store lab diagnostics | **Required:** lab_data (object) |
|
||||
| `provider_get_labs_list` | GET | `/api/labs/list` | Get labs list | No parameters |
|
||||
| `provider_create_labs_create` | POST | `/api/labs/create` | Create lab | **Required:** lab_data (object) |
|
||||
| `provider_update_labs_update_id` | PUT | `/api/labs/update/{lab_id}` | Update lab | **Required:** lab_id (string) |
|
||||
| `provider_delete_labs_delete_id` | DELETE | `/api/labs/delete/{lab_id}` | Delete lab | **Required:** lab_id (string) |
|
||||
| `provider_get_emr_get_medicine_list` | GET | `/api/emr/get-medicine-list` | Get medicine list | No parameters |
|
||||
| `provider_create_emr_import_medicines` | POST | `/api/emr/import-medicines` | Import medicines from Excel | **Required:** excel_file (file) |
|
||||
| `provider_create_add_medicine_template` | POST | `/api/add_medicine_template` | Store medicine template | **Required:** template_data (object) |
|
||||
| `provider_update_update_medicine_template_id` | PUT | `/api/update_medicine_template/{template_id}` | Update medicine template | **Required:** template_id (string), template_data (object) |
|
||||
| `provider_get_get_medicine_templates` | GET | `/api/get_medicine_templates` | Get medicine templates | No parameters |
|
||||
| `provider_get_get_medicine_template_by_id_id` | GET | `/api/get_medicine_template_by_id/{template_id}` | No description | No parameters |
|
||||
| `provider_get_emr_get_themes_list` | GET | `/api/emr/get-themes-list` | Get themes list | No parameters |
|
||||
| `provider_create_emr_store_builder` | POST | `/api/emr/store-builder` | Store builder with complete configuration | **Required:** builder_name (string), practitioner_id (string), **Optional:** intakes (array), questionnaire (array), products (array), paymentOption (object), patientFlow (object) |
|
||||
| `provider_create_emr_store_builder_config_id` | POST | `/api/emr/store-builder-config/{id}` | Store builder config with styling options | **Required:** id (string), **Optional:** theme (string), bgColor (string), btncolor (string), textColor (string), practitioner_fee (number) |
|
||||
| `provider_get_emr_get_builder_data_id` | GET | `/api/emr/get-builder-data/{builder_id}` | Get builder data | **Required:** builder_id (string) |
|
||||
| `provider_update_emr_builder_update_id` | PUT | `/api/emr/builder-update/{builder_id}` | Update builder | **Required:** builder_id (string), builder_data (object) |
|
||||
| `provider_update_emr_update_builder_config_id` | PUT | `/api/emr/update-builder-config/{config_id}` | Update builder config | **Required:** config_id (string), config_data (object) |
|
||||
| `provider_delete_emr_delete_builder_id` | DELETE | `/api/emr/delete-builder/{builder_id}` | Delete builder | **Required:** builder_id (string) |
|
||||
| `provider_get_emr_appointments_list` | GET | `/api/emr/appointments-list` | Get appointments list with DataTable parameters | **Optional:** draw (number), columns (array), order (array), start (number), length (number), search (object) |
|
||||
| `provider_create_emr_create_appointment` | POST | `/api/emr/create-appointment` | Create appointment with complete scheduling data | **Required:** patient_id (string), practitioner_id (string), appointment_date (string), appointment_time (string), **Optional:** duration (number), appointment_type (string), reason (string), notes (string), location_id (string), status (string) |
|
||||
| `provider_update_emr_update_appointment_id` | PUT | `/api/emr/update-appointment/{appointment_id}` | Update appointment | **Required:** appointment_id (string), **Optional:** appointment_date (string), appointment_time (string), duration (number), status (string), notes (string) |
|
||||
| `provider_delete_emr_cancel_appointment_id` | DELETE | `/api/emr/cancel-appointment/{appointment_id}` | Cancel appointment | **Required:** appointment_id (string), **Optional:** cancellation_reason (string) |
|
||||
| `provider_create_emr_documents_upload` | POST | `/api/emr/documents/upload` | Upload patient document | **Required:** patient_id (string), document_file (file), document_type (string), **Optional:** document_name (string), description (string) |
|
||||
| `provider_get_emr_documents_id` | GET | `/api/emr/documents/{patient_id}` | Get patient documents | **Required:** patient_id (string) |
|
||||
| `provider_delete_emr_documents_delete_id` | DELETE | `/api/emr/documents/delete/{document_id}` | Delete document | **Required:** document_id (string) |
|
||||
| `provider_get_emr_medical_records_id` | GET | `/api/emr/medical-records/{patient_id}` | Get patient medical records | **Required:** patient_id (string) |
|
||||
| `provider_create_emr_medical_records_create` | POST | `/api/emr/medical-records/create` | Create medical record | **Required:** patient_id (string), record_type (string), **Optional:** diagnosis (string), treatment (string), notes (string), vital_signs (object), allergies (array), medications (array) |
|
||||
| `provider_update_emr_medical_records_update_id` | PUT | `/api/emr/medical-records/update/{record_id}` | Update medical record | **Required:** record_id (string), **Optional:** diagnosis (string), treatment (string), notes (string), vital_signs (object) |
|
||||
| `provider_get_emr_providers_list` | GET | `/api/emr/providers-list` | Get providers list | No parameters |
|
||||
| `provider_get_emr_provider_profile` | GET | `/api/emr/provider-profile` | Get provider profile | No parameters |
|
||||
| `provider_create_emr_update_provider_profile` | POST | `/api/emr/update-provider-profile` | Update provider profile | **Optional:** firstName (string), lastName (string), emailAddress (string), textMessageNumber (string), specialties (array), license_number (string), npi_number (string) |
|
||||
| `provider_get_practitioners_list` | GET | `/api/practitioners-list` | Get practitioner list (requires provider authentication) | No parameters |
|
||||
| `provider_get_get_specialties` | GET | `/api/get-specialties` | Get medical specialties (requires provider authentication) | No parameters |
|
||||
| `provider_get_get_states` | GET | `/api/get-states` | Get states list (requires provider authentication) | No parameters |
|
||||
| `provider_get_get_cities_id` | GET | `/api/get-cities/{state_id}` | Get cities by state (requires provider authentication) | **Required:** state_id (string) |
|
||||
| `provider_get_get_countries` | GET | `/api/get-countries` | Get countries list (requires provider authentication) | No parameters |
|
||||
| `provider_get_get_timezones` | GET | `/api/get-timezones` | Get timezones list (requires provider authentication) | No parameters |
|
||||
| `provider_get_locations` | GET | `/api/locations` | Get locations (requires provider authentication) | **Optional:** draw (integer), start (integer), length (integer) |
|
||||
| `provider_get_get_pdf_list` | GET | `/api/get-pdf-list` | Get PDF list (requires provider authentication for patient data protection) | No parameters |
|
||||
| `provider_create_store_questioner_form_data` | POST | `/api/store-questioner-form-data` | Store questioner form data (requires provider authentication for patient data protection) | **Required:** form_data (object) |
|
||||
| `provider_create_store_patient_questionnaire_data` | POST | `/api/store-patient-questionnaire-data` | Store patient questionnaire data (requires provider authentication for patient data protection) | **Required:** questionnaire_data (object) |
|
||||
| `provider_create_getAvailableSlotsData` | POST | `/api/get-available-slots-data/{practitionerId}` | Get available appointment slots by practitioner ID, month and timezone (requires provider authentication for practitioner data protection) | **Required:** practitionerId (string), month (string), timezone (string) |
|
||||
| `provider_create__get_asseblyai_token` | POST | `/get-asseblyai-token` | Get AssemblyAI token | No parameters |
|
||||
| `provider_get__create_meeting_id` | GET | `/create-meeting/{meeting_id}` | Show meeting details | **Required:** meeting_id (string) |
|
||||
| `provider_get__join_meeting_id` | GET | `/join-meeting/{meeting_id}` | Join a meeting | **Required:** meeting_id (string) |
|
||||
| `provider_create_start_call_id_id_id` | POST | `/api/start-call/{patient_id}/{agent_id}/{appointment_id}` | Start a call | **Required:** patient_id (integer), agent_id (integer), appointment_id (integer), **Optional:** title (string) |
|
||||
| `provider_get__get_realtime_questions_id` | GET | `/get-realtime-questions/{appointmentId}` | Get real-time questions | **Required:** appointmentId (integer) |
|
||||
| `provider_create_end_call_id_id` | POST | `/api/end-call/{patient_id}/{appointment_id}` | End a call | **Required:** patient_id (integer), appointment_id (integer) |
|
||||
| `provider_create_labs_search` | POST | `/api/labs/search` | Search labs by address | **Required:** address (string) |
|
||||
| `provider_create_book_appointment` | POST | `/api/book-appointment` | Book an appointment | **Required:** telemed_pros_id (integer), patient_id (integer), doctor_id (integer), appointment_id (integer), appointment_time (string), patient_id (integer), doctor_id (integer), appointment_id (integer), appointment_time (string) |
|
||||
| `provider_create_update_patient_info_id` | POST | `/api/update-patient-info/{patientId}` | Update patient information | **Required:** patientId (integer), **Optional:** city (string), state (string), address (string), zip_code (string), dob (string), country (string) |
|
||||
| `provider_create_get_patient_info_id` | POST | `/api/get-patient-info/{patientId}` | Get patient information | **Required:** patientId (integer) |
|
||||
| `provider_create_get_doctors_list` | POST | `/api/get-doctors-list` | Get doctors list | No parameters |
|
||||
| `provider_create_add_note_patient` | POST | `/api/add-note-patient` | Add a note for patient | **Required:** note (string), note (string), note_type (string), note_type (string) |
|
||||
| `provider_get_get_note_patient` | GET | `/api/get-note-patient` | Get patient notes | No parameters |
|
||||
| `provider_create__add_inventory` | POST | `/add-inventory` | Add new inventory item | **Optional:** inventoryType (string), item_name (string), price (number), expirationDate (string) |
|
||||
| `provider_create__add_phone_log_id` | POST | `/add-phone-log/{patient_id}` | Add a new phone log for a patient | **Required:** patient_id (integer), provider (string), message (string), user_id (integer) |
|
||||
| `provider_create_add_email_id` | POST | `/api/add-email/{patient_id}` | Add a new email for a patient | **Required:** patient_id (integer), messageText (string), to_email (string), subject (string), **Optional:** practitioner (integer), from_email (string), emailTemplate (string) |
|
||||
| `provider_create_add_location` | POST | `/api/add-location` | Add a new location | **Required:** name (string), npiNumber (string), phoneNumber (string), address (string), city (string), state (string), zipcode (string), country (string) |
|
||||
| `provider_create_add_task_id` | POST | `/api/add-task/{patient_id}` | Add a new task for a patient | **Required:** patient_id (integer), task_title (string), task_body (string), task_due_date (string), task_assigned_to (integer), **Optional:** task_watchers (array), sendEmailtoPatientApplicationForTask (boolean), task_priority (string), task_status (string) |
|
||||
| `provider_create_add_user` | POST | `/api/add-user` | Add new user (legacy method) | **Required:** firstName (string), lastName (string), username (string), emailAddress (string), textMessageNumber (string), role_id (string), newUserPassword (string), type (string), **Optional:** dateOfBirth (string), gender (string), city (string), state (string), zipcode (string), avatarImg (file) |
|
||||
| `provider_create_add_vital_id` | POST | `/api/add-vital/{patientId}` | Add vital signs for a patient | **Required:** patientId (integer), provider_id (integer), **Optional:** blood_presssure (string), diastolic (string), weight_lbs (number), height_ft (integer), height_in (integer), temperature (number), pulse (integer), respiratory_rate (integer), saturation (integer), waist_in (number), headCircumference_in (number), note (string), provider (string), weight_oz (number), bmi (number), bloodSugar (number), fasting (boolean), neck_in (number), shoulders_in (number), chest_in (number), hips_in (number), lean_body_mass_lbs (number), body_fat (number), notes (string), subjective_notes (string) |
|
||||
| `provider_create_appointment_detail_id` | POST | `/api/appointment-detail/{appointment}` | Get appointment details | **Required:** appointment (integer) |
|
||||
| `provider_get_assistant_practitioners_list` | GET | `/api/assistant/practitioners-list` | Get practitioners list via assistant | No parameters |
|
||||
| `provider_create_assistant_save_signature` | POST | `/api/assistant/save-signature` | Store signature | **Required:** signature_data (string), **Optional:** provider_id (integer) |
|
||||
| `provider_create_assistant_store_form` | POST | `/api/assistant/store-form` | Store form data | **Required:** type (string), data (object), name (string) |
|
||||
| `provider_create_assistant_store_intake_form_data` | POST | `/api/assistant/store-intake-form-data` | Store intake form data | **Required:** form_id (integer), pid (integer), schema (string), orginal_form_schema (string), **Optional:** practitioner_id (integer), signatureMetaData (string), file_field_name (file) |
|
||||
| `provider_update_assistant_update_form_id` | PUT | `/api/assistant/update-form/{id}` | Update form | **Required:** id (integer), type (string), data (object), name (string) |
|
||||
| `provider_create_available_slots_id` | POST | `/api/available-slots/{date}` | Get available appointment slots | **Required:** date (string) |
|
||||
| `provider_update_company_complete_setup_id` | PUT | `/api/company/complete/setup/{status}` | Complete company setup | **Required:** status (string) |
|
||||
| `provider_delete_delete_form_id` | DELETE | `/api/delete-form/{id}` | Delete form | **Required:** id (integer) |
|
||||
| `provider_delete_delete_intake_question_id` | DELETE | `/api/delete-intake-question/{form_id}` | Delete intake question | **Required:** form_id (integer) |
|
||||
| `provider_get_document_download_id_id` | GET | `/api/document/download/{rowId}/{key}` | Download a patient document | **Required:** rowId (integer), key (string) |
|
||||
| `provider_get_emr_appointment_id_order` | GET | `/api/emr/appointment/{appointment_id}/order` | Get appointment order details | **Required:** appointment_id (integer) |
|
||||
| `provider_get_emr_appointment_id_detail` | GET | `/api/emr/appointment/{appointment}/detail` | Get appointment details | **Required:** appointment (integer) |
|
||||
| `provider_create_emr_appointment_id_update_meeting_analysis` | POST | `/api/emr/appointment/{appointment}/update-meeting-analysis` | Update meeting analysis | **Required:** appointment (integer), **Optional:** data (object) |
|
||||
| `provider_create_emr_appointment_id_cancel` | POST | `/api/emr/appointment/{id}/cancel` | Cancel an appointment | **Required:** id (integer) |
|
||||
| `provider_get_emr_appointment_agent_id` | GET | `/api/emr/appointment/agent/{appointment}` | Get agent appointment details | **Required:** appointment (integer) |
|
||||
| `provider_get_emr_appointment_list_by_date` | GET | `/api/emr/appointment/list-by-date` | Get appointments by date range | **Required:** start_date (string), end_date (string) |
|
||||
| `provider_create_emr_appointment_queue_id` | POST | `/api/emr/appointment/queue/{patientId}` | Add patient to queue | **Required:** patientId (integer) |
|
||||
| `provider_get_emr_appointment_report_last_30_days` | GET | `/api/emr/appointment/report/last-30-days` | Get appointment data for last 30 days | **Required:** start_date (string), end_date (string), **Optional:** provider (string) |
|
||||
| `provider_get_emr_appointment_transcribe_id` | GET | `/api/emr/appointment/transcribe/{patient_id}` | Get appointment transcriptions | **Required:** patient_id (integer) |
|
||||
| `provider_create_end_call_id_id` | POST | `/api/end-call/{patient_id}/{appointment_id}` | End a call | **Required:** patient_id (integer), appointment_id (integer) |
|
||||
| `provider_create_form_pdf_save` | POST | `/api/form-pdf-save` | Save form file | **Required:** form_id (integer), pdf_data (string) |
|
||||
| `provider_get_get_all_forms` | GET | `/api/get-all-forms` | Get all forms | No parameters |
|
||||
| `provider_create_get_appointment_by_id` | POST | `/api/get-appointment-by-id` | Get appointment by ID | **Required:** appointment_id (integer) |
|
||||
| `provider_create_get_appointment_list` | POST | `/api/get-appointment-list` | Get appointments list | No parameters |
|
||||
| `provider_create_get_appointment_list_date` | POST | `/api/get-appointment-list-date` | Get appointment list by date | **Optional:** date (string), practitioner_id (integer) |
|
||||
| `provider_create_get_doctors_appointment_list` | POST | `/api/get-doctors-appointment-list` | Get doctor appointments list | No parameters |
|
||||
| `provider_create_get_doctors_appointment_list` | POST | `/api/get-doctors-appointment-list` | Get doctor appointments list | No parameters |
|
||||
| `provider_get_get_document_by_id_id_id` | GET | `/api/get-document-by-id/{patientId}/{did}` | Get a specific patient document by ID | **Required:** patientId (integer), did (integer) |
|
||||
| `provider_get_get_document_vue_id` | GET | `/api/get-document-vue/{patient_id}` | Get documents for Vue component | **Required:** patient_id (integer) |
|
||||
| `provider_get_get_document_id` | GET | `/api/get-document/{patientId}` | Get patient documents | **Required:** patientId (integer) |
|
||||
| `provider_get_get_email_list_id` | GET | `/api/get-email-list/{patient_id}` | Get email list for a patient | **Required:** patient_id (integer), **Optional:** draw (integer), start (integer), length (integer) |
|
||||
| `provider_get_get_email_id` | GET | `/api/get-email/{id}` | Get an email by ID | **Required:** id (integer) |
|
||||
| `provider_get_get_form_id` | GET | `/api/get-form/{id}` | Get form by ID | **Required:** id (integer) |
|
||||
| `provider_get_get_forms_id` | GET | `/api/get-forms/{type}` | Get forms by type | **Required:** type (string) |
|
||||
| `provider_get_get_intake_forms_data_id` | GET | `/api/get-intake-forms-data/{form_id}` | Get intake form data by ID | **Required:** form_id (integer) |
|
||||
| `provider_get_get_intake_forms_list` | GET | `/api/get-intake-forms-list` | Get intake forms list | No parameters |
|
||||
| `provider_get_get_location_id` | GET | `/api/get-location/{uuid}` | Get a location by UUID | **Required:** uuid (string) |
|
||||
| `provider_get_get_patient_forms_list_id` | GET | `/api/get-patient-forms-list/{pid}` | Get patient intake simple forms list | **Required:** pid (integer) |
|
||||
| `provider_get_get_patient_forms_id` | GET | `/api/get-patient-forms/{pid}` | Get all forms for a patient | **Required:** pid (integer) |
|
||||
| `provider_create_get_patient_info_id` | POST | `/api/get-patient-info/{patientId}` | Get patient information | **Required:** patientId (integer) |
|
||||
| `provider_get_get_patient_intake_form_data_id_id_id` | GET | `/api/get-patient-intake-form-data/{form_id}/{pid}/{rowId}` | Get patient intake form data | **Required:** form_id (integer), pid (integer), rowId (integer) |
|
||||
| `provider_get_get_patient_intake_form_latest_data_id_id` | GET | `/api/get-patient-intake-form-latest-data/{form_id}/{pid}` | Get latest intake form data | **Required:** form_id (integer), pid (integer) |
|
||||
| `provider_get_get_patient_intake_form_list_id_id` | GET | `/api/get-patient-intake-form-list/{type}/{pid}` | Get patient intake forms by type | **Required:** type (string), pid (integer) |
|
||||
| `provider_get_get_patient_questionnaire_form_list_id` | GET | `/api/get-patient-questionnaire-form-list/{pid}` | Get patient questionnaire forms | **Required:** pid (integer) |
|
||||
| `provider_get_get_patient_submitted_intake_forms_id` | GET | `/api/get-patient-submitted-intake-forms/{pid}` | Get all submitted forms for a patient | **Required:** pid (integer) |
|
||||
| `provider_get_get_prescription_list_id` | GET | `/api/get-prescription-list/{patient_id}` | Get patient prescription list | **Required:** patient_id (integer) |
|
||||
| `provider_get_get_questioner_forms_data_id` | GET | `/api/get-questioner-forms-data/{form_id}` | Get questionnaire form data | **Required:** form_id (integer) |
|
||||
| `provider_get_get_questioner_question_id` | GET | `/api/get-questioner-question/{id}` | Get questionnaire question by ID | **Required:** id (integer) |
|
||||
| `provider_get_get_stored_methods_id` | GET | `/api/get-stored-methods/{id}` | Get stored payment methods | **Required:** id (integer) |
|
||||
| `provider_get_lab_detail_id` | GET | `/api/lab-detail/{appointment}` | Get lab details for an appointment | **Required:** appointment (integer) |
|
||||
| `provider_get_lab_detail_id` | GET | `/api/lab-detail/{appointment}` | Get lab details for an appointment | **Required:** appointment (integer) |
|
||||
| `provider_get_location_id` | GET | `/api/location/{id}` | Get a location by ID | **Required:** id (integer) |
|
||||
| `provider_get_medical_problem_id` | GET | `/api/medical-problem/{id}` | Get a medical problem by ID | **Required:** id (integer) |
|
||||
| `provider_create_medical_problems_store_id` | POST | `/api/medical-problems-store/{pid}` | Add a new medical problem for a patient | **Required:** pid (integer), name (string), lastDate (string), nextDate (string), screeningDetails (string), flag (string), typeOfItem (string) |
|
||||
| `provider_update_medical_problems_update_id` | PUT | `/api/medical-problems-update/{id}` | Update an existing medical problem | **Required:** id (integer), name (string), lastDate (string), nextDate (string), screeningDetails (string), flag (string), typeOfItem (string), medical_problem_id (integer) |
|
||||
| `provider_get_patient_data_id` | GET | `/api/patient-data/{id}` | Get patient data | **Required:** id (integer) |
|
||||
| `provider_get_patients` | GET | `/api/patients` | Get a list of patients | **Optional:** firstName (string), lastName (string), dateOfBirth (string), email (string) |
|
||||
| `provider_create_plans_product_sync` | POST | `/api/plans-product-sync` | Save multiple products | **Required:** builder_id (string), products (array) |
|
||||
| `provider_create_plans_product_update` | POST | `/api/plans-product-update` | Update product on publish | **Required:** builder_id (string), product_id (integer), product_name (string), product_price (number), product_slug (string), product_category (object), **Optional:** product_variation (array) |
|
||||
| `provider_create_provider_add_availability` | POST | `/api/provider-add-availability` | Store provider availability | **Required:** title (string), start (string), end (string), type (string), **Optional:** comment (string), practitioner_id (integer) |
|
||||
| `provider_create_provider_auth_logout` | POST | `/api/provider/auth/logout` | Logout provider | No parameters |
|
||||
| `provider_get_provider_practitioners_list` | GET | `/api/provider/practitioners-list` | Get practitioners list | No parameters |
|
||||
| `provider_get_render_pdf_id` | GET | `/api/render/pdf/{rowId}` | Render a PDF document | **Required:** rowId (integer) |
|
||||
| `provider_create_save_category` | POST | `/api/save-category` | Store product category | **Required:** name (string), **Optional:** description (string) |
|
||||
| `provider_create_save_payment_method` | POST | `/api/save-payment-method` | Store payment method configuration | **Required:** payment_method (string), **Optional:** api_key (string), secret_key (string), is_active (boolean) |
|
||||
| `provider_create_save_product` | POST | `/api/save-product` | Save product | **Required:** name (string), price (number), category_id (integer), **Optional:** description (string), sku (string), stock_quantity (integer) |
|
||||
| `provider_create_save_signature` | POST | `/api/save-signature` | Save provider signature | **Required:** signature (string) |
|
||||
| `provider_create_start_call_id_id_id` | POST | `/api/start-call/{patient_id}/{agent_id}/{appointment_id}` | Start a call | **Required:** patient_id (integer), agent_id (integer), appointment_id (integer), **Optional:** title (string) |
|
||||
| `provider_create_store_company` | POST | `/api/store-company` | Update company information | **Required:** name (string), **Optional:** address (string), city (string), state (string), zip (string), phone (string), email (string), website (string), logo (file) |
|
||||
| `provider_create_store_document_id` | POST | `/api/store-document/{patientId}` | Store patient documents | **Required:** patientId (integer), **Optional:** files (array), document_type (string), notes (string) |
|
||||
| `provider_create_store_patient_consent_form` | POST | `/api/store-patient-consent-form` | Store patient consent form | **Required:** form_id (integer), pid (integer), data (object), name (string), signature (string) |
|
||||
| `provider_get_task_id` | GET | `/api/task/{id}` | Get a task by ID | **Required:** id (integer) |
|
||||
| `provider_get_tasks_id` | GET | `/api/tasks/{patient_id}` | Get all tasks for a patient | **Required:** patient_id (integer), **Optional:** draw (integer), start (integer), length (integer) |
|
||||
| `provider_create_token_create_with_abilities` | POST | `/api/token/create-with-abilities` | Create a token with specific abilities | **Required:** user_id (integer), token_name (string), abilities (array), **Optional:** expires_in_hours (integer) |
|
||||
| `provider_create_token_generate_temporary` | POST | `/api/token/generate-temporary` | Generate a temporary API token | **Required:** user_id (integer), expires_in_hours (integer), **Optional:** abilities (array) |
|
||||
| `provider_get_token_list_id` | GET | `/api/token/list/{userId}` | List all tokens for a user | **Required:** userId (integer) |
|
||||
| `provider_create_token_refresh` | POST | `/api/token/refresh` | Refresh current token | No parameters |
|
||||
| `provider_delete_token_revoke` | DELETE | `/api/token/revoke` | Revoke a specific token | **Required:** token_id (integer) |
|
||||
| `provider_delete_token_revoke_all_id` | DELETE | `/api/token/revoke-all/{userId}` | Revoke all tokens for a user | **Required:** userId (integer) |
|
||||
| `provider_create_update_category_id` | POST | `/api/update-category/{id}` | Update product category | **Required:** id (integer), name (string), **Optional:** description (string) |
|
||||
| `provider_update_update_form_status` | PUT | `/api/update-form-status` | Update form request status | **Required:** form_id (integer), patient_id (integer), status (string) |
|
||||
| `provider_update_update_form_id` | PUT | `/api/update-form/{id}` | Update form | **Required:** id (integer), type (string), data (object), name (string) |
|
||||
| `provider_create_update_intake_form_data` | POST | `/api/update-intake-form-data` | Update intake form data | **Required:** form_id (integer), pid (integer), data (object) |
|
||||
| `provider_update_update_location_id` | PUT | `/api/update-location/{id}` | Update a location by ID | **Required:** id (integer), name (string), npiNumber (string), phoneNumber (string), address (string), city (string), state (string), zipcode (string), country (string) |
|
||||
| `provider_update_update_location_id` | PUT | `/api/update-location/{uuid}` | Update a location by UUID | **Required:** uuid (string), name (string), npiNumber (string), phoneNumber (string), address (string), city (string), state (string), zipcode (string), country (string) |
|
||||
| `provider_create_update_password` | POST | `/api/update-password` | Update patient password | **Required:** new_password (string) |
|
||||
| `provider_create_update_patient_info_id` | POST | `/api/update-patient-info/{patientId}` | Update patient information | **Required:** patientId (integer), **Optional:** city (string), state (string), address (string), zip_code (string), dob (string), country (string) |
|
||||
| `provider_create_update_product_id` | POST | `/api/update-product/{id}` | Update product | **Required:** id (integer), name (string), price (number), category_id (integer), **Optional:** description (string), sku (string), stock_quantity (integer) |
|
||||
| `provider_update_update_task_id` | PUT | `/api/update-task/{task_id}` | Update an existing task | **Required:** task_id (integer), **Optional:** task_title (string), task_body (string), task_due_date (string), task_assigned_to (integer), task_watchers (array), sendEmailtoPatientApplicationForTask (boolean), task_priority (string), task_status (string) |
|
||||
| `provider_create_update_user_id` | POST | `/api/update-user/{id}` | Update user | **Required:** id (integer), firstName (string), lastName (string), textMessageNumber (string), timezone (string), role_id (string), **Optional:** dateOfBirth (string), gender (string), city (string), state (string), zipcode (string), type (string), username (string), newUserPassword (string) |
|
||||
| `provider_get_user_list` | GET | `/api/user-list` | Get list of users | No parameters |
|
||||
| `provider_get_user_list_id` | GET | `/api/user-list/{id}` | Get user by ID | **Required:** id (integer) |
|
||||
| `provider_create_user_create` | POST | `/api/user/create` | Create new user from admin | **Required:** firstName (string), lastName (string), username (string), emailAddress (string), textMessageNumber (string), role_id (string), newUserPassword (string), type (string), **Optional:** dateOfBirth (string), gender (string), city (string), state (string), zipcode (string), avatarImg (file) |
|
||||
| `provider_update__appointment_status_id_id` | PUT | `/appointment-status/{id}/{status}` | Update appointment status | **Required:** id (integer), status (string) |
|
||||
| `provider_get__create_meeting_id` | GET | `/create-meeting/{meeting_id}` | Show meeting details | **Required:** meeting_id (string) |
|
||||
| `provider_delete__delete_inventory_id` | DELETE | `/delete-inventory/{id}` | Delete inventory item | **Required:** id (integer) |
|
||||
| `provider_update__emr_api_company_complete_setup_id` | PUT | `/emr-api/company/complete/setup/{status}` | Complete provider setup | **Required:** status (integer) |
|
||||
| `provider_get__emr_api_company_status` | GET | `/emr-api/company/status` | Get company status | No parameters |
|
||||
| `provider_get__emr_api_get_company` | GET | `/emr-api/get-company` | Get company information | No parameters |
|
||||
| `provider_get__emr_api_provider_wizard_setup` | GET | `/emr-api/provider-wizard-setup` | Get provider setup counts | No parameters |
|
||||
| `provider_create__emr_api_store_company` | POST | `/emr-api/store-company` | Update company information | **Required:** id (integer), company_name (string), company_email (string), **Optional:** company_phone (string), address (string), domain_name (string), city (string), state (string), zip (string), header_scripts (string), footer_scripts (string), logo (string) |
|
||||
| `provider_get__get_insurance_id` | GET | `/get-insurance/{patientId}` | Get insurance information for a patient | **Required:** patientId (integer) |
|
||||
| `provider_get__get_inventory_id` | GET | `/get-inventory/{id}` | Get inventory item by ID | **Required:** id (integer) |
|
||||
| `provider_get__get_realtime_questions_id` | GET | `/get-realtime-questions/{appointmentId}` | Get real-time questions | **Required:** appointmentId (integer) |
|
||||
| `provider_get__inventory` | GET | `/inventory` | Get inventory list | No parameters |
|
||||
| `provider_get__join_meeting_id` | GET | `/join-meeting/{meeting_id}` | Join a meeting | **Required:** meeting_id (string) |
|
||||
| `provider_get__phone_log_list_id` | GET | `/phone-log-list/{patient_id}` | Get phone logs for a patient | **Required:** patient_id (integer), **Optional:** draw (integer), start (integer), length (integer) |
|
||||
| `provider_get__provider_me` | GET | `/provider/me` | Get provider details by access token | No parameters |
|
||||
| `provider_create__save_payment_method` | POST | `/save-payment-method` | Save payment method configuration | **Required:** name (string), config (object) |
|
||||
| `provider_create__store_insurance_id` | POST | `/store-insurance/{patientId}` | Store insurance information for a patient | **Required:** patientId (integer), insuredPlanOrProgramName (string), insuredIDNumber (string), relationshiptoInsured (string), insuredDateOfBirth (string), insuredAddress (string), insuredCity (string), insuredState (string), insuredZip (string), insuredPhone (string), payerName (string), payerID (string), payerAddress (string), payerCity (string), payerState (string), payerZip (string), type (string), **Optional:** insurance (string), insuredGroupNameNo (string), employersSchoolName (string), insuredName (string), insuredGender (string), coPayment (number), coInsurance (number), insuranceDeductible (number), referringProviderName (string), referringProviderNPI (string), referringProviderTaxonomy (string) |
|
||||
| `provider_create__store_tags_id` | POST | `/store-tags/{patientId}` | Store tags for a patient (alternate endpoint) | **Required:** patientId (integer), tags (array) |
|
||||
| `provider_get__tags_list_id` | GET | `/tags/list/{pid}` | Get tags for a patient | **Required:** pid (integer) |
|
||||
| `provider_create__tags_store_id` | POST | `/tags/store/{pid}` | Store tags for a patient | **Required:** pid (integer), tags (array) |
|
||||
| `provider_update__update_insurance_id` | PUT | `/update-insurance/{patientId}` | Update insurance information for a patient | **Required:** patientId (integer), insuredPlanOrProgramName (string), insuredIDNumber (string), relationshiptoInsured (string), insuredDateOfBirth (string), insuredAddress (string), insuredCity (string), insuredState (string), insuredZip (string), insuredPhone (string), payerName (string), type (string), **Optional:** insuredGroupNameNo (string), coPayment (number) |
|
||||
| `provider_update__update_inventory_id` | PUT | `/update-inventory/{id}` | Update inventory item | **Required:** id (integer), **Optional:** inventoryType (string), item_name (string), price (number), expirationDate (string) |
|
||||
| `provider_get_emr_appointment_doctor_patient_id` | GET | `/api/emr/appointment/doctor/patient/{patientId}` | Get doctor appointments by patient ID | **Required:** patientId (integer) |
|
||||
| `provider_get_emr_appointment_patient_id_list` | GET | `/api/emr/appointment/patient/{patient_id}/list` | Get patient appointment list | **Required:** patient_id (integer) |
|
||||
| `provider_get_emr_appointment_patient_carts_items` | GET | `/api/emr/appointment/patient/carts-items` | Get patient appointments with carts and items | No parameters |
|
||||
|
||||
---
|
||||
|
||||
## Patient Tools (25 tools)
|
||||
|
||||
_Patient authentication required. These tools handle patient portal operations and personal health data access._
|
||||
|
||||
| Tool Name | Method | Endpoint | Description | Key Parameters |
|
||||
| ------------------------------------------------- | ------ | ------------------------------------------------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `patient_get_frontend_patient_dashboard` | GET | `/api/frontend/patient-dashboard` | Get patient dashboard data | No parameters |
|
||||
| `patient_get_frontend_patient_profile` | GET | `/api/frontend/patient-profile` | Get patient profile | No parameters |
|
||||
| `patient_create_frontend_update_patient_profile` | POST | `/api/frontend/update-patient-profile` | Update patient profile | **Optional:** first_name (string), last_name (string), email (string), phone (string), address (string), city (string), state (string), zipcode (string) |
|
||||
| `patient_get_frontend_patient_appointments` | GET | `/api/frontend/patient-appointments` | Get patient appointments | No parameters |
|
||||
| `patient_create_frontend_book_appointment` | POST | `/api/frontend/book-appointment` | Book appointment from patient portal | **Required:** practitioner_id (string), appointment_date (string), appointment_time (string), **Optional:** reason (string) |
|
||||
| `patient_get_frontend_patient_prescriptions` | GET | `/api/frontend/patient-prescriptions` | Get patient prescriptions | No parameters |
|
||||
| `patient_get_frontend_patient_documents` | GET | `/api/frontend/patient-documents` | Get patient documents | No parameters |
|
||||
| `patient_create_change_password` | POST | `/api/change-password` | Update patient password | **Required:** current_password (string), new_password (string), new_password (string), confirm_password (string) |
|
||||
| `patient_get_emr_appointment_doctor_patient_id` | GET | `/api/emr/appointment/doctor/patient/{patientId}` | Get doctor appointments by patient ID | **Required:** patientId (integer) |
|
||||
| `patient_get_emr_appointment_patient_id_list` | GET | `/api/emr/appointment/patient/{patient_id}/list` | Get patient appointment list | **Required:** patient_id (integer) |
|
||||
| `patient_get_emr_appointment_patient_carts_items` | GET | `/api/emr/appointment/patient/carts-items` | Get patient appointments with carts and items | No parameters |
|
||||
| `patient_get_patient_data` | GET | `/api/patient/data` | Get patient data | No parameters |
|
||||
| `patient_get_patient_history_id` | GET | `/api/patient/history/{patientId}` | Get patient history | **Required:** patientId (integer) |
|
||||
| `patient_get_patient_medical_problem_id` | GET | `/api/patient/medical-problem/{id}` | Get medical problem by ID | **Required:** id (integer) |
|
||||
| `patient_update_patient_medical_problem_id` | PUT | `/api/patient/medical-problem/{id}` | Update medical problem | **Required:** id (integer), **Optional:** description (string), date_of_onset (string), status (string) |
|
||||
| `patient_create_patient_medical_problem_id` | POST | `/api/patient/medical-problem/{pid}` | Store medical problem | **Required:** pid (integer), **Optional:** description (string), date_of_onset (string), status (string) |
|
||||
| `patient_get_patient_notifications` | GET | `/api/patient/notifications` | Get patient notifications | No parameters |
|
||||
| `patient_get_patient_prescription` | GET | `/api/patient/prescription` | Get patient prescriptions | No parameters |
|
||||
| `patient_create_patient_process_payment` | POST | `/api/patient/process-payment` | Process payment | **Required:** amount (number), payment_method (string), currency (string), **Optional:** payment_method_id (string), description (string) |
|
||||
| `patient_create_patient_profile_picture` | POST | `/api/patient/profile-picture` | Upload profile picture | **Optional:** profile_picture (string) |
|
||||
| `patient_create_patient_register_patient` | POST | `/api/patient/register-patient` | Register a new patient | **Required:** first_name (string), last_name (string), email (string), phone_no (string), dob (string), gender (string) |
|
||||
| `patient_get_patient_session_history` | GET | `/api/patient/session-history` | Get patient session history | No parameters |
|
||||
| `patient_create_patient_subscription_id_cancel` | POST | `/api/patient/subscription/{subscription}/cancel` | Cancel subscription | **Required:** subscription (integer), **Optional:** reason (string), feedback (string) |
|
||||
| `patient_get_patient_subscriptions` | GET | `/api/patient/subscriptions` | Get patient subscription list | No parameters |
|
||||
| `patient_get__patient_me` | GET | `/patient/me` | Get patient details by access token | No parameters |
|
||||
|
||||
---
|
||||
|
||||
## Partner Tools (6 tools)
|
||||
|
||||
_Partner authentication required. These tools handle business operations and partner management._
|
||||
|
||||
| Tool Name | Method | Endpoint | Description | Key Parameters |
|
||||
| ---------------------------------------- | ------ | ------------------------------ | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `partner_get_partner_dashboard` | GET | `/api/partner/dashboard` | Get partner dashboard | No parameters |
|
||||
| `partner_get_partner_profile` | GET | `/api/partner/profile` | Get partner profile | No parameters |
|
||||
| `partner_create_partner_update_profile` | POST | `/api/partner/update-profile` | Update partner profile | **Optional:** first_name (string), last_name (string), email (string), phone_no (string), company_name (string), business_type (string) |
|
||||
| `partner_get_partner_patients` | GET | `/api/partner/patients` | Get partner patients | No parameters |
|
||||
| `partner_get_partner_referrals` | GET | `/api/partner/referrals` | Get partner referrals | No parameters |
|
||||
| `partner_create_partner_create_referral` | POST | `/api/partner/create-referral` | Create referral | **Required:** patient_id (string), practitioner_id (string), **Optional:** referral_reason (string), notes (string) |
|
||||
|
||||
---
|
||||
|
||||
## Affiliate Tools (6 tools)
|
||||
|
||||
_Affiliate authentication required. These tools handle affiliate management and referral operations._
|
||||
|
||||
| Tool Name | Method | Endpoint | Description | Key Parameters |
|
||||
| ------------------------------------------- | ------ | ------------------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `affiliate_get_affiliate_dashboard` | GET | `/api/affiliate/dashboard` | Get affiliate dashboard | No parameters |
|
||||
| `affiliate_get_affiliate_profile` | GET | `/api/affiliate/profile` | Get affiliate profile | No parameters |
|
||||
| `affiliate_create_affiliate_update_profile` | POST | `/api/affiliate/update-profile` | Update affiliate profile | **Optional:** first_name (string), last_name (string), email (string), phone_no (string), partner_email (string) |
|
||||
| `affiliate_get_affiliate_commissions` | GET | `/api/affiliate/commissions` | Get affiliate commissions | No parameters |
|
||||
| `affiliate_get_affiliate_referrals` | GET | `/api/affiliate/referrals` | Get affiliate referrals | No parameters |
|
||||
| `affiliate_get__affiliate_me` | GET | `/affiliate/me` | Get affiliate details by access token | No parameters |
|
||||
|
||||
---
|
||||
|
||||
## Network Tools (5 tools)
|
||||
|
||||
_Network authentication required. These tools handle network operations and multi-partner management._
|
||||
|
||||
| Tool Name | Method | Endpoint | Description | Key Parameters |
|
||||
| --------------------------------------- | ------ | ----------------------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `network_get_network_dashboard` | GET | `/api/network/dashboard` | Get network dashboard | No parameters |
|
||||
| `network_get_network_profile` | GET | `/api/network/profile` | Get network profile | No parameters |
|
||||
| `network_create_network_update_profile` | POST | `/api/network/update-profile` | Update network profile | **Optional:** first_name (string), last_name (string), email (string), phone_no (string), partner_id (string) |
|
||||
| `network_get_network_partners` | GET | `/api/network/partners` | Get network partners | No parameters |
|
||||
| `network_get_network_analytics` | GET | `/api/network/analytics` | Get network analytics | No parameters |
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
| Authentication Type | Tool Count | Coverage |
|
||||
| ------------------- | ---------- | -------- |
|
||||
| PUBLIC | 77 | 100% |
|
||||
| PROVIDER | 199 | 100% |
|
||||
| PATIENT | 25 | 100% |
|
||||
| PARTNER | 6 | 100% |
|
||||
| AFFILIATE | 6 | 100% |
|
||||
| NETWORK | 5 | 100% |
|
||||
| **TOTAL** | **318** | **100%** |
|
||||
|
||||
---
|
||||
|
||||
_This documentation is automatically generated from the endpoint configuration and provides 100% coverage of all available MCP tools._
|
||||
Reference in New Issue
Block a user