Files
mcp-tool/complete-provider-tools.json
nasir@endelospay.com 8c74b0e23f first
2025-07-11 20:22:12 +05:00

32039 lines
943 KiB
JSON

[
{
"toolName": "provider_create_get_assemblyai_token",
"method": "POST",
"path": "/get-asseblyai-token",
"description": "Get AssemblyAI token",
"category": "meetings",
"parameters": "No parameters",
"operationId": "getAsseblyAiToekn",
"tags": [
"Meetings"
],
"endpoint": {
"path": "/get-asseblyai-token",
"method": "POST",
"operationId": "getAsseblyAiToekn",
"summary": "Get AssemblyAI token",
"description": "Retrieves an AssemblyAI token for transcription services",
"tags": [
"Meetings"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Token retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"token": {
"type": "string",
"example": "9f98sd7f9sd87f9sd87f9sd87f"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Failed to retrieve token"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "meetings",
"toolName": "provider_create_get_asseblyai_token",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Token retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"token": {
"type": "string",
"example": "9f98sd7f9sd87f9sd87f9sd87f"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Failed to retrieve token"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_get_asseblyai_token",
"detailedDescription": "Get AssemblyAI token"
}
},
{
"toolName": "provider_get_create_meeting",
"method": "GET",
"path": "/create-meeting/{meeting_id}",
"description": "Show meeting details",
"category": "meetings",
"parameters": "**Required:** meeting_id (string) - Meeting ID",
"operationId": "showMeeting",
"tags": [
"Meetings"
],
"endpoint": {
"path": "/create-meeting/{meeting_id}",
"method": "GET",
"operationId": "showMeeting",
"summary": "Show meeting details",
"description": "Display meeting details by meeting ID",
"tags": [
"Meetings"
],
"parameters": [
{
"name": "meeting_id",
"in": "path",
"required": true,
"type": "string",
"description": "Meeting ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Meeting details retrieved successfully"
},
"404": {
"description": "Meeting not found"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "meetings",
"toolName": "provider_get_create_meeting",
"completeParameters": {
"meeting_id": {
"name": "meeting_id",
"in": "path",
"type": "string",
"required": true,
"description": "Meeting ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Meeting details retrieved successfully",
"content": {}
},
"404": {
"description": "Meeting not found",
"content": {}
}
},
"exactToolName": "provider_get_create_meeting",
"detailedDescription": "Show meeting details"
}
},
{
"toolName": "provider_get_join_meeting",
"method": "GET",
"path": "/join-meeting/{meeting_id}",
"description": "Join a meeting",
"category": "meetings",
"parameters": "**Required:** meeting_id (string) - Meeting ID",
"operationId": "joinMeeting",
"tags": [
"Meetings"
],
"endpoint": {
"path": "/join-meeting/{meeting_id}",
"method": "GET",
"operationId": "joinMeeting",
"summary": "Join a meeting",
"description": "Join a meeting by meeting ID",
"tags": [
"Meetings"
],
"parameters": [
{
"name": "meeting_id",
"in": "path",
"required": true,
"type": "string",
"description": "Meeting ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Joined meeting successfully"
},
"404": {
"description": "Meeting not found"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "meetings",
"toolName": "provider_get_join_meeting",
"completeParameters": {
"meeting_id": {
"name": "meeting_id",
"in": "path",
"type": "string",
"required": true,
"description": "Meeting ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Joined meeting successfully",
"content": {}
},
"404": {
"description": "Meeting not found",
"content": {}
}
},
"exactToolName": "provider_get_join_meeting",
"detailedDescription": "Join a meeting"
}
},
{
"toolName": "provider_create_start_call",
"method": "POST",
"path": "/api/start-call/{patient_id}/{agent_id}/{appointment_id}",
"description": "Start a call",
"category": "meetings",
"parameters": "**Required:** patient_id (integer) - Patient ID, **Required:** agent_id (integer) - Agent ID, **Required:** appointment_id (integer) - Appointment ID, **Optional:** title (string) - title property",
"operationId": "startCall",
"tags": [
"Meetings"
],
"endpoint": {
"path": "/api/start-call/{patient_id}/{agent_id}/{appointment_id}",
"method": "POST",
"operationId": "startCall",
"summary": "Start a call",
"description": "Start a video call between patient and agent",
"tags": [
"Meetings"
],
"parameters": [
{
"name": "patient_id",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
},
{
"name": "agent_id",
"in": "path",
"required": true,
"type": "integer",
"description": "Agent ID"
},
{
"name": "appointment_id",
"in": "path",
"required": true,
"type": "integer",
"description": "Appointment ID"
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"properties": {
"title": {
"type": "string",
"example": "Consultation call"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Call started successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"token": {
"type": "string"
},
"appointment_id": {
"type": "integer"
},
"url": {
"type": "string"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Appointment not found"
},
"500": {
"description": "Failed to start call"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "meetings",
"toolName": "provider_create_start_call",
"completeParameters": {
"patient_id": {
"name": "patient_id",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
},
"agent_id": {
"name": "agent_id",
"in": "path",
"type": "integer",
"required": true,
"description": "Agent ID"
},
"appointment_id": {
"name": "appointment_id",
"in": "path",
"type": "integer",
"required": true,
"description": "Appointment ID"
}
},
"requestBodySchema": {
"required": false,
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"title": {
"type": "string",
"example": "Consultation call"
}
},
"type": "object"
},
"properties": {
"title": {
"type": "string",
"description": "title property",
"example": "Consultation call",
"required": false
}
},
"required": []
}
}
},
"responseSchema": {
"200": {
"description": "Call started successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"token": {
"type": "string"
},
"appointment_id": {
"type": "integer"
},
"url": {
"type": "string"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Appointment not found",
"content": {}
},
"500": {
"description": "Failed to start call",
"content": {}
}
},
"exactToolName": "provider_create_start_call",
"detailedDescription": "Start a call"
}
},
{
"toolName": "provider_get_get_realtime_questions",
"method": "GET",
"path": "/get-realtime-questions/{appointmentId}",
"description": "Get real-time questions",
"category": "meetings",
"parameters": "**Required:** appointmentId (integer) - Appointment ID",
"operationId": "getRealtimeQuestions",
"tags": [
"Meetings"
],
"endpoint": {
"path": "/get-realtime-questions/{appointmentId}",
"method": "GET",
"operationId": "getRealtimeQuestions",
"summary": "Get real-time questions",
"description": "Retrieves real-time questions generated during a session",
"tags": [
"Meetings"
],
"parameters": [
{
"name": "appointmentId",
"in": "path",
"required": true,
"type": "integer",
"description": "Appointment ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Questions retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Success"
},
"Response": {
"type": "string",
"example": "Success"
},
"questions": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer"
},
"appointment_id": {
"type": "integer"
},
"question": {
"type": "string"
},
"timestamp": {
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
},
"transcription_status": {
"type": "string"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Appointment not found"
},
"500": {
"description": "Failed to retrieve questions"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "meetings",
"toolName": "provider_get_get_realtime_questions",
"completeParameters": {
"appointmentId": {
"name": "appointmentId",
"in": "path",
"type": "integer",
"required": true,
"description": "Appointment ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Questions retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Success"
},
"Response": {
"type": "string",
"example": "Success"
},
"questions": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer"
},
"appointment_id": {
"type": "integer"
},
"question": {
"type": "string"
},
"timestamp": {
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
},
"transcription_status": {
"type": "string"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Appointment not found",
"content": {}
},
"500": {
"description": "Failed to retrieve questions",
"content": {}
}
},
"exactToolName": "provider_get_get_realtime_questions",
"detailedDescription": "Get real-time questions"
}
},
{
"toolName": "provider_create_end_call",
"method": "POST",
"path": "/api/end-call/{patient_id}/{appointment_id}",
"description": "End a call",
"category": "meetings",
"parameters": "**Required:** patient_id (integer) - Patient ID, **Required:** appointment_id (integer) - Appointment ID",
"operationId": "endCall",
"tags": [
"Meetings"
],
"endpoint": {
"path": "/api/end-call/{patient_id}/{appointment_id}",
"method": "POST",
"operationId": "endCall",
"summary": "End a call",
"description": "End an active video call",
"tags": [
"Meetings"
],
"parameters": [
{
"name": "patient_id",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
},
{
"name": "appointment_id",
"in": "path",
"required": true,
"type": "integer",
"description": "Appointment ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Call ended successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Call ended"
},
"appointment_id": {
"type": "integer"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Appointment not found"
},
"500": {
"description": "Failed to end call"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "meetings",
"toolName": "provider_create_end_call",
"completeParameters": {
"patient_id": {
"name": "patient_id",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
},
"appointment_id": {
"name": "appointment_id",
"in": "path",
"type": "integer",
"required": true,
"description": "Appointment ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Call ended successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Call ended"
},
"appointment_id": {
"type": "integer"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Appointment not found",
"content": {}
},
"500": {
"description": "Failed to end call",
"content": {}
}
},
"exactToolName": "provider_create_end_call",
"detailedDescription": "End a call"
}
},
{
"toolName": "provider_search_labs_search",
"method": "POST",
"path": "/api/labs/search",
"description": "Search labs by address",
"category": "labs",
"parameters": "**Required:** address (string) - address property",
"operationId": "searchLabsByAddress",
"tags": [
"Labs"
],
"endpoint": {
"path": "/api/labs/search",
"method": "POST",
"operationId": "searchLabsByAddress",
"summary": "Search labs by address",
"description": "Search for labs by address, city, state or zip code",
"tags": [
"Labs"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"address"
],
"properties": {
"address": {
"type": "string",
"example": "123 Main St"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Labs retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"lang": {
"type": "number",
"format": "float"
},
"lat": {
"type": "number",
"format": "float"
}
},
"type": "object"
}
}
}
}
},
"500": {
"description": "Failed to search labs"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "labs",
"toolName": "provider_create_labs_search",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"address"
],
"properties": {
"address": {
"type": "string",
"example": "123 Main St"
}
},
"type": "object"
},
"properties": {
"address": {
"type": "string",
"description": "address property",
"example": "123 Main St",
"required": true
}
},
"required": [
"address"
]
}
}
},
"responseSchema": {
"200": {
"description": "Labs retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"lang": {
"type": "number",
"format": "float"
},
"lat": {
"type": "number",
"format": "float"
}
},
"type": "object"
}
}
}
}
},
"500": {
"description": "Failed to search labs",
"content": {}
}
},
"exactToolName": "provider_search_labs_search",
"detailedDescription": "Search labs by address"
}
},
{
"toolName": "provider_create_book_appointment",
"method": "POST",
"path": "/api/book-appointment",
"description": "Book an appointment",
"category": "appointments",
"parameters": "**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",
"operationId": "bookAgentAppointment",
"tags": [
"Appointments"
],
"endpoint": {
"path": "/api/book-appointment",
"method": "POST",
"operationId": "bookAgentAppointment",
"summary": "Book an appointment",
"description": "Books a new appointment with a doctor",
"tags": [
"Appointments"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"telemed_pros_id",
"patient_id",
"doctor_id",
"appointment_id",
"appointment_time"
],
"properties": {
"telemed_pros_id": {
"type": "integer",
"example": 1
},
"patient_id": {
"type": "integer",
"example": 1
},
"doctor_id": {
"type": "integer",
"example": 1
},
"appointment_id": {
"type": "integer",
"example": 1
},
"appointment_time": {
"type": "string",
"format": "date-time",
"example": "2023-06-15 14:30:00"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Appointment booked successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Appointment booked successfully"
},
"meeting_id": {
"type": "string"
},
"appointment_time": {
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error"
},
"500": {
"description": "Failed to book appointment"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "appointments",
"toolName": "provider_create_book_appointment",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"telemed_pros_id",
"patient_id",
"doctor_id",
"appointment_id",
"appointment_time"
],
"properties": {
"telemed_pros_id": {
"type": "integer",
"example": 1
},
"patient_id": {
"type": "integer",
"example": 1
},
"doctor_id": {
"type": "integer",
"example": 1
},
"appointment_id": {
"type": "integer",
"example": 1
},
"appointment_time": {
"type": "string",
"format": "date-time",
"example": "2023-06-15 14:30:00"
}
},
"type": "object"
},
"properties": {
"telemed_pros_id": {
"type": "integer",
"description": "telemed_pros_id property",
"example": 1,
"required": true
},
"patient_id": {
"type": "integer",
"description": "patient_id property",
"example": 1,
"required": true
},
"doctor_id": {
"type": "integer",
"description": "doctor_id property",
"example": 1,
"required": true
},
"appointment_id": {
"type": "integer",
"description": "appointment_id property",
"example": 1,
"required": true
},
"appointment_time": {
"type": "string",
"format": "date-time",
"description": "appointment_time property",
"example": "2023-06-15 14:30:00",
"required": true
}
},
"required": [
"telemed_pros_id",
"patient_id",
"doctor_id",
"appointment_id",
"appointment_time"
]
}
}
},
"responseSchema": {
"200": {
"description": "Appointment booked successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Appointment booked successfully"
},
"meeting_id": {
"type": "string"
},
"appointment_time": {
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error",
"content": {}
},
"500": {
"description": "Failed to book appointment",
"content": {}
}
},
"exactToolName": "provider_create_book_appointment",
"detailedDescription": "Book an appointment"
}
},
{
"toolName": "provider_update_update_patient_info",
"method": "POST",
"path": "/api/update-patient-info/{patientId}",
"description": "Update patient information",
"category": "patients",
"parameters": "**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",
"operationId": "updateInfo",
"tags": [
"Patients"
],
"endpoint": {
"path": "/api/update-patient-info/{patientId}",
"method": "POST",
"operationId": "updateInfo",
"summary": "Update patient information",
"description": "Updates patient's personal information",
"tags": [
"Patients"
],
"parameters": [
{
"name": "patientId",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"properties": {
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"address": {
"type": "string",
"example": "123 Main St"
},
"zip_code": {
"type": "string",
"example": "10001"
},
"dob": {
"type": "string",
"format": "date",
"example": "1990-01-01"
},
"country": {
"type": "string",
"example": "USA"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Patient information updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Patient address updated successfully"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Failed to update patient information"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "patients",
"toolName": "provider_create_update_patient_info",
"completeParameters": {
"patientId": {
"name": "patientId",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"address": {
"type": "string",
"example": "123 Main St"
},
"zip_code": {
"type": "string",
"example": "10001"
},
"dob": {
"type": "string",
"format": "date",
"example": "1990-01-01"
},
"country": {
"type": "string",
"example": "USA"
}
},
"type": "object"
},
"properties": {
"city": {
"type": "string",
"description": "city property",
"example": "New York",
"required": false
},
"state": {
"type": "string",
"description": "state property",
"example": "NY",
"required": false
},
"address": {
"type": "string",
"description": "address property",
"example": "123 Main St",
"required": false
},
"zip_code": {
"type": "string",
"description": "zip_code property",
"example": "10001",
"required": false
},
"dob": {
"type": "string",
"format": "date",
"description": "dob property",
"example": "1990-01-01",
"required": false
},
"country": {
"type": "string",
"description": "country property",
"example": "USA",
"required": false
}
},
"required": []
}
}
},
"responseSchema": {
"200": {
"description": "Patient information updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Patient address updated successfully"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Failed to update patient information",
"content": {}
}
},
"exactToolName": "provider_create_update_patient_info",
"detailedDescription": "Update patient information"
}
},
{
"toolName": "provider_create_get_patient_info",
"method": "POST",
"path": "/api/get-patient-info/{patientId}",
"description": "Get patient information",
"category": "patients",
"parameters": "**Required:** patientId (integer) - Patient ID",
"operationId": "getInfo",
"tags": [
"Patients"
],
"endpoint": {
"path": "/api/get-patient-info/{patientId}",
"method": "POST",
"operationId": "getInfo",
"summary": "Get patient information",
"description": "Retrieves patient's personal information",
"tags": [
"Patients"
],
"parameters": [
{
"name": "patientId",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Patient information retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"address": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"country": {
"type": "string"
},
"dob": {
"type": "string",
"format": "date"
},
"age": {
"type": "integer"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Failed to retrieve patient information"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "patients",
"toolName": "provider_create_get_patient_info",
"completeParameters": {
"patientId": {
"name": "patientId",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Patient information retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"address": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"country": {
"type": "string"
},
"dob": {
"type": "string",
"format": "date"
},
"age": {
"type": "integer"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Failed to retrieve patient information",
"content": {}
}
},
"exactToolName": "provider_create_get_patient_info",
"detailedDescription": "Get patient information"
}
},
{
"toolName": "provider_create_get_doctors_list",
"method": "POST",
"path": "/api/get-doctors-list",
"description": "Get doctors list",
"category": "doctors",
"parameters": "No parameters",
"operationId": "getDoctorList",
"tags": [
"Doctors"
],
"endpoint": {
"path": "/api/get-doctors-list",
"method": "POST",
"operationId": "getDoctorList",
"summary": "Get doctors list",
"description": "Retrieves a list of all doctors",
"tags": [
"Doctors"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Doctors list retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"designation": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"500": {
"description": "Failed to retrieve doctors list"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "doctors",
"toolName": "provider_create_get_doctors_list",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Doctors list retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"designation": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"500": {
"description": "Failed to retrieve doctors list",
"content": {}
}
},
"exactToolName": "provider_create_get_doctors_list",
"detailedDescription": "Get doctors list"
}
},
{
"toolName": "provider_create_get_appointment_list",
"method": "POST",
"path": "/api/get-appointment-list",
"description": "Get appointments list",
"category": "appointments",
"parameters": "No parameters",
"operationId": "getAppointmentList",
"tags": [
"Appointments"
],
"endpoint": {
"path": "/api/get-appointment-list",
"method": "POST",
"operationId": "getAppointmentList",
"summary": "Get appointments list",
"description": "Retrieves a list of all appointments",
"tags": [
"Appointments"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Appointments list retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"agent_name": {
"type": "string"
},
"appointment_time": {
"type": "string",
"format": "date-time"
},
"status": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"500": {
"description": "Failed to retrieve appointments list"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "appointments",
"toolName": "provider_create_get_appointment_list",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Appointments list retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"agent_name": {
"type": "string"
},
"appointment_time": {
"type": "string",
"format": "date-time"
},
"status": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"500": {
"description": "Failed to retrieve appointments list",
"content": {}
}
},
"exactToolName": "provider_create_get_appointment_list",
"detailedDescription": "Get appointments list"
}
},
{
"toolName": "provider_create_get_doctors_appointment_list",
"method": "POST",
"path": "/api/get-doctors-appointment-list",
"description": "Get doctor appointments list",
"category": "appointments",
"parameters": "No parameters",
"operationId": "getDoctorAppointmentList",
"tags": [
"Appointments",
"Doctors"
],
"endpoint": {
"path": "/api/get-doctors-appointment-list",
"method": "POST",
"operationId": "getDoctorAppointmentList",
"summary": "Get doctor appointments list",
"description": "Retrieves a list of all doctor appointments",
"tags": [
"Appointments",
"Doctors"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Doctor appointments list retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"appointment_time": {
"type": "string",
"format": "date-time"
},
"doctor_id": {
"type": "integer"
},
"patient_id": {
"type": "integer"
},
"appointment_id": {
"type": "integer"
}
},
"type": "object"
}
}
}
}
},
"500": {
"description": "Failed to retrieve doctor appointments list"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "appointments",
"toolName": "provider_create_get_doctors_appointment_list",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Doctor appointments list retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"appointment_time": {
"type": "string",
"format": "date-time"
},
"doctor_id": {
"type": "integer"
},
"patient_id": {
"type": "integer"
},
"appointment_id": {
"type": "integer"
}
},
"type": "object"
}
}
}
}
},
"500": {
"description": "Failed to retrieve doctor appointments list",
"content": {}
}
},
"exactToolName": "provider_create_get_doctors_appointment_list",
"detailedDescription": "Get doctor appointments list"
}
},
{
"toolName": "provider_create_available_slots",
"method": "POST",
"path": "/api/available-slots/{date}",
"description": "Get available appointment slots",
"category": "appointments",
"parameters": "**Required:** date (string) - Date (YYYY-MM-DD)",
"operationId": "availableSlots",
"tags": [
"Appointments"
],
"endpoint": {
"path": "/api/available-slots/{date}",
"method": "POST",
"operationId": "availableSlots",
"summary": "Get available appointment slots",
"description": "Retrieves available appointment slots for a specific date",
"tags": [
"Appointments"
],
"parameters": [
{
"name": "date",
"in": "path",
"required": true,
"type": "string",
"description": "Date (YYYY-MM-DD)"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Available slots retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"available_slots": {
"type": "array",
"items": {
"type": "string",
"example": "9:00 AM"
}
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Failed to retrieve available slots"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "appointments",
"toolName": "provider_create_available_slots",
"completeParameters": {
"date": {
"name": "date",
"in": "path",
"type": "string",
"format": "date",
"required": true,
"description": "Date (YYYY-MM-DD)"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Available slots retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"available_slots": {
"type": "array",
"items": {
"type": "string",
"example": "9:00 AM"
}
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Failed to retrieve available slots",
"content": {}
}
},
"exactToolName": "provider_create_available_slots",
"detailedDescription": "Get available appointment slots"
}
},
{
"toolName": "provider_create_appointment_detail",
"method": "POST",
"path": "/api/appointment-detail/{appointment}",
"description": "Get appointment details",
"category": "appointments",
"parameters": "**Required:** appointment (integer) - Appointment ID",
"operationId": "appointmentDetail",
"tags": [
"Appointments"
],
"endpoint": {
"path": "/api/appointment-detail/{appointment}",
"method": "POST",
"operationId": "appointmentDetail",
"summary": "Get appointment details",
"description": "Retrieves detailed information about a specific appointment",
"tags": [
"Appointments"
],
"parameters": [
{
"name": "appointment",
"in": "path",
"required": true,
"type": "integer",
"description": "Appointment ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Appointment details retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"patient": {
"type": "object"
},
"telemedPro": {
"type": "object"
},
"doctor_appointment": {
"type": "object"
},
"agent_appointment": {
"type": "object"
},
"video_url": {
"type": "string"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Appointment not found"
},
"500": {
"description": "Failed to retrieve appointment details"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "appointments",
"toolName": "provider_create_appointment_detail",
"completeParameters": {
"appointment": {
"name": "appointment",
"in": "path",
"type": "integer",
"required": true,
"description": "Appointment ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Appointment details retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"patient": {
"type": "object"
},
"telemedPro": {
"type": "object"
},
"doctor_appointment": {
"type": "object"
},
"agent_appointment": {
"type": "object"
},
"video_url": {
"type": "string"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Appointment not found",
"content": {}
},
"500": {
"description": "Failed to retrieve appointment details",
"content": {}
}
},
"exactToolName": "provider_create_appointment_detail",
"detailedDescription": "Get appointment details"
}
},
{
"toolName": "provider_get_lab_detail",
"method": "GET",
"path": "/api/lab-detail/{appointment}",
"description": "Get lab details for an appointment",
"category": "appointments",
"parameters": "**Required:** appointment (integer) - Appointment ID",
"operationId": "labDetail",
"tags": [
"Labs",
"Appointments"
],
"endpoint": {
"path": "/api/lab-detail/{appointment}",
"method": "GET",
"operationId": "labDetail",
"summary": "Get lab details for an appointment",
"description": "Retrieves lab details associated with a specific appointment",
"tags": [
"Labs",
"Appointments"
],
"parameters": [
{
"name": "appointment",
"in": "path",
"required": true,
"type": "integer",
"description": "Appointment ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Lab details retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"lab_name": {
"type": "string"
},
"lab_address": {
"type": "string"
},
"lab_city": {
"type": "string"
},
"lab_state": {
"type": "string"
},
"lab_distance": {
"type": "number",
"format": "float"
},
"lab_contact_no": {
"type": "string"
},
"lab_lang": {
"type": "number",
"format": "float"
},
"lab_lat": {
"type": "number",
"format": "float"
},
"slot_date": {
"type": "string",
"format": "date"
},
"slot_time": {
"type": "string"
},
"booking_time": {
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Lab or appointment not found"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "appointments",
"toolName": "provider_get_lab_detail",
"completeParameters": {
"appointment": {
"name": "appointment",
"in": "path",
"type": "integer",
"required": true,
"description": "Appointment ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Lab details retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"lab_name": {
"type": "string"
},
"lab_address": {
"type": "string"
},
"lab_city": {
"type": "string"
},
"lab_state": {
"type": "string"
},
"lab_distance": {
"type": "number",
"format": "float"
},
"lab_contact_no": {
"type": "string"
},
"lab_lang": {
"type": "number",
"format": "float"
},
"lab_lat": {
"type": "number",
"format": "float"
},
"slot_date": {
"type": "string",
"format": "date"
},
"slot_time": {
"type": "string"
},
"booking_time": {
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Lab or appointment not found",
"content": {}
}
},
"exactToolName": "provider_get_lab_detail",
"detailedDescription": "Get lab details for an appointment"
}
},
{
"toolName": "provider_create_add_note_patient",
"method": "POST",
"path": "/api/add-note-patient",
"description": "Add a note for patient",
"category": "notes",
"parameters": "**Required:** note (string) - note property, **Required:** note_type (string) - note_type property",
"operationId": "addNotePatient",
"tags": [
"Notes"
],
"endpoint": {
"path": "/api/add-note-patient",
"method": "POST",
"operationId": "addNotePatient",
"summary": "Add a note for patient",
"description": "Creates a new note for the authenticated patient",
"tags": [
"Notes"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"note",
"note_type"
],
"properties": {
"note": {
"type": "string",
"example": "Follow-up required in 2 weeks"
},
"note_type": {
"type": "string",
"example": "medical"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Note created successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Note created"
},
"data": {
"properties": {
"id": {
"type": "integer"
},
"note": {
"type": "string"
},
"note_type": {
"type": "string"
},
"patient_id": {
"type": "integer"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"500": {
"description": "Failed to create note"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "notes",
"toolName": "provider_create_add_note_patient",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"note",
"note_type"
],
"properties": {
"note": {
"type": "string",
"example": "Follow-up required in 2 weeks"
},
"note_type": {
"type": "string",
"example": "medical"
}
},
"type": "object"
},
"properties": {
"note": {
"type": "string",
"description": "note property",
"example": "Follow-up required in 2 weeks",
"required": true
},
"note_type": {
"type": "string",
"description": "note_type property",
"example": "medical",
"required": true
}
},
"required": [
"note",
"note_type"
]
}
}
},
"responseSchema": {
"200": {
"description": "Note created successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Note created"
},
"data": {
"properties": {
"id": {
"type": "integer"
},
"note": {
"type": "string"
},
"note_type": {
"type": "string"
},
"patient_id": {
"type": "integer"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"500": {
"description": "Failed to create note",
"content": {}
}
},
"exactToolName": "provider_create_add_note_patient",
"detailedDescription": "Add a note for patient"
}
},
{
"toolName": "provider_get_get_note_patient",
"method": "GET",
"path": "/api/get-note-patient",
"description": "Get patient notes",
"category": "notes",
"parameters": "No parameters",
"operationId": "getNotePatient",
"tags": [
"Notes"
],
"endpoint": {
"path": "/api/get-note-patient",
"method": "GET",
"operationId": "getNotePatient",
"summary": "Get patient notes",
"description": "Retrieves all notes for the authenticated patient",
"tags": [
"Notes"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Notes retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Note created"
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer"
},
"note": {
"type": "string"
},
"note_type": {
"type": "string"
},
"patient_id": {
"type": "integer"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"500": {
"description": "Failed to retrieve notes"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "notes",
"toolName": "provider_get_get_note_patient",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Notes retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Note created"
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer"
},
"note": {
"type": "string"
},
"note_type": {
"type": "string"
},
"patient_id": {
"type": "integer"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"500": {
"description": "Failed to retrieve notes",
"content": {}
}
},
"exactToolName": "provider_get_get_note_patient",
"detailedDescription": "Get patient notes"
}
},
{
"toolName": "provider_update_appointment_status",
"method": "PUT",
"path": "/appointment-status/{id}/{status}",
"description": "Update appointment status",
"category": "appointments",
"parameters": "**Required:** id (integer) - Appointment ID, **Required:** status (string) - New status for the appointment",
"operationId": "updateAppointmentStatus",
"tags": [
"Appointments"
],
"endpoint": {
"path": "/appointment-status/{id}/{status}",
"method": "PUT",
"operationId": "updateAppointmentStatus",
"summary": "Update appointment status",
"description": "Updates the status of an appointment",
"tags": [
"Appointments"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "Appointment ID"
},
{
"name": "status",
"in": "path",
"required": true,
"type": "string",
"description": "New status for the appointment"
}
],
"requestBody": null,
"responses": {
"204": {
"description": "Appointment status updated successfully (No Content)",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "status updated !"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Appointment not found"
},
"500": {
"description": "Failed to update appointment status"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "appointments",
"toolName": "provider_update_appointment_status",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "Appointment ID"
},
"status": {
"name": "status",
"in": "path",
"type": "string",
"required": true,
"description": "New status for the appointment",
"enum": [
"booked",
"confirmed",
"canceled",
"completed"
]
}
},
"requestBodySchema": null,
"responseSchema": {
"204": {
"description": "Appointment status updated successfully (No Content)",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "status updated !"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Appointment not found",
"content": {}
},
"500": {
"description": "Failed to update appointment status",
"content": {}
}
},
"exactToolName": "provider_update_appointment_status",
"detailedDescription": "Update appointment status"
}
},
{
"toolName": "provider_get_patient_data",
"method": "GET",
"path": "/api/patient-data/{id}",
"description": "Get patient data",
"category": "patients",
"parameters": "**Required:** id (integer) - Patient ID",
"operationId": "getAssistantPatientData",
"tags": [
"Patient Data"
],
"endpoint": {
"path": "/api/patient-data/{id}",
"method": "GET",
"operationId": "getAssistantPatientData",
"summary": "Get patient data",
"description": "Retrieves detailed information about a patient",
"tags": [
"Patient Data"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Patient data retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"patient": {
"type": "object"
},
"patientExtra": {
"type": "object"
},
"insurance": {
"type": "object"
},
"address": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Patient not found"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "patients",
"toolName": "provider_get_patient_data",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Patient data retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"patient": {
"type": "object"
},
"patientExtra": {
"type": "object"
},
"insurance": {
"type": "object"
},
"address": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Patient not found",
"content": {}
}
},
"exactToolName": "provider_get_patient_data",
"detailedDescription": "Get patient data"
}
},
{
"toolName": "provider_get_get_patient_forms_list",
"method": "GET",
"path": "/api/get-patient-forms-list/{pid}",
"description": "Get patient intake simple forms list",
"category": "forms",
"parameters": "**Required:** pid (integer) - Patient ID",
"operationId": "getPatientIntakeSimpleFormList",
"tags": [
"Forms"
],
"endpoint": {
"path": "/api/get-patient-forms-list/{pid}",
"method": "GET",
"operationId": "getPatientIntakeSimpleFormList",
"summary": "Get patient intake simple forms list",
"description": "Retrieves a list of simple intake forms for a specific patient",
"tags": [
"Forms"
],
"parameters": [
{
"name": "pid",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Forms list retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"forms": {
"type": "array",
"items": {
"type": "object"
}
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_get_get_patient_forms_list",
"completeParameters": {
"pid": {
"name": "pid",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Forms list retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"forms": {
"type": "array",
"items": {
"type": "object"
}
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_get_patient_forms_list",
"detailedDescription": "Get patient intake simple forms list"
}
},
{
"toolName": "provider_get_get_all_forms",
"method": "GET",
"path": "/api/get-all-forms",
"description": "Get all forms",
"category": "forms",
"parameters": "No parameters",
"operationId": "getAllForms",
"tags": [
"Forms"
],
"endpoint": {
"path": "/api/get-all-forms",
"method": "GET",
"operationId": "getAllForms",
"summary": "Get all forms",
"description": "Retrieves a list of all available forms",
"tags": [
"Forms"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Forms list retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"forms": {
"type": "array",
"items": {
"type": "object"
}
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_get_get_all_forms",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Forms list retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"forms": {
"type": "array",
"items": {
"type": "object"
}
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_get_all_forms",
"detailedDescription": "Get all forms"
}
},
{
"toolName": "provider_get_get_prescription_list",
"method": "GET",
"path": "/api/get-prescription-list/{patient_id}",
"description": "Get patient prescription list",
"category": "patients",
"parameters": "**Required:** patient_id (integer) - Patient ID",
"operationId": "getPrescriptionList",
"tags": [
"Patient Data"
],
"endpoint": {
"path": "/api/get-prescription-list/{patient_id}",
"method": "GET",
"operationId": "getPrescriptionList",
"summary": "Get patient prescription list",
"description": "Retrieves a list of prescriptions for a specific patient",
"tags": [
"Patient Data"
],
"parameters": [
{
"name": "patient_id",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Prescription list retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"prescriptions": {
"type": "array",
"items": {
"type": "object"
}
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "patients",
"toolName": "provider_get_get_prescription_list",
"completeParameters": {
"patient_id": {
"name": "patient_id",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Prescription list retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"prescriptions": {
"type": "array",
"items": {
"type": "object"
}
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_get_prescription_list",
"detailedDescription": "Get patient prescription list"
}
},
{
"toolName": "provider_create_assistant_store_intake_form_data",
"method": "POST",
"path": "/api/assistant/store-intake-form-data",
"description": "Store intake form data",
"category": "forms",
"parameters": "No parameters",
"operationId": "storeAssistantIntakeFormData",
"tags": [
"Forms"
],
"endpoint": {
"path": "/api/assistant/store-intake-form-data",
"method": "POST",
"operationId": "storeAssistantIntakeFormData",
"summary": "Store intake form data",
"description": "Stores data from a patient intake form",
"tags": [
"Forms"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"required": [
"form_id",
"pid",
"schema",
"orginal_form_schema"
],
"properties": {
"form_id": {
"type": "integer",
"example": 1
},
"pid": {
"type": "integer",
"example": 123
},
"practitioner_id": {
"type": "integer",
"example": 456
},
"schema": {
"description": "JSON schema of the form",
"type": "string"
},
"orginal_form_schema": {
"description": "Original form schema",
"type": "string"
},
"signatureMetaData": {
"description": "Signature metadata",
"type": "string"
},
"file_field_name": {
"description": "File upload fields (multiple can be included)",
"type": "file"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Form data updated successfully"
},
"201": {
"description": "Form data stored successfully"
},
"400": {
"description": "Invalid input"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_create_assistant_store_intake_form_data",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"form_id",
"pid",
"schema",
"orginal_form_schema"
],
"properties": {
"form_id": {
"type": "integer",
"example": 1
},
"pid": {
"type": "integer",
"example": 123
},
"practitioner_id": {
"type": "integer",
"example": 456
},
"schema": {
"description": "JSON schema of the form",
"type": "string"
},
"orginal_form_schema": {
"description": "Original form schema",
"type": "string"
},
"signatureMetaData": {
"description": "Signature metadata",
"type": "string"
},
"file_field_name": {
"description": "File upload fields (multiple can be included)",
"type": "file"
}
},
"type": "object"
},
"properties": {
"form_id": {
"type": "integer",
"description": "form_id property",
"example": 1,
"required": true
},
"pid": {
"type": "integer",
"description": "pid property",
"example": 123,
"required": true
},
"practitioner_id": {
"type": "integer",
"description": "practitioner_id property",
"example": 456,
"required": false
},
"schema": {
"type": "string",
"description": "JSON schema of the form",
"required": true
},
"orginal_form_schema": {
"type": "string",
"description": "Original form schema",
"required": true
},
"signatureMetaData": {
"type": "string",
"description": "Signature metadata",
"required": false
},
"file_field_name": {
"type": "file",
"description": "File upload fields (multiple can be included)",
"required": false
}
},
"required": [
"form_id",
"pid",
"schema",
"orginal_form_schema"
]
}
}
},
"responseSchema": {
"200": {
"description": "Form data updated successfully",
"content": {}
},
"201": {
"description": "Form data stored successfully",
"content": {}
},
"400": {
"description": "Invalid input",
"content": {}
}
},
"exactToolName": "provider_create_assistant_store_intake_form_data",
"detailedDescription": "Store intake form data"
}
},
{
"toolName": "provider_create_assistant_store_form",
"method": "POST",
"path": "/api/assistant/store-form",
"description": "Store form data",
"category": "forms",
"parameters": "**Required:** type (string) - type property, **Required:** data (object) - Form structure and fields, **Required:** name (string) - name property",
"operationId": "assistantFormDataStore",
"tags": [
"Forms"
],
"endpoint": {
"path": "/api/assistant/store-form",
"method": "POST",
"operationId": "assistantFormDataStore",
"summary": "Store form data",
"description": "Creates a new form template",
"tags": [
"Forms"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"type",
"data",
"name"
],
"properties": {
"type": {
"type": "string",
"example": "consent-forms"
},
"data": {
"description": "Form structure and fields",
"type": "object"
},
"name": {
"type": "string",
"example": "Patient Consent Form"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Form stored successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"form": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Invalid input"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_create_assistant_store_form",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"type",
"data",
"name"
],
"properties": {
"type": {
"type": "string",
"example": "consent-forms"
},
"data": {
"description": "Form structure and fields",
"type": "object"
},
"name": {
"type": "string",
"example": "Patient Consent Form"
}
},
"type": "object"
},
"properties": {
"type": {
"type": "string",
"description": "type property",
"example": "consent-forms",
"required": true
},
"data": {
"type": "object",
"description": "Form structure and fields",
"required": true
},
"name": {
"type": "string",
"description": "name property",
"example": "Patient Consent Form",
"required": true
}
},
"required": [
"type",
"data",
"name"
]
}
}
},
"responseSchema": {
"200": {
"description": "Form stored successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"form": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Invalid input",
"content": {}
}
},
"exactToolName": "provider_create_assistant_store_form",
"detailedDescription": "Store form data"
}
},
{
"toolName": "provider_create_store_company",
"method": "POST",
"path": "/api/store-company",
"description": "Update company information",
"category": "assistant",
"parameters": "No parameters",
"operationId": "updateCompanyAssistant",
"tags": [
"Assistant"
],
"endpoint": {
"path": "/api/store-company",
"method": "POST",
"operationId": "updateCompanyAssistant",
"summary": "Update company information",
"description": "Updates company profile information and logo",
"tags": [
"Assistant"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "Health Guru Hub"
},
"address": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"zip": {
"type": "string"
},
"phone": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
},
"website": {
"type": "string"
},
"logo": {
"description": "Company logo",
"type": "file"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Company information updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"type": "object"
}
}
}
},
"409": {
"description": "Error updating company information",
"content": {
"application/json": {
"schema": {
"properties": {
"status": {
"type": "string",
"example": "error"
},
"message": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "assistant",
"toolName": "provider_create_store_company",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "Health Guru Hub"
},
"address": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"zip": {
"type": "string"
},
"phone": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
},
"website": {
"type": "string"
},
"logo": {
"description": "Company logo",
"type": "file"
}
},
"type": "object"
},
"properties": {
"name": {
"type": "string",
"description": "name property",
"example": "Health Guru Hub",
"required": true
},
"address": {
"type": "string",
"description": "address property",
"required": false
},
"city": {
"type": "string",
"description": "city property",
"required": false
},
"state": {
"type": "string",
"description": "state property",
"required": false
},
"zip": {
"type": "string",
"description": "zip property",
"required": false
},
"phone": {
"type": "string",
"description": "phone property",
"required": false
},
"email": {
"type": "string",
"format": "email",
"description": "email property",
"required": false
},
"website": {
"type": "string",
"description": "website property",
"required": false
},
"logo": {
"type": "file",
"description": "Company logo",
"required": false
}
},
"required": [
"name"
]
}
}
},
"responseSchema": {
"200": {
"description": "Company information updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"type": "object"
}
}
}
},
"409": {
"description": "Error updating company information",
"content": {
"application/json": {
"schema": {
"properties": {
"status": {
"type": "string",
"example": "error"
},
"message": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_store_company",
"detailedDescription": "Update company information"
}
},
{
"toolName": "provider_update_assistant_update_form",
"method": "PUT",
"path": "/api/assistant/update-form/{id}",
"description": "Update form",
"category": "forms",
"parameters": "**Required:** id (integer) - Form ID, **Required:** type (string) - type property, **Required:** data (object) - Form structure and fields, **Required:** name (string) - name property",
"operationId": "updateAssistantForm",
"tags": [
"Forms"
],
"endpoint": {
"path": "/api/assistant/update-form/{id}",
"method": "PUT",
"operationId": "updateAssistantForm",
"summary": "Update form",
"description": "Updates an existing form template",
"tags": [
"Forms"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "Form ID"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"type",
"data",
"name"
],
"properties": {
"type": {
"type": "string",
"example": "consent-forms"
},
"data": {
"description": "Form structure and fields",
"type": "object"
},
"name": {
"type": "string",
"example": "Updated Patient Consent Form"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Form updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"form": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Form not found",
"content": {
"application/json": {
"schema": {
"properties": {
"status": {
"type": "string",
"example": "404"
},
"message": {
"type": "string",
"example": "Form not found"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_update_assistant_update_form",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "Form ID"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"type",
"data",
"name"
],
"properties": {
"type": {
"type": "string",
"example": "consent-forms"
},
"data": {
"description": "Form structure and fields",
"type": "object"
},
"name": {
"type": "string",
"example": "Updated Patient Consent Form"
}
},
"type": "object"
},
"properties": {
"type": {
"type": "string",
"description": "type property",
"example": "consent-forms",
"required": true
},
"data": {
"type": "object",
"description": "Form structure and fields",
"required": true
},
"name": {
"type": "string",
"description": "name property",
"example": "Updated Patient Consent Form",
"required": true
}
},
"required": [
"type",
"data",
"name"
]
}
}
},
"responseSchema": {
"200": {
"description": "Form updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"form": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Form not found",
"content": {
"application/json": {
"schema": {
"properties": {
"status": {
"type": "string",
"example": "404"
},
"message": {
"type": "string",
"example": "Form not found"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_update_assistant_update_form",
"detailedDescription": "Update form"
}
},
{
"toolName": "provider_create_save_category",
"method": "POST",
"path": "/api/save-category",
"description": "Store product category",
"category": "products",
"parameters": "**Required:** name (string) - name property, **Optional:** description (string) - description property",
"operationId": "storeCategory",
"tags": [
"Products"
],
"endpoint": {
"path": "/api/save-category",
"method": "POST",
"operationId": "storeCategory",
"summary": "Store product category",
"description": "Creates a new product category",
"tags": [
"Products"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "Supplements"
},
"description": {
"type": "string",
"example": "Nutritional supplements and vitamins"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Category stored successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"category": {
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "products",
"toolName": "provider_create_save_category",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "Supplements"
},
"description": {
"type": "string",
"example": "Nutritional supplements and vitamins"
}
},
"type": "object"
},
"properties": {
"name": {
"type": "string",
"description": "name property",
"example": "Supplements",
"required": true
},
"description": {
"type": "string",
"description": "description property",
"example": "Nutritional supplements and vitamins",
"required": false
}
},
"required": [
"name"
]
}
}
},
"responseSchema": {
"200": {
"description": "Category stored successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"category": {
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_save_category",
"detailedDescription": "Store product category"
}
},
{
"toolName": "provider_update_update_category",
"method": "POST",
"path": "/api/update-category/{id}",
"description": "Update product category",
"category": "products",
"parameters": "**Required:** id (integer) - Category ID, **Required:** name (string) - name property, **Optional:** description (string) - description property",
"operationId": "updateCategory",
"tags": [
"Products"
],
"endpoint": {
"path": "/api/update-category/{id}",
"method": "POST",
"operationId": "updateCategory",
"summary": "Update product category",
"description": "Updates an existing product category",
"tags": [
"Products"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "Category ID"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "Updated Supplements"
},
"description": {
"type": "string",
"example": "Updated description"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Category updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"category": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Category not found"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "products",
"toolName": "provider_create_update_category",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "Category ID"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "Updated Supplements"
},
"description": {
"type": "string",
"example": "Updated description"
}
},
"type": "object"
},
"properties": {
"name": {
"type": "string",
"description": "name property",
"example": "Updated Supplements",
"required": true
},
"description": {
"type": "string",
"description": "description property",
"example": "Updated description",
"required": false
}
},
"required": [
"name"
]
}
}
},
"responseSchema": {
"200": {
"description": "Category updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"category": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Category not found",
"content": {}
}
},
"exactToolName": "provider_create_update_category",
"detailedDescription": "Update product category"
}
},
{
"toolName": "provider_create_save_product",
"method": "POST",
"path": "/api/save-product",
"description": "Save product",
"category": "products",
"parameters": "**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",
"operationId": "assistantSaveProduct",
"tags": [
"Products"
],
"endpoint": {
"path": "/api/save-product",
"method": "POST",
"operationId": "assistantSaveProduct",
"summary": "Save product",
"description": "Creates a new product",
"tags": [
"Products"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"name",
"price",
"category_id"
],
"properties": {
"name": {
"type": "string",
"example": "Vitamin D3"
},
"description": {
"type": "string",
"example": "Vitamin D3 supplement"
},
"price": {
"type": "number",
"format": "float",
"example": 19.99
},
"category_id": {
"type": "integer",
"example": 1
},
"sku": {
"type": "string",
"example": "VIT-D3-1000"
},
"stock_quantity": {
"type": "integer",
"example": 100
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Product saved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"product": {
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "products",
"toolName": "provider_create_save_product",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"name",
"price",
"category_id"
],
"properties": {
"name": {
"type": "string",
"example": "Vitamin D3"
},
"description": {
"type": "string",
"example": "Vitamin D3 supplement"
},
"price": {
"type": "number",
"format": "float",
"example": 19.99
},
"category_id": {
"type": "integer",
"example": 1
},
"sku": {
"type": "string",
"example": "VIT-D3-1000"
},
"stock_quantity": {
"type": "integer",
"example": 100
}
},
"type": "object"
},
"properties": {
"name": {
"type": "string",
"description": "name property",
"example": "Vitamin D3",
"required": true
},
"description": {
"type": "string",
"description": "description property",
"example": "Vitamin D3 supplement",
"required": false
},
"price": {
"type": "number",
"format": "float",
"description": "price property",
"example": 19.99,
"required": true
},
"category_id": {
"type": "integer",
"description": "category_id property",
"example": 1,
"required": true
},
"sku": {
"type": "string",
"description": "sku property",
"example": "VIT-D3-1000",
"required": false
},
"stock_quantity": {
"type": "integer",
"description": "stock_quantity property",
"example": 100,
"required": false
}
},
"required": [
"name",
"price",
"category_id"
]
}
}
},
"responseSchema": {
"200": {
"description": "Product saved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"product": {
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_save_product",
"detailedDescription": "Save product"
}
},
{
"toolName": "provider_update_update_product",
"method": "POST",
"path": "/api/update-product/{id}",
"description": "Update product",
"category": "products",
"parameters": "**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",
"operationId": "updateProduct",
"tags": [
"Products"
],
"endpoint": {
"path": "/api/update-product/{id}",
"method": "POST",
"operationId": "updateProduct",
"summary": "Update product",
"description": "Updates an existing product",
"tags": [
"Products"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "Product ID"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"name",
"price",
"category_id"
],
"properties": {
"name": {
"type": "string",
"example": "Updated Vitamin D3"
},
"description": {
"type": "string",
"example": "Updated description"
},
"price": {
"type": "number",
"format": "float",
"example": 24.99
},
"category_id": {
"type": "integer",
"example": 1
},
"sku": {
"type": "string",
"example": "VIT-D3-1000-UPD"
},
"stock_quantity": {
"type": "integer",
"example": 150
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Product updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"product": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Product not found"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "products",
"toolName": "provider_create_update_product",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "Product ID"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"name",
"price",
"category_id"
],
"properties": {
"name": {
"type": "string",
"example": "Updated Vitamin D3"
},
"description": {
"type": "string",
"example": "Updated description"
},
"price": {
"type": "number",
"format": "float",
"example": 24.99
},
"category_id": {
"type": "integer",
"example": 1
},
"sku": {
"type": "string",
"example": "VIT-D3-1000-UPD"
},
"stock_quantity": {
"type": "integer",
"example": 150
}
},
"type": "object"
},
"properties": {
"name": {
"type": "string",
"description": "name property",
"example": "Updated Vitamin D3",
"required": true
},
"description": {
"type": "string",
"description": "description property",
"example": "Updated description",
"required": false
},
"price": {
"type": "number",
"format": "float",
"description": "price property",
"example": 24.99,
"required": true
},
"category_id": {
"type": "integer",
"description": "category_id property",
"example": 1,
"required": true
},
"sku": {
"type": "string",
"description": "sku property",
"example": "VIT-D3-1000-UPD",
"required": false
},
"stock_quantity": {
"type": "integer",
"description": "stock_quantity property",
"example": 150,
"required": false
}
},
"required": [
"name",
"price",
"category_id"
]
}
}
},
"responseSchema": {
"200": {
"description": "Product updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"product": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Product not found",
"content": {}
}
},
"exactToolName": "provider_create_update_product",
"detailedDescription": "Update product"
}
},
{
"toolName": "provider_create_assistant_save_signature",
"method": "POST",
"path": "/api/assistant/save-signature",
"description": "Store signature",
"category": "user_management",
"parameters": "**Required:** signature_data (string) - Base64 encoded signature image, **Optional:** provider_id (integer) - provider_id property",
"operationId": "assistantStoreSignature",
"tags": [
"Provider"
],
"endpoint": {
"path": "/api/assistant/save-signature",
"method": "POST",
"operationId": "assistantStoreSignature",
"summary": "Store signature",
"description": "Stores a provider's signature via assistant API",
"tags": [
"Provider"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"signature_data"
],
"properties": {
"signature_data": {
"description": "Base64 encoded signature image",
"type": "string"
},
"provider_id": {
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Signature stored successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "user_management",
"toolName": "provider_create_assistant_save_signature",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"signature_data"
],
"properties": {
"signature_data": {
"description": "Base64 encoded signature image",
"type": "string"
},
"provider_id": {
"type": "integer",
"example": 1
}
},
"type": "object"
},
"properties": {
"signature_data": {
"type": "string",
"description": "Base64 encoded signature image",
"required": true
},
"provider_id": {
"type": "integer",
"description": "provider_id property",
"example": 1,
"required": false
}
},
"required": [
"signature_data"
]
}
}
},
"responseSchema": {
"200": {
"description": "Signature stored successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_assistant_save_signature",
"detailedDescription": "Store signature"
}
},
{
"toolName": "provider_create_save_payment_method",
"method": "POST",
"path": "/api/save-payment-method",
"description": "Store payment method configuration",
"category": "assistant",
"parameters": "**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",
"operationId": "storePaymentMethodConfigAssistant",
"tags": [
"Assistant"
],
"endpoint": {
"path": "/api/save-payment-method",
"method": "POST",
"operationId": "storePaymentMethodConfigAssistant",
"summary": "Store payment method configuration",
"description": "Stores payment method configuration settings",
"tags": [
"Assistant"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"payment_method"
],
"properties": {
"payment_method": {
"type": "string",
"example": "stripe"
},
"api_key": {
"type": "string"
},
"secret_key": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Payment method configuration stored successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "assistant",
"toolName": "provider_create_save_payment_method",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"payment_method"
],
"properties": {
"payment_method": {
"type": "string",
"example": "stripe"
},
"api_key": {
"type": "string"
},
"secret_key": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"type": "object"
},
"properties": {
"payment_method": {
"type": "string",
"description": "payment_method property",
"example": "stripe",
"required": true
},
"api_key": {
"type": "string",
"description": "api_key property",
"required": false
},
"secret_key": {
"type": "string",
"description": "secret_key property",
"required": false
},
"is_active": {
"type": "boolean",
"description": "is_active property",
"required": false
}
},
"required": [
"payment_method"
]
}
}
},
"responseSchema": {
"200": {
"description": "Payment method configuration stored successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_save_payment_method",
"detailedDescription": "Store payment method configuration"
}
},
{
"toolName": "provider_update_company_complete_setup",
"method": "PUT",
"path": "/api/company/complete/setup/{status}",
"description": "Complete company setup",
"category": "assistant",
"parameters": "**Required:** status (string) - Setup status (complete or incomplete)",
"operationId": "completeSetupAssistant",
"tags": [
"Assistant"
],
"endpoint": {
"path": "/api/company/complete/setup/{status}",
"method": "PUT",
"operationId": "completeSetupAssistant",
"summary": "Complete company setup",
"description": "Marks the company setup process as complete or incomplete",
"tags": [
"Assistant"
],
"parameters": [
{
"name": "status",
"in": "path",
"required": true,
"type": "string",
"description": "Setup status (complete or incomplete)"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Setup status updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Invalid status",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "assistant",
"toolName": "provider_update_company_complete_setup",
"completeParameters": {
"status": {
"name": "status",
"in": "path",
"type": "string",
"required": true,
"description": "Setup status (complete or incomplete)",
"enum": [
"complete",
"incomplete"
]
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Setup status updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Invalid status",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_update_company_complete_setup",
"detailedDescription": "Complete company setup"
}
},
{
"toolName": "provider_create_get_appointment_list_date",
"method": "POST",
"path": "/api/get-appointment-list-date",
"description": "Get appointment list by date",
"category": "appointments",
"parameters": "**Optional:** date (string) - date property, **Optional:** practitioner_id (integer) - practitioner_id property",
"operationId": "getAppointmentListByDate",
"tags": [
"Appointments"
],
"endpoint": {
"path": "/api/get-appointment-list-date",
"method": "POST",
"operationId": "getAppointmentListByDate",
"summary": "Get appointment list by date",
"description": "Retrieves a list of appointments filtered by date",
"tags": [
"Appointments"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"properties": {
"date": {
"type": "string",
"format": "date",
"example": "2023-07-01"
},
"practitioner_id": {
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Appointment list retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Appointment list"
},
"appointments": {
"type": "array",
"items": {
"type": "object"
}
},
"googel_events": {
"type": "array",
"items": {
"type": "object"
}
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "appointments",
"toolName": "provider_create_get_appointment_list_date",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"date": {
"type": "string",
"format": "date",
"example": "2023-07-01"
},
"practitioner_id": {
"type": "integer",
"example": 1
}
},
"type": "object"
},
"properties": {
"date": {
"type": "string",
"format": "date",
"description": "date property",
"example": "2023-07-01",
"required": false
},
"practitioner_id": {
"type": "integer",
"description": "practitioner_id property",
"example": 1,
"required": false
}
},
"required": []
}
}
},
"responseSchema": {
"200": {
"description": "Appointment list retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Appointment list"
},
"appointments": {
"type": "array",
"items": {
"type": "object"
}
},
"googel_events": {
"type": "array",
"items": {
"type": "object"
}
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_get_appointment_list_date",
"detailedDescription": "Get appointment list by date"
}
},
{
"toolName": "provider_create_get_appointment_by_id",
"method": "POST",
"path": "/api/get-appointment-by-id",
"description": "Get appointment by ID",
"category": "appointments",
"parameters": "**Required:** appointment_id (integer) - appointment_id property",
"operationId": "getAppointmentByID",
"tags": [
"Appointments"
],
"endpoint": {
"path": "/api/get-appointment-by-id",
"method": "POST",
"operationId": "getAppointmentByID",
"summary": "Get appointment by ID",
"description": "Retrieves details of a specific appointment",
"tags": [
"Appointments"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"appointment_id"
],
"properties": {
"appointment_id": {
"type": "integer",
"example": 123
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Appointment retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"404": {
"description": "Appointment not found"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "appointments",
"toolName": "provider_create_get_appointment_by_id",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"appointment_id"
],
"properties": {
"appointment_id": {
"type": "integer",
"example": 123
}
},
"type": "object"
},
"properties": {
"appointment_id": {
"type": "integer",
"description": "appointment_id property",
"example": 123,
"required": true
}
},
"required": [
"appointment_id"
]
}
}
},
"responseSchema": {
"200": {
"description": "Appointment retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"404": {
"description": "Appointment not found",
"content": {}
}
},
"exactToolName": "provider_create_get_appointment_by_id",
"detailedDescription": "Get appointment by ID"
}
},
{
"toolName": "provider_update_update_intake_form_data",
"method": "POST",
"path": "/api/update-intake-form-data",
"description": "Update intake form data",
"category": "forms",
"parameters": "**Required:** form_id (integer) - form_id property, **Required:** pid (integer) - pid property, **Required:** data (object) - data property",
"operationId": "updateIntakeFormData",
"tags": [
"Forms"
],
"endpoint": {
"path": "/api/update-intake-form-data",
"method": "POST",
"operationId": "updateIntakeFormData",
"summary": "Update intake form data",
"description": "Updates data in a patient intake form",
"tags": [
"Forms"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"form_id",
"pid",
"data"
],
"properties": {
"form_id": {
"type": "integer",
"example": 1
},
"pid": {
"type": "integer",
"example": 123
},
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Form data updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string"
},
"form": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_create_update_intake_form_data",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"form_id",
"pid",
"data"
],
"properties": {
"form_id": {
"type": "integer",
"example": 1
},
"pid": {
"type": "integer",
"example": 123
},
"data": {
"type": "object"
}
},
"type": "object"
},
"properties": {
"form_id": {
"type": "integer",
"description": "form_id property",
"example": 1,
"required": true
},
"pid": {
"type": "integer",
"description": "pid property",
"example": 123,
"required": true
},
"data": {
"type": "object",
"description": "data property",
"required": true
}
},
"required": [
"form_id",
"pid",
"data"
]
}
}
},
"responseSchema": {
"200": {
"description": "Form data updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string"
},
"form": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_update_intake_form_data",
"detailedDescription": "Update intake form data"
}
},
{
"toolName": "provider_create_form_pdf_save",
"method": "POST",
"path": "/api/form-pdf-save",
"description": "Save form file",
"category": "forms",
"parameters": "**Required:** form_id (integer) - form_id property, **Required:** pdf_data (string) - Base64 encoded PDF data",
"operationId": "saveFormFile",
"tags": [
"Forms"
],
"endpoint": {
"path": "/api/form-pdf-save",
"method": "POST",
"operationId": "saveFormFile",
"summary": "Save form file",
"description": "Saves a PDF file for a form",
"tags": [
"Forms"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"form_id",
"pdf_data"
],
"properties": {
"form_id": {
"type": "integer",
"example": 1
},
"pdf_data": {
"description": "Base64 encoded PDF data",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Form file saved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_create_form_pdf_save",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"form_id",
"pdf_data"
],
"properties": {
"form_id": {
"type": "integer",
"example": 1
},
"pdf_data": {
"description": "Base64 encoded PDF data",
"type": "string"
}
},
"type": "object"
},
"properties": {
"form_id": {
"type": "integer",
"description": "form_id property",
"example": 1,
"required": true
},
"pdf_data": {
"type": "string",
"description": "Base64 encoded PDF data",
"required": true
}
},
"required": [
"form_id",
"pdf_data"
]
}
}
},
"responseSchema": {
"200": {
"description": "Form file saved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_form_pdf_save",
"detailedDescription": "Save form file"
}
},
{
"toolName": "provider_create_provider_add_availability",
"method": "POST",
"path": "/api/provider-add-availability",
"description": "Store provider availability",
"category": "user_management",
"parameters": "**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",
"operationId": "storeProviderAvailability",
"tags": [
"Provider"
],
"endpoint": {
"path": "/api/provider-add-availability",
"method": "POST",
"operationId": "storeProviderAvailability",
"summary": "Store provider availability",
"description": "Creates a new provider availability time slot or event",
"tags": [
"Provider"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"title",
"start",
"end",
"type"
],
"properties": {
"title": {
"type": "string",
"example": "Available"
},
"start": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T09:00:00"
},
"end": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T17:00:00"
},
"type": {
"description": "availability or event",
"type": "string",
"example": "availability"
},
"comment": {
"type": "string"
},
"practitioner_id": {
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Provider availability created successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Provider availability created successfully"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "user_management",
"toolName": "provider_create_provider_add_availability",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"title",
"start",
"end",
"type"
],
"properties": {
"title": {
"type": "string",
"example": "Available"
},
"start": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T09:00:00"
},
"end": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T17:00:00"
},
"type": {
"description": "availability or event",
"type": "string",
"example": "availability"
},
"comment": {
"type": "string"
},
"practitioner_id": {
"type": "integer",
"example": 1
}
},
"type": "object"
},
"properties": {
"title": {
"type": "string",
"description": "title property",
"example": "Available",
"required": true
},
"start": {
"type": "string",
"format": "date-time",
"description": "start property",
"example": "2023-07-01T09:00:00",
"required": true
},
"end": {
"type": "string",
"format": "date-time",
"description": "end property",
"example": "2023-07-01T17:00:00",
"required": true
},
"type": {
"type": "string",
"description": "availability or event",
"example": "availability",
"required": true
},
"comment": {
"type": "string",
"description": "comment property",
"required": false
},
"practitioner_id": {
"type": "integer",
"description": "practitioner_id property",
"example": 1,
"required": false
}
},
"required": [
"title",
"start",
"end",
"type"
]
}
}
},
"responseSchema": {
"201": {
"description": "Provider availability created successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Provider availability created successfully"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_provider_add_availability",
"detailedDescription": "Store provider availability"
}
},
{
"toolName": "provider_get_assistant_practitioners_list",
"method": "GET",
"path": "/api/assistant/practitioners-list",
"description": "Get practitioners list via assistant",
"category": "user_management",
"parameters": "No parameters",
"operationId": "assistantPractitioner",
"tags": [
"Provider"
],
"endpoint": {
"path": "/api/assistant/practitioners-list",
"method": "GET",
"operationId": "assistantPractitioner",
"summary": "Get practitioners list via assistant",
"description": "Retrieves a list of practitioners for the current provider through the assistant API",
"tags": [
"Provider"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Practitioners list retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Practitioner list!"
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer"
},
"uuid": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"type": {
"type": "string"
},
"fname": {
"type": "string"
},
"lname": {
"type": "string"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"403": {
"description": "Unauthorized"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "user_management",
"toolName": "provider_get_assistant_practitioners_list",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Practitioners list retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Practitioner list!"
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer"
},
"uuid": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"type": {
"type": "string"
},
"fname": {
"type": "string"
},
"lname": {
"type": "string"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"403": {
"description": "Unauthorized",
"content": {}
}
},
"exactToolName": "provider_get_assistant_practitioners_list",
"detailedDescription": "Get practitioners list via assistant"
}
},
{
"toolName": "provider_create_save_payment_method",
"method": "POST",
"path": "/save-payment-method",
"description": "Save payment method configuration",
"category": "user_management",
"parameters": "**Required:** name (string) - name property, **Required:** config (object) - config property",
"operationId": "storePaymentMethodConfigProvider",
"tags": [
"Provider"
],
"endpoint": {
"path": "/save-payment-method",
"method": "POST",
"operationId": "storePaymentMethodConfigProvider",
"summary": "Save payment method configuration",
"description": "Store or update payment method configuration for the provider",
"tags": [
"Provider"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"name",
"config"
],
"properties": {
"name": {
"type": "string",
"example": "Stripe"
},
"config": {
"type": "object",
"example": {
"api_key": "sk_test_123",
"public_key": "pk_test_456"
}
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Payment method configuration saved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Updated Successfully!"
},
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"422": {
"description": "Validation error"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "user_management",
"toolName": "provider_create_save_payment_method",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"name",
"config"
],
"properties": {
"name": {
"type": "string",
"example": "Stripe"
},
"config": {
"type": "object",
"example": {
"api_key": "sk_test_123",
"public_key": "pk_test_456"
}
}
},
"type": "object"
},
"properties": {
"name": {
"type": "string",
"description": "name property",
"example": "Stripe",
"required": true
},
"config": {
"type": "object",
"description": "config property",
"example": {
"api_key": "sk_test_123",
"public_key": "pk_test_456"
},
"required": true
}
},
"required": [
"name",
"config"
]
}
}
},
"responseSchema": {
"200": {
"description": "Payment method configuration saved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Updated Successfully!"
},
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"422": {
"description": "Validation error",
"content": {}
}
},
"exactToolName": "provider_create_save_payment_method",
"detailedDescription": "Save payment method configuration"
}
},
{
"toolName": "provider_get_provider_wizard_setup",
"method": "GET",
"path": "/emr-api/provider-wizard-setup",
"description": "Get provider setup counts",
"category": "user_management",
"parameters": "No parameters",
"operationId": "getCounts",
"tags": [
"Provider"
],
"endpoint": {
"path": "/emr-api/provider-wizard-setup",
"method": "GET",
"operationId": "getCounts",
"summary": "Get provider setup counts",
"description": "Get counts of various setup items for the provider wizard",
"tags": [
"Provider"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"total_form": {
"type": "integer",
"example": 5
},
"signature_count": {
"type": "integer",
"example": 1
},
"product_count": {
"type": "integer",
"example": 10
},
"product_cate_count": {
"type": "integer",
"example": 3
},
"affliate_product_count": {
"type": "integer",
"example": 2
},
"sync_google_account": {
"type": "boolean",
"example": true
},
"payment_method_setup": {
"type": "boolean",
"example": true
},
"on_your_domain": {
"type": "boolean",
"example": true
},
"method": {
"type": "object",
"nullable": true
},
"company": {
"type": "object",
"nullable": true
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "user_management",
"toolName": "provider_get_provider_wizard_setup",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"total_form": {
"type": "integer",
"example": 5
},
"signature_count": {
"type": "integer",
"example": 1
},
"product_count": {
"type": "integer",
"example": 10
},
"product_cate_count": {
"type": "integer",
"example": 3
},
"affliate_product_count": {
"type": "integer",
"example": 2
},
"sync_google_account": {
"type": "boolean",
"example": true
},
"payment_method_setup": {
"type": "boolean",
"example": true
},
"on_your_domain": {
"type": "boolean",
"example": true
},
"method": {
"type": "object",
"nullable": true
},
"company": {
"type": "object",
"nullable": true
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
}
},
"exactToolName": "provider_get_provider_wizard_setup",
"detailedDescription": "Get provider setup counts"
}
},
{
"toolName": "provider_update_company_complete_setup",
"method": "PUT",
"path": "/emr-api/company/complete/setup/{status}",
"description": "Complete provider setup",
"category": "company",
"parameters": "**Required:** status (integer) - Setup status (1 for complete, 0 for incomplete)",
"operationId": "completeSetup",
"tags": [
"Company"
],
"endpoint": {
"path": "/emr-api/company/complete/setup/{status}",
"method": "PUT",
"operationId": "completeSetup",
"summary": "Complete provider setup",
"description": "Mark provider setup as complete or incomplete",
"tags": [
"Company"
],
"parameters": [
{
"name": "status",
"in": "path",
"required": true,
"type": "integer",
"description": "Setup status (1 for complete, 0 for incomplete)"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Setup status updated successfully",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "company",
"toolName": "provider_update_company_complete_setup",
"completeParameters": {
"status": {
"name": "status",
"in": "path",
"type": "integer",
"required": true,
"description": "Setup status (1 for complete, 0 for incomplete)",
"enum": [
0,
1
]
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Setup status updated successfully",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
}
},
"exactToolName": "provider_update_company_complete_setup",
"detailedDescription": "Complete provider setup"
}
},
{
"toolName": "provider_get_company_status",
"method": "GET",
"path": "/emr-api/company/status",
"description": "Get company status",
"category": "company",
"parameters": "No parameters",
"operationId": "getCompanyStatus",
"tags": [
"Company"
],
"endpoint": {
"path": "/emr-api/company/status",
"method": "GET",
"operationId": "getCompanyStatus",
"summary": "Get company status",
"description": "Get the current company status",
"tags": [
"Company"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "company",
"toolName": "provider_get_company_status",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
}
},
"exactToolName": "provider_get_company_status",
"detailedDescription": "Get company status"
}
},
{
"toolName": "provider_create_store_company",
"method": "POST",
"path": "/emr-api/store-company",
"description": "Update company information",
"category": "company",
"parameters": "No parameters",
"operationId": "updateCompany",
"tags": [
"Company"
],
"endpoint": {
"path": "/emr-api/store-company",
"method": "POST",
"operationId": "updateCompany",
"summary": "Update company information",
"description": "Update company details including logo, contact information, and domain settings",
"tags": [
"Company"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"required": [
"id",
"company_name",
"company_email"
],
"properties": {
"id": {
"type": "integer",
"example": 1
},
"company_name": {
"type": "string",
"example": "Health Clinic"
},
"company_phone": {
"type": "string",
"example": "1234567890"
},
"company_email": {
"type": "string",
"format": "email",
"example": "info@healthclinic.com"
},
"address": {
"type": "string",
"example": "123 Main St"
},
"domain_name": {
"type": "string",
"example": "healthclinic.com"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"zip": {
"type": "string",
"example": "10001"
},
"header_scripts": {
"type": "string"
},
"footer_scripts": {
"type": "string"
},
"logo": {
"type": "string",
"format": "binary"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Company updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"409": {
"description": "Email already exists",
"content": {
"application/json": {
"schema": {
"properties": {
"status": {
"type": "string",
"example": "error"
},
"message": {
"type": "string",
"example": "Email Already Exists!"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "company",
"toolName": "provider_create_store_company",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"id",
"company_name",
"company_email"
],
"properties": {
"id": {
"type": "integer",
"example": 1
},
"company_name": {
"type": "string",
"example": "Health Clinic"
},
"company_phone": {
"type": "string",
"example": "1234567890"
},
"company_email": {
"type": "string",
"format": "email",
"example": "info@healthclinic.com"
},
"address": {
"type": "string",
"example": "123 Main St"
},
"domain_name": {
"type": "string",
"example": "healthclinic.com"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"zip": {
"type": "string",
"example": "10001"
},
"header_scripts": {
"type": "string"
},
"footer_scripts": {
"type": "string"
},
"logo": {
"type": "string",
"format": "binary"
}
},
"type": "object"
},
"properties": {
"id": {
"type": "integer",
"description": "id property",
"example": 1,
"required": true
},
"company_name": {
"type": "string",
"description": "company_name property",
"example": "Health Clinic",
"required": true
},
"company_phone": {
"type": "string",
"description": "company_phone property",
"example": "1234567890",
"required": false
},
"company_email": {
"type": "string",
"format": "email",
"description": "company_email property",
"example": "info@healthclinic.com",
"required": true
},
"address": {
"type": "string",
"description": "address property",
"example": "123 Main St",
"required": false
},
"domain_name": {
"type": "string",
"description": "domain_name property",
"example": "healthclinic.com",
"required": false
},
"city": {
"type": "string",
"description": "city property",
"example": "New York",
"required": false
},
"state": {
"type": "string",
"description": "state property",
"example": "NY",
"required": false
},
"zip": {
"type": "string",
"description": "zip property",
"example": "10001",
"required": false
},
"header_scripts": {
"type": "string",
"description": "header_scripts property",
"required": false
},
"footer_scripts": {
"type": "string",
"description": "footer_scripts property",
"required": false
},
"logo": {
"type": "string",
"format": "binary",
"description": "logo property",
"required": false
}
},
"required": [
"id",
"company_name",
"company_email"
]
}
}
},
"responseSchema": {
"200": {
"description": "Company updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"409": {
"description": "Email already exists",
"content": {
"application/json": {
"schema": {
"properties": {
"status": {
"type": "string",
"example": "error"
},
"message": {
"type": "string",
"example": "Email Already Exists!"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error",
"content": {}
}
},
"exactToolName": "provider_create_store_company",
"detailedDescription": "Update company information"
}
},
{
"toolName": "provider_get_get_company",
"method": "GET",
"path": "/emr-api/get-company",
"description": "Get company information",
"category": "company",
"parameters": "No parameters",
"operationId": "getCompany",
"tags": [
"Company"
],
"endpoint": {
"path": "/emr-api/get-company",
"method": "GET",
"operationId": "getCompany",
"summary": "Get company information",
"description": "Get detailed information about the provider's company",
"tags": [
"Company"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "company",
"toolName": "provider_get_get_company",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
}
},
"exactToolName": "provider_get_get_company",
"detailedDescription": "Get company information"
}
},
{
"toolName": "provider_create_save_signature",
"method": "POST",
"path": "/api/save-signature",
"description": "Save provider signature",
"category": "user_management",
"parameters": "**Required:** signature (string) - signature property",
"operationId": "storeSignature",
"tags": [
"Provider"
],
"endpoint": {
"path": "/api/save-signature",
"method": "POST",
"operationId": "storeSignature",
"summary": "Save provider signature",
"description": "Store or update the provider's signature",
"tags": [
"Provider"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"signature"
],
"properties": {
"signature": {
"type": "string",
"example": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Signature saved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Updated Successfully!"
},
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "The signature field is required."
},
"errors": {
"properties": {
"signature": {
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "user_management",
"toolName": "provider_create_save_signature",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"signature"
],
"properties": {
"signature": {
"type": "string",
"example": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
}
},
"type": "object"
},
"properties": {
"signature": {
"type": "string",
"description": "signature property",
"example": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
"required": true
}
},
"required": [
"signature"
]
}
}
},
"responseSchema": {
"200": {
"description": "Signature saved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Updated Successfully!"
},
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "The signature field is required."
},
"errors": {
"properties": {
"signature": {
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_save_signature",
"detailedDescription": "Save provider signature"
}
},
{
"toolName": "provider_get_provider_practitioners_list",
"method": "GET",
"path": "/api/provider/practitioners-list",
"description": "Get practitioners list",
"category": "user_management",
"parameters": "No parameters",
"operationId": "providerPractitioner",
"tags": [
"Provider"
],
"endpoint": {
"path": "/api/provider/practitioners-list",
"method": "GET",
"operationId": "providerPractitioner",
"summary": "Get practitioners list",
"description": "Get a list of practitioners associated with the provider",
"tags": [
"Provider"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"type": "object"
}
},
"message": {
"type": "string",
"example": "Practitioner list!"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "user_management",
"toolName": "provider_get_provider_practitioners_list",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"type": "object"
}
},
"message": {
"type": "string",
"example": "Practitioner list!"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
}
},
"exactToolName": "provider_get_provider_practitioners_list",
"detailedDescription": "Get practitioners list"
}
},
{
"toolName": "provider_create_provider_auth_logout",
"method": "POST",
"path": "/api/provider/auth/logout",
"description": "Logout provider",
"category": "authentication",
"parameters": "No parameters",
"operationId": "logout",
"tags": [
"Authentication"
],
"endpoint": {
"path": "/api/provider/auth/logout",
"method": "POST",
"operationId": "logout",
"summary": "Logout provider",
"description": "Invalidate the provider's access token",
"tags": [
"Authentication"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Successfully logged out",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "User logged out successfully"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Invalid or missing token",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Invalid access token"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "authentication",
"toolName": "provider_create_provider_auth_logout",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Successfully logged out",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "User logged out successfully"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Invalid or missing token",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Invalid access token"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_provider_auth_logout",
"detailedDescription": "Logout provider"
}
},
{
"toolName": "provider_create_appointment_cancel",
"method": "POST",
"path": "/api/emr/appointment/{id}/cancel",
"description": "Cancel an appointment",
"category": "appointments",
"parameters": "**Required:** id (integer) - Appointment ID",
"operationId": "cancelAppointment",
"tags": [
"Appointments"
],
"endpoint": {
"path": "/api/emr/appointment/{id}/cancel",
"method": "POST",
"operationId": "cancelAppointment",
"summary": "Cancel an appointment",
"description": "Updates the status of an appointment to cancelled",
"tags": [
"Appointments"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "Appointment ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Appointment cancelled successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Appointment cancelled successfully"
},
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Appointment not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Appointment not found"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "An error occurred while cancelling the appointment"
},
"error": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "appointments",
"toolName": "provider_create_appointment_cancel",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "Appointment ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Appointment cancelled successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Appointment cancelled successfully"
},
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"404": {
"description": "Appointment not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Appointment not found"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "An error occurred while cancelling the appointment"
},
"error": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_appointment_cancel",
"detailedDescription": "Cancel an appointment"
}
},
{
"toolName": "provider_get_appointment_order",
"method": "GET",
"path": "/api/emr/appointment/{appointment_id}/order",
"description": "Get appointment order details",
"category": "appointments",
"parameters": "**Required:** appointment_id (integer) - Appointment ID",
"operationId": "getAppointmentOrder",
"tags": [
"Appointments"
],
"endpoint": {
"path": "/api/emr/appointment/{appointment_id}/order",
"method": "GET",
"operationId": "getAppointmentOrder",
"summary": "Get appointment order details",
"description": "Retrieves order details associated with an appointment",
"tags": [
"Appointments"
],
"parameters": [
{
"name": "appointment_id",
"in": "path",
"required": true,
"type": "integer",
"description": "Appointment ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Order details retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"order_id": {
"type": "integer",
"example": 1
},
"patient_id": {
"type": "integer",
"example": 123
},
"provider_id": {
"type": "integer",
"example": 456
},
"shipping_address1": {
"type": "string",
"example": "123 Main St"
},
"shipping_address2": {
"type": "string",
"example": "Apt 4B"
},
"shipping_city": {
"type": "string",
"example": "New York"
},
"shipping_state": {
"type": "string",
"example": "NY"
},
"shipping_zipcode": {
"type": "string",
"example": "10001"
},
"shipping_country": {
"type": "string",
"example": "USA"
},
"shipping_amount": {
"type": "string",
"example": "5.99"
},
"builder_id": {
"type": "integer",
"example": 789
},
"total_amount": {
"type": "string",
"example": "99.99"
},
"discounted_amount": {
"type": "string",
"example": "89.99"
},
"promo_code": {
"type": "string",
"example": "SAVE10"
},
"items": {
"type": "array",
"items": {
"properties": {
"product_id": {
"type": "integer",
"example": 101
},
"product_name": {
"type": "string",
"example": "Medication A"
},
"qty": {
"type": "integer",
"example": 2
},
"subscription": {
"type": "string",
"example": "true"
},
"onetime": {
"type": "string",
"example": "false"
},
"variation_id": {
"type": "integer",
"example": 201
},
"variation_name": {
"type": "string",
"example": "100mg"
},
"price": {
"type": "string",
"example": "49.99"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Appointment or order not found",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Appointment not found"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Error retrieving order details"
},
"error": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "appointments",
"toolName": "provider_get_appointment_order",
"completeParameters": {
"appointment_id": {
"name": "appointment_id",
"in": "path",
"type": "integer",
"required": true,
"description": "Appointment ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Order details retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"order_id": {
"type": "integer",
"example": 1
},
"patient_id": {
"type": "integer",
"example": 123
},
"provider_id": {
"type": "integer",
"example": 456
},
"shipping_address1": {
"type": "string",
"example": "123 Main St"
},
"shipping_address2": {
"type": "string",
"example": "Apt 4B"
},
"shipping_city": {
"type": "string",
"example": "New York"
},
"shipping_state": {
"type": "string",
"example": "NY"
},
"shipping_zipcode": {
"type": "string",
"example": "10001"
},
"shipping_country": {
"type": "string",
"example": "USA"
},
"shipping_amount": {
"type": "string",
"example": "5.99"
},
"builder_id": {
"type": "integer",
"example": 789
},
"total_amount": {
"type": "string",
"example": "99.99"
},
"discounted_amount": {
"type": "string",
"example": "89.99"
},
"promo_code": {
"type": "string",
"example": "SAVE10"
},
"items": {
"type": "array",
"items": {
"properties": {
"product_id": {
"type": "integer",
"example": 101
},
"product_name": {
"type": "string",
"example": "Medication A"
},
"qty": {
"type": "integer",
"example": 2
},
"subscription": {
"type": "string",
"example": "true"
},
"onetime": {
"type": "string",
"example": "false"
},
"variation_id": {
"type": "integer",
"example": 201
},
"variation_name": {
"type": "string",
"example": "100mg"
},
"price": {
"type": "string",
"example": "49.99"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"404": {
"description": "Appointment or order not found",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Appointment not found"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Error retrieving order details"
},
"error": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_appointment_order",
"detailedDescription": "Get appointment order details"
}
},
{
"toolName": "provider_get_appointment_list_by_date",
"method": "GET",
"path": "/api/emr/appointment/list-by-date",
"description": "Get appointments by date range",
"category": "appointments",
"parameters": "**Required:** start_date (string) - Start date (YYYY-MM-DD), **Required:** end_date (string) - End date (YYYY-MM-DD)",
"operationId": "getAppointmentListByDateProvider",
"tags": [
"Appointments"
],
"endpoint": {
"path": "/api/emr/appointment/list-by-date",
"method": "GET",
"operationId": "getAppointmentListByDateProvider",
"summary": "Get appointments by date range",
"description": "Retrieves a list of appointments within a specified date range",
"tags": [
"Appointments"
],
"parameters": [
{
"name": "start_date",
"in": "query",
"required": true,
"type": "string",
"description": "Start date (YYYY-MM-DD)"
},
{
"name": "end_date",
"in": "query",
"required": true,
"type": "string",
"description": "End date (YYYY-MM-DD)"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "List of appointments",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Appointment list"
},
"appointments": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"practitioner": {
"type": "string",
"example": "John Doe"
},
"practitioner_id": {
"type": "integer",
"example": 123
},
"patient": {
"type": "string",
"example": "Jane Smith"
},
"patient_id": {
"type": "integer",
"example": 456
},
"title": {
"type": "string",
"example": "Follow-up Appointment"
},
"start": {
"type": "string",
"format": "date-time",
"example": "2023-05-15T14:30:00.000Z"
},
"end": {
"type": "string",
"format": "date-time",
"example": "2023-05-15T15:00:00.000Z"
},
"date": {
"type": "string",
"format": "date",
"example": "2023-05-15"
},
"start_time": {
"type": "string",
"example": "02:30 pm"
},
"end_time": {
"type": "string",
"example": "03:00 pm"
},
"allDay": {
"type": "boolean",
"example": false
},
"status": {
"type": "string",
"example": "booked"
},
"service": {
"type": "string",
"example": "Consultation"
},
"location": {
"type": "string",
"example": "Main Clinic"
},
"room": {
"type": "string",
"example": "Room 3B"
},
"appointment_type": {
"type": "string",
"example": "Follow-up"
},
"payment_type": {
"type": "string",
"example": "Insurance"
},
"notes": {
"type": "string",
"example": "Patient requested late afternoon appointment"
},
"url": {
"type": "string",
"example": ""
},
"extendedProps": {
"properties": {
"calendar": {
"type": "string",
"example": "Business"
}
},
"type": "object"
}
},
"type": "object"
}
},
"googel_events": {
"type": "array",
"items": {
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"500": {
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "appointments",
"toolName": "provider_get_appointment_list_by_date",
"completeParameters": {
"start_date": {
"name": "start_date",
"in": "query",
"type": "string",
"format": "date",
"required": true,
"description": "Start date (YYYY-MM-DD)"
},
"end_date": {
"name": "end_date",
"in": "query",
"type": "string",
"format": "date",
"required": true,
"description": "End date (YYYY-MM-DD)"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "List of appointments",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Appointment list"
},
"appointments": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"practitioner": {
"type": "string",
"example": "John Doe"
},
"practitioner_id": {
"type": "integer",
"example": 123
},
"patient": {
"type": "string",
"example": "Jane Smith"
},
"patient_id": {
"type": "integer",
"example": 456
},
"title": {
"type": "string",
"example": "Follow-up Appointment"
},
"start": {
"type": "string",
"format": "date-time",
"example": "2023-05-15T14:30:00.000Z"
},
"end": {
"type": "string",
"format": "date-time",
"example": "2023-05-15T15:00:00.000Z"
},
"date": {
"type": "string",
"format": "date",
"example": "2023-05-15"
},
"start_time": {
"type": "string",
"example": "02:30 pm"
},
"end_time": {
"type": "string",
"example": "03:00 pm"
},
"allDay": {
"type": "boolean",
"example": false
},
"status": {
"type": "string",
"example": "booked"
},
"service": {
"type": "string",
"example": "Consultation"
},
"location": {
"type": "string",
"example": "Main Clinic"
},
"room": {
"type": "string",
"example": "Room 3B"
},
"appointment_type": {
"type": "string",
"example": "Follow-up"
},
"payment_type": {
"type": "string",
"example": "Insurance"
},
"notes": {
"type": "string",
"example": "Patient requested late afternoon appointment"
},
"url": {
"type": "string",
"example": ""
},
"extendedProps": {
"properties": {
"calendar": {
"type": "string",
"example": "Business"
}
},
"type": "object"
}
},
"type": "object"
}
},
"googel_events": {
"type": "array",
"items": {
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"500": {
"description": "Server error",
"content": {}
}
},
"exactToolName": "provider_get_appointment_list_by_date",
"detailedDescription": "Get appointments by date range"
}
},
{
"toolName": "provider_get_appointment_transcribe",
"method": "GET",
"path": "/api/emr/appointment/transcribe/{patient_id}",
"description": "Get appointment transcriptions",
"category": "appointments",
"parameters": "**Required:** patient_id (integer) - Patient ID",
"operationId": "getAppointmentTranscribe",
"tags": [
"Appointments"
],
"endpoint": {
"path": "/api/emr/appointment/transcribe/{patient_id}",
"method": "GET",
"operationId": "getAppointmentTranscribe",
"summary": "Get appointment transcriptions",
"description": "Retrieves transcription data for a patient's appointments",
"tags": [
"Appointments"
],
"parameters": [
{
"name": "patient_id",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Appointment transcriptions",
"content": {
"application/json": {
"schema": {
"properties": {
"draw": {
"type": "integer",
"example": 1
},
"recordsTotal": {
"type": "integer",
"example": 10
},
"recordsFiltered": {
"type": "integer",
"example": 10
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"pc_pid": {
"type": "integer",
"example": 123
},
"date": {
"type": "string",
"format": "date",
"example": "2023-05-15"
},
"patient": {
"type": "string",
"example": "Jane Smith"
},
"practitioner": {
"type": "string",
"example": "Dr. John Doe"
},
"transcription": {
"properties": {
"text": {
"type": "string",
"example": "Patient reports improved symptoms..."
},
"status": {
"type": "string",
"example": "completed"
},
"summary": {
"type": "string",
"example": "Follow-up for hypertension..."
},
"notes": {
"type": "array",
"items": {
"properties": {
"subjective": {
"type": "string"
},
"objective": {
"type": "string"
},
"assessment": {
"type": "string"
},
"plan": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
}
},
"type": "object"
},
"recording_url": {
"type": "string",
"format": "uri"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"500": {
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "appointments",
"toolName": "provider_get_appointment_transcribe",
"completeParameters": {
"patient_id": {
"name": "patient_id",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Appointment transcriptions",
"content": {
"application/json": {
"schema": {
"properties": {
"draw": {
"type": "integer",
"example": 1
},
"recordsTotal": {
"type": "integer",
"example": 10
},
"recordsFiltered": {
"type": "integer",
"example": 10
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"pc_pid": {
"type": "integer",
"example": 123
},
"date": {
"type": "string",
"format": "date",
"example": "2023-05-15"
},
"patient": {
"type": "string",
"example": "Jane Smith"
},
"practitioner": {
"type": "string",
"example": "Dr. John Doe"
},
"transcription": {
"properties": {
"text": {
"type": "string",
"example": "Patient reports improved symptoms..."
},
"status": {
"type": "string",
"example": "completed"
},
"summary": {
"type": "string",
"example": "Follow-up for hypertension..."
},
"notes": {
"type": "array",
"items": {
"properties": {
"subjective": {
"type": "string"
},
"objective": {
"type": "string"
},
"assessment": {
"type": "string"
},
"plan": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
}
},
"type": "object"
},
"recording_url": {
"type": "string",
"format": "uri"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"500": {
"description": "Server error",
"content": {}
}
},
"exactToolName": "provider_get_appointment_transcribe",
"detailedDescription": "Get appointment transcriptions"
}
},
{
"toolName": "provider_get_appointment_patient_list",
"method": "GET",
"path": "/api/emr/appointment/patient/{patient_id}/list",
"description": "Get patient appointment list",
"category": "appointments",
"parameters": "**Required:** patient_id (integer) - Patient ID",
"operationId": "getPatientApptList",
"tags": [
"Appointments"
],
"endpoint": {
"path": "/api/emr/appointment/patient/{patient_id}/list",
"method": "GET",
"operationId": "getPatientApptList",
"summary": "Get patient appointment list",
"description": "Retrieves a list of appointments for a specific patient",
"tags": [
"Appointments"
],
"parameters": [
{
"name": "patient_id",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "List of patient appointments",
"content": {
"application/json": {
"schema": {
"properties": {
"draw": {
"type": "integer",
"example": 1
},
"recordsTotal": {
"type": "integer",
"example": 5
},
"recordsFiltered": {
"type": "integer",
"example": 5
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"title": {
"type": "string",
"example": "Initial Consultation"
},
"date": {
"type": "string",
"format": "date",
"example": "2023-05-15"
},
"start_time": {
"type": "string",
"example": "14:30:00"
},
"start": {
"type": "string",
"format": "date-time",
"example": "2023-05-15T14:30:00.000Z"
},
"end_time": {
"type": "string",
"example": "15:00:00"
},
"status": {
"type": "string",
"example": "booked"
},
"timezone": {
"type": "string",
"example": "America/New_York"
},
"notes": {
"type": "string",
"example": "Initial consultation for new patient"
},
"fname": {
"type": "string",
"example": "Jane"
},
"lname": {
"type": "string",
"example": "Smith"
},
"practitioner": {
"type": "string",
"example": "Dr. John Doe"
},
"practitioner_id": {
"type": "integer",
"example": 456
},
"facility_id": {
"type": "integer",
"example": 789
},
"room": {
"type": "string",
"example": "Room 3B"
},
"patient": {
"type": "string",
"example": "Jane Smith"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"500": {
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "appointments",
"toolName": "provider_get_appointment_patient_list",
"completeParameters": {
"patient_id": {
"name": "patient_id",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "List of patient appointments",
"content": {
"application/json": {
"schema": {
"properties": {
"draw": {
"type": "integer",
"example": 1
},
"recordsTotal": {
"type": "integer",
"example": 5
},
"recordsFiltered": {
"type": "integer",
"example": 5
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"title": {
"type": "string",
"example": "Initial Consultation"
},
"date": {
"type": "string",
"format": "date",
"example": "2023-05-15"
},
"start_time": {
"type": "string",
"example": "14:30:00"
},
"start": {
"type": "string",
"format": "date-time",
"example": "2023-05-15T14:30:00.000Z"
},
"end_time": {
"type": "string",
"example": "15:00:00"
},
"status": {
"type": "string",
"example": "booked"
},
"timezone": {
"type": "string",
"example": "America/New_York"
},
"notes": {
"type": "string",
"example": "Initial consultation for new patient"
},
"fname": {
"type": "string",
"example": "Jane"
},
"lname": {
"type": "string",
"example": "Smith"
},
"practitioner": {
"type": "string",
"example": "Dr. John Doe"
},
"practitioner_id": {
"type": "integer",
"example": 456
},
"facility_id": {
"type": "integer",
"example": 789
},
"room": {
"type": "string",
"example": "Room 3B"
},
"patient": {
"type": "string",
"example": "Jane Smith"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"500": {
"description": "Server error",
"content": {}
}
},
"exactToolName": "provider_get_appointment_patient_list",
"detailedDescription": "Get patient appointment list"
}
},
{
"toolName": "provider_get_appointment_detail",
"method": "GET",
"path": "/api/emr/appointment/{appointment}/detail",
"description": "Get appointment details",
"category": "appointments",
"parameters": "**Required:** appointment (integer) - Appointment ID",
"operationId": "getAppointmentDetailUnique",
"tags": [
"Appointments"
],
"endpoint": {
"path": "/api/emr/appointment/{appointment}/detail",
"method": "GET",
"operationId": "getAppointmentDetailUnique",
"summary": "Get appointment details",
"description": "Fetches detailed information about an appointment",
"tags": [
"Appointments"
],
"parameters": [
{
"name": "appointment",
"in": "path",
"required": true,
"type": "integer",
"description": "Appointment ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Appointment details",
"content": {
"application/json": {
"schema": {
"properties": {
"appointment": {
"description": "Appointment information",
"type": "object"
},
"telemedPro": {
"description": "Telemed professional information",
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Appointment not found"
},
"500": {
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "appointments",
"toolName": "provider_get_appointment_detail",
"completeParameters": {
"appointment": {
"name": "appointment",
"in": "path",
"type": "integer",
"required": true,
"description": "Appointment ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Appointment details",
"content": {
"application/json": {
"schema": {
"properties": {
"appointment": {
"description": "Appointment information",
"type": "object"
},
"telemedPro": {
"description": "Telemed professional information",
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"404": {
"description": "Appointment not found",
"content": {}
},
"500": {
"description": "Server error",
"content": {}
}
},
"exactToolName": "provider_get_appointment_detail",
"detailedDescription": "Get appointment details"
}
},
{
"toolName": "provider_create_appointment_queue",
"method": "POST",
"path": "/api/emr/appointment/queue/{patientId}",
"description": "Add patient to queue",
"category": "appointments",
"parameters": "**Required:** patientId (integer) - Patient ID",
"operationId": "addPatientToQueue",
"tags": [
"Appointments"
],
"endpoint": {
"path": "/api/emr/appointment/queue/{patientId}",
"method": "POST",
"operationId": "addPatientToQueue",
"summary": "Add patient to queue",
"description": "Adds a patient to the appointment queue",
"tags": [
"Appointments"
],
"parameters": [
{
"name": "patientId",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Successfully added to queue",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Added to queue"
},
"queue_number": {
"type": "integer",
"example": 3
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"500": {
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "appointments",
"toolName": "provider_create_appointment_queue",
"completeParameters": {
"patientId": {
"name": "patientId",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Successfully added to queue",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Added to queue"
},
"queue_number": {
"type": "integer",
"example": 3
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"500": {
"description": "Server error",
"content": {}
}
},
"exactToolName": "provider_create_appointment_queue",
"detailedDescription": "Add patient to queue"
}
},
{
"toolName": "provider_get_appointment_doctor_patient",
"method": "GET",
"path": "/api/emr/appointment/doctor/patient/{patientId}",
"description": "Get doctor appointments by patient ID",
"category": "appointments",
"parameters": "**Required:** patientId (integer) - Patient ID",
"operationId": "getDoctorAppointmentsByPatientId",
"tags": [
"Appointments"
],
"endpoint": {
"path": "/api/emr/appointment/doctor/patient/{patientId}",
"method": "GET",
"operationId": "getDoctorAppointmentsByPatientId",
"summary": "Get doctor appointments by patient ID",
"description": "Retrieves all doctor appointments for a specific patient",
"tags": [
"Appointments"
],
"parameters": [
{
"name": "patientId",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "List of doctor appointments",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"first_name": {
"type": "string",
"example": "Jane"
},
"last_name": {
"type": "string",
"example": "Smith"
},
"id": {
"type": "integer",
"example": 1
},
"doctor_id": {
"type": "integer",
"example": 456
},
"patient_id": {
"type": "integer",
"example": 123
},
"appointment_date": {
"type": "string",
"format": "date",
"example": "2023-05-15"
},
"appointment_time": {
"type": "string",
"example": "14:30:00"
},
"status": {
"type": "string",
"example": "confirmed"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-05-10T10:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-05-10T10:00:00Z"
}
},
"type": "object"
}
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"500": {
"description": "Failed to retrieve appointments",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Failed to retrieve appointments"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "appointments",
"toolName": "provider_get_appointment_doctor_patient",
"completeParameters": {
"patientId": {
"name": "patientId",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "List of doctor appointments",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"first_name": {
"type": "string",
"example": "Jane"
},
"last_name": {
"type": "string",
"example": "Smith"
},
"id": {
"type": "integer",
"example": 1
},
"doctor_id": {
"type": "integer",
"example": 456
},
"patient_id": {
"type": "integer",
"example": 123
},
"appointment_date": {
"type": "string",
"format": "date",
"example": "2023-05-15"
},
"appointment_time": {
"type": "string",
"example": "14:30:00"
},
"status": {
"type": "string",
"example": "confirmed"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-05-10T10:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-05-10T10:00:00Z"
}
},
"type": "object"
}
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"500": {
"description": "Failed to retrieve appointments",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Failed to retrieve appointments"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_appointment_doctor_patient",
"detailedDescription": "Get doctor appointments by patient ID"
}
},
{
"toolName": "provider_get_appointment_patient_carts_items",
"method": "GET",
"path": "/api/emr/appointment/patient/carts-items",
"description": "Get patient appointments with carts and items",
"category": "appointments",
"parameters": "No parameters",
"operationId": "getPatientAppointmentsWithCartsAndItems",
"tags": [
"Appointments"
],
"endpoint": {
"path": "/api/emr/appointment/patient/carts-items",
"method": "GET",
"operationId": "getPatientAppointmentsWithCartsAndItems",
"summary": "Get patient appointments with carts and items",
"description": "Retrieves all appointments with associated carts and items for the authenticated patient",
"tags": [
"Appointments"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "List of appointments with carts and items",
"content": {
"application/json": {
"schema": {
"properties": {
"status": {
"type": "string",
"example": "Success"
},
"appointments": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"telemed_pros_id": {
"type": "integer",
"example": 456
},
"patient_id": {
"type": "integer",
"example": 123
},
"appointment_time": {
"type": "string",
"example": "14:30:00"
},
"in_call": {
"type": "boolean",
"example": false
},
"meeting_id": {
"type": "string",
"example": "meet-abc-123"
},
"agent_call_token": {
"type": "string"
},
"patient_call_token": {
"type": "string"
},
"video_token": {
"type": "string"
},
"appointment_date": {
"type": "string",
"format": "date",
"example": "2023-05-15"
},
"patient_email": {
"type": "string",
"format": "email",
"example": "patient@example.com"
},
"patient_name": {
"type": "string",
"example": "Jane Smith"
},
"timezone": {
"type": "string",
"example": "America/New_York"
},
"analytics": {
"type": "string"
},
"start_time": {
"type": "string",
"example": "14:30:00"
},
"end_time": {
"type": "string",
"example": "15:00:00"
},
"duration": {
"type": "integer",
"example": 30
},
"carts": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 101
},
"first_name": {
"type": "string",
"example": "Jane"
},
"last_name": {
"type": "string",
"example": "Smith"
},
"email": {
"type": "string",
"format": "email",
"example": "jane.smith@example.com"
},
"phone": {
"type": "string",
"example": "123-456-7890"
},
"status": {
"type": "string",
"example": "active"
},
"items": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 201
},
"status": {
"type": "string",
"example": "active"
},
"labkit_delivery_status": {
"type": "string",
"example": "delivered"
},
"plan": {
"properties": {
"title": {
"type": "string",
"example": "Health Plan Premium"
},
"currency": {
"type": "string",
"example": "USD"
},
"price": {
"type": "number",
"format": "float",
"example": 99.99
}
},
"type": "object"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"500": {
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "appointments",
"toolName": "provider_get_appointment_patient_carts_items",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "List of appointments with carts and items",
"content": {
"application/json": {
"schema": {
"properties": {
"status": {
"type": "string",
"example": "Success"
},
"appointments": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"telemed_pros_id": {
"type": "integer",
"example": 456
},
"patient_id": {
"type": "integer",
"example": 123
},
"appointment_time": {
"type": "string",
"example": "14:30:00"
},
"in_call": {
"type": "boolean",
"example": false
},
"meeting_id": {
"type": "string",
"example": "meet-abc-123"
},
"agent_call_token": {
"type": "string"
},
"patient_call_token": {
"type": "string"
},
"video_token": {
"type": "string"
},
"appointment_date": {
"type": "string",
"format": "date",
"example": "2023-05-15"
},
"patient_email": {
"type": "string",
"format": "email",
"example": "patient@example.com"
},
"patient_name": {
"type": "string",
"example": "Jane Smith"
},
"timezone": {
"type": "string",
"example": "America/New_York"
},
"analytics": {
"type": "string"
},
"start_time": {
"type": "string",
"example": "14:30:00"
},
"end_time": {
"type": "string",
"example": "15:00:00"
},
"duration": {
"type": "integer",
"example": 30
},
"carts": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 101
},
"first_name": {
"type": "string",
"example": "Jane"
},
"last_name": {
"type": "string",
"example": "Smith"
},
"email": {
"type": "string",
"format": "email",
"example": "jane.smith@example.com"
},
"phone": {
"type": "string",
"example": "123-456-7890"
},
"status": {
"type": "string",
"example": "active"
},
"items": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 201
},
"status": {
"type": "string",
"example": "active"
},
"labkit_delivery_status": {
"type": "string",
"example": "delivered"
},
"plan": {
"properties": {
"title": {
"type": "string",
"example": "Health Plan Premium"
},
"currency": {
"type": "string",
"example": "USD"
},
"price": {
"type": "number",
"format": "float",
"example": 99.99
}
},
"type": "object"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"500": {
"description": "Server error",
"content": {}
}
},
"exactToolName": "provider_get_appointment_patient_carts_items",
"detailedDescription": "Get patient appointments with carts and items"
}
},
{
"toolName": "provider_get_appointment_report_last_30_days",
"method": "GET",
"path": "/api/emr/appointment/report/last-30-days",
"description": "Get appointment data for last 30 days",
"category": "appointments",
"parameters": "**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",
"operationId": "last30DaysAppointmentsData",
"tags": [
"Appointment Reports"
],
"endpoint": {
"path": "/api/emr/appointment/report/last-30-days",
"method": "GET",
"operationId": "last30DaysAppointmentsData",
"summary": "Get appointment data for last 30 days",
"description": "Retrieves appointment statistics and data for the specified date range",
"tags": [
"Appointment Reports"
],
"parameters": [
{
"name": "start_date",
"in": "query",
"required": true,
"type": "string",
"description": "Start date (YYYY-MM-DD)"
},
{
"name": "end_date",
"in": "query",
"required": true,
"type": "string",
"description": "End date (YYYY-MM-DD)"
},
{
"name": "provider",
"in": "query",
"required": false,
"type": "string",
"description": "Provider ID or 'all' for all providers"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Appointment report data",
"content": {
"application/json": {
"schema": {
"properties": {
"totalPatients": {
"type": "integer",
"example": 45
},
"totalAppointments": {
"type": "integer",
"example": 72
},
"appointments": {
"type": "array",
"items": {
"properties": {
"name": {
"type": "string",
"example": "Initial Consultation"
},
"data": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
}
},
"monthly": {
"type": "array",
"items": {
"type": "string",
"example": "May 15"
}
},
"monthlyData": {
"type": "array",
"items": {
"type": "integer"
}
},
"startDate": {
"type": "string",
"format": "date",
"example": "2023-05-01"
},
"endDate": {
"type": "string",
"format": "date",
"example": "2023-05-30"
},
"provider": {
"type": "string",
"example": "all"
},
"providerAppointments": {
"type": "array",
"items": {
"type": "integer"
}
},
"providersName": {
"type": "array",
"items": {
"type": "string",
"example": "Dr. John Doe"
}
},
"appointmentTypes": {
"type": "array",
"items": {
"type": "string",
"example": "Follow-up"
}
},
"typeValue": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Start date cannot be later than end date"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "appointments",
"toolName": "provider_get_appointment_report_last_30_days",
"completeParameters": {
"start_date": {
"name": "start_date",
"in": "query",
"type": "string",
"format": "date",
"required": true,
"description": "Start date (YYYY-MM-DD)"
},
"end_date": {
"name": "end_date",
"in": "query",
"type": "string",
"format": "date",
"required": true,
"description": "End date (YYYY-MM-DD)"
},
"provider": {
"name": "provider",
"in": "query",
"type": "string",
"required": false,
"description": "Provider ID or 'all' for all providers"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Appointment report data",
"content": {
"application/json": {
"schema": {
"properties": {
"totalPatients": {
"type": "integer",
"example": 45
},
"totalAppointments": {
"type": "integer",
"example": 72
},
"appointments": {
"type": "array",
"items": {
"properties": {
"name": {
"type": "string",
"example": "Initial Consultation"
},
"data": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
}
},
"monthly": {
"type": "array",
"items": {
"type": "string",
"example": "May 15"
}
},
"monthlyData": {
"type": "array",
"items": {
"type": "integer"
}
},
"startDate": {
"type": "string",
"format": "date",
"example": "2023-05-01"
},
"endDate": {
"type": "string",
"format": "date",
"example": "2023-05-30"
},
"provider": {
"type": "string",
"example": "all"
},
"providerAppointments": {
"type": "array",
"items": {
"type": "integer"
}
},
"providersName": {
"type": "array",
"items": {
"type": "string",
"example": "Dr. John Doe"
}
},
"appointmentTypes": {
"type": "array",
"items": {
"type": "string",
"example": "Follow-up"
}
},
"typeValue": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Start date cannot be later than end date"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {}
}
},
"exactToolName": "provider_get_appointment_report_last_30_days",
"detailedDescription": "Get appointment data for last 30 days"
}
},
{
"toolName": "provider_get_appointment_agent",
"method": "GET",
"path": "/api/emr/appointment/agent/{appointment}",
"description": "Get agent appointment details",
"category": "appointments",
"parameters": "**Required:** appointment (integer) - Appointment ID",
"operationId": "getAgentAppointment",
"tags": [
"Appointments"
],
"endpoint": {
"path": "/api/emr/appointment/agent/{appointment}",
"method": "GET",
"operationId": "getAgentAppointment",
"summary": "Get agent appointment details",
"description": "Retrieves detailed information about an agent's appointment",
"tags": [
"Appointments"
],
"parameters": [
{
"name": "appointment",
"in": "path",
"required": true,
"type": "integer",
"description": "Appointment ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Agent appointment details",
"content": {
"application/json": {
"schema": {
"properties": {
"first_name": {
"type": "string",
"example": "Jane"
},
"last_name": {
"type": "string",
"example": "Smith"
},
"agent_name": {
"type": "string",
"example": "John Doe"
},
"id": {
"type": "integer",
"example": 1
},
"telemed_pros_id": {
"type": "integer",
"example": 456
},
"patient_id": {
"type": "integer",
"example": 123
},
"appointment_time": {
"type": "string",
"example": "14:30:00"
},
"in_call": {
"type": "boolean",
"example": false
},
"meeting_id": {
"type": "string",
"example": "meet-abc-123"
},
"appointment_date": {
"type": "string",
"format": "date",
"example": "2023-05-15"
},
"patient_email": {
"type": "string",
"format": "email",
"example": "patient@example.com"
},
"patient_name": {
"type": "string",
"example": "Jane Smith"
},
"timezone": {
"type": "string",
"example": "America/New_York"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-05-10T10:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-05-10T10:00:00Z"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Appointment not found"
},
"500": {
"description": "Failed to retrieve appointments",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Failed to retrieve appointments"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "appointments",
"toolName": "provider_get_appointment_agent",
"completeParameters": {
"appointment": {
"name": "appointment",
"in": "path",
"type": "integer",
"required": true,
"description": "Appointment ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Agent appointment details",
"content": {
"application/json": {
"schema": {
"properties": {
"first_name": {
"type": "string",
"example": "Jane"
},
"last_name": {
"type": "string",
"example": "Smith"
},
"agent_name": {
"type": "string",
"example": "John Doe"
},
"id": {
"type": "integer",
"example": 1
},
"telemed_pros_id": {
"type": "integer",
"example": 456
},
"patient_id": {
"type": "integer",
"example": 123
},
"appointment_time": {
"type": "string",
"example": "14:30:00"
},
"in_call": {
"type": "boolean",
"example": false
},
"meeting_id": {
"type": "string",
"example": "meet-abc-123"
},
"appointment_date": {
"type": "string",
"format": "date",
"example": "2023-05-15"
},
"patient_email": {
"type": "string",
"format": "email",
"example": "patient@example.com"
},
"patient_name": {
"type": "string",
"example": "Jane Smith"
},
"timezone": {
"type": "string",
"example": "America/New_York"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-05-10T10:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-05-10T10:00:00Z"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"404": {
"description": "Appointment not found",
"content": {}
},
"500": {
"description": "Failed to retrieve appointments",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Failed to retrieve appointments"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_appointment_agent",
"detailedDescription": "Get agent appointment details"
}
},
{
"toolName": "provider_update_appointment_update_meeting_analysis",
"method": "POST",
"path": "/api/emr/appointment/{appointment}/update-meeting-analysis",
"description": "Update meeting analysis",
"category": "appointments",
"parameters": "**Required:** appointment (integer) - Appointment ID, **Optional:** data (object) - Meeting analytics data",
"operationId": "updateMeetingAnalysis",
"tags": [
"Appointments"
],
"endpoint": {
"path": "/api/emr/appointment/{appointment}/update-meeting-analysis",
"method": "POST",
"operationId": "updateMeetingAnalysis",
"summary": "Update meeting analysis",
"description": "Updates the analytics data for an appointment meeting",
"tags": [
"Appointments"
],
"parameters": [
{
"name": "appointment",
"in": "path",
"required": true,
"type": "integer",
"description": "Appointment ID"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"description": "Meeting analytics data",
"type": "object"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Analytics updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"status": {
"type": "string",
"example": "success"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Appointment not found"
},
"500": {
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "appointments",
"toolName": "provider_create_appointment_update_meeting_analysis",
"completeParameters": {
"appointment": {
"name": "appointment",
"in": "path",
"type": "integer",
"required": true,
"description": "Appointment ID"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"description": "Meeting analytics data",
"type": "object"
}
},
"type": "object"
},
"properties": {
"data": {
"type": "object",
"description": "Meeting analytics data",
"required": false
}
},
"required": []
}
}
},
"responseSchema": {
"200": {
"description": "Analytics updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"status": {
"type": "string",
"example": "success"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"404": {
"description": "Appointment not found",
"content": {}
},
"500": {
"description": "Server error",
"content": {}
}
},
"exactToolName": "provider_create_appointment_update_meeting_analysis",
"detailedDescription": "Update meeting analysis"
}
},
{
"toolName": "provider_get_document_download",
"method": "GET",
"path": "/api/document/download/{rowId}/{key}",
"description": "Download a patient document",
"category": "documents",
"parameters": "**Required:** rowId (integer) - ID of the intake form record, **Required:** key (string) - Key identifier for the document in the form data",
"operationId": "downloadDocument",
"tags": [
"Documents"
],
"endpoint": {
"path": "/api/document/download/{rowId}/{key}",
"method": "GET",
"operationId": "downloadDocument",
"summary": "Download a patient document",
"description": "Downloads a specific document from patient intake form data",
"tags": [
"Documents"
],
"parameters": [
{
"name": "rowId",
"in": "path",
"required": true,
"type": "integer",
"description": "ID of the intake form record"
},
{
"name": "key",
"in": "path",
"required": true,
"type": "string",
"description": "Key identifier for the document in the form data"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Document file download",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"description": "Document not found",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Not Found"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Server Error"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "documents",
"toolName": "provider_get_document_download",
"completeParameters": {
"rowId": {
"name": "rowId",
"in": "path",
"type": "integer",
"required": true,
"description": "ID of the intake form record"
},
"key": {
"name": "key",
"in": "path",
"type": "string",
"required": true,
"description": "Key identifier for the document in the form data"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Document file download",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"description": "Document not found",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Not Found"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Server Error"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_document_download",
"detailedDescription": "Download a patient document"
}
},
{
"toolName": "provider_get_render_pdf",
"method": "GET",
"path": "/api/render/pdf/{rowId}",
"description": "Render a PDF document",
"category": "documents",
"parameters": "**Required:** rowId (integer) - ID of the intake form record",
"operationId": "renderPdf",
"tags": [
"Documents"
],
"endpoint": {
"path": "/api/render/pdf/{rowId}",
"method": "GET",
"operationId": "renderPdf",
"summary": "Render a PDF document",
"description": "Renders a PDF document from a patient intake form",
"tags": [
"Documents"
],
"parameters": [
{
"name": "rowId",
"in": "path",
"required": true,
"type": "integer",
"description": "ID of the intake form record"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "PDF document stream",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"description": "PDF not found",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Not Found"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Server Error"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "documents",
"toolName": "provider_get_render_pdf",
"completeParameters": {
"rowId": {
"name": "rowId",
"in": "path",
"type": "integer",
"required": true,
"description": "ID of the intake form record"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "PDF document stream",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"description": "PDF not found",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Not Found"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Server Error"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_render_pdf",
"detailedDescription": "Render a PDF document"
}
},
{
"toolName": "provider_create_add_email",
"method": "POST",
"path": "/api/add-email/{patient_id}",
"description": "Add a new email for a patient",
"category": "emails",
"parameters": "**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",
"operationId": "addEmail",
"tags": [
"Emails"
],
"endpoint": {
"path": "/api/add-email/{patient_id}",
"method": "POST",
"operationId": "addEmail",
"summary": "Add a new email for a patient",
"description": "Creates a new email record associated with a specific patient",
"tags": [
"Emails"
],
"parameters": [
{
"name": "patient_id",
"in": "path",
"required": true,
"type": "integer",
"description": "ID of the patient"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"to_email",
"subject",
"messageText"
],
"properties": {
"practitioner": {
"description": "User ID of the practitioner",
"type": "integer",
"example": 1
},
"messageText": {
"type": "string",
"example": "This is the email body text"
},
"to_email": {
"type": "string",
"format": "email",
"example": "patient@example.com"
},
"from_email": {
"type": "string",
"format": "email",
"example": "doctor@healthguruhub.com"
},
"emailTemplate": {
"description": "Template name used for the email",
"type": "string",
"example": "Appointment Reminder"
},
"subject": {
"type": "string",
"example": "Your upcoming appointment"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Email added successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Email added."
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"422": {
"description": "Validation error"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "emails",
"toolName": "provider_create_add_email",
"completeParameters": {
"patient_id": {
"name": "patient_id",
"in": "path",
"type": "integer",
"required": true,
"description": "ID of the patient"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"to_email",
"subject",
"messageText"
],
"properties": {
"practitioner": {
"description": "User ID of the practitioner",
"type": "integer",
"example": 1
},
"messageText": {
"type": "string",
"example": "This is the email body text"
},
"to_email": {
"type": "string",
"format": "email",
"example": "patient@example.com"
},
"from_email": {
"type": "string",
"format": "email",
"example": "doctor@healthguruhub.com"
},
"emailTemplate": {
"description": "Template name used for the email",
"type": "string",
"example": "Appointment Reminder"
},
"subject": {
"type": "string",
"example": "Your upcoming appointment"
}
},
"type": "object"
},
"properties": {
"practitioner": {
"type": "integer",
"description": "User ID of the practitioner",
"example": 1,
"required": false
},
"messageText": {
"type": "string",
"description": "messageText property",
"example": "This is the email body text",
"required": true
},
"to_email": {
"type": "string",
"format": "email",
"description": "to_email property",
"example": "patient@example.com",
"required": true
},
"from_email": {
"type": "string",
"format": "email",
"description": "from_email property",
"example": "doctor@healthguruhub.com",
"required": false
},
"emailTemplate": {
"type": "string",
"description": "Template name used for the email",
"example": "Appointment Reminder",
"required": false
},
"subject": {
"type": "string",
"description": "subject property",
"example": "Your upcoming appointment",
"required": true
}
},
"required": [
"to_email",
"subject",
"messageText"
]
}
}
},
"responseSchema": {
"200": {
"description": "Email added successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Email added."
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"422": {
"description": "Validation error",
"content": {}
}
},
"exactToolName": "provider_create_add_email",
"detailedDescription": "Add a new email for a patient"
}
},
{
"toolName": "provider_get_get_email_list",
"method": "GET",
"path": "/api/get-email-list/{patient_id}",
"description": "Get email list for a patient",
"category": "emails",
"parameters": "**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)",
"operationId": "getEmailList",
"tags": [
"Emails"
],
"endpoint": {
"path": "/api/get-email-list/{patient_id}",
"method": "GET",
"operationId": "getEmailList",
"summary": "Get email list for a patient",
"description": "Retrieves all emails associated with a specific patient with pagination support via DataTables",
"tags": [
"Emails"
],
"parameters": [
{
"name": "patient_id",
"in": "path",
"required": true,
"type": "integer",
"description": "ID of the patient"
},
{
"name": "draw",
"in": "query",
"required": false,
"type": "integer",
"description": "DataTables draw counter"
},
{
"name": "start",
"in": "query",
"required": false,
"type": "integer",
"description": "DataTables start offset"
},
{
"name": "length",
"in": "query",
"required": false,
"type": "integer",
"description": "DataTables page length"
},
{
"name": "search[value]",
"in": "query",
"required": false,
"type": "string",
"description": "DataTables search value"
},
{
"name": "order[0][column]",
"in": "query",
"required": false,
"type": "integer",
"description": "DataTables column index for ordering"
},
{
"name": "order[0][dir]",
"in": "query",
"required": false,
"type": "string",
"description": "DataTables order direction (asc/desc)"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"draw": {
"type": "integer",
"example": 1
},
"recordsTotal": {
"type": "integer",
"example": 10
},
"recordsFiltered": {
"type": "integer",
"example": 10
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"subject_id": {
"type": "integer",
"example": 1
},
"practitioner_name": {
"type": "string",
"example": "John Doe"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-07-01 14:30:00"
},
"messageText": {
"type": "string",
"example": "This is the email body text"
},
"to_email": {
"type": "string",
"format": "email",
"example": "patient@example.com"
},
"from_email": {
"type": "string",
"format": "email",
"example": "doctor@healthguruhub.com"
},
"emailTemplate": {
"type": "string",
"example": "Appointment Reminder"
},
"subject": {
"type": "string",
"example": "Your upcoming appointment"
},
"pid": {
"type": "integer",
"example": 42
},
"date": {
"type": "string",
"format": "date",
"example": "2025-07-01"
},
"DT_RowIndex": {
"type": "integer",
"example": 0
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Failed to fetch emails: Error message"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "emails",
"toolName": "provider_get_get_email_list",
"completeParameters": {
"patient_id": {
"name": "patient_id",
"in": "path",
"type": "integer",
"required": true,
"description": "ID of the patient"
},
"draw": {
"name": "draw",
"in": "query",
"type": "integer",
"required": false,
"description": "DataTables draw counter"
},
"start": {
"name": "start",
"in": "query",
"type": "integer",
"required": false,
"description": "DataTables start offset"
},
"length": {
"name": "length",
"in": "query",
"type": "integer",
"required": false,
"description": "DataTables page length"
},
"search[value]": {
"name": "search[value]",
"in": "query",
"type": "string",
"required": false,
"description": "DataTables search value"
},
"order[0][column]": {
"name": "order[0][column]",
"in": "query",
"type": "integer",
"required": false,
"description": "DataTables column index for ordering"
},
"order[0][dir]": {
"name": "order[0][dir]",
"in": "query",
"type": "string",
"required": false,
"description": "DataTables order direction (asc/desc)",
"enum": [
"asc",
"desc"
]
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"draw": {
"type": "integer",
"example": 1
},
"recordsTotal": {
"type": "integer",
"example": 10
},
"recordsFiltered": {
"type": "integer",
"example": 10
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"subject_id": {
"type": "integer",
"example": 1
},
"practitioner_name": {
"type": "string",
"example": "John Doe"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-07-01 14:30:00"
},
"messageText": {
"type": "string",
"example": "This is the email body text"
},
"to_email": {
"type": "string",
"format": "email",
"example": "patient@example.com"
},
"from_email": {
"type": "string",
"format": "email",
"example": "doctor@healthguruhub.com"
},
"emailTemplate": {
"type": "string",
"example": "Appointment Reminder"
},
"subject": {
"type": "string",
"example": "Your upcoming appointment"
},
"pid": {
"type": "integer",
"example": 42
},
"date": {
"type": "string",
"format": "date",
"example": "2025-07-01"
},
"DT_RowIndex": {
"type": "integer",
"example": 0
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Failed to fetch emails: Error message"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_get_email_list",
"detailedDescription": "Get email list for a patient"
}
},
{
"toolName": "provider_get_get_email",
"method": "GET",
"path": "/api/get-email/{id}",
"description": "Get an email by ID",
"category": "emails",
"parameters": "**Required:** id (integer) - ID of the email to retrieve",
"operationId": "getEmailById",
"tags": [
"Emails"
],
"endpoint": {
"path": "/api/get-email/{id}",
"method": "GET",
"operationId": "getEmailById",
"summary": "Get an email by ID",
"description": "Retrieves a specific email record by its ID",
"tags": [
"Emails"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "ID of the email to retrieve"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"pid": {
"type": "integer",
"example": 42
},
"user_id": {
"type": "integer",
"example": 1
},
"messageText": {
"type": "string",
"example": "This is the email body text"
},
"to_email": {
"type": "string",
"format": "email",
"example": "patient@example.com"
},
"from_email": {
"type": "string",
"format": "email",
"example": "doctor@healthguruhub.com"
},
"emailTemplate": {
"type": "string",
"example": "Appointment Reminder"
},
"subject": {
"type": "string",
"example": "Your upcoming appointment"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-07-01 14:30:00"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-07-01 14:30:00"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"404": {
"description": "Email not found"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "emails",
"toolName": "provider_get_get_email",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "ID of the email to retrieve"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"pid": {
"type": "integer",
"example": 42
},
"user_id": {
"type": "integer",
"example": 1
},
"messageText": {
"type": "string",
"example": "This is the email body text"
},
"to_email": {
"type": "string",
"format": "email",
"example": "patient@example.com"
},
"from_email": {
"type": "string",
"format": "email",
"example": "doctor@healthguruhub.com"
},
"emailTemplate": {
"type": "string",
"example": "Appointment Reminder"
},
"subject": {
"type": "string",
"example": "Your upcoming appointment"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-07-01 14:30:00"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-07-01 14:30:00"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"404": {
"description": "Email not found",
"content": {}
}
},
"exactToolName": "provider_get_get_email",
"detailedDescription": "Get an email by ID"
}
},
{
"toolName": "provider_get_get_forms",
"method": "GET",
"path": "/api/get-forms/{type}",
"description": "Get forms by type",
"category": "forms",
"parameters": "**Required:** type (string) - Form type (simple-forms, consent-forms, charting-forms, etc.)",
"operationId": "getForms",
"tags": [
"Forms Management"
],
"endpoint": {
"path": "/api/get-forms/{type}",
"method": "GET",
"operationId": "getForms",
"summary": "Get forms by type",
"description": "Retrieves all forms of a specific type for the authenticated provider",
"tags": [
"Forms Management"
],
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"type": "string",
"description": "Form type (simple-forms, consent-forms, charting-forms, etc.)"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Forms retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"draw": {
"type": "integer",
"example": 1
},
"recordsTotal": {
"type": "integer",
"example": 10
},
"recordsFiltered": {
"type": "integer",
"example": 10
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"type": {
"type": "string",
"example": "simple-forms"
},
"name": {
"type": "string",
"example": "Patient Intake Form"
},
"data": {
"type": "object"
},
"provider_id": {
"type": "integer",
"example": 1
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_get_get_forms",
"completeParameters": {
"type": {
"name": "type",
"in": "path",
"type": "string",
"required": true,
"description": "Form type (simple-forms, consent-forms, charting-forms, etc.)"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Forms retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"draw": {
"type": "integer",
"example": 1
},
"recordsTotal": {
"type": "integer",
"example": 10
},
"recordsFiltered": {
"type": "integer",
"example": 10
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"type": {
"type": "string",
"example": "simple-forms"
},
"name": {
"type": "string",
"example": "Patient Intake Form"
},
"data": {
"type": "object"
},
"provider_id": {
"type": "integer",
"example": 1
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
}
},
"exactToolName": "provider_get_get_forms",
"detailedDescription": "Get forms by type"
}
},
{
"toolName": "provider_get_get_form",
"method": "GET",
"path": "/api/get-form/{id}",
"description": "Get form by ID",
"category": "forms",
"parameters": "**Required:** id (integer) - Form ID",
"operationId": "getFormById",
"tags": [
"Forms Management"
],
"endpoint": {
"path": "/api/get-form/{id}",
"method": "GET",
"operationId": "getFormById",
"summary": "Get form by ID",
"description": "Retrieves a specific form by its ID",
"tags": [
"Forms Management"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "Form ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Form retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "success"
},
"data": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"type": {
"type": "string",
"example": "simple-forms"
},
"name": {
"type": "string",
"example": "Patient Intake Form"
},
"data": {
"type": "object"
},
"provider_id": {
"type": "integer",
"example": 1
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"404": {
"description": "Form not found",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Form not found"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_get_get_form",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "Form ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Form retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "success"
},
"data": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"type": {
"type": "string",
"example": "simple-forms"
},
"name": {
"type": "string",
"example": "Patient Intake Form"
},
"data": {
"type": "object"
},
"provider_id": {
"type": "integer",
"example": 1
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"404": {
"description": "Form not found",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Form not found"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_get_form",
"detailedDescription": "Get form by ID"
}
},
{
"toolName": "provider_update_update_form",
"method": "PUT",
"path": "/api/update-form/{id}",
"description": "Update form",
"category": "forms",
"parameters": "**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",
"operationId": "updateForm",
"tags": [
"Forms Management"
],
"endpoint": {
"path": "/api/update-form/{id}",
"method": "PUT",
"operationId": "updateForm",
"summary": "Update form",
"description": "Updates an existing form with the provided data",
"tags": [
"Forms Management"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "Form ID"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"type",
"data",
"name"
],
"properties": {
"type": {
"description": "Form type (simple-forms, consent-forms, charting-forms, etc.)",
"type": "string",
"example": "simple-forms"
},
"data": {
"description": "Form structure and fields",
"type": "object"
},
"name": {
"type": "string",
"example": "Updated Patient Intake Form"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Form updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Form updated successfully"
},
"data": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"type": {
"type": "string",
"example": "simple-forms"
},
"name": {
"type": "string",
"example": "Updated Patient Intake Form"
},
"data": {
"type": "object"
},
"provider_id": {
"type": "integer",
"example": 1
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"404": {
"description": "Form not found",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Form not found"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error"
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Error updating form"
},
"error": {
"type": "string",
"example": "Error message"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_update_update_form",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "Form ID"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"type",
"data",
"name"
],
"properties": {
"type": {
"description": "Form type (simple-forms, consent-forms, charting-forms, etc.)",
"type": "string",
"example": "simple-forms"
},
"data": {
"description": "Form structure and fields",
"type": "object"
},
"name": {
"type": "string",
"example": "Updated Patient Intake Form"
}
},
"type": "object"
},
"properties": {
"type": {
"type": "string",
"description": "Form type (simple-forms, consent-forms, charting-forms, etc.)",
"example": "simple-forms",
"required": true
},
"data": {
"type": "object",
"description": "Form structure and fields",
"required": true
},
"name": {
"type": "string",
"description": "name property",
"example": "Updated Patient Intake Form",
"required": true
}
},
"required": [
"type",
"data",
"name"
]
}
}
},
"responseSchema": {
"200": {
"description": "Form updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Form updated successfully"
},
"data": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"type": {
"type": "string",
"example": "simple-forms"
},
"name": {
"type": "string",
"example": "Updated Patient Intake Form"
},
"data": {
"type": "object"
},
"provider_id": {
"type": "integer",
"example": 1
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"404": {
"description": "Form not found",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Form not found"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error",
"content": {}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Error updating form"
},
"error": {
"type": "string",
"example": "Error message"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_update_update_form",
"detailedDescription": "Update form"
}
},
{
"toolName": "provider_delete_delete_form",
"method": "DELETE",
"path": "/api/delete-form/{id}",
"description": "Delete form",
"category": "forms",
"parameters": "**Required:** id (integer) - Form ID",
"operationId": "deleteForm",
"tags": [
"Forms Management"
],
"endpoint": {
"path": "/api/delete-form/{id}",
"method": "DELETE",
"operationId": "deleteForm",
"summary": "Delete form",
"description": "Deletes a form by its ID",
"tags": [
"Forms Management"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "Form ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Form deleted successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "success"
},
"data": {
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"404": {
"description": "Form not found",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Form not found"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Error deleting form"
},
"error": {
"type": "string",
"example": "Error message"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_delete_delete_form",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "Form ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Form deleted successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "success"
},
"data": {
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"404": {
"description": "Form not found",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Form not found"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Error deleting form"
},
"error": {
"type": "string",
"example": "Error message"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_delete_delete_form",
"detailedDescription": "Delete form"
}
},
{
"toolName": "provider_get_get_patient_intake_form_data",
"method": "GET",
"path": "/api/get-patient-intake-form-data/{form_id}/{pid}/{rowId}",
"description": "Get patient intake form data",
"category": "forms",
"parameters": "**Required:** form_id (integer) - Form ID, **Required:** pid (integer) - Patient ID, **Required:** rowId (integer) - Row ID of the specific form submission",
"operationId": "getIntakeFormData",
"tags": [
"Patient Forms"
],
"endpoint": {
"path": "/api/get-patient-intake-form-data/{form_id}/{pid}/{rowId}",
"method": "GET",
"operationId": "getIntakeFormData",
"summary": "Get patient intake form data",
"description": "Retrieves specific intake form data for a patient",
"tags": [
"Patient Forms"
],
"parameters": [
{
"name": "form_id",
"in": "path",
"required": true,
"type": "integer",
"description": "Form ID"
},
{
"name": "pid",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
},
{
"name": "rowId",
"in": "path",
"required": true,
"type": "integer",
"description": "Row ID of the specific form submission"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Form data retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatientIntakeForms"
}
}
}
},
"404": {
"description": "Form data not found"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_get_get_patient_intake_form_data",
"completeParameters": {
"form_id": {
"name": "form_id",
"in": "path",
"type": "integer",
"required": true,
"description": "Form ID"
},
"pid": {
"name": "pid",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
},
"rowId": {
"name": "rowId",
"in": "path",
"type": "integer",
"required": true,
"description": "Row ID of the specific form submission"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Form data retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatientIntakeForms"
}
}
}
},
"404": {
"description": "Form data not found",
"content": {}
}
},
"exactToolName": "provider_get_get_patient_intake_form_data",
"detailedDescription": "Get patient intake form data"
}
},
{
"toolName": "provider_get_get_patient_intake_form_latest_data",
"method": "GET",
"path": "/api/get-patient-intake-form-latest-data/{form_id}/{pid}",
"description": "Get latest intake form data",
"category": "forms",
"parameters": "**Required:** form_id (integer) - Form ID, **Required:** pid (integer) - Patient ID",
"operationId": "getIntakeFormLatestData",
"tags": [
"Patient Forms"
],
"endpoint": {
"path": "/api/get-patient-intake-form-latest-data/{form_id}/{pid}",
"method": "GET",
"operationId": "getIntakeFormLatestData",
"summary": "Get latest intake form data",
"description": "Retrieves the latest intake form data for a patient, or pre-filled data if no submission exists",
"tags": [
"Patient Forms"
],
"parameters": [
{
"name": "form_id",
"in": "path",
"required": true,
"type": "integer",
"description": "Form ID"
},
{
"name": "pid",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Form data retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatientIntakeForms"
}
}
}
},
"404": {
"description": "Form not found or invalid type",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Form not found or invalid type"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_get_get_patient_intake_form_latest_data",
"completeParameters": {
"form_id": {
"name": "form_id",
"in": "path",
"type": "integer",
"required": true,
"description": "Form ID"
},
"pid": {
"name": "pid",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Form data retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatientIntakeForms"
}
}
}
},
"404": {
"description": "Form not found or invalid type",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Form not found or invalid type"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_get_patient_intake_form_latest_data",
"detailedDescription": "Get latest intake form data"
}
},
{
"toolName": "provider_get_get_patient_submitted_intake_forms",
"method": "GET",
"path": "/api/get-patient-submitted-intake-forms/{pid}",
"description": "Get all submitted forms for a patient",
"category": "forms",
"parameters": "**Required:** pid (integer) - Patient ID",
"operationId": "getMergedFormData",
"tags": [
"Patient Forms"
],
"endpoint": {
"path": "/api/get-patient-submitted-intake-forms/{pid}",
"method": "GET",
"operationId": "getMergedFormData",
"summary": "Get all submitted forms for a patient",
"description": "Retrieves all intake and consent forms submitted by a patient",
"tags": [
"Patient Forms"
],
"parameters": [
{
"name": "pid",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Forms data retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"draw": {
"type": "integer",
"example": 1
},
"recordsTotal": {
"type": "integer",
"example": 10
},
"recordsFiltered": {
"type": "integer",
"example": 10
},
"data": {
"type": "array",
"items": {
"properties": {
"intake_form_id": {
"type": "integer",
"example": 1
},
"provider_id": {
"type": "integer",
"example": 1
},
"form_id": {
"type": "integer",
"example": 1
},
"pid": {
"type": "integer",
"example": 2
},
"data": {
"type": "object"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
},
"form_name": {
"type": "string",
"example": "Patient Intake Form"
},
"signature": {
"type": "string",
"example": ""
},
"name": {
"type": "string",
"example": ""
},
"type": {
"type": "string",
"example": "Intake"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_get_get_patient_submitted_intake_forms",
"completeParameters": {
"pid": {
"name": "pid",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Forms data retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"draw": {
"type": "integer",
"example": 1
},
"recordsTotal": {
"type": "integer",
"example": 10
},
"recordsFiltered": {
"type": "integer",
"example": 10
},
"data": {
"type": "array",
"items": {
"properties": {
"intake_form_id": {
"type": "integer",
"example": 1
},
"provider_id": {
"type": "integer",
"example": 1
},
"form_id": {
"type": "integer",
"example": 1
},
"pid": {
"type": "integer",
"example": 2
},
"data": {
"type": "object"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
},
"form_name": {
"type": "string",
"example": "Patient Intake Form"
},
"signature": {
"type": "string",
"example": ""
},
"name": {
"type": "string",
"example": ""
},
"type": {
"type": "string",
"example": "Intake"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_get_patient_submitted_intake_forms",
"detailedDescription": "Get all submitted forms for a patient"
}
},
{
"toolName": "provider_get_get_patient_intake_form_list",
"method": "GET",
"path": "/api/get-patient-intake-form-list/{type}/{pid}",
"description": "Get patient intake forms by type",
"category": "forms",
"parameters": "**Required:** type (string) - Form type (simple-forms, consent-forms, charting-forms, etc.), **Required:** pid (integer) - Patient ID",
"operationId": "getPatientIntakeFormList",
"tags": [
"Patient Forms"
],
"endpoint": {
"path": "/api/get-patient-intake-form-list/{type}/{pid}",
"method": "GET",
"operationId": "getPatientIntakeFormList",
"summary": "Get patient intake forms by type",
"description": "Retrieves a list of patient intake forms of a specific type",
"tags": [
"Patient Forms"
],
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"type": "string",
"description": "Form type (simple-forms, consent-forms, charting-forms, etc.)"
},
{
"name": "pid",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Form list retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"draw": {
"type": "integer",
"example": 1
},
"recordsTotal": {
"type": "integer",
"example": 10
},
"recordsFiltered": {
"type": "integer",
"example": 10
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"form_id": {
"type": "integer",
"example": 1
},
"pid": {
"type": "integer",
"example": 2
},
"provider_id": {
"type": "integer",
"example": 1
},
"data": {
"type": "object"
},
"schema": {
"type": "object"
},
"practitioner_id": {
"type": "integer",
"example": 3
},
"pdf_url": {
"type": "string",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
},
"name": {
"type": "string",
"example": "Patient Intake Form"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_get_get_patient_intake_form_list",
"completeParameters": {
"type": {
"name": "type",
"in": "path",
"type": "string",
"required": true,
"description": "Form type (simple-forms, consent-forms, charting-forms, etc.)"
},
"pid": {
"name": "pid",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Form list retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"draw": {
"type": "integer",
"example": 1
},
"recordsTotal": {
"type": "integer",
"example": 10
},
"recordsFiltered": {
"type": "integer",
"example": 10
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"form_id": {
"type": "integer",
"example": 1
},
"pid": {
"type": "integer",
"example": 2
},
"provider_id": {
"type": "integer",
"example": 1
},
"data": {
"type": "object"
},
"schema": {
"type": "object"
},
"practitioner_id": {
"type": "integer",
"example": 3
},
"pdf_url": {
"type": "string",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
},
"name": {
"type": "string",
"example": "Patient Intake Form"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_get_patient_intake_form_list",
"detailedDescription": "Get patient intake forms by type"
}
},
{
"toolName": "provider_update_update_form_status",
"method": "PUT",
"path": "/api/update-form-status",
"description": "Update form request status",
"category": "forms",
"parameters": "**Required:** form_id (integer) - form_id property, **Required:** patient_id (integer) - patient_id property, **Required:** status (string) - status property",
"operationId": "updateFormRequestStatus",
"tags": [
"Patient Forms"
],
"endpoint": {
"path": "/api/update-form-status",
"method": "PUT",
"operationId": "updateFormRequestStatus",
"summary": "Update form request status",
"description": "Updates the status of a patient's form request",
"tags": [
"Patient Forms"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"form_id",
"patient_id",
"status"
],
"properties": {
"form_id": {
"type": "integer",
"example": 1
},
"patient_id": {
"type": "integer",
"example": 2
},
"status": {
"type": "string",
"example": "completed"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Status updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Status updated successfully"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Form request not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Form request not found"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error"
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Error message"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_update_update_form_status",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"form_id",
"patient_id",
"status"
],
"properties": {
"form_id": {
"type": "integer",
"example": 1
},
"patient_id": {
"type": "integer",
"example": 2
},
"status": {
"type": "string",
"example": "completed"
}
},
"type": "object"
},
"properties": {
"form_id": {
"type": "integer",
"description": "form_id property",
"example": 1,
"required": true
},
"patient_id": {
"type": "integer",
"description": "patient_id property",
"example": 2,
"required": true
},
"status": {
"type": "string",
"description": "status property",
"example": "completed",
"required": true
}
},
"required": [
"form_id",
"patient_id",
"status"
]
}
}
},
"responseSchema": {
"200": {
"description": "Status updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Status updated successfully"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Form request not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Form request not found"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error",
"content": {}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Error message"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_update_update_form_status",
"detailedDescription": "Update form request status"
}
},
{
"toolName": "provider_get_get_intake_forms_list",
"method": "GET",
"path": "/api/get-intake-forms-list",
"description": "Get intake forms list",
"category": "forms",
"parameters": "No parameters",
"operationId": "getIntakeFormList",
"tags": [
"Intake Forms"
],
"endpoint": {
"path": "/api/get-intake-forms-list",
"method": "GET",
"operationId": "getIntakeFormList",
"summary": "Get intake forms list",
"description": "Retrieves a list of all intake question forms",
"tags": [
"Intake Forms"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "List retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Medical History Form"
}
},
"type": "object"
}
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_get_get_intake_forms_list",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "List retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Medical History Form"
}
},
"type": "object"
}
}
}
}
}
},
"exactToolName": "provider_get_get_intake_forms_list",
"detailedDescription": "Get intake forms list"
}
},
{
"toolName": "provider_create_store_patient_consent_form",
"method": "POST",
"path": "/api/store-patient-consent-form",
"description": "Store patient consent form",
"category": "forms",
"parameters": "**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",
"operationId": "storePatientConsentForm",
"tags": [
"Consent Forms"
],
"endpoint": {
"path": "/api/store-patient-consent-form",
"method": "POST",
"operationId": "storePatientConsentForm",
"summary": "Store patient consent form",
"description": "Stores a new patient consent form submission",
"tags": [
"Consent Forms"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"form_id",
"pid",
"data",
"name",
"signature"
],
"properties": {
"form_id": {
"type": "integer",
"example": 1
},
"pid": {
"type": "integer",
"example": 2
},
"data": {
"type": "object"
},
"name": {
"type": "string",
"example": "John Doe"
},
"signature": {
"type": "string",
"example": "base64encoded-signature-data"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Form stored successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"form_id": {
"type": "integer",
"example": 1
},
"pid": {
"type": "integer",
"example": 2
},
"provider_id": {
"type": "integer",
"example": 1
},
"data": {
"type": "string"
},
"name": {
"type": "string",
"example": "John Doe"
},
"signature": {
"type": "string",
"example": "base64encoded-signature-data"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_create_store_patient_consent_form",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"form_id",
"pid",
"data",
"name",
"signature"
],
"properties": {
"form_id": {
"type": "integer",
"example": 1
},
"pid": {
"type": "integer",
"example": 2
},
"data": {
"type": "object"
},
"name": {
"type": "string",
"example": "John Doe"
},
"signature": {
"type": "string",
"example": "base64encoded-signature-data"
}
},
"type": "object"
},
"properties": {
"form_id": {
"type": "integer",
"description": "form_id property",
"example": 1,
"required": true
},
"pid": {
"type": "integer",
"description": "pid property",
"example": 2,
"required": true
},
"data": {
"type": "object",
"description": "data property",
"required": true
},
"name": {
"type": "string",
"description": "name property",
"example": "John Doe",
"required": true
},
"signature": {
"type": "string",
"description": "signature property",
"example": "base64encoded-signature-data",
"required": true
}
},
"required": [
"form_id",
"pid",
"data",
"name",
"signature"
]
}
}
},
"responseSchema": {
"200": {
"description": "Form stored successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"form_id": {
"type": "integer",
"example": 1
},
"pid": {
"type": "integer",
"example": 2
},
"provider_id": {
"type": "integer",
"example": 1
},
"data": {
"type": "string"
},
"name": {
"type": "string",
"example": "John Doe"
},
"signature": {
"type": "string",
"example": "base64encoded-signature-data"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
}
},
"exactToolName": "provider_create_store_patient_consent_form",
"detailedDescription": "Store patient consent form"
}
},
{
"toolName": "provider_create_store_form",
"method": "POST",
"path": "/api/store-form",
"description": "Store a new form",
"category": "forms",
"parameters": "**Required:** type (string) - Form type (simple-forms, consent-forms, charting-forms, etc.), **Required:** data (object) - Form structure and fields, **Required:** name (string) - name property",
"operationId": "formDataStore",
"tags": [
"Forms Management"
],
"endpoint": {
"path": "/api/store-form",
"method": "POST",
"operationId": "formDataStore",
"summary": "Store a new form",
"description": "Creates a new form (intake, consent, etc.)",
"tags": [
"Forms Management"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"type",
"data",
"name"
],
"properties": {
"type": {
"description": "Form type (simple-forms, consent-forms, charting-forms, etc.)",
"type": "string",
"example": "simple-forms"
},
"data": {
"description": "Form structure and fields",
"type": "object"
},
"name": {
"type": "string",
"example": "New Patient Intake Form"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Form created successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Form created successfully"
},
"data": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"type": {
"type": "string",
"example": "simple-forms"
},
"name": {
"type": "string",
"example": "New Patient Intake Form"
},
"data": {
"type": "object"
},
"provider_id": {
"type": "integer",
"example": 1
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"422": {
"description": "Validation error"
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Form not created"
},
"error": {
"type": "string",
"example": "Error message"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_create_store_form",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"type",
"data",
"name"
],
"properties": {
"type": {
"description": "Form type (simple-forms, consent-forms, charting-forms, etc.)",
"type": "string",
"example": "simple-forms"
},
"data": {
"description": "Form structure and fields",
"type": "object"
},
"name": {
"type": "string",
"example": "New Patient Intake Form"
}
},
"type": "object"
},
"properties": {
"type": {
"type": "string",
"description": "Form type (simple-forms, consent-forms, charting-forms, etc.)",
"example": "simple-forms",
"required": true
},
"data": {
"type": "object",
"description": "Form structure and fields",
"required": true
},
"name": {
"type": "string",
"description": "name property",
"example": "New Patient Intake Form",
"required": true
}
},
"required": [
"type",
"data",
"name"
]
}
}
},
"responseSchema": {
"201": {
"description": "Form created successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Form created successfully"
},
"data": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"type": {
"type": "string",
"example": "simple-forms"
},
"name": {
"type": "string",
"example": "New Patient Intake Form"
},
"data": {
"type": "object"
},
"provider_id": {
"type": "integer",
"example": 1
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T12:00:00Z"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"422": {
"description": "Validation error",
"content": {}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Form not created"
},
"error": {
"type": "string",
"example": "Error message"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_store_form",
"detailedDescription": "Store a new form"
}
},
{
"toolName": "provider_delete_delete_intake_question",
"method": "DELETE",
"path": "/api/delete-intake-question/{form_id}",
"description": "Delete intake question",
"category": "forms",
"parameters": "**Required:** form_id (integer) - Intake question ID",
"operationId": "deleteIntakeQuestionById",
"tags": [
"Intake Forms"
],
"endpoint": {
"path": "/api/delete-intake-question/{form_id}",
"method": "DELETE",
"operationId": "deleteIntakeQuestionById",
"summary": "Delete intake question",
"description": "Deletes an intake question by its ID",
"tags": [
"Intake Forms"
],
"parameters": [
{
"name": "form_id",
"in": "path",
"required": true,
"type": "integer",
"description": "Intake question ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Question deleted successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Question Deleted"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Question not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Question not found!"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_delete_delete_intake_question",
"completeParameters": {
"form_id": {
"name": "form_id",
"in": "path",
"type": "integer",
"required": true,
"description": "Intake question ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Question deleted successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Question Deleted"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Question not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Question not found!"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_delete_delete_intake_question",
"detailedDescription": "Delete intake question"
}
},
{
"toolName": "provider_get_get_intake_forms_data",
"method": "GET",
"path": "/api/get-intake-forms-data/{form_id}",
"description": "Get intake form data by ID",
"category": "forms",
"parameters": "**Required:** form_id (integer) - Form ID",
"operationId": "getQuestionFormIntakeById",
"tags": [
"Intake Forms"
],
"endpoint": {
"path": "/api/get-intake-forms-data/{form_id}",
"method": "GET",
"operationId": "getQuestionFormIntakeById",
"summary": "Get intake form data by ID",
"description": "Retrieves the data of a specific intake form",
"tags": [
"Intake Forms"
],
"parameters": [
{
"name": "form_id",
"in": "path",
"required": true,
"type": "integer",
"description": "Form ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Form data retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FormsData"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_get_get_intake_forms_data",
"completeParameters": {
"form_id": {
"name": "form_id",
"in": "path",
"type": "integer",
"required": true,
"description": "Form ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Form data retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FormsData"
}
}
}
}
},
"exactToolName": "provider_get_get_intake_forms_data",
"detailedDescription": "Get intake form data by ID"
}
},
{
"toolName": "provider_get_get_document_vue",
"method": "GET",
"path": "/api/get-document-vue/{patient_id}",
"description": "Get documents for Vue component",
"category": "forms",
"parameters": "**Required:** patient_id (integer) - Patient ID",
"operationId": "getDocumentVue",
"tags": [
"Patient Forms"
],
"endpoint": {
"path": "/api/get-document-vue/{patient_id}",
"method": "GET",
"operationId": "getDocumentVue",
"summary": "Get documents for Vue component",
"description": "Initializes VueFinder for displaying patient documents",
"tags": [
"Patient Forms"
],
"parameters": [
{
"name": "patient_id",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "VueFinder initialized (no direct JSON response)"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_get_get_document_vue",
"completeParameters": {
"patient_id": {
"name": "patient_id",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "VueFinder initialized (no direct JSON response)",
"content": {}
}
},
"exactToolName": "provider_get_get_document_vue",
"detailedDescription": "Get documents for Vue component"
}
},
{
"toolName": "provider_get_get_patient_forms",
"method": "GET",
"path": "/api/get-patient-forms/{pid}",
"description": "Get all forms for a patient",
"category": "forms",
"parameters": "**Required:** pid (integer) - Patient ID",
"operationId": "getPatientFormList",
"tags": [
"Patient Forms"
],
"endpoint": {
"path": "/api/get-patient-forms/{pid}",
"method": "GET",
"operationId": "getPatientFormList",
"summary": "Get all forms for a patient",
"description": "Retrieves all forms submitted by a patient",
"tags": [
"Patient Forms"
],
"parameters": [
{
"name": "pid",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Forms retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PatientIntakeForms"
}
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_get_get_patient_forms",
"completeParameters": {
"pid": {
"name": "pid",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Forms retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PatientIntakeForms"
}
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_get_patient_forms",
"detailedDescription": "Get all forms for a patient"
}
},
{
"toolName": "provider_get_get_patient_questionnaire_form_list",
"method": "GET",
"path": "/api/get-patient-questionnaire-form-list/{pid}",
"description": "Get patient questionnaire forms",
"category": "forms",
"parameters": "**Required:** pid (integer) - Patient ID",
"operationId": "getPatientQuestionairForm",
"tags": [
"Patient Forms"
],
"endpoint": {
"path": "/api/get-patient-questionnaire-form-list/{pid}",
"method": "GET",
"operationId": "getPatientQuestionairForm",
"summary": "Get patient questionnaire forms",
"description": "Retrieves a list of questionnaire forms for a patient",
"tags": [
"Patient Forms"
],
"parameters": [
{
"name": "pid",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "List retrieved successfully"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_get_get_patient_questionnaire_form_list",
"completeParameters": {
"pid": {
"name": "pid",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "List retrieved successfully",
"content": {}
}
},
"exactToolName": "provider_get_get_patient_questionnaire_form_list",
"detailedDescription": "Get patient questionnaire forms"
}
},
{
"toolName": "provider_get_get_questioner_forms_data",
"method": "GET",
"path": "/api/get-questioner-forms-data/{form_id}",
"description": "Get questionnaire form data",
"category": "forms",
"parameters": "**Required:** form_id (integer) - Form ID",
"operationId": "getQuestionFormQuestionerById",
"tags": [
"Intake Forms"
],
"endpoint": {
"path": "/api/get-questioner-forms-data/{form_id}",
"method": "GET",
"operationId": "getQuestionFormQuestionerById",
"summary": "Get questionnaire form data",
"description": "Retrieves data for a specific questionnaire form",
"tags": [
"Intake Forms"
],
"parameters": [
{
"name": "form_id",
"in": "path",
"required": true,
"type": "integer",
"description": "Form ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Data retrieved successfully"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_get_get_questioner_forms_data",
"completeParameters": {
"form_id": {
"name": "form_id",
"in": "path",
"type": "integer",
"required": true,
"description": "Form ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Data retrieved successfully",
"content": {}
}
},
"exactToolName": "provider_get_get_questioner_forms_data",
"detailedDescription": "Get questionnaire form data"
}
},
{
"toolName": "provider_get_get_questioner_question",
"method": "GET",
"path": "/api/get-questioner-question/{id}",
"description": "Get questionnaire question by ID",
"category": "forms",
"parameters": "**Required:** id (integer) - Question ID",
"operationId": "getQuestionQuestionerById",
"tags": [
"Intake Forms"
],
"endpoint": {
"path": "/api/get-questioner-question/{id}",
"method": "GET",
"operationId": "getQuestionQuestionerById",
"summary": "Get questionnaire question by ID",
"description": "Retrieves a specific questionnaire question by its ID",
"tags": [
"Intake Forms"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "Question ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Data retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Data retrieved successfully"
},
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "forms",
"toolName": "provider_get_get_questioner_question",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "Question ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Data retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Data retrieved successfully"
},
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_get_questioner_question",
"detailedDescription": "Get questionnaire question by ID"
}
},
{
"toolName": "provider_get_get_insurance",
"method": "GET",
"path": "/get-insurance/{patientId}",
"description": "Get insurance information for a patient",
"category": "insurance",
"parameters": "**Required:** patientId (integer) - ID of the patient",
"operationId": "getInsurance",
"tags": [
"Insurance"
],
"endpoint": {
"path": "/get-insurance/{patientId}",
"method": "GET",
"operationId": "getInsurance",
"summary": "Get insurance information for a patient",
"description": "Retrieves the insurance details for a specific patient",
"tags": [
"Insurance"
],
"parameters": [
{
"name": "patientId",
"in": "path",
"required": true,
"type": "integer",
"description": "ID of the patient"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Insurance data retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Insurance Listing"
},
"data": {
"properties": {
"insuranceId": {
"type": "integer",
"example": 1
},
"insuredPlanOrProgramName": {
"type": "string",
"example": "Blue Cross"
},
"insuredIDNumber": {
"type": "string",
"example": "BC123456"
},
"insuredGroupNameNo": {
"type": "string",
"example": "GRP123"
},
"payerName": {
"type": "string",
"example": "John Doe"
},
"relationshiptoInsured": {
"type": "string",
"example": "Self"
},
"insuredDateOfBirth": {
"type": "string",
"format": "date",
"example": "1980-01-01"
},
"payerAddress": {
"type": "string",
"example": "123 Main St"
},
"payerZip": {
"type": "string",
"example": "12345"
},
"payerCity": {
"type": "string",
"example": "Anytown"
},
"payerState": {
"type": "string",
"example": "CA"
},
"payerCountry": {
"type": "string",
"example": "USA"
},
"insuredPhone": {
"type": "string",
"example": "555-123-4567"
},
"coPayment": {
"type": "number",
"format": "float",
"example": 20
},
"type": {
"type": "string",
"example": "primary"
},
"subscriber_mname": {
"type": "string",
"example": ""
},
"subscriber_ss": {
"type": "string",
"example": ""
},
"subscriber_employer": {
"type": "string",
"example": "ABC Company"
},
"subscriber_employer_street": {
"type": "string",
"example": "456 Business Ave"
},
"subscriber_employer_postal_code": {
"type": "string",
"example": "54321"
},
"subscriber_employer_state": {
"type": "string",
"example": "CA"
},
"subscriber_employer_country": {
"type": "string",
"example": "USA"
},
"subscriber_employer_city": {
"type": "string",
"example": "Business City"
},
"date": {
"type": "string",
"format": "date-time",
"example": "2023-01-01 12:00:00"
},
"subscriber_sex": {
"type": "string",
"example": "M"
},
"accept_assignment": {
"type": "string",
"example": ""
},
"policy_type": {
"type": "string",
"example": ""
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Insurance data not found",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "null",
"example": null
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "insurance",
"toolName": "provider_get_get_insurance",
"completeParameters": {
"patientId": {
"name": "patientId",
"in": "path",
"type": "integer",
"format": "int64",
"required": true,
"description": "ID of the patient"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Insurance data retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Insurance Listing"
},
"data": {
"properties": {
"insuranceId": {
"type": "integer",
"example": 1
},
"insuredPlanOrProgramName": {
"type": "string",
"example": "Blue Cross"
},
"insuredIDNumber": {
"type": "string",
"example": "BC123456"
},
"insuredGroupNameNo": {
"type": "string",
"example": "GRP123"
},
"payerName": {
"type": "string",
"example": "John Doe"
},
"relationshiptoInsured": {
"type": "string",
"example": "Self"
},
"insuredDateOfBirth": {
"type": "string",
"format": "date",
"example": "1980-01-01"
},
"payerAddress": {
"type": "string",
"example": "123 Main St"
},
"payerZip": {
"type": "string",
"example": "12345"
},
"payerCity": {
"type": "string",
"example": "Anytown"
},
"payerState": {
"type": "string",
"example": "CA"
},
"payerCountry": {
"type": "string",
"example": "USA"
},
"insuredPhone": {
"type": "string",
"example": "555-123-4567"
},
"coPayment": {
"type": "number",
"format": "float",
"example": 20
},
"type": {
"type": "string",
"example": "primary"
},
"subscriber_mname": {
"type": "string",
"example": ""
},
"subscriber_ss": {
"type": "string",
"example": ""
},
"subscriber_employer": {
"type": "string",
"example": "ABC Company"
},
"subscriber_employer_street": {
"type": "string",
"example": "456 Business Ave"
},
"subscriber_employer_postal_code": {
"type": "string",
"example": "54321"
},
"subscriber_employer_state": {
"type": "string",
"example": "CA"
},
"subscriber_employer_country": {
"type": "string",
"example": "USA"
},
"subscriber_employer_city": {
"type": "string",
"example": "Business City"
},
"date": {
"type": "string",
"format": "date-time",
"example": "2023-01-01 12:00:00"
},
"subscriber_sex": {
"type": "string",
"example": "M"
},
"accept_assignment": {
"type": "string",
"example": ""
},
"policy_type": {
"type": "string",
"example": ""
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Insurance data not found",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "null",
"example": null
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_get_insurance",
"detailedDescription": "Get insurance information for a patient"
}
},
{
"toolName": "provider_create_store_insurance",
"method": "POST",
"path": "/store-insurance/{patientId}",
"description": "Store insurance information for a patient",
"category": "insurance",
"parameters": "**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",
"operationId": "insuranceStore",
"tags": [
"Insurance"
],
"endpoint": {
"path": "/store-insurance/{patientId}",
"method": "POST",
"operationId": "insuranceStore",
"summary": "Store insurance information for a patient",
"description": "Creates or updates insurance information for a specific patient",
"tags": [
"Insurance"
],
"parameters": [
{
"name": "patientId",
"in": "path",
"required": true,
"type": "integer",
"description": "ID of the patient"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"insuredPlanOrProgramName",
"insuredIDNumber",
"relationshiptoInsured",
"insuredDateOfBirth",
"insuredAddress",
"insuredCity",
"insuredState",
"insuredZip",
"insuredPhone",
"payerName",
"payerID",
"payerAddress",
"payerCity",
"payerState",
"payerZip",
"type"
],
"properties": {
"insurance": {
"type": "string",
"example": "Blue Cross"
},
"insuredPlanOrProgramName": {
"type": "string",
"example": "Blue Cross PPO"
},
"insuredIDNumber": {
"type": "string",
"example": "BC123456"
},
"insuredGroupNameNo": {
"type": "string",
"example": "GRP123"
},
"employersSchoolName": {
"type": "string",
"example": "ABC Company"
},
"relationshiptoInsured": {
"type": "string",
"example": "Self"
},
"insuredName": {
"type": "string",
"example": "John Doe"
},
"insuredDateOfBirth": {
"type": "string",
"format": "date",
"example": "1980-01-01"
},
"insuredGender": {
"type": "string",
"example": "M"
},
"coPayment": {
"type": "number",
"format": "float",
"example": 20
},
"coInsurance": {
"type": "number",
"format": "float",
"example": 20
},
"insuranceDeductible": {
"type": "number",
"format": "float",
"example": 500
},
"insuredAddress": {
"type": "string",
"example": "123 Main St"
},
"insuredCity": {
"type": "string",
"example": "Anytown"
},
"insuredState": {
"type": "string",
"example": "CA"
},
"insuredZip": {
"type": "string",
"example": "12345"
},
"insuredPhone": {
"type": "string",
"example": "555-123-4567"
},
"payerName": {
"type": "string",
"example": "John Doe"
},
"payerID": {
"type": "string",
"example": "PAY123"
},
"payerAddress": {
"type": "string",
"example": "456 Payer St"
},
"payerCity": {
"type": "string",
"example": "Payertown"
},
"payerState": {
"type": "string",
"example": "CA"
},
"payerZip": {
"type": "string",
"example": "54321"
},
"referringProviderName": {
"type": "string",
"example": "Dr. Jane Smith"
},
"referringProviderNPI": {
"type": "string",
"example": "1234567890"
},
"referringProviderTaxonomy": {
"type": "string",
"example": "207Q00000X"
},
"type": {
"type": "string",
"example": "primary"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Insurance created successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Insurance created"
},
"status": {
"type": "integer",
"example": 200
},
"data": {
"type": "object"
},
"patientId": {
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "The given data was invalid."
},
"errors": {
"properties": {
"insuredPlanOrProgramName": {
"type": "array",
"items": {
"type": "string",
"example": "The insurance plan or program name field is required."
}
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "insurance",
"toolName": "provider_create_store_insurance",
"completeParameters": {
"patientId": {
"name": "patientId",
"in": "path",
"type": "integer",
"format": "int64",
"required": true,
"description": "ID of the patient"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"insuredPlanOrProgramName",
"insuredIDNumber",
"relationshiptoInsured",
"insuredDateOfBirth",
"insuredAddress",
"insuredCity",
"insuredState",
"insuredZip",
"insuredPhone",
"payerName",
"payerID",
"payerAddress",
"payerCity",
"payerState",
"payerZip",
"type"
],
"properties": {
"insurance": {
"type": "string",
"example": "Blue Cross"
},
"insuredPlanOrProgramName": {
"type": "string",
"example": "Blue Cross PPO"
},
"insuredIDNumber": {
"type": "string",
"example": "BC123456"
},
"insuredGroupNameNo": {
"type": "string",
"example": "GRP123"
},
"employersSchoolName": {
"type": "string",
"example": "ABC Company"
},
"relationshiptoInsured": {
"type": "string",
"example": "Self"
},
"insuredName": {
"type": "string",
"example": "John Doe"
},
"insuredDateOfBirth": {
"type": "string",
"format": "date",
"example": "1980-01-01"
},
"insuredGender": {
"type": "string",
"example": "M"
},
"coPayment": {
"type": "number",
"format": "float",
"example": 20
},
"coInsurance": {
"type": "number",
"format": "float",
"example": 20
},
"insuranceDeductible": {
"type": "number",
"format": "float",
"example": 500
},
"insuredAddress": {
"type": "string",
"example": "123 Main St"
},
"insuredCity": {
"type": "string",
"example": "Anytown"
},
"insuredState": {
"type": "string",
"example": "CA"
},
"insuredZip": {
"type": "string",
"example": "12345"
},
"insuredPhone": {
"type": "string",
"example": "555-123-4567"
},
"payerName": {
"type": "string",
"example": "John Doe"
},
"payerID": {
"type": "string",
"example": "PAY123"
},
"payerAddress": {
"type": "string",
"example": "456 Payer St"
},
"payerCity": {
"type": "string",
"example": "Payertown"
},
"payerState": {
"type": "string",
"example": "CA"
},
"payerZip": {
"type": "string",
"example": "54321"
},
"referringProviderName": {
"type": "string",
"example": "Dr. Jane Smith"
},
"referringProviderNPI": {
"type": "string",
"example": "1234567890"
},
"referringProviderTaxonomy": {
"type": "string",
"example": "207Q00000X"
},
"type": {
"type": "string",
"example": "primary"
}
},
"type": "object"
},
"properties": {
"insurance": {
"type": "string",
"description": "insurance property",
"example": "Blue Cross",
"required": false
},
"insuredPlanOrProgramName": {
"type": "string",
"description": "insuredPlanOrProgramName property",
"example": "Blue Cross PPO",
"required": true
},
"insuredIDNumber": {
"type": "string",
"description": "insuredIDNumber property",
"example": "BC123456",
"required": true
},
"insuredGroupNameNo": {
"type": "string",
"description": "insuredGroupNameNo property",
"example": "GRP123",
"required": false
},
"employersSchoolName": {
"type": "string",
"description": "employersSchoolName property",
"example": "ABC Company",
"required": false
},
"relationshiptoInsured": {
"type": "string",
"description": "relationshiptoInsured property",
"example": "Self",
"required": true
},
"insuredName": {
"type": "string",
"description": "insuredName property",
"example": "John Doe",
"required": false
},
"insuredDateOfBirth": {
"type": "string",
"format": "date",
"description": "insuredDateOfBirth property",
"example": "1980-01-01",
"required": true
},
"insuredGender": {
"type": "string",
"description": "insuredGender property",
"example": "M",
"required": false
},
"coPayment": {
"type": "number",
"format": "float",
"description": "coPayment property",
"example": 20,
"required": false
},
"coInsurance": {
"type": "number",
"format": "float",
"description": "coInsurance property",
"example": 20,
"required": false
},
"insuranceDeductible": {
"type": "number",
"format": "float",
"description": "insuranceDeductible property",
"example": 500,
"required": false
},
"insuredAddress": {
"type": "string",
"description": "insuredAddress property",
"example": "123 Main St",
"required": true
},
"insuredCity": {
"type": "string",
"description": "insuredCity property",
"example": "Anytown",
"required": true
},
"insuredState": {
"type": "string",
"description": "insuredState property",
"example": "CA",
"required": true
},
"insuredZip": {
"type": "string",
"description": "insuredZip property",
"example": "12345",
"required": true
},
"insuredPhone": {
"type": "string",
"description": "insuredPhone property",
"example": "555-123-4567",
"required": true
},
"payerName": {
"type": "string",
"description": "payerName property",
"example": "John Doe",
"required": true
},
"payerID": {
"type": "string",
"description": "payerID property",
"example": "PAY123",
"required": true
},
"payerAddress": {
"type": "string",
"description": "payerAddress property",
"example": "456 Payer St",
"required": true
},
"payerCity": {
"type": "string",
"description": "payerCity property",
"example": "Payertown",
"required": true
},
"payerState": {
"type": "string",
"description": "payerState property",
"example": "CA",
"required": true
},
"payerZip": {
"type": "string",
"description": "payerZip property",
"example": "54321",
"required": true
},
"referringProviderName": {
"type": "string",
"description": "referringProviderName property",
"example": "Dr. Jane Smith",
"required": false
},
"referringProviderNPI": {
"type": "string",
"description": "referringProviderNPI property",
"example": "1234567890",
"required": false
},
"referringProviderTaxonomy": {
"type": "string",
"description": "referringProviderTaxonomy property",
"example": "207Q00000X",
"required": false
},
"type": {
"type": "string",
"description": "type property",
"example": "primary",
"required": true
}
},
"required": [
"insuredPlanOrProgramName",
"insuredIDNumber",
"relationshiptoInsured",
"insuredDateOfBirth",
"insuredAddress",
"insuredCity",
"insuredState",
"insuredZip",
"insuredPhone",
"payerName",
"payerID",
"payerAddress",
"payerCity",
"payerState",
"payerZip",
"type"
]
}
}
},
"responseSchema": {
"200": {
"description": "Insurance created successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Insurance created"
},
"status": {
"type": "integer",
"example": 200
},
"data": {
"type": "object"
},
"patientId": {
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "The given data was invalid."
},
"errors": {
"properties": {
"insuredPlanOrProgramName": {
"type": "array",
"items": {
"type": "string",
"example": "The insurance plan or program name field is required."
}
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_store_insurance",
"detailedDescription": "Store insurance information for a patient"
}
},
{
"toolName": "provider_update_update_insurance",
"method": "PUT",
"path": "/update-insurance/{patientId}",
"description": "Update insurance information for a patient",
"category": "insurance",
"parameters": "**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",
"operationId": "updateInsurance",
"tags": [
"Insurance"
],
"endpoint": {
"path": "/update-insurance/{patientId}",
"method": "PUT",
"operationId": "updateInsurance",
"summary": "Update insurance information for a patient",
"description": "Updates the existing insurance information for a specific patient",
"tags": [
"Insurance"
],
"parameters": [
{
"name": "patientId",
"in": "path",
"required": true,
"type": "integer",
"description": "ID of the patient"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"insuredPlanOrProgramName",
"insuredIDNumber",
"relationshiptoInsured",
"insuredDateOfBirth",
"insuredAddress",
"insuredCity",
"insuredState",
"insuredZip",
"insuredPhone",
"payerName",
"type"
],
"properties": {
"insuredPlanOrProgramName": {
"type": "string",
"example": "Blue Cross PPO"
},
"insuredIDNumber": {
"type": "string",
"example": "BC123456"
},
"insuredGroupNameNo": {
"type": "string",
"example": "GRP123"
},
"relationshiptoInsured": {
"type": "string",
"example": "Self"
},
"insuredDateOfBirth": {
"type": "string",
"format": "date",
"example": "1980-01-01"
},
"insuredAddress": {
"type": "string",
"example": "123 Main St"
},
"insuredCity": {
"type": "string",
"example": "Anytown"
},
"insuredState": {
"type": "string",
"example": "CA"
},
"insuredZip": {
"type": "string",
"example": "12345"
},
"insuredPhone": {
"type": "string",
"example": "555-123-4567"
},
"payerName": {
"type": "string",
"example": "John Doe"
},
"coPayment": {
"type": "number",
"format": "float",
"example": 20
},
"type": {
"type": "string",
"example": "primary"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Insurance updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Updated Successfully!"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Insurance record not found",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Insurance record not found"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "insurance",
"toolName": "provider_update_update_insurance",
"completeParameters": {
"patientId": {
"name": "patientId",
"in": "path",
"type": "integer",
"format": "int64",
"required": true,
"description": "ID of the patient"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"insuredPlanOrProgramName",
"insuredIDNumber",
"relationshiptoInsured",
"insuredDateOfBirth",
"insuredAddress",
"insuredCity",
"insuredState",
"insuredZip",
"insuredPhone",
"payerName",
"type"
],
"properties": {
"insuredPlanOrProgramName": {
"type": "string",
"example": "Blue Cross PPO"
},
"insuredIDNumber": {
"type": "string",
"example": "BC123456"
},
"insuredGroupNameNo": {
"type": "string",
"example": "GRP123"
},
"relationshiptoInsured": {
"type": "string",
"example": "Self"
},
"insuredDateOfBirth": {
"type": "string",
"format": "date",
"example": "1980-01-01"
},
"insuredAddress": {
"type": "string",
"example": "123 Main St"
},
"insuredCity": {
"type": "string",
"example": "Anytown"
},
"insuredState": {
"type": "string",
"example": "CA"
},
"insuredZip": {
"type": "string",
"example": "12345"
},
"insuredPhone": {
"type": "string",
"example": "555-123-4567"
},
"payerName": {
"type": "string",
"example": "John Doe"
},
"coPayment": {
"type": "number",
"format": "float",
"example": 20
},
"type": {
"type": "string",
"example": "primary"
}
},
"type": "object"
},
"properties": {
"insuredPlanOrProgramName": {
"type": "string",
"description": "insuredPlanOrProgramName property",
"example": "Blue Cross PPO",
"required": true
},
"insuredIDNumber": {
"type": "string",
"description": "insuredIDNumber property",
"example": "BC123456",
"required": true
},
"insuredGroupNameNo": {
"type": "string",
"description": "insuredGroupNameNo property",
"example": "GRP123",
"required": false
},
"relationshiptoInsured": {
"type": "string",
"description": "relationshiptoInsured property",
"example": "Self",
"required": true
},
"insuredDateOfBirth": {
"type": "string",
"format": "date",
"description": "insuredDateOfBirth property",
"example": "1980-01-01",
"required": true
},
"insuredAddress": {
"type": "string",
"description": "insuredAddress property",
"example": "123 Main St",
"required": true
},
"insuredCity": {
"type": "string",
"description": "insuredCity property",
"example": "Anytown",
"required": true
},
"insuredState": {
"type": "string",
"description": "insuredState property",
"example": "CA",
"required": true
},
"insuredZip": {
"type": "string",
"description": "insuredZip property",
"example": "12345",
"required": true
},
"insuredPhone": {
"type": "string",
"description": "insuredPhone property",
"example": "555-123-4567",
"required": true
},
"payerName": {
"type": "string",
"description": "payerName property",
"example": "John Doe",
"required": true
},
"coPayment": {
"type": "number",
"format": "float",
"description": "coPayment property",
"example": 20,
"required": false
},
"type": {
"type": "string",
"description": "type property",
"example": "primary",
"required": true
}
},
"required": [
"insuredPlanOrProgramName",
"insuredIDNumber",
"relationshiptoInsured",
"insuredDateOfBirth",
"insuredAddress",
"insuredCity",
"insuredState",
"insuredZip",
"insuredPhone",
"payerName",
"type"
]
}
}
},
"responseSchema": {
"200": {
"description": "Insurance updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Updated Successfully!"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Insurance record not found",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Insurance record not found"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_update_update_insurance",
"detailedDescription": "Update insurance information for a patient"
}
},
{
"toolName": "provider_get_inventory",
"method": "GET",
"path": "/inventory",
"description": "Get inventory list",
"category": "inventory",
"parameters": "No parameters",
"operationId": "listInventoryItems",
"tags": [
"Inventory"
],
"endpoint": {
"path": "/inventory",
"method": "GET",
"operationId": "listInventoryItems",
"summary": "Get inventory list",
"description": "Retrieves a list of all inventory items for the current provider",
"tags": [
"Inventory"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"draw": {
"type": "integer",
"example": 1
},
"recordsTotal": {
"type": "integer",
"example": 100
},
"recordsFiltered": {
"type": "integer",
"example": 10
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"inventoryType": {
"type": "string",
"example": "Medication"
},
"item_name": {
"type": "string",
"example": "Aspirin 325mg"
},
"manufPartNo": {
"type": "string",
"example": "ASP325"
},
"barcode": {
"type": "string",
"example": "123456789"
},
"isTaxable": {
"type": "string",
"example": "Yes"
},
"vendor_name": {
"type": "string",
"example": "Pharma Inc."
},
"price": {
"type": "number",
"format": "float",
"example": 10.99
},
"cost": {
"type": "number",
"format": "float",
"example": 5.99
},
"onhand": {
"type": "number",
"example": 100
},
"expirationDate": {
"type": "string",
"format": "date",
"example": "2023-12-31"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Unauthenticated"
}
},
"type": "object"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "This action is unauthorized"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "inventory",
"toolName": "provider_get_inventory",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"draw": {
"type": "integer",
"example": 1
},
"recordsTotal": {
"type": "integer",
"example": 100
},
"recordsFiltered": {
"type": "integer",
"example": 10
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"inventoryType": {
"type": "string",
"example": "Medication"
},
"item_name": {
"type": "string",
"example": "Aspirin 325mg"
},
"manufPartNo": {
"type": "string",
"example": "ASP325"
},
"barcode": {
"type": "string",
"example": "123456789"
},
"isTaxable": {
"type": "string",
"example": "Yes"
},
"vendor_name": {
"type": "string",
"example": "Pharma Inc."
},
"price": {
"type": "number",
"format": "float",
"example": 10.99
},
"cost": {
"type": "number",
"format": "float",
"example": 5.99
},
"onhand": {
"type": "number",
"example": 100
},
"expirationDate": {
"type": "string",
"format": "date",
"example": "2023-12-31"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Unauthenticated"
}
},
"type": "object"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "This action is unauthorized"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_inventory",
"detailedDescription": "Get inventory list"
}
},
{
"toolName": "provider_get_get_inventory",
"method": "GET",
"path": "/get-inventory/{id}",
"description": "Get inventory item by ID",
"category": "inventory",
"parameters": "**Required:** id (integer) - ID of the inventory item",
"operationId": "getInventoryItemById",
"tags": [
"Inventory"
],
"endpoint": {
"path": "/get-inventory/{id}",
"method": "GET",
"operationId": "getInventoryItemById",
"summary": "Get inventory item by ID",
"description": "Retrieves a specific inventory item by its ID",
"tags": [
"Inventory"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "ID of the inventory item"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"data": {
"$ref": "#/components/schemas/InventoryItem"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Inventory item not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Inventory item not found"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Error retrieving inventory: {error message}"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "inventory",
"toolName": "provider_get_get_inventory",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"format": "int64",
"required": true,
"description": "ID of the inventory item"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"data": {
"$ref": "#/components/schemas/InventoryItem"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Inventory item not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Inventory item not found"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Error retrieving inventory: {error message}"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_get_inventory",
"detailedDescription": "Get inventory item by ID"
}
},
{
"toolName": "provider_create_add_inventory",
"method": "POST",
"path": "/add-inventory",
"description": "Add new inventory item",
"category": "inventory",
"parameters": "**Optional:** inventoryType (string) - inventoryType property, **Optional:** item_name (string) - item_name property, **Optional:** price (number) - price property, **Optional:** expirationDate (string) - expirationDate property",
"operationId": "createInventoryItem",
"tags": [
"Inventory"
],
"endpoint": {
"path": "/add-inventory",
"method": "POST",
"operationId": "createInventoryItem",
"summary": "Add new inventory item",
"description": "Creates a new inventory item in the system",
"tags": [
"Inventory"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"properties": {
"inventoryType": {
"type": "string",
"example": "Medication"
},
"item_name": {
"type": "string",
"example": "Aspirin 325mg"
},
"price": {
"type": "number",
"format": "float",
"example": 10.99
},
"expirationDate": {
"type": "string",
"format": "date",
"example": "2023-12-31"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/InventoryItem"
},
"message": {
"type": "string",
"example": "Inventory added sucessfully!"
}
},
"type": "object"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "This action is unauthorized"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "The given data was invalid."
},
"errors": {
"properties": {
"item_name": {
"type": "array",
"items": {
"type": "string",
"example": "The item name field is required."
}
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "inventory",
"toolName": "provider_create_add_inventory",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"inventoryType": {
"type": "string",
"example": "Medication"
},
"item_name": {
"type": "string",
"example": "Aspirin 325mg"
},
"price": {
"type": "number",
"format": "float",
"example": 10.99
},
"expirationDate": {
"type": "string",
"format": "date",
"example": "2023-12-31"
}
},
"type": "object"
},
"properties": {
"inventoryType": {
"type": "string",
"description": "inventoryType property",
"example": "Medication",
"required": false
},
"item_name": {
"type": "string",
"description": "item_name property",
"example": "Aspirin 325mg",
"required": false
},
"price": {
"type": "number",
"format": "float",
"description": "price property",
"example": 10.99,
"required": false
},
"expirationDate": {
"type": "string",
"format": "date",
"description": "expirationDate property",
"example": "2023-12-31",
"required": false
}
},
"required": []
}
}
},
"responseSchema": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/InventoryItem"
},
"message": {
"type": "string",
"example": "Inventory added sucessfully!"
}
},
"type": "object"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "This action is unauthorized"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "The given data was invalid."
},
"errors": {
"properties": {
"item_name": {
"type": "array",
"items": {
"type": "string",
"example": "The item name field is required."
}
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_add_inventory",
"detailedDescription": "Add new inventory item"
}
},
{
"toolName": "provider_update_update_inventory",
"method": "PUT",
"path": "/update-inventory/{id}",
"description": "Update inventory item",
"category": "inventory",
"parameters": "**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",
"operationId": "updateInventoryItem",
"tags": [
"Inventory"
],
"endpoint": {
"path": "/update-inventory/{id}",
"method": "PUT",
"operationId": "updateInventoryItem",
"summary": "Update inventory item",
"description": "Updates an existing inventory item",
"tags": [
"Inventory"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "ID of the inventory item to update"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"properties": {
"inventoryType": {
"type": "string",
"example": "Medication"
},
"item_name": {
"type": "string",
"example": "Aspirin 325mg"
},
"price": {
"type": "number",
"format": "float",
"example": 10.99
},
"expirationDate": {
"type": "string",
"format": "date",
"example": "2023-12-31"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/InventoryItem"
},
"message": {
"type": "string",
"example": "Inventory updated sucessfully!"
}
},
"type": "object"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "This action is unauthorized"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "The given data was invalid."
},
"errors": {
"properties": {
"item_name": {
"type": "array",
"items": {
"type": "string",
"example": "The item name field is required."
}
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "inventory",
"toolName": "provider_update_update_inventory",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"format": "int64",
"required": true,
"description": "ID of the inventory item to update"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"inventoryType": {
"type": "string",
"example": "Medication"
},
"item_name": {
"type": "string",
"example": "Aspirin 325mg"
},
"price": {
"type": "number",
"format": "float",
"example": 10.99
},
"expirationDate": {
"type": "string",
"format": "date",
"example": "2023-12-31"
}
},
"type": "object"
},
"properties": {
"inventoryType": {
"type": "string",
"description": "inventoryType property",
"example": "Medication",
"required": false
},
"item_name": {
"type": "string",
"description": "item_name property",
"example": "Aspirin 325mg",
"required": false
},
"price": {
"type": "number",
"format": "float",
"description": "price property",
"example": 10.99,
"required": false
},
"expirationDate": {
"type": "string",
"format": "date",
"description": "expirationDate property",
"example": "2023-12-31",
"required": false
}
},
"required": []
}
}
},
"responseSchema": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/InventoryItem"
},
"message": {
"type": "string",
"example": "Inventory updated sucessfully!"
}
},
"type": "object"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "This action is unauthorized"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "The given data was invalid."
},
"errors": {
"properties": {
"item_name": {
"type": "array",
"items": {
"type": "string",
"example": "The item name field is required."
}
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_update_update_inventory",
"detailedDescription": "Update inventory item"
}
},
{
"toolName": "provider_delete_delete_inventory",
"method": "DELETE",
"path": "/delete-inventory/{id}",
"description": "Delete inventory item",
"category": "inventory",
"parameters": "**Required:** id (integer) - ID of the inventory item to delete",
"operationId": "deleteInventoryItem",
"tags": [
"Inventory"
],
"endpoint": {
"path": "/delete-inventory/{id}",
"method": "DELETE",
"operationId": "deleteInventoryItem",
"summary": "Delete inventory item",
"description": "Deletes an existing inventory item",
"tags": [
"Inventory"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "ID of the inventory item to delete"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Inventory deleted successfully"
},
"data": {
"$ref": "#/components/schemas/InventoryItem"
}
},
"type": "object"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "This action is unauthorized"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Inventory item not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Inventory item not found"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Error deleting inventory: {error message}"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "inventory",
"toolName": "provider_delete_delete_inventory",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"format": "int64",
"required": true,
"description": "ID of the inventory item to delete"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Inventory deleted successfully"
},
"data": {
"$ref": "#/components/schemas/InventoryItem"
}
},
"type": "object"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "This action is unauthorized"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Inventory item not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Inventory item not found"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Error deleting inventory: {error message}"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_delete_delete_inventory",
"detailedDescription": "Delete inventory item"
}
},
{
"toolName": "provider_get_locations",
"method": "GET",
"path": "/api/locations",
"description": "Get all locations",
"category": "locations",
"parameters": "**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)",
"operationId": "getLocations",
"tags": [
"Locations"
],
"endpoint": {
"path": "/api/locations",
"method": "GET",
"operationId": "getLocations",
"summary": "Get all locations",
"description": "Retrieves all facility locations for the current provider with pagination support via DataTables",
"tags": [
"Locations"
],
"parameters": [
{
"name": "draw",
"in": "query",
"required": false,
"type": "integer",
"description": "DataTables draw counter"
},
{
"name": "start",
"in": "query",
"required": false,
"type": "integer",
"description": "DataTables start offset"
},
{
"name": "length",
"in": "query",
"required": false,
"type": "integer",
"description": "DataTables page length"
},
{
"name": "search[value]",
"in": "query",
"required": false,
"type": "string",
"description": "DataTables search value"
},
{
"name": "order[0][column]",
"in": "query",
"required": false,
"type": "integer",
"description": "DataTables column index for ordering"
},
{
"name": "order[0][dir]",
"in": "query",
"required": false,
"type": "string",
"description": "DataTables order direction (asc/desc)"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"draw": {
"type": "integer",
"example": 1
},
"recordsTotal": {
"type": "integer",
"example": 10
},
"recordsFiltered": {
"type": "integer",
"example": 10
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Main Clinic"
},
"facility_npi": {
"type": "string",
"example": "1234567890"
},
"phone": {
"type": "string",
"example": "1234567890"
},
"street": {
"type": "string",
"example": "123 Main St"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"postal_code": {
"type": "string",
"example": "10001"
},
"country_code": {
"type": "string",
"example": "US"
},
"provider_id": {
"type": "integer",
"example": 42
},
"uuid": {
"type": "string",
"example": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "locations",
"toolName": "provider_get_locations",
"completeParameters": {
"draw": {
"name": "draw",
"in": "query",
"type": "integer",
"required": false,
"description": "DataTables draw counter"
},
"start": {
"name": "start",
"in": "query",
"type": "integer",
"required": false,
"description": "DataTables start offset"
},
"length": {
"name": "length",
"in": "query",
"type": "integer",
"required": false,
"description": "DataTables page length"
},
"search[value]": {
"name": "search[value]",
"in": "query",
"type": "string",
"required": false,
"description": "DataTables search value"
},
"order[0][column]": {
"name": "order[0][column]",
"in": "query",
"type": "integer",
"required": false,
"description": "DataTables column index for ordering"
},
"order[0][dir]": {
"name": "order[0][dir]",
"in": "query",
"type": "string",
"required": false,
"description": "DataTables order direction (asc/desc)",
"enum": [
"asc",
"desc"
]
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"draw": {
"type": "integer",
"example": 1
},
"recordsTotal": {
"type": "integer",
"example": 10
},
"recordsFiltered": {
"type": "integer",
"example": 10
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Main Clinic"
},
"facility_npi": {
"type": "string",
"example": "1234567890"
},
"phone": {
"type": "string",
"example": "1234567890"
},
"street": {
"type": "string",
"example": "123 Main St"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"postal_code": {
"type": "string",
"example": "10001"
},
"country_code": {
"type": "string",
"example": "US"
},
"provider_id": {
"type": "integer",
"example": 42
},
"uuid": {
"type": "string",
"example": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
}
},
"exactToolName": "provider_get_locations",
"detailedDescription": "Get all locations"
}
},
{
"toolName": "provider_get_location",
"method": "GET",
"path": "/api/location/{id}",
"description": "Get a location by ID",
"category": "locations",
"parameters": "**Required:** id (integer) - ID of the location to retrieve",
"operationId": "getLocationById",
"tags": [
"Locations"
],
"endpoint": {
"path": "/api/location/{id}",
"method": "GET",
"operationId": "getLocationById",
"summary": "Get a location by ID",
"description": "Retrieves a specific location by its ID",
"tags": [
"Locations"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "ID of the location to retrieve"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Main Clinic"
},
"facility_npi": {
"type": "string",
"example": "1234567890"
},
"phone": {
"type": "string",
"example": "1234567890"
},
"street": {
"type": "string",
"example": "123 Main St"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"postal_code": {
"type": "string",
"example": "10001"
},
"country_code": {
"type": "string",
"example": "US"
},
"provider_id": {
"type": "integer",
"example": 42
},
"uuid": {
"type": "string",
"format": "uuid",
"example": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"404": {
"description": "Location not found"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "locations",
"toolName": "provider_get_location",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "ID of the location to retrieve"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Main Clinic"
},
"facility_npi": {
"type": "string",
"example": "1234567890"
},
"phone": {
"type": "string",
"example": "1234567890"
},
"street": {
"type": "string",
"example": "123 Main St"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"postal_code": {
"type": "string",
"example": "10001"
},
"country_code": {
"type": "string",
"example": "US"
},
"provider_id": {
"type": "integer",
"example": 42
},
"uuid": {
"type": "string",
"format": "uuid",
"example": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"404": {
"description": "Location not found",
"content": {}
}
},
"exactToolName": "provider_get_location",
"detailedDescription": "Get a location by ID"
}
},
{
"toolName": "provider_get_get_location",
"method": "GET",
"path": "/api/get-location/{uuid}",
"description": "Get a location by UUID",
"category": "locations",
"parameters": "**Required:** uuid (string) - UUID of the location to retrieve",
"operationId": "getLocationByUuid",
"tags": [
"Locations"
],
"endpoint": {
"path": "/api/get-location/{uuid}",
"method": "GET",
"operationId": "getLocationByUuid",
"summary": "Get a location by UUID",
"description": "Retrieves a specific location by its UUID (compatibility with PatientController)",
"tags": [
"Locations"
],
"parameters": [
{
"name": "uuid",
"in": "path",
"required": true,
"type": "string",
"description": "UUID of the location to retrieve"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Main Clinic"
},
"facility_npi": {
"type": "string",
"example": "1234567890"
},
"phone": {
"type": "string",
"example": "1234567890"
},
"street": {
"type": "string",
"example": "123 Main St"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"postal_code": {
"type": "string",
"example": "10001"
},
"country_code": {
"type": "string",
"example": "US"
},
"provider_id": {
"type": "integer",
"example": 42
},
"uuid": {
"type": "string",
"format": "uuid",
"example": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"404": {
"description": "Location not found"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "locations",
"toolName": "provider_get_get_location",
"completeParameters": {
"uuid": {
"name": "uuid",
"in": "path",
"type": "string",
"format": "uuid",
"required": true,
"description": "UUID of the location to retrieve"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Main Clinic"
},
"facility_npi": {
"type": "string",
"example": "1234567890"
},
"phone": {
"type": "string",
"example": "1234567890"
},
"street": {
"type": "string",
"example": "123 Main St"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"postal_code": {
"type": "string",
"example": "10001"
},
"country_code": {
"type": "string",
"example": "US"
},
"provider_id": {
"type": "integer",
"example": 42
},
"uuid": {
"type": "string",
"format": "uuid",
"example": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"404": {
"description": "Location not found",
"content": {}
}
},
"exactToolName": "provider_get_get_location",
"detailedDescription": "Get a location by UUID"
}
},
{
"toolName": "provider_create_add_location",
"method": "POST",
"path": "/api/add-location",
"description": "Add a new location",
"category": "locations",
"parameters": "**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",
"operationId": "addLocation",
"tags": [
"Locations"
],
"endpoint": {
"path": "/api/add-location",
"method": "POST",
"operationId": "addLocation",
"summary": "Add a new location",
"description": "Creates a new facility location",
"tags": [
"Locations"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"name",
"npiNumber",
"phoneNumber",
"address",
"city",
"state",
"zipcode",
"country"
],
"properties": {
"name": {
"type": "string",
"example": "Main Clinic"
},
"npiNumber": {
"type": "string",
"example": "1234567890"
},
"phoneNumber": {
"type": "string",
"example": "(123) 456-7890"
},
"address": {
"type": "string",
"example": "123 Main St"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"zipcode": {
"type": "string",
"example": "10001"
},
"country": {
"type": "string",
"example": "US"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Location created successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Location added successfully"
},
"data": {
"properties": {
"name": {
"type": "string",
"example": "Main Clinic"
},
"facility_npi": {
"type": "string",
"example": "1234567890"
},
"phone": {
"type": "string",
"example": "1234567890"
},
"street": {
"type": "string",
"example": "123 Main St"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"postal_code": {
"type": "string",
"example": "10001"
},
"country_code": {
"type": "string",
"example": "US"
},
"provider_id": {
"type": "integer",
"example": 42
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"422": {
"description": "Validation error"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "locations",
"toolName": "provider_create_add_location",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"name",
"npiNumber",
"phoneNumber",
"address",
"city",
"state",
"zipcode",
"country"
],
"properties": {
"name": {
"type": "string",
"example": "Main Clinic"
},
"npiNumber": {
"type": "string",
"example": "1234567890"
},
"phoneNumber": {
"type": "string",
"example": "(123) 456-7890"
},
"address": {
"type": "string",
"example": "123 Main St"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"zipcode": {
"type": "string",
"example": "10001"
},
"country": {
"type": "string",
"example": "US"
}
},
"type": "object"
},
"properties": {
"name": {
"type": "string",
"description": "name property",
"example": "Main Clinic",
"required": true
},
"npiNumber": {
"type": "string",
"description": "npiNumber property",
"example": "1234567890",
"required": true
},
"phoneNumber": {
"type": "string",
"description": "phoneNumber property",
"example": "(123) 456-7890",
"required": true
},
"address": {
"type": "string",
"description": "address property",
"example": "123 Main St",
"required": true
},
"city": {
"type": "string",
"description": "city property",
"example": "New York",
"required": true
},
"state": {
"type": "string",
"description": "state property",
"example": "NY",
"required": true
},
"zipcode": {
"type": "string",
"description": "zipcode property",
"example": "10001",
"required": true
},
"country": {
"type": "string",
"description": "country property",
"example": "US",
"required": true
}
},
"required": [
"name",
"npiNumber",
"phoneNumber",
"address",
"city",
"state",
"zipcode",
"country"
]
}
}
},
"responseSchema": {
"201": {
"description": "Location created successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Location added successfully"
},
"data": {
"properties": {
"name": {
"type": "string",
"example": "Main Clinic"
},
"facility_npi": {
"type": "string",
"example": "1234567890"
},
"phone": {
"type": "string",
"example": "1234567890"
},
"street": {
"type": "string",
"example": "123 Main St"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"postal_code": {
"type": "string",
"example": "10001"
},
"country_code": {
"type": "string",
"example": "US"
},
"provider_id": {
"type": "integer",
"example": 42
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"422": {
"description": "Validation error",
"content": {}
}
},
"exactToolName": "provider_create_add_location",
"detailedDescription": "Add a new location"
}
},
{
"toolName": "provider_update_update_location",
"method": "PUT",
"path": "/api/update-location/{id}",
"description": "Update a location by ID",
"category": "locations",
"parameters": "**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",
"operationId": "updateLocation",
"tags": [
"Locations"
],
"endpoint": {
"path": "/api/update-location/{id}",
"method": "PUT",
"operationId": "updateLocation",
"summary": "Update a location by ID",
"description": "Updates an existing facility location by ID",
"tags": [
"Locations"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "ID of the location to update"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"name",
"npiNumber",
"phoneNumber",
"address",
"city",
"state",
"zipcode",
"country"
],
"properties": {
"name": {
"type": "string",
"example": "Updated Clinic Name"
},
"npiNumber": {
"type": "string",
"example": "1234567890"
},
"phoneNumber": {
"type": "string",
"example": "(123) 456-7890"
},
"address": {
"type": "string",
"example": "123 Main St"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"zipcode": {
"type": "string",
"example": "10001"
},
"country": {
"type": "string",
"example": "US"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Location updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Location updated successfully"
},
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"404": {
"description": "Location not found"
},
"422": {
"description": "Validation error"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "locations",
"toolName": "provider_update_update_location",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "ID of the location to update"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"name",
"npiNumber",
"phoneNumber",
"address",
"city",
"state",
"zipcode",
"country"
],
"properties": {
"name": {
"type": "string",
"example": "Updated Clinic Name"
},
"npiNumber": {
"type": "string",
"example": "1234567890"
},
"phoneNumber": {
"type": "string",
"example": "(123) 456-7890"
},
"address": {
"type": "string",
"example": "123 Main St"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"zipcode": {
"type": "string",
"example": "10001"
},
"country": {
"type": "string",
"example": "US"
}
},
"type": "object"
},
"properties": {
"name": {
"type": "string",
"description": "name property",
"example": "Updated Clinic Name",
"required": true
},
"npiNumber": {
"type": "string",
"description": "npiNumber property",
"example": "1234567890",
"required": true
},
"phoneNumber": {
"type": "string",
"description": "phoneNumber property",
"example": "(123) 456-7890",
"required": true
},
"address": {
"type": "string",
"description": "address property",
"example": "123 Main St",
"required": true
},
"city": {
"type": "string",
"description": "city property",
"example": "New York",
"required": true
},
"state": {
"type": "string",
"description": "state property",
"example": "NY",
"required": true
},
"zipcode": {
"type": "string",
"description": "zipcode property",
"example": "10001",
"required": true
},
"country": {
"type": "string",
"description": "country property",
"example": "US",
"required": true
}
},
"required": [
"name",
"npiNumber",
"phoneNumber",
"address",
"city",
"state",
"zipcode",
"country"
]
}
}
},
"responseSchema": {
"201": {
"description": "Location updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Location updated successfully"
},
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"404": {
"description": "Location not found",
"content": {}
},
"422": {
"description": "Validation error",
"content": {}
}
},
"exactToolName": "provider_update_update_location",
"detailedDescription": "Update a location by ID"
}
},
{
"toolName": "provider_update_update_location",
"method": "PUT",
"path": "/api/update-location/{uuid}",
"description": "Update a location by UUID",
"category": "locations",
"parameters": "**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",
"operationId": "updateLocationByUuid",
"tags": [
"Locations"
],
"endpoint": {
"path": "/api/update-location/{uuid}",
"method": "PUT",
"operationId": "updateLocationByUuid",
"summary": "Update a location by UUID",
"description": "Updates an existing facility location by UUID (compatibility with PatientController)",
"tags": [
"Locations"
],
"parameters": [
{
"name": "uuid",
"in": "path",
"required": true,
"type": "string",
"description": "UUID of the location to update"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"name",
"npiNumber",
"phoneNumber",
"address",
"city",
"state",
"zipcode",
"country"
],
"properties": {
"name": {
"type": "string",
"example": "Updated Clinic Name"
},
"npiNumber": {
"type": "string",
"example": "1234567890"
},
"phoneNumber": {
"type": "string",
"example": "(123) 456-7890"
},
"address": {
"type": "string",
"example": "123 Main St"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"zipcode": {
"type": "string",
"example": "10001"
},
"country": {
"type": "string",
"example": "US"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Location updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Location updated successfully"
},
"data": {
"properties": {
"name": {
"type": "string",
"example": "Updated Clinic Name"
},
"facility_npi": {
"type": "string",
"example": "1234567890"
},
"phone": {
"type": "string",
"example": "1234567890"
},
"street": {
"type": "string",
"example": "123 Main St"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"postal_code": {
"type": "string",
"example": "10001"
},
"country_code": {
"type": "string",
"example": "US"
},
"uuid": {
"type": "string",
"format": "uuid",
"example": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"404": {
"description": "Location not found"
},
"422": {
"description": "Validation error"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "locations",
"toolName": "provider_update_update_location",
"completeParameters": {
"uuid": {
"name": "uuid",
"in": "path",
"type": "string",
"format": "uuid",
"required": true,
"description": "UUID of the location to update"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"name",
"npiNumber",
"phoneNumber",
"address",
"city",
"state",
"zipcode",
"country"
],
"properties": {
"name": {
"type": "string",
"example": "Updated Clinic Name"
},
"npiNumber": {
"type": "string",
"example": "1234567890"
},
"phoneNumber": {
"type": "string",
"example": "(123) 456-7890"
},
"address": {
"type": "string",
"example": "123 Main St"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"zipcode": {
"type": "string",
"example": "10001"
},
"country": {
"type": "string",
"example": "US"
}
},
"type": "object"
},
"properties": {
"name": {
"type": "string",
"description": "name property",
"example": "Updated Clinic Name",
"required": true
},
"npiNumber": {
"type": "string",
"description": "npiNumber property",
"example": "1234567890",
"required": true
},
"phoneNumber": {
"type": "string",
"description": "phoneNumber property",
"example": "(123) 456-7890",
"required": true
},
"address": {
"type": "string",
"description": "address property",
"example": "123 Main St",
"required": true
},
"city": {
"type": "string",
"description": "city property",
"example": "New York",
"required": true
},
"state": {
"type": "string",
"description": "state property",
"example": "NY",
"required": true
},
"zipcode": {
"type": "string",
"description": "zipcode property",
"example": "10001",
"required": true
},
"country": {
"type": "string",
"description": "country property",
"example": "US",
"required": true
}
},
"required": [
"name",
"npiNumber",
"phoneNumber",
"address",
"city",
"state",
"zipcode",
"country"
]
}
}
},
"responseSchema": {
"201": {
"description": "Location updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Location updated successfully"
},
"data": {
"properties": {
"name": {
"type": "string",
"example": "Updated Clinic Name"
},
"facility_npi": {
"type": "string",
"example": "1234567890"
},
"phone": {
"type": "string",
"example": "1234567890"
},
"street": {
"type": "string",
"example": "123 Main St"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"postal_code": {
"type": "string",
"example": "10001"
},
"country_code": {
"type": "string",
"example": "US"
},
"uuid": {
"type": "string",
"format": "uuid",
"example": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"404": {
"description": "Location not found",
"content": {}
},
"422": {
"description": "Validation error",
"content": {}
}
},
"exactToolName": "provider_update_update_location",
"detailedDescription": "Update a location by UUID"
}
},
{
"toolName": "provider_create_medical_problems_store",
"method": "POST",
"path": "/api/medical-problems-store/{pid}",
"description": "Add a new medical problem for a patient",
"category": "medical_records",
"parameters": "**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",
"operationId": "storeMedicalProblem",
"tags": [
"Medical Problems"
],
"endpoint": {
"path": "/api/medical-problems-store/{pid}",
"method": "POST",
"operationId": "storeMedicalProblem",
"summary": "Add a new medical problem for a patient",
"description": "Creates a new medical problem record associated with a specific patient",
"tags": [
"Medical Problems"
],
"parameters": [
{
"name": "pid",
"in": "path",
"required": true,
"type": "integer",
"description": "ID of the patient"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"name",
"lastDate",
"nextDate",
"screeningDetails",
"flag",
"typeOfItem"
],
"properties": {
"name": {
"type": "string",
"example": "Hypertension"
},
"lastDate": {
"type": "string",
"format": "date",
"example": "2025-06-01"
},
"nextDate": {
"type": "string",
"format": "date",
"example": "2025-09-01"
},
"screeningDetails": {
"type": "string",
"example": "Patient has stage 1 hypertension"
},
"flag": {
"description": "Status flag for the medical problem",
"type": "string",
"example": "active"
},
"typeOfItem": {
"description": "Type of medical problem",
"type": "string",
"example": "chronic"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Medical problem created successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object"
},
"message": {
"type": "string",
"example": "Medical Problem Created Successfully!"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "The given data was invalid."
},
"errors": {
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "medical_records",
"toolName": "provider_create_medical_problems_store",
"completeParameters": {
"pid": {
"name": "pid",
"in": "path",
"type": "integer",
"required": true,
"description": "ID of the patient"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"name",
"lastDate",
"nextDate",
"screeningDetails",
"flag",
"typeOfItem"
],
"properties": {
"name": {
"type": "string",
"example": "Hypertension"
},
"lastDate": {
"type": "string",
"format": "date",
"example": "2025-06-01"
},
"nextDate": {
"type": "string",
"format": "date",
"example": "2025-09-01"
},
"screeningDetails": {
"type": "string",
"example": "Patient has stage 1 hypertension"
},
"flag": {
"description": "Status flag for the medical problem",
"type": "string",
"example": "active"
},
"typeOfItem": {
"description": "Type of medical problem",
"type": "string",
"example": "chronic"
}
},
"type": "object"
},
"properties": {
"name": {
"type": "string",
"description": "name property",
"example": "Hypertension",
"required": true
},
"lastDate": {
"type": "string",
"format": "date",
"description": "lastDate property",
"example": "2025-06-01",
"required": true
},
"nextDate": {
"type": "string",
"format": "date",
"description": "nextDate property",
"example": "2025-09-01",
"required": true
},
"screeningDetails": {
"type": "string",
"description": "screeningDetails property",
"example": "Patient has stage 1 hypertension",
"required": true
},
"flag": {
"type": "string",
"description": "Status flag for the medical problem",
"example": "active",
"required": true
},
"typeOfItem": {
"type": "string",
"description": "Type of medical problem",
"example": "chronic",
"required": true
}
},
"required": [
"name",
"lastDate",
"nextDate",
"screeningDetails",
"flag",
"typeOfItem"
]
}
}
},
"responseSchema": {
"200": {
"description": "Medical problem created successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object"
},
"message": {
"type": "string",
"example": "Medical Problem Created Successfully!"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "The given data was invalid."
},
"errors": {
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_medical_problems_store",
"detailedDescription": "Add a new medical problem for a patient"
}
},
{
"toolName": "provider_update_medical_problems_update",
"method": "PUT",
"path": "/api/medical-problems-update/{id}",
"description": "Update an existing medical problem",
"category": "medical_records",
"parameters": "**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",
"operationId": "updateMedicalProblemRecord",
"tags": [
"Medical Problems"
],
"endpoint": {
"path": "/api/medical-problems-update/{id}",
"method": "PUT",
"operationId": "updateMedicalProblemRecord",
"summary": "Update an existing medical problem",
"description": "Updates the details of an existing medical problem",
"tags": [
"Medical Problems"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "ID of the medical problem to update"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"name",
"lastDate",
"nextDate",
"screeningDetails",
"flag",
"typeOfItem",
"medical_problem_id"
],
"properties": {
"name": {
"type": "string",
"example": "Updated Hypertension"
},
"lastDate": {
"type": "string",
"format": "date",
"example": "2025-06-15"
},
"nextDate": {
"type": "string",
"format": "date",
"example": "2025-09-15"
},
"screeningDetails": {
"type": "string",
"example": "Patient has controlled stage 1 hypertension"
},
"flag": {
"description": "Status flag for the medical problem",
"type": "string",
"example": "active"
},
"typeOfItem": {
"description": "Type of medical problem",
"type": "string",
"example": "chronic"
},
"medical_problem_id": {
"description": "ID of the medical problem",
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Medical problem updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "integer",
"example": 1
},
"message": {
"type": "string",
"example": "Medical Problem Updated Successfully!"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"404": {
"description": "Medical problem not found"
},
"422": {
"description": "Validation error"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "medical_records",
"toolName": "provider_update_medical_problems_update",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "ID of the medical problem to update"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"name",
"lastDate",
"nextDate",
"screeningDetails",
"flag",
"typeOfItem",
"medical_problem_id"
],
"properties": {
"name": {
"type": "string",
"example": "Updated Hypertension"
},
"lastDate": {
"type": "string",
"format": "date",
"example": "2025-06-15"
},
"nextDate": {
"type": "string",
"format": "date",
"example": "2025-09-15"
},
"screeningDetails": {
"type": "string",
"example": "Patient has controlled stage 1 hypertension"
},
"flag": {
"description": "Status flag for the medical problem",
"type": "string",
"example": "active"
},
"typeOfItem": {
"description": "Type of medical problem",
"type": "string",
"example": "chronic"
},
"medical_problem_id": {
"description": "ID of the medical problem",
"type": "integer",
"example": 1
}
},
"type": "object"
},
"properties": {
"name": {
"type": "string",
"description": "name property",
"example": "Updated Hypertension",
"required": true
},
"lastDate": {
"type": "string",
"format": "date",
"description": "lastDate property",
"example": "2025-06-15",
"required": true
},
"nextDate": {
"type": "string",
"format": "date",
"description": "nextDate property",
"example": "2025-09-15",
"required": true
},
"screeningDetails": {
"type": "string",
"description": "screeningDetails property",
"example": "Patient has controlled stage 1 hypertension",
"required": true
},
"flag": {
"type": "string",
"description": "Status flag for the medical problem",
"example": "active",
"required": true
},
"typeOfItem": {
"type": "string",
"description": "Type of medical problem",
"example": "chronic",
"required": true
},
"medical_problem_id": {
"type": "integer",
"description": "ID of the medical problem",
"example": 1,
"required": true
}
},
"required": [
"name",
"lastDate",
"nextDate",
"screeningDetails",
"flag",
"typeOfItem",
"medical_problem_id"
]
}
}
},
"responseSchema": {
"200": {
"description": "Medical problem updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "integer",
"example": 1
},
"message": {
"type": "string",
"example": "Medical Problem Updated Successfully!"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"404": {
"description": "Medical problem not found",
"content": {}
},
"422": {
"description": "Validation error",
"content": {}
}
},
"exactToolName": "provider_update_medical_problems_update",
"detailedDescription": "Update an existing medical problem"
}
},
{
"toolName": "provider_get_medical_problem",
"method": "GET",
"path": "/api/medical-problem/{id}",
"description": "Get a medical problem by ID",
"category": "medical_records",
"parameters": "**Required:** id (integer) - ID of the medical problem to retrieve",
"operationId": "getMedicalProblemById",
"tags": [
"Medical Problems"
],
"endpoint": {
"path": "/api/medical-problem/{id}",
"method": "GET",
"operationId": "getMedicalProblemById",
"summary": "Get a medical problem by ID",
"description": "Retrieves the details of a specific medical problem by its ID",
"tags": [
"Medical Problems"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "ID of the medical problem to retrieve"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"medical_prob_id": {
"type": "integer",
"example": 1
},
"title": {
"type": "string",
"example": "Hypertension"
},
"date": {
"type": "string",
"format": "date",
"example": "2025-06-01"
},
"begdate": {
"type": "string",
"format": "date",
"example": "2025-06-01"
},
"enddate": {
"type": "string",
"format": "date",
"example": "2025-09-01"
},
"screening_detail": {
"type": "string",
"example": "Patient has stage 1 hypertension"
},
"flag": {
"type": "string",
"example": "active"
},
"type_of_item": {
"type": "string",
"example": "chronic"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"404": {
"description": "Medical problem not found"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "medical_records",
"toolName": "provider_get_medical_problem",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "ID of the medical problem to retrieve"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"medical_prob_id": {
"type": "integer",
"example": 1
},
"title": {
"type": "string",
"example": "Hypertension"
},
"date": {
"type": "string",
"format": "date",
"example": "2025-06-01"
},
"begdate": {
"type": "string",
"format": "date",
"example": "2025-06-01"
},
"enddate": {
"type": "string",
"format": "date",
"example": "2025-09-01"
},
"screening_detail": {
"type": "string",
"example": "Patient has stage 1 hypertension"
},
"flag": {
"type": "string",
"example": "active"
},
"type_of_item": {
"type": "string",
"example": "chronic"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"404": {
"description": "Medical problem not found",
"content": {}
}
},
"exactToolName": "provider_get_medical_problem",
"detailedDescription": "Get a medical problem by ID"
}
},
{
"toolName": "provider_create_add_phone_log",
"method": "POST",
"path": "/add-phone-log/{patient_id}",
"description": "Add a new phone log for a patient",
"category": "phone_logs",
"parameters": "**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",
"operationId": "addPhoneLog",
"tags": [
"Phone Logs"
],
"endpoint": {
"path": "/add-phone-log/{patient_id}",
"method": "POST",
"operationId": "addPhoneLog",
"summary": "Add a new phone log for a patient",
"description": "Records a new phone call log entry for a specific patient",
"tags": [
"Phone Logs"
],
"parameters": [
{
"name": "patient_id",
"in": "path",
"required": true,
"type": "integer",
"description": "ID of the patient"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"provider",
"message",
"user_id"
],
"properties": {
"provider": {
"description": "Name of the provider who made/received the call",
"type": "string",
"example": "Dr. Smith"
},
"message": {
"description": "Details about the phone call",
"type": "string",
"example": "Discussed medication changes"
},
"user_id": {
"description": "ID of the user who logged the call",
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Phone log added successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"provider": {
"type": "string",
"example": "Dr. Smith"
},
"message": {
"type": "string",
"example": "Discussed medication changes"
},
"user_id": {
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
}
},
"403": {
"description": "Unauthorized access",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "This action is unauthorized."
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "An error occurred while adding phone log"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "phone_logs",
"toolName": "provider_create_add_phone_log",
"completeParameters": {
"patient_id": {
"name": "patient_id",
"in": "path",
"type": "integer",
"format": "int64",
"required": true,
"description": "ID of the patient"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"provider",
"message",
"user_id"
],
"properties": {
"provider": {
"description": "Name of the provider who made/received the call",
"type": "string",
"example": "Dr. Smith"
},
"message": {
"description": "Details about the phone call",
"type": "string",
"example": "Discussed medication changes"
},
"user_id": {
"description": "ID of the user who logged the call",
"type": "integer",
"example": 1
}
},
"type": "object"
},
"properties": {
"provider": {
"type": "string",
"description": "Name of the provider who made/received the call",
"example": "Dr. Smith",
"required": true
},
"message": {
"type": "string",
"description": "Details about the phone call",
"example": "Discussed medication changes",
"required": true
},
"user_id": {
"type": "integer",
"description": "ID of the user who logged the call",
"example": 1,
"required": true
}
},
"required": [
"provider",
"message",
"user_id"
]
}
}
},
"responseSchema": {
"200": {
"description": "Phone log added successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"provider": {
"type": "string",
"example": "Dr. Smith"
},
"message": {
"type": "string",
"example": "Discussed medication changes"
},
"user_id": {
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
}
},
"403": {
"description": "Unauthorized access",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "This action is unauthorized."
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "An error occurred while adding phone log"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_add_phone_log",
"detailedDescription": "Add a new phone log for a patient"
}
},
{
"toolName": "provider_get_phone_log_list",
"method": "GET",
"path": "/phone-log-list/{patient_id}",
"description": "Get phone logs for a patient",
"category": "phone_logs",
"parameters": "**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",
"operationId": "getPhoneLogList",
"tags": [
"Phone Logs"
],
"endpoint": {
"path": "/phone-log-list/{patient_id}",
"method": "GET",
"operationId": "getPhoneLogList",
"summary": "Get phone logs for a patient",
"description": "Retrieves all phone logs for a specific patient in DataTables format",
"tags": [
"Phone Logs"
],
"parameters": [
{
"name": "patient_id",
"in": "path",
"required": true,
"type": "integer",
"description": "ID of the patient"
},
{
"name": "draw",
"in": "query",
"required": false,
"type": "integer",
"description": "Draw counter for DataTables"
},
{
"name": "start",
"in": "query",
"required": false,
"type": "integer",
"description": "Paging first record indicator for DataTables"
},
{
"name": "length",
"in": "query",
"required": false,
"type": "integer",
"description": "Number of records per page for DataTables"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Phone logs retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"draw": {
"type": "integer",
"example": 1
},
"recordsTotal": {
"type": "integer",
"example": 10
},
"recordsFiltered": {
"type": "integer",
"example": 10
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"provider": {
"type": "string",
"example": "Dr. Smith"
},
"message": {
"type": "string",
"example": "Discussed medication changes"
},
"patient_id": {
"type": "integer",
"example": 123
},
"date": {
"type": "string",
"format": "date-time",
"example": "2023-01-01 12:00:00"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"403": {
"description": "Unauthorized access",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "This action is unauthorized."
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "phone_logs",
"toolName": "provider_get_phone_log_list",
"completeParameters": {
"patient_id": {
"name": "patient_id",
"in": "path",
"type": "integer",
"format": "int64",
"required": true,
"description": "ID of the patient"
},
"draw": {
"name": "draw",
"in": "query",
"type": "integer",
"required": false,
"description": "Draw counter for DataTables"
},
"start": {
"name": "start",
"in": "query",
"type": "integer",
"required": false,
"description": "Paging first record indicator for DataTables"
},
"length": {
"name": "length",
"in": "query",
"type": "integer",
"required": false,
"description": "Number of records per page for DataTables"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Phone logs retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"draw": {
"type": "integer",
"example": 1
},
"recordsTotal": {
"type": "integer",
"example": 10
},
"recordsFiltered": {
"type": "integer",
"example": 10
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"provider": {
"type": "string",
"example": "Dr. Smith"
},
"message": {
"type": "string",
"example": "Discussed medication changes"
},
"patient_id": {
"type": "integer",
"example": 123
},
"date": {
"type": "string",
"format": "date-time",
"example": "2023-01-01 12:00:00"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"403": {
"description": "Unauthorized access",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "This action is unauthorized."
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_phone_log_list",
"detailedDescription": "Get phone logs for a patient"
}
},
{
"toolName": "provider_create_plans_product_sync",
"method": "POST",
"path": "/api/plans-product-sync",
"description": "Save multiple products",
"category": "products",
"parameters": "**Required:** builder_id (string) - Base64 encoded builder ID, **Required:** products (array) - products property",
"operationId": "syncProducts",
"tags": [
"Product Sync"
],
"endpoint": {
"path": "/api/plans-product-sync",
"method": "POST",
"operationId": "syncProducts",
"summary": "Save multiple products",
"description": "Save or update multiple products and their categories",
"tags": [
"Product Sync"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"builder_id",
"products"
],
"properties": {
"builder_id": {
"description": "Base64 encoded builder ID",
"type": "string",
"example": "MQ=="
},
"products": {
"type": "array",
"items": {
"properties": {
"product_id": {
"type": "integer",
"example": 123
},
"product_name": {
"type": "string",
"example": "Test Product"
},
"product_price": {
"type": "number",
"format": "float",
"example": 29.99
},
"product_slug": {
"type": "string",
"example": "test-product"
},
"product_category": {
"properties": {
"id": {
"type": "array",
"items": {
"type": "integer",
"example": 10
}
},
"name": {
"type": "array",
"items": {
"type": "string",
"example": "Health Products"
}
}
},
"type": "object"
},
"product_variation": {
"type": "array",
"items": {
"properties": {
"variation_id": {
"type": "integer",
"example": 456
},
"display_name": {
"type": "string",
"example": "Small"
},
"price": {
"type": "number",
"format": "float",
"example": 19.99
}
},
"type": "object"
}
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Products saved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "string",
"example": "Product successfully!"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Something went wrong!"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "products",
"toolName": "provider_create_plans_product_sync",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"builder_id",
"products"
],
"properties": {
"builder_id": {
"description": "Base64 encoded builder ID",
"type": "string",
"example": "MQ=="
},
"products": {
"type": "array",
"items": {
"properties": {
"product_id": {
"type": "integer",
"example": 123
},
"product_name": {
"type": "string",
"example": "Test Product"
},
"product_price": {
"type": "number",
"format": "float",
"example": 29.99
},
"product_slug": {
"type": "string",
"example": "test-product"
},
"product_category": {
"properties": {
"id": {
"type": "array",
"items": {
"type": "integer",
"example": 10
}
},
"name": {
"type": "array",
"items": {
"type": "string",
"example": "Health Products"
}
}
},
"type": "object"
},
"product_variation": {
"type": "array",
"items": {
"properties": {
"variation_id": {
"type": "integer",
"example": 456
},
"display_name": {
"type": "string",
"example": "Small"
},
"price": {
"type": "number",
"format": "float",
"example": 19.99
}
},
"type": "object"
}
}
},
"type": "object"
}
}
},
"type": "object"
},
"properties": {
"builder_id": {
"type": "string",
"description": "Base64 encoded builder ID",
"example": "MQ==",
"required": true
},
"products": {
"type": "array",
"description": "products property",
"items": {
"properties": {
"product_id": {
"type": "integer",
"example": 123
},
"product_name": {
"type": "string",
"example": "Test Product"
},
"product_price": {
"type": "number",
"format": "float",
"example": 29.99
},
"product_slug": {
"type": "string",
"example": "test-product"
},
"product_category": {
"properties": {
"id": {
"type": "array",
"items": {
"type": "integer",
"example": 10
}
},
"name": {
"type": "array",
"items": {
"type": "string",
"example": "Health Products"
}
}
},
"type": "object"
},
"product_variation": {
"type": "array",
"items": {
"properties": {
"variation_id": {
"type": "integer",
"example": 456
},
"display_name": {
"type": "string",
"example": "Small"
},
"price": {
"type": "number",
"format": "float",
"example": 19.99
}
},
"type": "object"
}
}
},
"type": "object"
},
"required": true
}
},
"required": [
"builder_id",
"products"
]
}
}
},
"responseSchema": {
"200": {
"description": "Products saved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "string",
"example": "Product successfully!"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Something went wrong!"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_plans_product_sync",
"detailedDescription": "Save multiple products"
}
},
{
"toolName": "provider_create_plans_product_update",
"method": "POST",
"path": "/api/plans-product-update",
"description": "Update product on publish",
"category": "products",
"parameters": "**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",
"operationId": "updateOnPublish",
"tags": [
"Product Sync"
],
"endpoint": {
"path": "/api/plans-product-update",
"method": "POST",
"operationId": "updateOnPublish",
"summary": "Update product on publish",
"description": "Update a product when it is published",
"tags": [
"Product Sync"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"builder_id",
"product_id",
"product_name",
"product_price",
"product_slug",
"product_category"
],
"properties": {
"builder_id": {
"description": "Base64 encoded builder ID",
"type": "string",
"example": "MQ=="
},
"product_id": {
"type": "integer",
"example": 123
},
"product_name": {
"type": "string",
"example": "Test Product"
},
"product_price": {
"type": "number",
"format": "float",
"example": 29.99
},
"product_slug": {
"type": "string",
"example": "test-product"
},
"product_category": {
"properties": {
"id": {
"type": "array",
"items": {
"type": "integer",
"example": 10
}
},
"name": {
"type": "array",
"items": {
"type": "string",
"example": "Health Products"
}
}
},
"type": "object"
},
"product_variation": {
"type": "array",
"items": {
"properties": {
"variation_id": {
"type": "integer",
"example": 456
},
"display_name": {
"type": "string",
"example": "Small"
},
"price": {
"type": "number",
"format": "float",
"example": 19.99
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Product updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "string",
"example": "Product successfully!"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"500": {
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "products",
"toolName": "provider_create_plans_product_update",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"builder_id",
"product_id",
"product_name",
"product_price",
"product_slug",
"product_category"
],
"properties": {
"builder_id": {
"description": "Base64 encoded builder ID",
"type": "string",
"example": "MQ=="
},
"product_id": {
"type": "integer",
"example": 123
},
"product_name": {
"type": "string",
"example": "Test Product"
},
"product_price": {
"type": "number",
"format": "float",
"example": 29.99
},
"product_slug": {
"type": "string",
"example": "test-product"
},
"product_category": {
"properties": {
"id": {
"type": "array",
"items": {
"type": "integer",
"example": 10
}
},
"name": {
"type": "array",
"items": {
"type": "string",
"example": "Health Products"
}
}
},
"type": "object"
},
"product_variation": {
"type": "array",
"items": {
"properties": {
"variation_id": {
"type": "integer",
"example": 456
},
"display_name": {
"type": "string",
"example": "Small"
},
"price": {
"type": "number",
"format": "float",
"example": 19.99
}
},
"type": "object"
}
}
},
"type": "object"
},
"properties": {
"builder_id": {
"type": "string",
"description": "Base64 encoded builder ID",
"example": "MQ==",
"required": true
},
"product_id": {
"type": "integer",
"description": "product_id property",
"example": 123,
"required": true
},
"product_name": {
"type": "string",
"description": "product_name property",
"example": "Test Product",
"required": true
},
"product_price": {
"type": "number",
"format": "float",
"description": "product_price property",
"example": 29.99,
"required": true
},
"product_slug": {
"type": "string",
"description": "product_slug property",
"example": "test-product",
"required": true
},
"product_category": {
"type": "object",
"description": "product_category property",
"properties": {
"id": {
"type": "array",
"description": "id property",
"items": {
"type": "integer",
"example": 10
},
"required": false
},
"name": {
"type": "array",
"description": "name property",
"items": {
"type": "string",
"example": "Health Products"
},
"required": false
}
},
"required": true
},
"product_variation": {
"type": "array",
"description": "product_variation property",
"items": {
"properties": {
"variation_id": {
"type": "integer",
"example": 456
},
"display_name": {
"type": "string",
"example": "Small"
},
"price": {
"type": "number",
"format": "float",
"example": 19.99
}
},
"type": "object"
},
"required": false
}
},
"required": [
"builder_id",
"product_id",
"product_name",
"product_price",
"product_slug",
"product_category"
]
}
}
},
"responseSchema": {
"200": {
"description": "Product updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "string",
"example": "Product successfully!"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"500": {
"description": "Server error",
"content": {}
}
},
"exactToolName": "provider_create_plans_product_update",
"detailedDescription": "Update product on publish"
}
},
{
"toolName": "provider_create_tags_store",
"method": "POST",
"path": "/tags/store/{pid}",
"description": "Store tags for a patient",
"category": "tags",
"parameters": "**Required:** pid (integer) - Patient ID, **Required:** tags (array) - Array of tag names to be associated with the patient",
"operationId": "storeTags",
"tags": [
"Tags"
],
"endpoint": {
"path": "/tags/store/{pid}",
"method": "POST",
"operationId": "storeTags",
"summary": "Store tags for a patient",
"description": "Clears all previous tags and stores new tags for a specific patient",
"tags": [
"Tags"
],
"parameters": [
{
"name": "pid",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"tags"
],
"properties": {
"tags": {
"description": "Array of tag names to be associated with the patient",
"type": "array",
"items": {
"type": "string",
"example": "diabetes"
}
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Tags stored successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Tags stored"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Invalid request data"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "An error occurred while storing tags"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "tags",
"toolName": "provider_create_tags_store",
"completeParameters": {
"pid": {
"name": "pid",
"in": "path",
"type": "integer",
"format": "int64",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"tags"
],
"properties": {
"tags": {
"description": "Array of tag names to be associated with the patient",
"type": "array",
"items": {
"type": "string",
"example": "diabetes"
}
}
},
"type": "object"
},
"properties": {
"tags": {
"type": "array",
"description": "Array of tag names to be associated with the patient",
"items": {
"type": "string",
"example": "diabetes"
},
"required": true
}
},
"required": [
"tags"
]
}
}
},
"responseSchema": {
"200": {
"description": "Tags stored successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Tags stored"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Invalid request data"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "An error occurred while storing tags"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_tags_store",
"detailedDescription": "Store tags for a patient"
}
},
{
"toolName": "provider_create_store_tags",
"method": "POST",
"path": "/store-tags/{patientId}",
"description": "Store tags for a patient (alternate endpoint)",
"category": "tags",
"parameters": "**Required:** patientId (integer) - Patient ID, **Required:** tags (array) - Array of tag names to be associated with the patient",
"operationId": "storeTagsAlternate",
"tags": [
"Tags"
],
"endpoint": {
"path": "/store-tags/{patientId}",
"method": "POST",
"operationId": "storeTagsAlternate",
"summary": "Store tags for a patient (alternate endpoint)",
"description": "Clears all previous tags and stores new tags for a specific patient",
"tags": [
"Tags"
],
"parameters": [
{
"name": "patientId",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"tags"
],
"properties": {
"tags": {
"description": "Array of tag names to be associated with the patient",
"type": "array",
"items": {
"type": "string",
"example": "hypertension"
}
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Tags stored successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Tags stored"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Invalid request data"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "tags",
"toolName": "provider_create_store_tags",
"completeParameters": {
"patientId": {
"name": "patientId",
"in": "path",
"type": "integer",
"format": "int64",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"tags"
],
"properties": {
"tags": {
"description": "Array of tag names to be associated with the patient",
"type": "array",
"items": {
"type": "string",
"example": "hypertension"
}
}
},
"type": "object"
},
"properties": {
"tags": {
"type": "array",
"description": "Array of tag names to be associated with the patient",
"items": {
"type": "string",
"example": "hypertension"
},
"required": true
}
},
"required": [
"tags"
]
}
}
},
"responseSchema": {
"200": {
"description": "Tags stored successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Tags stored"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Invalid request data"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_store_tags",
"detailedDescription": "Store tags for a patient (alternate endpoint)"
}
},
{
"toolName": "provider_get_tags_list",
"method": "GET",
"path": "/tags/list/{pid}",
"description": "Get tags for a patient",
"category": "tags",
"parameters": "**Required:** pid (integer) - Patient ID",
"operationId": "getTags",
"tags": [
"Tags"
],
"endpoint": {
"path": "/tags/list/{pid}",
"method": "GET",
"operationId": "getTags",
"summary": "Get tags for a patient",
"description": "Retrieves all tags associated with a specific patient",
"tags": [
"Tags"
],
"parameters": [
{
"name": "pid",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Tags retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"tags": {
"description": "Array of tag names associated with the patient",
"type": "array",
"items": {
"type": "string",
"example": "diabetes"
}
}
},
"type": "object"
}
}
}
},
"404": {
"description": "No tags found",
"content": {
"application/json": {
"schema": {
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": []
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "An error occurred while retrieving tags"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "tags",
"toolName": "provider_get_tags_list",
"completeParameters": {
"pid": {
"name": "pid",
"in": "path",
"type": "integer",
"format": "int64",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Tags retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"tags": {
"description": "Array of tag names associated with the patient",
"type": "array",
"items": {
"type": "string",
"example": "diabetes"
}
}
},
"type": "object"
}
}
}
},
"404": {
"description": "No tags found",
"content": {
"application/json": {
"schema": {
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": []
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "An error occurred while retrieving tags"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_tags_list",
"detailedDescription": "Get tags for a patient"
}
},
{
"toolName": "provider_create_add_task",
"method": "POST",
"path": "/api/add-task/{patient_id}",
"description": "Add a new task for a patient",
"category": "tasks",
"parameters": "**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",
"operationId": "addTask",
"tags": [
"Tasks"
],
"endpoint": {
"path": "/api/add-task/{patient_id}",
"method": "POST",
"operationId": "addTask",
"summary": "Add a new task for a patient",
"description": "Creates a new task associated with a specific patient",
"tags": [
"Tasks"
],
"parameters": [
{
"name": "patient_id",
"in": "path",
"required": true,
"type": "integer",
"description": "ID of the patient"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"task_title",
"task_body",
"task_due_date",
"task_assigned_to"
],
"properties": {
"task_title": {
"type": "string",
"example": "Complete blood work"
},
"task_body": {
"type": "string",
"example": "Patient needs to complete blood work at local lab"
},
"task_due_date": {
"type": "string",
"format": "date-time",
"example": "2025-07-10 10:00:00"
},
"task_assigned_to": {
"type": "integer",
"example": 5
},
"task_watchers": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
1,
2
]
},
"sendEmailtoPatientApplicationForTask": {
"type": "boolean",
"example": true
},
"task_priority": {
"type": "string",
"enum": [
"low",
"normal",
"high"
],
"example": "normal"
},
"task_status": {
"type": "string",
"enum": [
"pending",
"in_progress",
"completed"
],
"example": "pending"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Task created successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Task added successfully"
},
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"422": {
"description": "Validation error"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "tasks",
"toolName": "provider_create_add_task",
"completeParameters": {
"patient_id": {
"name": "patient_id",
"in": "path",
"type": "integer",
"required": true,
"description": "ID of the patient"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"task_title",
"task_body",
"task_due_date",
"task_assigned_to"
],
"properties": {
"task_title": {
"type": "string",
"example": "Complete blood work"
},
"task_body": {
"type": "string",
"example": "Patient needs to complete blood work at local lab"
},
"task_due_date": {
"type": "string",
"format": "date-time",
"example": "2025-07-10 10:00:00"
},
"task_assigned_to": {
"type": "integer",
"example": 5
},
"task_watchers": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
1,
2
]
},
"sendEmailtoPatientApplicationForTask": {
"type": "boolean",
"example": true
},
"task_priority": {
"type": "string",
"enum": [
"low",
"normal",
"high"
],
"example": "normal"
},
"task_status": {
"type": "string",
"enum": [
"pending",
"in_progress",
"completed"
],
"example": "pending"
}
},
"type": "object"
},
"properties": {
"task_title": {
"type": "string",
"description": "task_title property",
"example": "Complete blood work",
"required": true
},
"task_body": {
"type": "string",
"description": "task_body property",
"example": "Patient needs to complete blood work at local lab",
"required": true
},
"task_due_date": {
"type": "string",
"format": "date-time",
"description": "task_due_date property",
"example": "2025-07-10 10:00:00",
"required": true
},
"task_assigned_to": {
"type": "integer",
"description": "task_assigned_to property",
"example": 5,
"required": true
},
"task_watchers": {
"type": "array",
"description": "task_watchers property",
"example": [
1,
2
],
"items": {
"type": "integer"
},
"required": false
},
"sendEmailtoPatientApplicationForTask": {
"type": "boolean",
"description": "sendEmailtoPatientApplicationForTask property",
"example": true,
"required": false
},
"task_priority": {
"type": "string",
"description": "task_priority property",
"example": "normal",
"enum": [
"low",
"normal",
"high"
],
"required": false
},
"task_status": {
"type": "string",
"description": "task_status property",
"example": "pending",
"enum": [
"pending",
"in_progress",
"completed"
],
"required": false
}
},
"required": [
"task_title",
"task_body",
"task_due_date",
"task_assigned_to"
]
}
}
},
"responseSchema": {
"201": {
"description": "Task created successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Task added successfully"
},
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"422": {
"description": "Validation error",
"content": {}
}
},
"exactToolName": "provider_create_add_task",
"detailedDescription": "Add a new task for a patient"
}
},
{
"toolName": "provider_update_update_task",
"method": "PUT",
"path": "/api/update-task/{task_id}",
"description": "Update an existing task",
"category": "tasks",
"parameters": "**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",
"operationId": "updateTask",
"tags": [
"Tasks"
],
"endpoint": {
"path": "/api/update-task/{task_id}",
"method": "PUT",
"operationId": "updateTask",
"summary": "Update an existing task",
"description": "Updates the details of an existing task",
"tags": [
"Tasks"
],
"parameters": [
{
"name": "task_id",
"in": "path",
"required": true,
"type": "integer",
"description": "ID of the task to update"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"properties": {
"task_title": {
"type": "string",
"example": "Updated blood work"
},
"task_body": {
"type": "string",
"example": "Patient needs to complete updated blood work at local lab"
},
"task_due_date": {
"type": "string",
"format": "date-time",
"example": "2025-07-15 10:00:00"
},
"task_assigned_to": {
"type": "integer",
"example": 5
},
"task_watchers": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
1,
2,
3
]
},
"sendEmailtoPatientApplicationForTask": {
"type": "boolean",
"example": false
},
"task_priority": {
"type": "string",
"enum": [
"low",
"normal",
"high"
],
"example": "high"
},
"task_status": {
"type": "string",
"enum": [
"pending",
"in_progress",
"completed"
],
"example": "in_progress"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Task updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Task updated successfully"
},
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"404": {
"description": "Task not found"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "tasks",
"toolName": "provider_update_update_task",
"completeParameters": {
"task_id": {
"name": "task_id",
"in": "path",
"type": "integer",
"required": true,
"description": "ID of the task to update"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"task_title": {
"type": "string",
"example": "Updated blood work"
},
"task_body": {
"type": "string",
"example": "Patient needs to complete updated blood work at local lab"
},
"task_due_date": {
"type": "string",
"format": "date-time",
"example": "2025-07-15 10:00:00"
},
"task_assigned_to": {
"type": "integer",
"example": 5
},
"task_watchers": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
1,
2,
3
]
},
"sendEmailtoPatientApplicationForTask": {
"type": "boolean",
"example": false
},
"task_priority": {
"type": "string",
"enum": [
"low",
"normal",
"high"
],
"example": "high"
},
"task_status": {
"type": "string",
"enum": [
"pending",
"in_progress",
"completed"
],
"example": "in_progress"
}
},
"type": "object"
},
"properties": {
"task_title": {
"type": "string",
"description": "task_title property",
"example": "Updated blood work",
"required": false
},
"task_body": {
"type": "string",
"description": "task_body property",
"example": "Patient needs to complete updated blood work at local lab",
"required": false
},
"task_due_date": {
"type": "string",
"format": "date-time",
"description": "task_due_date property",
"example": "2025-07-15 10:00:00",
"required": false
},
"task_assigned_to": {
"type": "integer",
"description": "task_assigned_to property",
"example": 5,
"required": false
},
"task_watchers": {
"type": "array",
"description": "task_watchers property",
"example": [
1,
2,
3
],
"items": {
"type": "integer"
},
"required": false
},
"sendEmailtoPatientApplicationForTask": {
"type": "boolean",
"description": "sendEmailtoPatientApplicationForTask property",
"example": false,
"required": false
},
"task_priority": {
"type": "string",
"description": "task_priority property",
"example": "high",
"enum": [
"low",
"normal",
"high"
],
"required": false
},
"task_status": {
"type": "string",
"description": "task_status property",
"example": "in_progress",
"enum": [
"pending",
"in_progress",
"completed"
],
"required": false
}
},
"required": []
}
}
},
"responseSchema": {
"201": {
"description": "Task updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Task updated successfully"
},
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"404": {
"description": "Task not found",
"content": {}
}
},
"exactToolName": "provider_update_update_task",
"detailedDescription": "Update an existing task"
}
},
{
"toolName": "provider_get_task",
"method": "GET",
"path": "/api/task/{id}",
"description": "Get a task by ID",
"category": "tasks",
"parameters": "**Required:** id (integer) - ID of the task to retrieve",
"operationId": "getOneTaskById",
"tags": [
"Tasks"
],
"endpoint": {
"path": "/api/task/{id}",
"method": "GET",
"operationId": "getOneTaskById",
"summary": "Get a task by ID",
"description": "Retrieves the details of a specific task by its ID",
"tags": [
"Tasks"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "ID of the task to retrieve"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"patient_id": {
"type": "integer",
"example": 42
},
"task_title": {
"type": "string",
"example": "Complete blood work"
},
"task_body": {
"type": "string",
"example": "Patient needs to complete blood work at local lab"
},
"task_due_date": {
"type": "string",
"format": "date-time",
"example": "2025-07-10 10:00:00"
},
"task_assigned_to": {
"type": "integer",
"example": 5
},
"task_watchers": {
"type": "string",
"example": "[1,2]"
},
"sendEmailtoPatientApplicationForTask": {
"type": "integer",
"example": 1
},
"task_priority": {
"type": "string",
"example": "normal"
},
"task_status": {
"type": "string",
"example": "pending"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-07-01 14:30:00"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-07-01 14:30:00"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"404": {
"description": "Task not found"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "tasks",
"toolName": "provider_get_task",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "ID of the task to retrieve"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"patient_id": {
"type": "integer",
"example": 42
},
"task_title": {
"type": "string",
"example": "Complete blood work"
},
"task_body": {
"type": "string",
"example": "Patient needs to complete blood work at local lab"
},
"task_due_date": {
"type": "string",
"format": "date-time",
"example": "2025-07-10 10:00:00"
},
"task_assigned_to": {
"type": "integer",
"example": 5
},
"task_watchers": {
"type": "string",
"example": "[1,2]"
},
"sendEmailtoPatientApplicationForTask": {
"type": "integer",
"example": 1
},
"task_priority": {
"type": "string",
"example": "normal"
},
"task_status": {
"type": "string",
"example": "pending"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-07-01 14:30:00"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-07-01 14:30:00"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"404": {
"description": "Task not found",
"content": {}
}
},
"exactToolName": "provider_get_task",
"detailedDescription": "Get a task by ID"
}
},
{
"toolName": "provider_get_tasks",
"method": "GET",
"path": "/api/tasks/{patient_id}",
"description": "Get all tasks for a patient",
"category": "tasks",
"parameters": "**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)",
"operationId": "getTasks",
"tags": [
"Tasks"
],
"endpoint": {
"path": "/api/tasks/{patient_id}",
"method": "GET",
"operationId": "getTasks",
"summary": "Get all tasks for a patient",
"description": "Retrieves all tasks associated with a specific patient with pagination support via DataTables",
"tags": [
"Tasks"
],
"parameters": [
{
"name": "patient_id",
"in": "path",
"required": true,
"type": "integer",
"description": "ID of the patient"
},
{
"name": "draw",
"in": "query",
"required": false,
"type": "integer",
"description": "DataTables draw counter"
},
{
"name": "start",
"in": "query",
"required": false,
"type": "integer",
"description": "DataTables start offset"
},
{
"name": "length",
"in": "query",
"required": false,
"type": "integer",
"description": "DataTables page length"
},
{
"name": "search[value]",
"in": "query",
"required": false,
"type": "string",
"description": "DataTables search value"
},
{
"name": "order[0][column]",
"in": "query",
"required": false,
"type": "integer",
"description": "DataTables column index for ordering"
},
{
"name": "order[0][dir]",
"in": "query",
"required": false,
"type": "string",
"description": "DataTables order direction (asc/desc)"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"draw": {
"type": "integer",
"example": 1
},
"recordsTotal": {
"type": "integer",
"example": 10
},
"recordsFiltered": {
"type": "integer",
"example": 10
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"patient_id": {
"type": "integer",
"example": 42
},
"task_title": {
"type": "string",
"example": "Complete blood work"
},
"task_body": {
"type": "string",
"example": "Patient needs to complete blood work at local lab"
},
"task_due_date": {
"type": "string",
"format": "date-time",
"example": "2025-07-10 10:00:00"
},
"task_assigned_to": {
"type": "integer",
"example": 5
},
"task_watchers": {
"type": "string",
"example": "[1,2]"
},
"sendemailtopatientapplicationfortask": {
"type": "boolean",
"example": true
},
"task_priority": {
"type": "string",
"example": "normal"
},
"task_status": {
"type": "string",
"example": "pending"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-07-01 14:30:00"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-07-01 14:30:00"
},
"DT_RowIndex": {
"type": "integer",
"example": 0
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Failed to fetch tasks: Error message"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "tasks",
"toolName": "provider_get_tasks",
"completeParameters": {
"patient_id": {
"name": "patient_id",
"in": "path",
"type": "integer",
"required": true,
"description": "ID of the patient"
},
"draw": {
"name": "draw",
"in": "query",
"type": "integer",
"required": false,
"description": "DataTables draw counter"
},
"start": {
"name": "start",
"in": "query",
"type": "integer",
"required": false,
"description": "DataTables start offset"
},
"length": {
"name": "length",
"in": "query",
"type": "integer",
"required": false,
"description": "DataTables page length"
},
"search[value]": {
"name": "search[value]",
"in": "query",
"type": "string",
"required": false,
"description": "DataTables search value"
},
"order[0][column]": {
"name": "order[0][column]",
"in": "query",
"type": "integer",
"required": false,
"description": "DataTables column index for ordering"
},
"order[0][dir]": {
"name": "order[0][dir]",
"in": "query",
"type": "string",
"required": false,
"description": "DataTables order direction (asc/desc)",
"enum": [
"asc",
"desc"
]
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"draw": {
"type": "integer",
"example": 1
},
"recordsTotal": {
"type": "integer",
"example": 10
},
"recordsFiltered": {
"type": "integer",
"example": 10
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"patient_id": {
"type": "integer",
"example": 42
},
"task_title": {
"type": "string",
"example": "Complete blood work"
},
"task_body": {
"type": "string",
"example": "Patient needs to complete blood work at local lab"
},
"task_due_date": {
"type": "string",
"format": "date-time",
"example": "2025-07-10 10:00:00"
},
"task_assigned_to": {
"type": "integer",
"example": 5
},
"task_watchers": {
"type": "string",
"example": "[1,2]"
},
"sendemailtopatientapplicationfortask": {
"type": "boolean",
"example": true
},
"task_priority": {
"type": "string",
"example": "normal"
},
"task_status": {
"type": "string",
"example": "pending"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-07-01 14:30:00"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-07-01 14:30:00"
},
"DT_RowIndex": {
"type": "integer",
"example": 0
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Failed to fetch tasks: Error message"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_tasks",
"detailedDescription": "Get all tasks for a patient"
}
},
{
"toolName": "provider_get_user_list",
"method": "GET",
"path": "/api/user-list",
"description": "Get list of users",
"category": "user_management",
"parameters": "No parameters",
"operationId": "getUserList",
"tags": [
"User Management"
],
"endpoint": {
"path": "/api/user-list",
"method": "GET",
"operationId": "getUserList",
"summary": "Get list of users",
"description": "Returns a list of all users for the authenticated provider",
"tags": [
"User Management"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"draw": {
"type": "integer",
"example": 1
},
"recordsTotal": {
"type": "integer",
"example": 10
},
"recordsFiltered": {
"type": "integer",
"example": 10
},
"data": {
"type": "array",
"items": {
"properties": {
"user_id": {
"type": "integer",
"example": 1
},
"firstName": {
"type": "string",
"example": "John"
},
"lastName": {
"type": "string",
"example": "Doe"
},
"username": {
"type": "string",
"example": "johndoe"
},
"role_id": {
"type": "string",
"example": "1"
},
"fullName": {
"type": "string",
"example": "John Doe"
},
"emailAddress": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"textMessageNumber": {
"type": "string",
"example": "123-456-7890"
},
"accessRights": {
"properties": {
"admin": {
"type": "boolean",
"example": false
},
"practitioner": {
"type": "boolean",
"example": false
},
"patientPortalMessaging": {
"type": "boolean",
"example": false
}
},
"type": "object"
},
"analytics": {
"type": "string",
"example": "None"
},
"replyToEmail": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"chartCoSigner": {
"type": "string",
"nullable": true
},
"supervisor": {
"type": "string",
"nullable": true
},
"sendEmail": {
"type": "boolean",
"example": false
},
"notes": {
"type": "string",
"example": ""
},
"copyDetailsFrom": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"example": 1
},
"profile_picture": {
"type": "string",
"example": "base64encodedstring"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"500": {
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "user_management",
"toolName": "provider_get_user_list",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"draw": {
"type": "integer",
"example": 1
},
"recordsTotal": {
"type": "integer",
"example": 10
},
"recordsFiltered": {
"type": "integer",
"example": 10
},
"data": {
"type": "array",
"items": {
"properties": {
"user_id": {
"type": "integer",
"example": 1
},
"firstName": {
"type": "string",
"example": "John"
},
"lastName": {
"type": "string",
"example": "Doe"
},
"username": {
"type": "string",
"example": "johndoe"
},
"role_id": {
"type": "string",
"example": "1"
},
"fullName": {
"type": "string",
"example": "John Doe"
},
"emailAddress": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"textMessageNumber": {
"type": "string",
"example": "123-456-7890"
},
"accessRights": {
"properties": {
"admin": {
"type": "boolean",
"example": false
},
"practitioner": {
"type": "boolean",
"example": false
},
"patientPortalMessaging": {
"type": "boolean",
"example": false
}
},
"type": "object"
},
"analytics": {
"type": "string",
"example": "None"
},
"replyToEmail": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"chartCoSigner": {
"type": "string",
"nullable": true
},
"supervisor": {
"type": "string",
"nullable": true
},
"sendEmail": {
"type": "boolean",
"example": false
},
"notes": {
"type": "string",
"example": ""
},
"copyDetailsFrom": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"example": 1
},
"profile_picture": {
"type": "string",
"example": "base64encodedstring"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"500": {
"description": "Server error",
"content": {}
}
},
"exactToolName": "provider_get_user_list",
"detailedDescription": "Get list of users"
}
},
{
"toolName": "provider_get_user_list",
"method": "GET",
"path": "/api/user-list/{id}",
"description": "Get user by ID",
"category": "user_management",
"parameters": "**Required:** id (integer) - User ID",
"operationId": "getUserById",
"tags": [
"User Management"
],
"endpoint": {
"path": "/api/user-list/{id}",
"method": "GET",
"operationId": "getUserById",
"summary": "Get user by ID",
"description": "Returns detailed information about a specific user",
"tags": [
"User Management"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "User ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"firstName": {
"type": "string",
"example": "John"
},
"lastName": {
"type": "string",
"example": "Doe"
},
"username": {
"type": "string",
"example": "johndoe"
},
"emailAddress": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"textMessageNumber": {
"type": "string",
"example": "123-456-7890"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"example": "1990-01-01"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"zipcode": {
"type": "string",
"example": "10001"
},
"gender": {
"type": "string",
"example": "M"
},
"accessRights": {
"properties": {
"admin": {
"type": "boolean",
"example": false
},
"practitioner": {
"type": "boolean",
"example": false
},
"patientPortalMessaging": {
"type": "boolean",
"example": false
}
},
"type": "object"
},
"analytics": {
"type": "string",
"example": "None"
},
"replyToEmail": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"chartCoSigner": {
"type": "string",
"nullable": true
},
"supervisor": {
"type": "string",
"nullable": true
},
"sendEmail": {
"type": "boolean",
"example": false
},
"notes": {
"type": "string",
"example": ""
},
"copyDetailsFrom": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"example": 1
},
"role_id": {
"type": "string",
"example": "1"
},
"type": {
"type": "string",
"example": "practitioner"
},
"avatarImg": {
"type": "string",
"example": "base64encodedstring"
}
},
"type": "object"
},
"message": {
"type": "string",
"example": "Users list!"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"404": {
"description": "User not found"
},
"500": {
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "user_management",
"toolName": "provider_get_user_list",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "User ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"firstName": {
"type": "string",
"example": "John"
},
"lastName": {
"type": "string",
"example": "Doe"
},
"username": {
"type": "string",
"example": "johndoe"
},
"emailAddress": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"textMessageNumber": {
"type": "string",
"example": "123-456-7890"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"example": "1990-01-01"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"zipcode": {
"type": "string",
"example": "10001"
},
"gender": {
"type": "string",
"example": "M"
},
"accessRights": {
"properties": {
"admin": {
"type": "boolean",
"example": false
},
"practitioner": {
"type": "boolean",
"example": false
},
"patientPortalMessaging": {
"type": "boolean",
"example": false
}
},
"type": "object"
},
"analytics": {
"type": "string",
"example": "None"
},
"replyToEmail": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"chartCoSigner": {
"type": "string",
"nullable": true
},
"supervisor": {
"type": "string",
"nullable": true
},
"sendEmail": {
"type": "boolean",
"example": false
},
"notes": {
"type": "string",
"example": ""
},
"copyDetailsFrom": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"example": 1
},
"role_id": {
"type": "string",
"example": "1"
},
"type": {
"type": "string",
"example": "practitioner"
},
"avatarImg": {
"type": "string",
"example": "base64encodedstring"
}
},
"type": "object"
},
"message": {
"type": "string",
"example": "Users list!"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"404": {
"description": "User not found",
"content": {}
},
"500": {
"description": "Server error",
"content": {}
}
},
"exactToolName": "provider_get_user_list",
"detailedDescription": "Get user by ID"
}
},
{
"toolName": "provider_update_update_user",
"method": "POST",
"path": "/api/update-user/{id}",
"description": "Update user",
"category": "user_management",
"parameters": "**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",
"operationId": "updateUser",
"tags": [
"User Management"
],
"endpoint": {
"path": "/api/update-user/{id}",
"method": "POST",
"operationId": "updateUser",
"summary": "Update user",
"description": "Update an existing user's information",
"tags": [
"User Management"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "User ID"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"firstName",
"lastName",
"textMessageNumber",
"timezone",
"role_id"
],
"properties": {
"firstName": {
"type": "string",
"example": "John"
},
"lastName": {
"type": "string",
"example": "Doe"
},
"textMessageNumber": {
"type": "string",
"example": "123-456-7890"
},
"timezone": {
"type": "string",
"example": "UTC"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"example": "1990-01-01"
},
"gender": {
"type": "string",
"example": "M"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"zipcode": {
"type": "string",
"example": "10001"
},
"type": {
"type": "string",
"example": "practitioner"
},
"role_id": {
"type": "string",
"example": "1"
},
"username": {
"type": "string",
"example": "johndoe"
},
"newUserPassword": {
"type": "string",
"example": "newpassword123"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "User updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "User updated successfully!"
},
"data": {
"properties": {
"fname": {
"type": "string",
"example": "John"
},
"lname": {
"type": "string",
"example": "Doe"
},
"phone": {
"type": "string",
"example": "123-456-7890"
},
"timezone": {
"type": "string",
"example": "UTC"
},
"last_updated": {
"type": "string",
"format": "date-time",
"example": "2023-06-30T15:30:00Z"
},
"profile_image_base64": {
"type": "string",
"example": "https://example.com/storage/John-Doe/image.jpg"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"example": "1990-01-01"
},
"gender": {
"type": "string",
"example": "M"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"zip": {
"type": "string",
"example": "10001"
},
"type": {
"type": "string",
"example": "practitioner"
},
"role_id": {
"type": "string",
"example": "1"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"404": {
"description": "User not found"
},
"422": {
"description": "Validation error"
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "An error occurred"
},
"message": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "user_management",
"toolName": "provider_create_update_user",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "User ID"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"firstName",
"lastName",
"textMessageNumber",
"timezone",
"role_id"
],
"properties": {
"firstName": {
"type": "string",
"example": "John"
},
"lastName": {
"type": "string",
"example": "Doe"
},
"textMessageNumber": {
"type": "string",
"example": "123-456-7890"
},
"timezone": {
"type": "string",
"example": "UTC"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"example": "1990-01-01"
},
"gender": {
"type": "string",
"example": "M"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"zipcode": {
"type": "string",
"example": "10001"
},
"type": {
"type": "string",
"example": "practitioner"
},
"role_id": {
"type": "string",
"example": "1"
},
"username": {
"type": "string",
"example": "johndoe"
},
"newUserPassword": {
"type": "string",
"example": "newpassword123"
}
},
"type": "object"
},
"properties": {
"firstName": {
"type": "string",
"description": "firstName property",
"example": "John",
"required": true
},
"lastName": {
"type": "string",
"description": "lastName property",
"example": "Doe",
"required": true
},
"textMessageNumber": {
"type": "string",
"description": "textMessageNumber property",
"example": "123-456-7890",
"required": true
},
"timezone": {
"type": "string",
"description": "timezone property",
"example": "UTC",
"required": true
},
"dateOfBirth": {
"type": "string",
"format": "date",
"description": "dateOfBirth property",
"example": "1990-01-01",
"required": false
},
"gender": {
"type": "string",
"description": "gender property",
"example": "M",
"required": false
},
"city": {
"type": "string",
"description": "city property",
"example": "New York",
"required": false
},
"state": {
"type": "string",
"description": "state property",
"example": "NY",
"required": false
},
"zipcode": {
"type": "string",
"description": "zipcode property",
"example": "10001",
"required": false
},
"type": {
"type": "string",
"description": "type property",
"example": "practitioner",
"required": false
},
"role_id": {
"type": "string",
"description": "role_id property",
"example": "1",
"required": true
},
"username": {
"type": "string",
"description": "username property",
"example": "johndoe",
"required": false
},
"newUserPassword": {
"type": "string",
"description": "newUserPassword property",
"example": "newpassword123",
"required": false
}
},
"required": [
"firstName",
"lastName",
"textMessageNumber",
"timezone",
"role_id"
]
}
}
},
"responseSchema": {
"201": {
"description": "User updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "User updated successfully!"
},
"data": {
"properties": {
"fname": {
"type": "string",
"example": "John"
},
"lname": {
"type": "string",
"example": "Doe"
},
"phone": {
"type": "string",
"example": "123-456-7890"
},
"timezone": {
"type": "string",
"example": "UTC"
},
"last_updated": {
"type": "string",
"format": "date-time",
"example": "2023-06-30T15:30:00Z"
},
"profile_image_base64": {
"type": "string",
"example": "https://example.com/storage/John-Doe/image.jpg"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"example": "1990-01-01"
},
"gender": {
"type": "string",
"example": "M"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"zip": {
"type": "string",
"example": "10001"
},
"type": {
"type": "string",
"example": "practitioner"
},
"role_id": {
"type": "string",
"example": "1"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"404": {
"description": "User not found",
"content": {}
},
"422": {
"description": "Validation error",
"content": {}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "An error occurred"
},
"message": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_update_user",
"detailedDescription": "Update user"
}
},
{
"toolName": "provider_create_user_create",
"method": "POST",
"path": "/api/user/create",
"description": "Create new user from admin",
"category": "user_management",
"parameters": "No parameters",
"operationId": "createUserFromAdmin",
"tags": [
"User Management"
],
"endpoint": {
"path": "/api/user/create",
"method": "POST",
"operationId": "createUserFromAdmin",
"summary": "Create new user from admin",
"description": "Creates a new user from the admin panel with improved validation",
"tags": [
"User Management"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"required": [
"firstName",
"lastName",
"username",
"emailAddress",
"textMessageNumber",
"role_id",
"newUserPassword",
"type"
],
"properties": {
"firstName": {
"type": "string",
"example": "John"
},
"lastName": {
"type": "string",
"example": "Doe"
},
"username": {
"type": "string",
"example": "johndoe"
},
"emailAddress": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"textMessageNumber": {
"type": "string",
"example": "123-456-7890"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"example": "1990-01-01"
},
"gender": {
"type": "string",
"example": "M"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"zipcode": {
"type": "string",
"example": "10001"
},
"role_id": {
"type": "string",
"example": "1"
},
"newUserPassword": {
"type": "string",
"example": "password123"
},
"type": {
"type": "string",
"example": "practitioner"
},
"avatarImg": {
"description": "User profile image",
"type": "file"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "User created successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "User added successfully"
},
"data": {
"properties": {
"fname": {
"type": "string",
"example": "John"
},
"lname": {
"type": "string",
"example": "Doe"
},
"username": {
"type": "string",
"example": "johndoe"
},
"email": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"phone": {
"type": "string",
"example": "123-456-7890"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"example": "1990-01-01"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"zipcode": {
"type": "string",
"example": "10001"
},
"gender": {
"type": "string",
"example": "M"
},
"company_id": {
"type": "integer",
"example": 1
},
"provider_id": {
"type": "integer",
"example": 1
},
"type": {
"type": "string",
"example": "practitioner"
},
"profile_image_base64": {
"type": "string",
"example": "https://example.com/storage/John-Doe/image.jpg"
},
"timezone": {
"type": "string",
"example": "UTC"
},
"role_id": {
"type": "string",
"example": "1"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"422": {
"description": "Validation error"
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "An error occurred: Error message"
},
"message": {
"type": "string",
"example": "Failed to add user"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "user_management",
"toolName": "provider_create_user_create",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"firstName",
"lastName",
"username",
"emailAddress",
"textMessageNumber",
"role_id",
"newUserPassword",
"type"
],
"properties": {
"firstName": {
"type": "string",
"example": "John"
},
"lastName": {
"type": "string",
"example": "Doe"
},
"username": {
"type": "string",
"example": "johndoe"
},
"emailAddress": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"textMessageNumber": {
"type": "string",
"example": "123-456-7890"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"example": "1990-01-01"
},
"gender": {
"type": "string",
"example": "M"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"zipcode": {
"type": "string",
"example": "10001"
},
"role_id": {
"type": "string",
"example": "1"
},
"newUserPassword": {
"type": "string",
"example": "password123"
},
"type": {
"type": "string",
"example": "practitioner"
},
"avatarImg": {
"description": "User profile image",
"type": "file"
}
},
"type": "object"
},
"properties": {
"firstName": {
"type": "string",
"description": "firstName property",
"example": "John",
"required": true
},
"lastName": {
"type": "string",
"description": "lastName property",
"example": "Doe",
"required": true
},
"username": {
"type": "string",
"description": "username property",
"example": "johndoe",
"required": true
},
"emailAddress": {
"type": "string",
"format": "email",
"description": "emailAddress property",
"example": "john.doe@example.com",
"required": true
},
"textMessageNumber": {
"type": "string",
"description": "textMessageNumber property",
"example": "123-456-7890",
"required": true
},
"dateOfBirth": {
"type": "string",
"format": "date",
"description": "dateOfBirth property",
"example": "1990-01-01",
"required": false
},
"gender": {
"type": "string",
"description": "gender property",
"example": "M",
"required": false
},
"city": {
"type": "string",
"description": "city property",
"example": "New York",
"required": false
},
"state": {
"type": "string",
"description": "state property",
"example": "NY",
"required": false
},
"zipcode": {
"type": "string",
"description": "zipcode property",
"example": "10001",
"required": false
},
"role_id": {
"type": "string",
"description": "role_id property",
"example": "1",
"required": true
},
"newUserPassword": {
"type": "string",
"description": "newUserPassword property",
"example": "password123",
"required": true
},
"type": {
"type": "string",
"description": "type property",
"example": "practitioner",
"required": true
},
"avatarImg": {
"type": "file",
"description": "User profile image",
"required": false
}
},
"required": [
"firstName",
"lastName",
"username",
"emailAddress",
"textMessageNumber",
"role_id",
"newUserPassword",
"type"
]
}
}
},
"responseSchema": {
"201": {
"description": "User created successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "User added successfully"
},
"data": {
"properties": {
"fname": {
"type": "string",
"example": "John"
},
"lname": {
"type": "string",
"example": "Doe"
},
"username": {
"type": "string",
"example": "johndoe"
},
"email": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"phone": {
"type": "string",
"example": "123-456-7890"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"example": "1990-01-01"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"zipcode": {
"type": "string",
"example": "10001"
},
"gender": {
"type": "string",
"example": "M"
},
"company_id": {
"type": "integer",
"example": 1
},
"provider_id": {
"type": "integer",
"example": 1
},
"type": {
"type": "string",
"example": "practitioner"
},
"profile_image_base64": {
"type": "string",
"example": "https://example.com/storage/John-Doe/image.jpg"
},
"timezone": {
"type": "string",
"example": "UTC"
},
"role_id": {
"type": "string",
"example": "1"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"422": {
"description": "Validation error",
"content": {}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "An error occurred: Error message"
},
"message": {
"type": "string",
"example": "Failed to add user"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_user_create",
"detailedDescription": "Create new user from admin"
}
},
{
"toolName": "provider_create_add_user",
"method": "POST",
"path": "/api/add-user",
"description": "Add new user (legacy method)",
"category": "user_management",
"parameters": "No parameters",
"operationId": "addUser",
"tags": [
"User Management"
],
"endpoint": {
"path": "/api/add-user",
"method": "POST",
"operationId": "addUser",
"summary": "Add new user (legacy method)",
"description": "Creates a new user (legacy method for compatibility)",
"tags": [
"User Management"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"required": [
"firstName",
"lastName",
"username",
"emailAddress",
"textMessageNumber",
"role_id",
"newUserPassword",
"type"
],
"properties": {
"firstName": {
"type": "string",
"example": "John"
},
"lastName": {
"type": "string",
"example": "Doe"
},
"username": {
"type": "string",
"example": "johndoe"
},
"emailAddress": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"textMessageNumber": {
"type": "string",
"example": "123-456-7890"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"example": "1990-01-01"
},
"gender": {
"type": "string",
"example": "M"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"zipcode": {
"type": "string",
"example": "10001"
},
"role_id": {
"type": "string",
"example": "1"
},
"newUserPassword": {
"type": "string",
"example": "password123"
},
"type": {
"type": "string",
"example": "practitioner"
},
"avatarImg": {
"description": "User profile image",
"type": "file"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "User added successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "User added successfully"
},
"data": {
"properties": {
"fname": {
"type": "string",
"example": "John"
},
"lname": {
"type": "string",
"example": "Doe"
},
"username": {
"type": "string",
"example": "johndoe"
},
"email": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"phone": {
"type": "string",
"example": "123-456-7890"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"example": "1990-01-01"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"zipcode": {
"type": "string",
"example": "10001"
},
"gender": {
"type": "string",
"example": "M"
},
"date_created": {
"type": "string",
"format": "date-time",
"example": "2023-06-30T15:30:00Z"
},
"last_updated": {
"type": "string",
"format": "date-time",
"example": "2023-06-30T15:30:00Z"
},
"company_id": {
"type": "integer",
"example": 1
},
"provider_id": {
"type": "integer",
"example": 1
},
"type": {
"type": "string",
"example": "practitioner"
},
"profile_image_base64": {
"type": "string",
"example": "https://example.com/storage/John-Doe/image.jpg"
},
"timezone": {
"type": "string",
"example": "UTC"
},
"role_id": {
"type": "string",
"example": "1"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"properties": {
"messages": {
"type": "string",
"example": "Error"
},
"data": {
"type": "string",
"example": "Username Already Exists!"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "user_management",
"toolName": "provider_create_add_user",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"firstName",
"lastName",
"username",
"emailAddress",
"textMessageNumber",
"role_id",
"newUserPassword",
"type"
],
"properties": {
"firstName": {
"type": "string",
"example": "John"
},
"lastName": {
"type": "string",
"example": "Doe"
},
"username": {
"type": "string",
"example": "johndoe"
},
"emailAddress": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"textMessageNumber": {
"type": "string",
"example": "123-456-7890"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"example": "1990-01-01"
},
"gender": {
"type": "string",
"example": "M"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"zipcode": {
"type": "string",
"example": "10001"
},
"role_id": {
"type": "string",
"example": "1"
},
"newUserPassword": {
"type": "string",
"example": "password123"
},
"type": {
"type": "string",
"example": "practitioner"
},
"avatarImg": {
"description": "User profile image",
"type": "file"
}
},
"type": "object"
},
"properties": {
"firstName": {
"type": "string",
"description": "firstName property",
"example": "John",
"required": true
},
"lastName": {
"type": "string",
"description": "lastName property",
"example": "Doe",
"required": true
},
"username": {
"type": "string",
"description": "username property",
"example": "johndoe",
"required": true
},
"emailAddress": {
"type": "string",
"format": "email",
"description": "emailAddress property",
"example": "john.doe@example.com",
"required": true
},
"textMessageNumber": {
"type": "string",
"description": "textMessageNumber property",
"example": "123-456-7890",
"required": true
},
"dateOfBirth": {
"type": "string",
"format": "date",
"description": "dateOfBirth property",
"example": "1990-01-01",
"required": false
},
"gender": {
"type": "string",
"description": "gender property",
"example": "M",
"required": false
},
"city": {
"type": "string",
"description": "city property",
"example": "New York",
"required": false
},
"state": {
"type": "string",
"description": "state property",
"example": "NY",
"required": false
},
"zipcode": {
"type": "string",
"description": "zipcode property",
"example": "10001",
"required": false
},
"role_id": {
"type": "string",
"description": "role_id property",
"example": "1",
"required": true
},
"newUserPassword": {
"type": "string",
"description": "newUserPassword property",
"example": "password123",
"required": true
},
"type": {
"type": "string",
"description": "type property",
"example": "practitioner",
"required": true
},
"avatarImg": {
"type": "file",
"description": "User profile image",
"required": false
}
},
"required": [
"firstName",
"lastName",
"username",
"emailAddress",
"textMessageNumber",
"role_id",
"newUserPassword",
"type"
]
}
}
},
"responseSchema": {
"201": {
"description": "User added successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "User added successfully"
},
"data": {
"properties": {
"fname": {
"type": "string",
"example": "John"
},
"lname": {
"type": "string",
"example": "Doe"
},
"username": {
"type": "string",
"example": "johndoe"
},
"email": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"phone": {
"type": "string",
"example": "123-456-7890"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"example": "1990-01-01"
},
"city": {
"type": "string",
"example": "New York"
},
"state": {
"type": "string",
"example": "NY"
},
"zipcode": {
"type": "string",
"example": "10001"
},
"gender": {
"type": "string",
"example": "M"
},
"date_created": {
"type": "string",
"format": "date-time",
"example": "2023-06-30T15:30:00Z"
},
"last_updated": {
"type": "string",
"format": "date-time",
"example": "2023-06-30T15:30:00Z"
},
"company_id": {
"type": "integer",
"example": 1
},
"provider_id": {
"type": "integer",
"example": 1
},
"type": {
"type": "string",
"example": "practitioner"
},
"profile_image_base64": {
"type": "string",
"example": "https://example.com/storage/John-Doe/image.jpg"
},
"timezone": {
"type": "string",
"example": "UTC"
},
"role_id": {
"type": "string",
"example": "1"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"properties": {
"messages": {
"type": "string",
"example": "Error"
},
"data": {
"type": "string",
"example": "Username Already Exists!"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_add_user",
"detailedDescription": "Add new user (legacy method)"
}
},
{
"toolName": "provider_get_practitioners_list",
"method": "GET",
"path": "/api/practitioners-list",
"description": "Get practitioners list",
"category": "user_management",
"parameters": "No parameters",
"operationId": "practitioner",
"tags": [
"User Management"
],
"endpoint": {
"path": "/api/practitioners-list",
"method": "GET",
"operationId": "practitioner",
"summary": "Get practitioners list",
"description": "Returns a list of all practitioners",
"tags": [
"User Management"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"email": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"phone": {
"type": "string",
"example": "123-456-7890"
},
"type": {
"type": "string",
"example": "practitioner"
},
"fname": {
"type": "string",
"example": "John"
},
"lname": {
"type": "string",
"example": "Doe"
}
},
"type": "object"
}
},
"message": {
"type": "string",
"example": "Practitioner list!"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized"
},
"500": {
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "user_management",
"toolName": "provider_get_practitioners_list",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"email": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"phone": {
"type": "string",
"example": "123-456-7890"
},
"type": {
"type": "string",
"example": "practitioner"
},
"fname": {
"type": "string",
"example": "John"
},
"lname": {
"type": "string",
"example": "Doe"
}
},
"type": "object"
}
},
"message": {
"type": "string",
"example": "Practitioner list!"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {}
},
"500": {
"description": "Server error",
"content": {}
}
},
"exactToolName": "provider_get_practitioners_list",
"detailedDescription": "Get practitioners list"
}
},
{
"toolName": "provider_get_patient_me",
"method": "GET",
"path": "/patient/me",
"description": "Get patient details by access token",
"category": "authentication",
"parameters": "No parameters",
"operationId": "getPatientDetailsByAccessToken",
"tags": [
"Authentication"
],
"endpoint": {
"path": "/patient/me",
"method": "GET",
"operationId": "getPatientDetailsByAccessToken",
"summary": "Get patient details by access token",
"description": "Retrieves authenticated patient's profile details using the access token",
"tags": [
"Authentication"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Patient details retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"userAbilityRules": {
"type": "array",
"items": {
"properties": {
"action": {
"type": "string",
"example": "manage"
},
"subject": {
"type": "string",
"example": "all"
}
},
"type": "object"
}
},
"userData": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"firstName": {
"type": "string",
"example": "John"
},
"lastName": {
"type": "string",
"example": "Doe"
},
"email": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"phone": {
"type": "string",
"example": "1234567890"
},
"time_zone": {
"type": "string",
"example": "America/New_York"
},
"dob": {
"type": "string",
"format": "date",
"example": "1990-01-01"
},
"gender": {
"type": "string",
"example": "Male"
},
"registrationDate": {
"type": "string",
"format": "date",
"example": "2023-01-01"
},
"practitioner_id": {
"type": "integer",
"example": 1
},
"provider_id": {
"type": "integer",
"example": 1
},
"user_type": {
"type": "string",
"example": "patient"
},
"company": {
"type": "string",
"example": "Health Guru Hub"
},
"fullName": {
"type": "string",
"example": "John Doe"
},
"order_id": {
"type": "integer",
"example": null,
"nullable": true
},
"pending_task": {
"type": "string",
"example": null,
"nullable": true
},
"builder_id": {
"type": "integer",
"example": null,
"nullable": true
},
"completed_task": {
"type": "string",
"example": null,
"nullable": true
},
"forms": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
},
"message": {
"type": "string",
"example": "User LoggedIn"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Invalid token format",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Invalid token format"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Invalid access token",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Invalid access token"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Patient not found",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Patient not found"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "An error occurred while retrieving patient details."
},
"exception": {
"type": "string",
"example": "Error message"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"accessToken": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "authentication",
"toolName": "provider_get_patient_me",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Patient details retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"userAbilityRules": {
"type": "array",
"items": {
"properties": {
"action": {
"type": "string",
"example": "manage"
},
"subject": {
"type": "string",
"example": "all"
}
},
"type": "object"
}
},
"userData": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"firstName": {
"type": "string",
"example": "John"
},
"lastName": {
"type": "string",
"example": "Doe"
},
"email": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"phone": {
"type": "string",
"example": "1234567890"
},
"time_zone": {
"type": "string",
"example": "America/New_York"
},
"dob": {
"type": "string",
"format": "date",
"example": "1990-01-01"
},
"gender": {
"type": "string",
"example": "Male"
},
"registrationDate": {
"type": "string",
"format": "date",
"example": "2023-01-01"
},
"practitioner_id": {
"type": "integer",
"example": 1
},
"provider_id": {
"type": "integer",
"example": 1
},
"user_type": {
"type": "string",
"example": "patient"
},
"company": {
"type": "string",
"example": "Health Guru Hub"
},
"fullName": {
"type": "string",
"example": "John Doe"
},
"order_id": {
"type": "integer",
"example": null,
"nullable": true
},
"pending_task": {
"type": "string",
"example": null,
"nullable": true
},
"builder_id": {
"type": "integer",
"example": null,
"nullable": true
},
"completed_task": {
"type": "string",
"example": null,
"nullable": true
},
"forms": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
},
"message": {
"type": "string",
"example": "User LoggedIn"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Invalid token format",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Invalid token format"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Invalid access token",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Invalid access token"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Patient not found",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Patient not found"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "An error occurred while retrieving patient details."
},
"exception": {
"type": "string",
"example": "Error message"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_patient_me",
"detailedDescription": "Get patient details by access token"
}
},
{
"toolName": "provider_get_provider_me",
"method": "GET",
"path": "/provider/me",
"description": "Get provider details by access token",
"category": "authentication",
"parameters": "No parameters",
"operationId": "getProviderDetailsByAccessToken",
"tags": [
"Authentication"
],
"endpoint": {
"path": "/provider/me",
"method": "GET",
"operationId": "getProviderDetailsByAccessToken",
"summary": "Get provider details by access token",
"description": "Retrieves authenticated provider's profile details using the access token",
"tags": [
"Authentication"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Provider details retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"userAbilityRules": {
"type": "array",
"items": {
"properties": {
"action": {
"type": "string",
"example": "manage"
},
"subject": {
"type": "string",
"example": "all"
}
},
"type": "object"
}
},
"userData": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"uuid": {
"type": "string",
"example": "550e8400-e29b-41d4-a716-446655440000"
},
"fullName": {
"type": "string",
"example": "Dr. Jane Smith"
},
"username": {
"type": "string",
"example": "drjane"
},
"avatar": {
"type": "string",
"example": "base64encodedstring"
},
"email": {
"type": "string",
"format": "email",
"example": "jane.smith@example.com"
},
"role": {
"type": "string",
"example": "provider"
},
"google_sync_status": {
"type": "boolean",
"example": true
},
"role_name": {
"type": "string",
"example": "Doctor"
},
"user_type": {
"type": "string",
"example": "practitioner"
},
"company": {
"type": "string",
"example": "Health Guru Hub"
},
"time_zone": {
"type": "string",
"example": "America/New_York"
},
"dummy_practitioner": {
"type": "boolean",
"example": false
}
},
"type": "object"
},
"permissions": {
"type": "object"
},
"message": {
"type": "string",
"example": "User LoggedIn"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Invalid token format",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Invalid token format"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Invalid access token",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Invalid access token"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "An error occurred while retrieving provider details."
},
"exception": {
"type": "string",
"example": "Error message"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"accessToken": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "authentication",
"toolName": "provider_get_provider_me",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Provider details retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"userAbilityRules": {
"type": "array",
"items": {
"properties": {
"action": {
"type": "string",
"example": "manage"
},
"subject": {
"type": "string",
"example": "all"
}
},
"type": "object"
}
},
"userData": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"uuid": {
"type": "string",
"example": "550e8400-e29b-41d4-a716-446655440000"
},
"fullName": {
"type": "string",
"example": "Dr. Jane Smith"
},
"username": {
"type": "string",
"example": "drjane"
},
"avatar": {
"type": "string",
"example": "base64encodedstring"
},
"email": {
"type": "string",
"format": "email",
"example": "jane.smith@example.com"
},
"role": {
"type": "string",
"example": "provider"
},
"google_sync_status": {
"type": "boolean",
"example": true
},
"role_name": {
"type": "string",
"example": "Doctor"
},
"user_type": {
"type": "string",
"example": "practitioner"
},
"company": {
"type": "string",
"example": "Health Guru Hub"
},
"time_zone": {
"type": "string",
"example": "America/New_York"
},
"dummy_practitioner": {
"type": "boolean",
"example": false
}
},
"type": "object"
},
"permissions": {
"type": "object"
},
"message": {
"type": "string",
"example": "User LoggedIn"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Invalid token format",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Invalid token format"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Invalid access token",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Invalid access token"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "An error occurred while retrieving provider details."
},
"exception": {
"type": "string",
"example": "Error message"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_provider_me",
"detailedDescription": "Get provider details by access token"
}
},
{
"toolName": "provider_get_patients",
"method": "GET",
"path": "/api/patients",
"description": "Get a list of patients",
"category": "patients",
"parameters": "**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",
"operationId": "getPatientList",
"tags": [
"Patients"
],
"endpoint": {
"path": "/api/patients",
"method": "GET",
"operationId": "getPatientList",
"summary": "Get a list of patients",
"description": "Returns a list of patients with optional filtering by first name, last name, date of birth, or email",
"tags": [
"Patients"
],
"parameters": [
{
"name": "firstName",
"in": "query",
"required": false,
"type": "string",
"description": "Filter by patient's first name"
},
{
"name": "lastName",
"in": "query",
"required": false,
"type": "string",
"description": "Filter by patient's last name"
},
{
"name": "dateOfBirth",
"in": "query",
"required": false,
"type": "string",
"description": "Filter by patient's date of birth (YYYY-MM-DD)"
},
{
"name": "email",
"in": "query",
"required": false,
"type": "string",
"description": "Filter by patient's email"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"uuid": {
"type": "string",
"example": "550e8400-e29b-41d4-a716-446655440000"
},
"firstName": {
"type": "string",
"example": "John"
},
"lastName": {
"type": "string",
"example": "Doe"
},
"fullName": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"example": "john.doe@example.com"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"example": "1990-01-01"
}
},
"type": "object"
}
}
}
}
},
"401": {
"description": "Unauthenticated"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "patients",
"toolName": "provider_get_patients",
"completeParameters": {
"firstName": {
"name": "firstName",
"in": "query",
"type": "string",
"required": false,
"description": "Filter by patient's first name"
},
"lastName": {
"name": "lastName",
"in": "query",
"type": "string",
"required": false,
"description": "Filter by patient's last name"
},
"dateOfBirth": {
"name": "dateOfBirth",
"in": "query",
"type": "string",
"format": "date",
"required": false,
"description": "Filter by patient's date of birth (YYYY-MM-DD)"
},
"email": {
"name": "email",
"in": "query",
"type": "string",
"required": false,
"description": "Filter by patient's email"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"uuid": {
"type": "string",
"example": "550e8400-e29b-41d4-a716-446655440000"
},
"firstName": {
"type": "string",
"example": "John"
},
"lastName": {
"type": "string",
"example": "Doe"
},
"fullName": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"example": "john.doe@example.com"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"example": "1990-01-01"
}
},
"type": "object"
}
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
}
},
"exactToolName": "provider_get_patients",
"detailedDescription": "Get a list of patients"
}
},
{
"toolName": "provider_auth_patient_register_patient",
"method": "POST",
"path": "/api/patient/register-patient",
"description": "Register a new patient",
"category": "patients",
"parameters": "**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",
"operationId": "registerPatientForPatient",
"tags": [
"Patients"
],
"endpoint": {
"path": "/api/patient/register-patient",
"method": "POST",
"operationId": "registerPatientForPatient",
"summary": "Register a new patient",
"description": "Creates a new patient account",
"tags": [
"Patients"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"first_name",
"last_name",
"email",
"phone_no",
"dob",
"gender"
],
"properties": {
"first_name": {
"type": "string",
"example": "John"
},
"last_name": {
"type": "string",
"example": "Doe"
},
"email": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"phone_no": {
"type": "string",
"example": "1234567890"
},
"dob": {
"type": "string",
"format": "date",
"example": "1990-01-01"
},
"gender": {
"type": "string",
"example": "Male"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Patient registered successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"first_name": {
"type": "string",
"example": "John"
},
"last_name": {
"type": "string",
"example": "Doe"
},
"email": {
"type": "string",
"example": "john.doe@example.com"
}
},
"type": "object"
},
"message": {
"type": "string",
"example": "Patient has been registered!"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Unauthorized"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "An error occurred"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "patients",
"toolName": "provider_create_patient_register_patient",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"first_name",
"last_name",
"email",
"phone_no",
"dob",
"gender"
],
"properties": {
"first_name": {
"type": "string",
"example": "John"
},
"last_name": {
"type": "string",
"example": "Doe"
},
"email": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"phone_no": {
"type": "string",
"example": "1234567890"
},
"dob": {
"type": "string",
"format": "date",
"example": "1990-01-01"
},
"gender": {
"type": "string",
"example": "Male"
}
},
"type": "object"
},
"properties": {
"first_name": {
"type": "string",
"description": "first_name property",
"example": "John",
"required": true
},
"last_name": {
"type": "string",
"description": "last_name property",
"example": "Doe",
"required": true
},
"email": {
"type": "string",
"format": "email",
"description": "email property",
"example": "john.doe@example.com",
"required": true
},
"phone_no": {
"type": "string",
"description": "phone_no property",
"example": "1234567890",
"required": true
},
"dob": {
"type": "string",
"format": "date",
"description": "dob property",
"example": "1990-01-01",
"required": true
},
"gender": {
"type": "string",
"description": "gender property",
"example": "Male",
"required": true
}
},
"required": [
"first_name",
"last_name",
"email",
"phone_no",
"dob",
"gender"
]
}
}
},
"responseSchema": {
"200": {
"description": "Patient registered successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"first_name": {
"type": "string",
"example": "John"
},
"last_name": {
"type": "string",
"example": "Doe"
},
"email": {
"type": "string",
"example": "john.doe@example.com"
}
},
"type": "object"
},
"message": {
"type": "string",
"example": "Patient has been registered!"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Unauthorized"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "An error occurred"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_patient_register_patient",
"detailedDescription": "Register a new patient"
}
},
{
"toolName": "provider_update_update_password",
"method": "POST",
"path": "/api/update-password",
"description": "Update patient password",
"category": "authentication",
"parameters": "**Required:** new_password (string) - new_password property",
"operationId": "updatePasswordPatient",
"tags": [
"Authentication"
],
"endpoint": {
"path": "/api/update-password",
"method": "POST",
"operationId": "updatePasswordPatient",
"summary": "Update patient password",
"description": "Updates a patient's password",
"tags": [
"Authentication"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"new_password"
],
"properties": {
"new_password": {
"type": "string",
"example": "newSecurePassword123"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Password updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Password updated successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Unauthenticated"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"new_password": {
"type": "array",
"items": {
"type": "string",
"example": "The new password field is required."
}
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "authentication",
"toolName": "provider_create_update_password",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"new_password"
],
"properties": {
"new_password": {
"type": "string",
"example": "newSecurePassword123"
}
},
"type": "object"
},
"properties": {
"new_password": {
"type": "string",
"description": "new_password property",
"example": "newSecurePassword123",
"required": true
}
},
"required": [
"new_password"
]
}
}
},
"responseSchema": {
"200": {
"description": "Password updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Password updated successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Unauthenticated"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"new_password": {
"type": "array",
"items": {
"type": "string",
"example": "The new password field is required."
}
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_update_password",
"detailedDescription": "Update patient password"
}
},
{
"toolName": "provider_create_store_document",
"method": "POST",
"path": "/api/store-document/{patientId}",
"description": "Store patient documents",
"category": "documents",
"parameters": "**Required:** patientId (integer) - Patient ID",
"operationId": "storeDocuments",
"tags": [
"Documents"
],
"endpoint": {
"path": "/api/store-document/{patientId}",
"method": "POST",
"operationId": "storeDocuments",
"summary": "Store patient documents",
"description": "Upload and store documents for a patient",
"tags": [
"Documents"
],
"parameters": [
{
"name": "patientId",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"files[]": {
"description": "Document files to upload",
"type": "array",
"items": {
"type": "string",
"format": "binary"
}
},
"document_type": {
"type": "string",
"example": "medical_record"
},
"notes": {
"type": "string",
"example": "Patient medical records"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Documents stored successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"status": {
"type": "string",
"example": "success"
},
"data": {
"type": "array",
"items": {
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Invalid file format"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Unauthenticated"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "documents",
"toolName": "provider_create_store_document",
"completeParameters": {
"patientId": {
"name": "patientId",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"files[]": {
"description": "Document files to upload",
"type": "array",
"items": {
"type": "string",
"format": "binary"
}
},
"document_type": {
"type": "string",
"example": "medical_record"
},
"notes": {
"type": "string",
"example": "Patient medical records"
}
},
"type": "object"
},
"properties": {
"files[]": {
"type": "array",
"description": "Document files to upload",
"items": {
"type": "string",
"format": "binary"
},
"required": false
},
"document_type": {
"type": "string",
"description": "document_type property",
"example": "medical_record",
"required": false
},
"notes": {
"type": "string",
"description": "notes property",
"example": "Patient medical records",
"required": false
}
},
"required": []
}
}
},
"responseSchema": {
"200": {
"description": "Documents stored successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"status": {
"type": "string",
"example": "success"
},
"data": {
"type": "array",
"items": {
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Invalid file format"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Unauthenticated"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_store_document",
"detailedDescription": "Store patient documents"
}
},
{
"toolName": "provider_get_get_document",
"method": "GET",
"path": "/api/get-document/{patientId}",
"description": "Get patient documents",
"category": "documents",
"parameters": "**Required:** patientId (integer) - Patient ID",
"operationId": "getDocuments",
"tags": [
"Documents"
],
"endpoint": {
"path": "/api/get-document/{patientId}",
"method": "GET",
"operationId": "getDocuments",
"summary": "Get patient documents",
"description": "Retrieve documents for a specific patient",
"tags": [
"Documents"
],
"parameters": [
{
"name": "patientId",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Documents retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"document_name": {
"type": "string",
"example": "medical_report.pdf"
},
"document_type": {
"type": "string",
"example": "medical_record"
},
"file_path": {
"type": "string",
"example": "documents/patient_1/medical_report.pdf"
},
"uploaded_at": {
"type": "string",
"format": "date-time",
"example": "2023-06-01T10:00:00"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Unauthenticated"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "No documents found",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "No documents found for this patient"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "documents",
"toolName": "provider_get_get_document",
"completeParameters": {
"patientId": {
"name": "patientId",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Documents retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"document_name": {
"type": "string",
"example": "medical_report.pdf"
},
"document_type": {
"type": "string",
"example": "medical_record"
},
"file_path": {
"type": "string",
"example": "documents/patient_1/medical_report.pdf"
},
"uploaded_at": {
"type": "string",
"format": "date-time",
"example": "2023-06-01T10:00:00"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Unauthenticated"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "No documents found",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "No documents found for this patient"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_get_document",
"detailedDescription": "Get patient documents"
}
},
{
"toolName": "provider_get_get_document_by_id",
"method": "GET",
"path": "/api/get-document-by-id/{patientId}/{did}",
"description": "Get a specific patient document by ID",
"category": "documents",
"parameters": "**Required:** patientId (integer) - Patient ID, **Required:** did (integer) - Document ID",
"operationId": "getDocumentsById",
"tags": [
"Documents"
],
"endpoint": {
"path": "/api/get-document-by-id/{patientId}/{did}",
"method": "GET",
"operationId": "getDocumentsById",
"summary": "Get a specific patient document by ID",
"description": "Retrieve a specific document for a patient by document ID",
"tags": [
"Documents"
],
"parameters": [
{
"name": "patientId",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
},
{
"name": "did",
"in": "path",
"required": true,
"type": "integer",
"description": "Document ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Document retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"document_name": {
"type": "string",
"example": "medical_report.pdf"
},
"document_type": {
"type": "string",
"example": "medical_record"
},
"file_path": {
"type": "string",
"example": "documents/patient_1/medical_report.pdf"
},
"uploaded_at": {
"type": "string",
"format": "date-time",
"example": "2023-06-01T10:00:00"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Unauthenticated"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Document not found",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Document not found"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "documents",
"toolName": "provider_get_get_document_by_id",
"completeParameters": {
"patientId": {
"name": "patientId",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
},
"did": {
"name": "did",
"in": "path",
"type": "integer",
"required": true,
"description": "Document ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Document retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"document_name": {
"type": "string",
"example": "medical_report.pdf"
},
"document_type": {
"type": "string",
"example": "medical_record"
},
"file_path": {
"type": "string",
"example": "documents/patient_1/medical_report.pdf"
},
"uploaded_at": {
"type": "string",
"format": "date-time",
"example": "2023-06-01T10:00:00"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Unauthenticated"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Document not found",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Document not found"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_get_document_by_id",
"detailedDescription": "Get a specific patient document by ID"
}
},
{
"toolName": "provider_create_add_vital",
"method": "POST",
"path": "/api/add-vital/{patientId}",
"description": "Add vital signs for a patient",
"category": "vitals",
"parameters": "**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",
"operationId": "addVital",
"tags": [
"Vitals"
],
"endpoint": {
"path": "/api/add-vital/{patientId}",
"method": "POST",
"operationId": "addVital",
"summary": "Add vital signs for a patient",
"description": "Record vital sign measurements for a specific patient",
"tags": [
"Vitals"
],
"parameters": [
{
"name": "patientId",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"provider_id"
],
"properties": {
"provider_id": {
"type": "integer",
"example": 1
},
"blood_presssure": {
"type": "string",
"example": "120"
},
"diastolic": {
"type": "string",
"example": "80"
},
"weight_lbs": {
"type": "number",
"format": "float",
"example": 175.5
},
"height_ft": {
"type": "integer",
"example": 5
},
"height_in": {
"type": "integer",
"example": 10
},
"temperature": {
"type": "number",
"format": "float",
"example": 98.6
},
"pulse": {
"type": "integer",
"example": 72
},
"respiratory_rate": {
"type": "integer",
"example": 16
},
"saturation": {
"type": "integer",
"example": 98
},
"waist_in": {
"type": "number",
"format": "float",
"example": 32.5
},
"headCircumference_in": {
"type": "number",
"format": "float",
"example": 22.5
},
"note": {
"type": "string",
"example": "Patient appears healthy"
},
"provider": {
"type": "string",
"example": "Dr. Smith"
},
"weight_oz": {
"type": "number",
"format": "float",
"example": 0
},
"bmi": {
"type": "number",
"format": "float",
"example": 24.5
},
"bloodSugar": {
"type": "number",
"format": "float",
"example": 95
},
"fasting": {
"type": "boolean",
"example": true
},
"neck_in": {
"type": "number",
"format": "float",
"example": 15.5
},
"shoulders_in": {
"type": "number",
"format": "float",
"example": 44
},
"chest_in": {
"type": "number",
"format": "float",
"example": 42
},
"hips_in": {
"type": "number",
"format": "float",
"example": 38
},
"lean_body_mass_lbs": {
"type": "number",
"format": "float",
"example": 145
},
"body_fat": {
"type": "number",
"format": "float",
"example": 18
},
"notes": {
"type": "string",
"example": "Additional observations"
},
"subjective_notes": {
"type": "string",
"example": "Patient reports feeling well"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Vitals added successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"status": {
"type": "string",
"example": "Success"
},
"patient": {
"type": "string",
"example": "Added Succesfully!"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Unauthenticated"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "The given data was invalid."
},
"errors": {
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "vitals",
"toolName": "provider_create_add_vital",
"completeParameters": {
"patientId": {
"name": "patientId",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"provider_id"
],
"properties": {
"provider_id": {
"type": "integer",
"example": 1
},
"blood_presssure": {
"type": "string",
"example": "120"
},
"diastolic": {
"type": "string",
"example": "80"
},
"weight_lbs": {
"type": "number",
"format": "float",
"example": 175.5
},
"height_ft": {
"type": "integer",
"example": 5
},
"height_in": {
"type": "integer",
"example": 10
},
"temperature": {
"type": "number",
"format": "float",
"example": 98.6
},
"pulse": {
"type": "integer",
"example": 72
},
"respiratory_rate": {
"type": "integer",
"example": 16
},
"saturation": {
"type": "integer",
"example": 98
},
"waist_in": {
"type": "number",
"format": "float",
"example": 32.5
},
"headCircumference_in": {
"type": "number",
"format": "float",
"example": 22.5
},
"note": {
"type": "string",
"example": "Patient appears healthy"
},
"provider": {
"type": "string",
"example": "Dr. Smith"
},
"weight_oz": {
"type": "number",
"format": "float",
"example": 0
},
"bmi": {
"type": "number",
"format": "float",
"example": 24.5
},
"bloodSugar": {
"type": "number",
"format": "float",
"example": 95
},
"fasting": {
"type": "boolean",
"example": true
},
"neck_in": {
"type": "number",
"format": "float",
"example": 15.5
},
"shoulders_in": {
"type": "number",
"format": "float",
"example": 44
},
"chest_in": {
"type": "number",
"format": "float",
"example": 42
},
"hips_in": {
"type": "number",
"format": "float",
"example": 38
},
"lean_body_mass_lbs": {
"type": "number",
"format": "float",
"example": 145
},
"body_fat": {
"type": "number",
"format": "float",
"example": 18
},
"notes": {
"type": "string",
"example": "Additional observations"
},
"subjective_notes": {
"type": "string",
"example": "Patient reports feeling well"
}
},
"type": "object"
},
"properties": {
"provider_id": {
"type": "integer",
"description": "provider_id property",
"example": 1,
"required": true
},
"blood_presssure": {
"type": "string",
"description": "blood_presssure property",
"example": "120",
"required": false
},
"diastolic": {
"type": "string",
"description": "diastolic property",
"example": "80",
"required": false
},
"weight_lbs": {
"type": "number",
"format": "float",
"description": "weight_lbs property",
"example": 175.5,
"required": false
},
"height_ft": {
"type": "integer",
"description": "height_ft property",
"example": 5,
"required": false
},
"height_in": {
"type": "integer",
"description": "height_in property",
"example": 10,
"required": false
},
"temperature": {
"type": "number",
"format": "float",
"description": "temperature property",
"example": 98.6,
"required": false
},
"pulse": {
"type": "integer",
"description": "pulse property",
"example": 72,
"required": false
},
"respiratory_rate": {
"type": "integer",
"description": "respiratory_rate property",
"example": 16,
"required": false
},
"saturation": {
"type": "integer",
"description": "saturation property",
"example": 98,
"required": false
},
"waist_in": {
"type": "number",
"format": "float",
"description": "waist_in property",
"example": 32.5,
"required": false
},
"headCircumference_in": {
"type": "number",
"format": "float",
"description": "headCircumference_in property",
"example": 22.5,
"required": false
},
"note": {
"type": "string",
"description": "note property",
"example": "Patient appears healthy",
"required": false
},
"provider": {
"type": "string",
"description": "provider property",
"example": "Dr. Smith",
"required": false
},
"weight_oz": {
"type": "number",
"format": "float",
"description": "weight_oz property",
"example": 0,
"required": false
},
"bmi": {
"type": "number",
"format": "float",
"description": "bmi property",
"example": 24.5,
"required": false
},
"bloodSugar": {
"type": "number",
"format": "float",
"description": "bloodSugar property",
"example": 95,
"required": false
},
"fasting": {
"type": "boolean",
"description": "fasting property",
"example": true,
"required": false
},
"neck_in": {
"type": "number",
"format": "float",
"description": "neck_in property",
"example": 15.5,
"required": false
},
"shoulders_in": {
"type": "number",
"format": "float",
"description": "shoulders_in property",
"example": 44,
"required": false
},
"chest_in": {
"type": "number",
"format": "float",
"description": "chest_in property",
"example": 42,
"required": false
},
"hips_in": {
"type": "number",
"format": "float",
"description": "hips_in property",
"example": 38,
"required": false
},
"lean_body_mass_lbs": {
"type": "number",
"format": "float",
"description": "lean_body_mass_lbs property",
"example": 145,
"required": false
},
"body_fat": {
"type": "number",
"format": "float",
"description": "body_fat property",
"example": 18,
"required": false
},
"notes": {
"type": "string",
"description": "notes property",
"example": "Additional observations",
"required": false
},
"subjective_notes": {
"type": "string",
"description": "subjective_notes property",
"example": "Patient reports feeling well",
"required": false
}
},
"required": [
"provider_id"
]
}
}
},
"responseSchema": {
"200": {
"description": "Vitals added successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"status": {
"type": "string",
"example": "Success"
},
"patient": {
"type": "string",
"example": "Added Succesfully!"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Unauthenticated"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "The given data was invalid."
},
"errors": {
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_add_vital",
"detailedDescription": "Add vital signs for a patient"
}
},
{
"toolName": "provider_get_get_stored_methods",
"method": "GET",
"path": "/api/get-stored-methods/{id}",
"description": "Get stored payment methods",
"category": "payments",
"parameters": "**Required:** id (integer) - Patient ID",
"operationId": "getStoredMethods",
"tags": [
"Payments"
],
"endpoint": {
"path": "/api/get-stored-methods/{id}",
"method": "GET",
"operationId": "getStoredMethods",
"summary": "Get stored payment methods",
"description": "Retrieve stored payment methods for a patient",
"tags": [
"Payments"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Payment methods retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "string",
"example": "pm_1NQb3f2eZvKYlo2CRZhYZ9Nj"
},
"brand": {
"type": "string",
"example": "visa"
},
"last4": {
"type": "string",
"example": "4242"
},
"exp_month": {
"type": "integer",
"example": 12
},
"exp_year": {
"type": "integer",
"example": 2025
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Unauthenticated"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "No payment methods found",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "No payment methods found"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "payments",
"toolName": "provider_get_get_stored_methods",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Payment methods retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "string",
"example": "pm_1NQb3f2eZvKYlo2CRZhYZ9Nj"
},
"brand": {
"type": "string",
"example": "visa"
},
"last4": {
"type": "string",
"example": "4242"
},
"exp_month": {
"type": "integer",
"example": 12
},
"exp_year": {
"type": "integer",
"example": 2025
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Unauthenticated"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "No payment methods found",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "No payment methods found"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_get_stored_methods",
"detailedDescription": "Get stored payment methods"
}
},
{
"toolName": "provider_get_patient_medical_problem",
"method": "GET",
"path": "/api/patient/medical-problem/{id}",
"description": "Get medical problem by ID",
"category": "medical_records",
"parameters": "**Required:** id (integer) - Medical problem ID",
"operationId": "getPatientMedicalProblemById",
"tags": [
"Patient Medical"
],
"endpoint": {
"path": "/api/patient/medical-problem/{id}",
"method": "GET",
"operationId": "getPatientMedicalProblemById",
"summary": "Get medical problem by ID",
"description": "Retrieve a specific medical problem details by ID",
"tags": [
"Patient Medical"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "Medical problem ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"data": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"patient_id": {
"type": "integer",
"example": 123
},
"description": {
"type": "string",
"example": "Hypertension"
},
"date_of_onset": {
"type": "string",
"format": "date",
"example": "2023-01-15"
},
"status": {
"type": "string",
"example": "active"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-01-15T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-01-15T12:00:00Z"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Medical problem not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Medical problem not found"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "medical_records",
"toolName": "provider_get_patient_medical_problem",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "Medical problem ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"data": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"patient_id": {
"type": "integer",
"example": 123
},
"description": {
"type": "string",
"example": "Hypertension"
},
"date_of_onset": {
"type": "string",
"format": "date",
"example": "2023-01-15"
},
"status": {
"type": "string",
"example": "active"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-01-15T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-01-15T12:00:00Z"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"404": {
"description": "Medical problem not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Medical problem not found"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_patient_medical_problem",
"detailedDescription": "Get medical problem by ID"
}
},
{
"toolName": "provider_update_patient_medical_problem",
"method": "PUT",
"path": "/api/patient/medical-problem/{id}",
"description": "Update medical problem",
"category": "medical_records",
"parameters": "**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",
"operationId": "updatePatientMedicalProblem",
"tags": [
"Patient Medical"
],
"endpoint": {
"path": "/api/patient/medical-problem/{id}",
"method": "PUT",
"operationId": "updatePatientMedicalProblem",
"summary": "Update medical problem",
"description": "Update an existing medical problem record",
"tags": [
"Patient Medical"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "Medical problem ID"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"properties": {
"description": {
"type": "string",
"example": "Updated diagnosis"
},
"date_of_onset": {
"type": "string",
"format": "date",
"example": "2023-02-15"
},
"status": {
"type": "string",
"example": "resolved"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Medical problem updated successfully"
},
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Medical problem not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Medical problem not found"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Validation error"
},
"errors": {
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "medical_records",
"toolName": "provider_update_patient_medical_problem",
"completeParameters": {
"id": {
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "Medical problem ID"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"description": {
"type": "string",
"example": "Updated diagnosis"
},
"date_of_onset": {
"type": "string",
"format": "date",
"example": "2023-02-15"
},
"status": {
"type": "string",
"example": "resolved"
}
},
"type": "object"
},
"properties": {
"description": {
"type": "string",
"description": "description property",
"example": "Updated diagnosis",
"required": false
},
"date_of_onset": {
"type": "string",
"format": "date",
"description": "date_of_onset property",
"example": "2023-02-15",
"required": false
},
"status": {
"type": "string",
"description": "status property",
"example": "resolved",
"required": false
}
},
"required": []
}
}
},
"responseSchema": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Medical problem updated successfully"
},
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"404": {
"description": "Medical problem not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Medical problem not found"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Validation error"
},
"errors": {
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_update_patient_medical_problem",
"detailedDescription": "Update medical problem"
}
},
{
"toolName": "provider_get_patient_history",
"method": "GET",
"path": "/api/patient/history/{patientId}",
"description": "Get patient history",
"category": "medical_records",
"parameters": "**Required:** patientId (integer) - Patient ID",
"operationId": "patientHistory",
"tags": [
"Patient Medical"
],
"endpoint": {
"path": "/api/patient/history/{patientId}",
"method": "GET",
"operationId": "patientHistory",
"summary": "Get patient history",
"description": "Retrieve patient medical history by patient ID",
"tags": [
"Patient Medical"
],
"parameters": [
{
"name": "patientId",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"visit_date": {
"type": "string",
"format": "date",
"example": "2023-01-15"
},
"diagnosis": {
"type": "string",
"example": "Common cold"
},
"treatment": {
"type": "string",
"example": "Rest and hydration"
},
"notes": {
"type": "string",
"example": "Patient improving"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-01-15T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-01-15T12:00:00Z"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Patient not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Patient not found"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "medical_records",
"toolName": "provider_get_patient_history",
"completeParameters": {
"patientId": {
"name": "patientId",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"visit_date": {
"type": "string",
"format": "date",
"example": "2023-01-15"
},
"diagnosis": {
"type": "string",
"example": "Common cold"
},
"treatment": {
"type": "string",
"example": "Rest and hydration"
},
"notes": {
"type": "string",
"example": "Patient improving"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-01-15T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-01-15T12:00:00Z"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"404": {
"description": "Patient not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Patient not found"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_patient_history",
"detailedDescription": "Get patient history"
}
},
{
"toolName": "provider_create_patient_medical_problem",
"method": "POST",
"path": "/api/patient/medical-problem/{pid}",
"description": "Store medical problem",
"category": "medical_records",
"parameters": "**Required:** pid (integer) - Patient ID, **Optional:** description (string) - description property, **Optional:** date_of_onset (string) - date_of_onset property, **Optional:** status (string) - status property",
"operationId": "storePatientMedicalProblem",
"tags": [
"Patient Medical"
],
"endpoint": {
"path": "/api/patient/medical-problem/{pid}",
"method": "POST",
"operationId": "storePatientMedicalProblem",
"summary": "Store medical problem",
"description": "Create a new medical problem record for a patient",
"tags": [
"Patient Medical"
],
"parameters": [
{
"name": "pid",
"in": "path",
"required": true,
"type": "integer",
"description": "Patient ID"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"properties": {
"description": {
"type": "string",
"example": "Migraine"
},
"date_of_onset": {
"type": "string",
"format": "date",
"example": "2023-03-10"
},
"status": {
"type": "string",
"example": "active"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Successfully created",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Medical problem created successfully"
},
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Patient not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Patient not found"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Validation error"
},
"errors": {
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "medical_records",
"toolName": "provider_create_patient_medical_problem",
"completeParameters": {
"pid": {
"name": "pid",
"in": "path",
"type": "integer",
"required": true,
"description": "Patient ID"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"description": {
"type": "string",
"example": "Migraine"
},
"date_of_onset": {
"type": "string",
"format": "date",
"example": "2023-03-10"
},
"status": {
"type": "string",
"example": "active"
}
},
"type": "object"
},
"properties": {
"description": {
"type": "string",
"description": "description property",
"example": "Migraine",
"required": false
},
"date_of_onset": {
"type": "string",
"format": "date",
"description": "date_of_onset property",
"example": "2023-03-10",
"required": false
},
"status": {
"type": "string",
"description": "status property",
"example": "active",
"required": false
}
},
"required": []
}
}
},
"responseSchema": {
"201": {
"description": "Successfully created",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Medical problem created successfully"
},
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"404": {
"description": "Patient not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Patient not found"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Validation error"
},
"errors": {
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_patient_medical_problem",
"detailedDescription": "Store medical problem"
}
},
{
"toolName": "provider_create_patient_profile_picture",
"method": "POST",
"path": "/api/patient/profile-picture",
"description": "Upload profile picture",
"category": "patients",
"parameters": "No parameters",
"operationId": "uploadProfilePicture",
"tags": [
"Patient Profile"
],
"endpoint": {
"path": "/api/patient/profile-picture",
"method": "POST",
"operationId": "uploadProfilePicture",
"summary": "Upload profile picture",
"description": "Upload and update patient profile picture",
"tags": [
"Patient Profile"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"profile_picture": {
"description": "Profile picture file (JPEG, PNG)",
"type": "string",
"format": "binary"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Profile picture uploaded successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Profile picture uploaded successfully"
},
"image_url": {
"type": "string",
"example": "https://example.com/storage/profiles/user123.jpg"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Invalid file format"
},
"errors": {
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "patients",
"toolName": "provider_create_patient_profile_picture",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"profile_picture": {
"description": "Profile picture file (JPEG, PNG)",
"type": "string",
"format": "binary"
}
},
"type": "object"
},
"properties": {
"profile_picture": {
"type": "string",
"format": "binary",
"description": "Profile picture file (JPEG, PNG)",
"required": false
}
},
"required": []
}
}
},
"responseSchema": {
"200": {
"description": "Profile picture uploaded successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Profile picture uploaded successfully"
},
"image_url": {
"type": "string",
"example": "https://example.com/storage/profiles/user123.jpg"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Invalid file format"
},
"errors": {
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_patient_profile_picture",
"detailedDescription": "Upload profile picture"
}
},
{
"toolName": "provider_get_patient_prescription",
"method": "GET",
"path": "/api/patient/prescription",
"description": "Get patient prescriptions",
"category": "medical_records",
"parameters": "No parameters",
"operationId": "getPatientPrescriptions",
"tags": [
"Patient Medical"
],
"endpoint": {
"path": "/api/patient/prescription",
"method": "GET",
"operationId": "getPatientPrescriptions",
"summary": "Get patient prescriptions",
"description": "Get list of prescriptions for the authenticated patient",
"tags": [
"Patient Medical"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"medication": {
"type": "string",
"example": "Amoxicillin"
},
"dosage": {
"type": "string",
"example": "500mg"
},
"frequency": {
"type": "string",
"example": "3 times daily"
},
"start_date": {
"type": "string",
"format": "date",
"example": "2023-04-15"
},
"end_date": {
"type": "string",
"format": "date",
"example": "2023-04-25"
},
"doctor_name": {
"type": "string",
"example": "Dr. John Smith"
},
"status": {
"type": "string",
"example": "active"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-04-15T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-04-15T12:00:00Z"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "No prescriptions found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "No prescriptions found"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "medical_records",
"toolName": "provider_get_patient_prescription",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"medication": {
"type": "string",
"example": "Amoxicillin"
},
"dosage": {
"type": "string",
"example": "500mg"
},
"frequency": {
"type": "string",
"example": "3 times daily"
},
"start_date": {
"type": "string",
"format": "date",
"example": "2023-04-15"
},
"end_date": {
"type": "string",
"format": "date",
"example": "2023-04-25"
},
"doctor_name": {
"type": "string",
"example": "Dr. John Smith"
},
"status": {
"type": "string",
"example": "active"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-04-15T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-04-15T12:00:00Z"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"404": {
"description": "No prescriptions found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "No prescriptions found"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_patient_prescription",
"detailedDescription": "Get patient prescriptions"
}
},
{
"toolName": "provider_get_patient_session_history",
"method": "GET",
"path": "/api/patient/session-history",
"description": "Get patient session history",
"category": "medical_records",
"parameters": "No parameters",
"operationId": "sessionHistory",
"tags": [
"Patient Medical"
],
"endpoint": {
"path": "/api/patient/session-history",
"method": "GET",
"operationId": "sessionHistory",
"summary": "Get patient session history",
"description": "Get history of patient sessions and visits",
"tags": [
"Patient Medical"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"session_date": {
"type": "string",
"format": "date-time",
"example": "2023-05-15T14:30:00Z"
},
"doctor_name": {
"type": "string",
"example": "Dr. Jane Doe"
},
"duration": {
"type": "integer",
"example": 30
},
"notes": {
"type": "string",
"example": "Follow-up appointment"
},
"status": {
"type": "string",
"example": "completed"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-05-15T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-05-15T12:00:00Z"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "No session history found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "No session history found"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "medical_records",
"toolName": "provider_get_patient_session_history",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"session_date": {
"type": "string",
"format": "date-time",
"example": "2023-05-15T14:30:00Z"
},
"doctor_name": {
"type": "string",
"example": "Dr. Jane Doe"
},
"duration": {
"type": "integer",
"example": 30
},
"notes": {
"type": "string",
"example": "Follow-up appointment"
},
"status": {
"type": "string",
"example": "completed"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-05-15T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-05-15T12:00:00Z"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"404": {
"description": "No session history found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "No session history found"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_patient_session_history",
"detailedDescription": "Get patient session history"
}
},
{
"toolName": "provider_get_patient_notifications",
"method": "GET",
"path": "/api/patient/notifications",
"description": "Get patient notifications",
"category": "patients",
"parameters": "No parameters",
"operationId": "getNotification",
"tags": [
"Patient Profile"
],
"endpoint": {
"path": "/api/patient/notifications",
"method": "GET",
"operationId": "getNotification",
"summary": "Get patient notifications",
"description": "Get list of notifications for the authenticated patient",
"tags": [
"Patient Profile"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"title": {
"type": "string",
"example": "Appointment Reminder"
},
"message": {
"type": "string",
"example": "You have an appointment tomorrow at 2:00 PM"
},
"read": {
"type": "boolean",
"example": false
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-06-15T12:00:00Z"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "patients",
"toolName": "provider_get_patient_notifications",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"title": {
"type": "string",
"example": "Appointment Reminder"
},
"message": {
"type": "string",
"example": "You have an appointment tomorrow at 2:00 PM"
},
"read": {
"type": "boolean",
"example": false
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-06-15T12:00:00Z"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
}
},
"exactToolName": "provider_get_patient_notifications",
"detailedDescription": "Get patient notifications"
}
},
{
"toolName": "provider_get_patient_data",
"method": "GET",
"path": "/api/patient/data",
"description": "Get patient data",
"category": "patients",
"parameters": "No parameters",
"operationId": "getPatientData",
"tags": [
"Patient Profile"
],
"endpoint": {
"path": "/api/patient/data",
"method": "GET",
"operationId": "getPatientData",
"summary": "Get patient data",
"description": "Get comprehensive data for the authenticated patient",
"tags": [
"Patient Profile"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"data": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"first_name": {
"type": "string",
"example": "John"
},
"last_name": {
"type": "string",
"example": "Doe"
},
"email": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"phone": {
"type": "string",
"example": "123-456-7890"
},
"dob": {
"type": "string",
"format": "date",
"example": "1985-05-15"
},
"gender": {
"type": "string",
"example": "male"
},
"address": {
"type": "object"
},
"medical_history": {
"type": "array",
"items": {
"type": "object"
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-01-01T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-01-01T12:00:00Z"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Patient not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Patient not found"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "patients",
"toolName": "provider_get_patient_data",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"data": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"first_name": {
"type": "string",
"example": "John"
},
"last_name": {
"type": "string",
"example": "Doe"
},
"email": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
},
"phone": {
"type": "string",
"example": "123-456-7890"
},
"dob": {
"type": "string",
"format": "date",
"example": "1985-05-15"
},
"gender": {
"type": "string",
"example": "male"
},
"address": {
"type": "object"
},
"medical_history": {
"type": "array",
"items": {
"type": "object"
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-01-01T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-01-01T12:00:00Z"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"404": {
"description": "Patient not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Patient not found"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_patient_data",
"detailedDescription": "Get patient data"
}
},
{
"toolName": "provider_get_patient_subscriptions",
"method": "GET",
"path": "/api/patient/subscriptions",
"description": "Get patient subscription list",
"category": "patients",
"parameters": "No parameters",
"operationId": "getSubscriptionList",
"tags": [
"Patient Subscription"
],
"endpoint": {
"path": "/api/patient/subscriptions",
"method": "GET",
"operationId": "getSubscriptionList",
"summary": "Get patient subscription list",
"description": "Get list of subscriptions for the authenticated patient",
"tags": [
"Patient Subscription"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"plan_name": {
"type": "string",
"example": "Premium Health Plan"
},
"amount": {
"type": "number",
"format": "float",
"example": 49.99
},
"frequency": {
"type": "string",
"example": "monthly"
},
"start_date": {
"type": "string",
"format": "date",
"example": "2023-01-15"
},
"next_billing_date": {
"type": "string",
"format": "date",
"example": "2023-02-15"
},
"status": {
"type": "string",
"example": "active"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-01-15T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-01-15T12:00:00Z"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "patients",
"toolName": "provider_get_patient_subscriptions",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"plan_name": {
"type": "string",
"example": "Premium Health Plan"
},
"amount": {
"type": "number",
"format": "float",
"example": 49.99
},
"frequency": {
"type": "string",
"example": "monthly"
},
"start_date": {
"type": "string",
"format": "date",
"example": "2023-01-15"
},
"next_billing_date": {
"type": "string",
"format": "date",
"example": "2023-02-15"
},
"status": {
"type": "string",
"example": "active"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-01-15T12:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-01-15T12:00:00Z"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
}
},
"exactToolName": "provider_get_patient_subscriptions",
"detailedDescription": "Get patient subscription list"
}
},
{
"toolName": "provider_create_patient_subscription_cancel",
"method": "POST",
"path": "/api/patient/subscription/{subscription}/cancel",
"description": "Cancel subscription",
"category": "patients",
"parameters": "**Required:** subscription (integer) - Subscription ID, **Optional:** reason (string) - reason property, **Optional:** feedback (string) - feedback property",
"operationId": "cancelSubscription",
"tags": [
"Patient Subscription"
],
"endpoint": {
"path": "/api/patient/subscription/{subscription}/cancel",
"method": "POST",
"operationId": "cancelSubscription",
"summary": "Cancel subscription",
"description": "Cancel an existing patient subscription",
"tags": [
"Patient Subscription"
],
"parameters": [
{
"name": "subscription",
"in": "path",
"required": true,
"type": "integer",
"description": "Subscription ID"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"properties": {
"reason": {
"type": "string",
"example": "Too expensive"
},
"feedback": {
"type": "string",
"example": "I found a better option elsewhere"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Subscription cancelled successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Subscription cancelled successfully"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Subscription not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Subscription not found"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "patients",
"toolName": "provider_create_patient_subscription_cancel",
"completeParameters": {
"subscription": {
"name": "subscription",
"in": "path",
"type": "integer",
"required": true,
"description": "Subscription ID"
}
},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"reason": {
"type": "string",
"example": "Too expensive"
},
"feedback": {
"type": "string",
"example": "I found a better option elsewhere"
}
},
"type": "object"
},
"properties": {
"reason": {
"type": "string",
"description": "reason property",
"example": "Too expensive",
"required": false
},
"feedback": {
"type": "string",
"description": "feedback property",
"example": "I found a better option elsewhere",
"required": false
}
},
"required": []
}
}
},
"responseSchema": {
"200": {
"description": "Subscription cancelled successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Subscription cancelled successfully"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"404": {
"description": "Subscription not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Subscription not found"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_patient_subscription_cancel",
"detailedDescription": "Cancel subscription"
}
},
{
"toolName": "provider_create_patient_process_payment",
"method": "POST",
"path": "/api/patient/process-payment",
"description": "Process payment",
"category": "payments",
"parameters": "**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",
"operationId": "processPayment",
"tags": [
"Patient Payment"
],
"endpoint": {
"path": "/api/patient/process-payment",
"method": "POST",
"operationId": "processPayment",
"summary": "Process payment",
"description": "Process a payment for the patient",
"tags": [
"Patient Payment"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"amount",
"payment_method",
"currency"
],
"properties": {
"amount": {
"type": "number",
"format": "float",
"example": 99.99
},
"payment_method": {
"type": "string",
"example": "card"
},
"currency": {
"type": "string",
"example": "USD"
},
"payment_method_id": {
"type": "string",
"example": "pm_card_visa"
},
"description": {
"type": "string",
"example": "Payment for consultation"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Payment processed successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Payment processed successfully"
},
"transaction_id": {
"type": "string",
"example": "txn_1KjH7b2eZvKYlo2C0A3b5XCL"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Validation error"
},
"errors": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Payment processing failed",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Payment processing failed"
},
"error": {
"type": "string",
"example": "Your card was declined"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "payments",
"toolName": "provider_create_patient_process_payment",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"amount",
"payment_method",
"currency"
],
"properties": {
"amount": {
"type": "number",
"format": "float",
"example": 99.99
},
"payment_method": {
"type": "string",
"example": "card"
},
"currency": {
"type": "string",
"example": "USD"
},
"payment_method_id": {
"type": "string",
"example": "pm_card_visa"
},
"description": {
"type": "string",
"example": "Payment for consultation"
}
},
"type": "object"
},
"properties": {
"amount": {
"type": "number",
"format": "float",
"description": "amount property",
"example": 99.99,
"required": true
},
"payment_method": {
"type": "string",
"description": "payment_method property",
"example": "card",
"required": true
},
"currency": {
"type": "string",
"description": "currency property",
"example": "USD",
"required": true
},
"payment_method_id": {
"type": "string",
"description": "payment_method_id property",
"example": "pm_card_visa",
"required": false
},
"description": {
"type": "string",
"description": "description property",
"example": "Payment for consultation",
"required": false
}
},
"required": [
"amount",
"payment_method",
"currency"
]
}
}
},
"responseSchema": {
"200": {
"description": "Payment processed successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Payment processed successfully"
},
"transaction_id": {
"type": "string",
"example": "txn_1KjH7b2eZvKYlo2C0A3b5XCL"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Validation error"
},
"errors": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Payment processing failed",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Payment processing failed"
},
"error": {
"type": "string",
"example": "Your card was declined"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_patient_process_payment",
"detailedDescription": "Process payment"
}
},
{
"toolName": "provider_create_token_generate_temporary",
"method": "POST",
"path": "/api/token/generate-temporary",
"description": "Generate a temporary API token",
"category": "tokens",
"parameters": "**Required:** user_id (integer) - user_id property, **Required:** expires_in_hours (integer) - expires_in_hours property, **Optional:** abilities (array) - abilities property",
"operationId": "generateTemporaryToken",
"tags": [
"Token Management"
],
"endpoint": {
"path": "/api/token/generate-temporary",
"method": "POST",
"operationId": "generateTemporaryToken",
"summary": "Generate a temporary API token",
"description": "Creates a token with specified expiration time for a user",
"tags": [
"Token Management"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"user_id",
"expires_in_hours"
],
"properties": {
"user_id": {
"type": "integer",
"example": 1
},
"expires_in_hours": {
"type": "integer",
"example": 24
},
"abilities": {
"type": "array",
"items": {
"type": "string",
"example": "read"
}
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Temporary token generated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"user": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
}
},
"type": "object"
},
"token": {
"type": "string",
"example": "1|LNEBIslIcADi7yjPgHPxNZ0EfFdRrHG5g3KJw1Bd"
},
"expires_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-03T12:00:00Z"
},
"expires_in_hours": {
"type": "integer",
"example": 24
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Validation failed"
},
"errors": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Failed to generate temporary token"
},
"error": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "tokens",
"toolName": "provider_create_token_generate_temporary",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"user_id",
"expires_in_hours"
],
"properties": {
"user_id": {
"type": "integer",
"example": 1
},
"expires_in_hours": {
"type": "integer",
"example": 24
},
"abilities": {
"type": "array",
"items": {
"type": "string",
"example": "read"
}
}
},
"type": "object"
},
"properties": {
"user_id": {
"type": "integer",
"description": "user_id property",
"example": 1,
"required": true
},
"expires_in_hours": {
"type": "integer",
"description": "expires_in_hours property",
"example": 24,
"required": true
},
"abilities": {
"type": "array",
"description": "abilities property",
"items": {
"type": "string",
"example": "read"
},
"required": false
}
},
"required": [
"user_id",
"expires_in_hours"
]
}
}
},
"responseSchema": {
"200": {
"description": "Temporary token generated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"user": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
}
},
"type": "object"
},
"token": {
"type": "string",
"example": "1|LNEBIslIcADi7yjPgHPxNZ0EfFdRrHG5g3KJw1Bd"
},
"expires_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-03T12:00:00Z"
},
"expires_in_hours": {
"type": "integer",
"example": 24
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Validation failed"
},
"errors": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Failed to generate temporary token"
},
"error": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_token_generate_temporary",
"detailedDescription": "Generate a temporary API token"
}
},
{
"toolName": "provider_get_token_list",
"method": "GET",
"path": "/api/token/list/{userId}",
"description": "List all tokens for a user",
"category": "tokens",
"parameters": "**Required:** userId (integer) - User ID",
"operationId": "listUserTokens",
"tags": [
"Token Management"
],
"endpoint": {
"path": "/api/token/list/{userId}",
"method": "GET",
"operationId": "listUserTokens",
"summary": "List all tokens for a user",
"description": "Retrieves all active tokens for the specified user",
"tags": [
"Token Management"
],
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"type": "integer",
"description": "User ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "List of user tokens",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"user": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
}
},
"type": "object"
},
"tokens_count": {
"type": "integer",
"example": 2
},
"tokens": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "permanent-access-token"
},
"abilities": {
"type": "array",
"items": {
"type": "string",
"example": "*"
}
},
"last_used_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T10:00:00Z"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-06-15T08:30:00Z"
},
"expires_at": {
"type": "string",
"example": "Never"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "User not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "User not found"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Failed to retrieve tokens"
},
"error": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "tokens",
"toolName": "provider_get_token_list",
"completeParameters": {
"userId": {
"name": "userId",
"in": "path",
"type": "integer",
"required": true,
"description": "User ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "List of user tokens",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"user": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
}
},
"type": "object"
},
"tokens_count": {
"type": "integer",
"example": 2
},
"tokens": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "permanent-access-token"
},
"abilities": {
"type": "array",
"items": {
"type": "string",
"example": "*"
}
},
"last_used_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-01T10:00:00Z"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-06-15T08:30:00Z"
},
"expires_at": {
"type": "string",
"example": "Never"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"404": {
"description": "User not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "User not found"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Failed to retrieve tokens"
},
"error": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_get_token_list",
"detailedDescription": "List all tokens for a user"
}
},
{
"toolName": "provider_delete_token_revoke",
"method": "DELETE",
"path": "/api/token/revoke",
"description": "Revoke a specific token",
"category": "tokens",
"parameters": "**Required:** token_id (integer) - token_id property",
"operationId": "revokeToken",
"tags": [
"Token Management"
],
"endpoint": {
"path": "/api/token/revoke",
"method": "DELETE",
"operationId": "revokeToken",
"summary": "Revoke a specific token",
"description": "Revokes a token by its ID. Only the token owner or an admin can revoke a token.",
"tags": [
"Token Management"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"token_id"
],
"properties": {
"token_id": {
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Token revoked successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Token revoked successfully"
},
"token_id": {
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Unauthorized to revoke this token"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Validation failed"
},
"errors": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Failed to revoke token"
},
"error": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "tokens",
"toolName": "provider_delete_token_revoke",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"token_id"
],
"properties": {
"token_id": {
"type": "integer",
"example": 1
}
},
"type": "object"
},
"properties": {
"token_id": {
"type": "integer",
"description": "token_id property",
"example": 1,
"required": true
}
},
"required": [
"token_id"
]
}
}
},
"responseSchema": {
"200": {
"description": "Token revoked successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Token revoked successfully"
},
"token_id": {
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Unauthorized to revoke this token"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Validation failed"
},
"errors": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Failed to revoke token"
},
"error": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_delete_token_revoke",
"detailedDescription": "Revoke a specific token"
}
},
{
"toolName": "provider_delete_token_revoke_all",
"method": "DELETE",
"path": "/api/token/revoke-all/{userId}",
"description": "Revoke all tokens for a user",
"category": "tokens",
"parameters": "**Required:** userId (integer) - User ID",
"operationId": "revokeAllUserTokens",
"tags": [
"Token Management"
],
"endpoint": {
"path": "/api/token/revoke-all/{userId}",
"method": "DELETE",
"operationId": "revokeAllUserTokens",
"summary": "Revoke all tokens for a user",
"description": "Revokes all tokens for the specified user. Only the user themselves or an admin can perform this action.",
"tags": [
"Token Management"
],
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"type": "integer",
"description": "User ID"
}
],
"requestBody": null,
"responses": {
"200": {
"description": "All tokens revoked successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "All tokens revoked successfully"
},
"tokens_revoked": {
"type": "integer",
"example": 5
},
"user_id": {
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Unauthorized to revoke tokens for this user"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "User not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "User not found"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Failed to revoke tokens"
},
"error": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "tokens",
"toolName": "provider_delete_token_revoke_all",
"completeParameters": {
"userId": {
"name": "userId",
"in": "path",
"type": "integer",
"required": true,
"description": "User ID"
}
},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "All tokens revoked successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "All tokens revoked successfully"
},
"tokens_revoked": {
"type": "integer",
"example": 5
},
"user_id": {
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"403": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Unauthorized to revoke tokens for this user"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "User not found",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "User not found"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Failed to revoke tokens"
},
"error": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_delete_token_revoke_all",
"detailedDescription": "Revoke all tokens for a user"
}
},
{
"toolName": "provider_create_token_create_with_abilities",
"method": "POST",
"path": "/api/token/create-with-abilities",
"description": "Create a token with specific abilities",
"category": "tokens",
"parameters": "**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",
"operationId": "createTokenWithAbilities",
"tags": [
"Token Management"
],
"endpoint": {
"path": "/api/token/create-with-abilities",
"method": "POST",
"operationId": "createTokenWithAbilities",
"summary": "Create a token with specific abilities",
"description": "Creates a token with specific abilities (permissions) for a user",
"tags": [
"Token Management"
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"user_id",
"token_name",
"abilities"
],
"properties": {
"user_id": {
"type": "integer",
"example": 1
},
"token_name": {
"type": "string",
"example": "api-access-token"
},
"abilities": {
"type": "array",
"items": {
"type": "string",
"example": "read"
}
},
"expires_in_hours": {
"type": "integer",
"example": 72
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Token created successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Token created successfully"
},
"user": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
}
},
"type": "object"
},
"token": {
"properties": {
"name": {
"type": "string",
"example": "api-access-token"
},
"abilities": {
"type": "array",
"items": {
"type": "string",
"example": "read"
}
},
"plain_text": {
"type": "string",
"example": "1|LNEBIslIcADi7yjPgHPxNZ0EfFdRrHG5g3KJw1Bd"
},
"expires_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-05T12:00:00Z"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Validation failed"
},
"errors": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Failed to create token"
},
"error": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "tokens",
"toolName": "provider_create_token_create_with_abilities",
"completeParameters": {},
"requestBodySchema": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"user_id",
"token_name",
"abilities"
],
"properties": {
"user_id": {
"type": "integer",
"example": 1
},
"token_name": {
"type": "string",
"example": "api-access-token"
},
"abilities": {
"type": "array",
"items": {
"type": "string",
"example": "read"
}
},
"expires_in_hours": {
"type": "integer",
"example": 72
}
},
"type": "object"
},
"properties": {
"user_id": {
"type": "integer",
"description": "user_id property",
"example": 1,
"required": true
},
"token_name": {
"type": "string",
"description": "token_name property",
"example": "api-access-token",
"required": true
},
"abilities": {
"type": "array",
"description": "abilities property",
"items": {
"type": "string",
"example": "read"
},
"required": true
},
"expires_in_hours": {
"type": "integer",
"description": "expires_in_hours property",
"example": 72,
"required": false
}
},
"required": [
"user_id",
"token_name",
"abilities"
]
}
}
},
"responseSchema": {
"200": {
"description": "Token created successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Token created successfully"
},
"user": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
}
},
"type": "object"
},
"token": {
"properties": {
"name": {
"type": "string",
"example": "api-access-token"
},
"abilities": {
"type": "array",
"items": {
"type": "string",
"example": "read"
}
},
"plain_text": {
"type": "string",
"example": "1|LNEBIslIcADi7yjPgHPxNZ0EfFdRrHG5g3KJw1Bd"
},
"expires_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-05T12:00:00Z"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Validation failed"
},
"errors": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Failed to create token"
},
"error": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_token_create_with_abilities",
"detailedDescription": "Create a token with specific abilities"
}
},
{
"toolName": "provider_create_token_refresh",
"method": "POST",
"path": "/api/token/refresh",
"description": "Refresh current token",
"category": "tokens",
"parameters": "No parameters",
"operationId": "refreshCurrentToken",
"tags": [
"Token Management"
],
"endpoint": {
"path": "/api/token/refresh",
"method": "POST",
"operationId": "refreshCurrentToken",
"summary": "Refresh current token",
"description": "Refreshes the current token while preserving its abilities and expiration settings",
"tags": [
"Token Management"
],
"parameters": [],
"requestBody": null,
"responses": {
"200": {
"description": "Token refreshed successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Token refreshed successfully"
},
"user": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
}
},
"type": "object"
},
"token": {
"type": "string",
"example": "1|LNEBIslIcADi7yjPgHPxNZ0EfFdRrHG5g3KJw1Bd"
},
"expires_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-05T12:00:00Z"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Invalid token",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Invalid token"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Unauthenticated"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Failed to refresh token"
},
"error": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
],
"requiresAuth": true,
"authType": "provider",
"category": "tokens",
"toolName": "provider_create_token_refresh",
"completeParameters": {},
"requestBodySchema": null,
"responseSchema": {
"200": {
"description": "Token refreshed successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Token refreshed successfully"
},
"user": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"format": "email",
"example": "john.doe@example.com"
}
},
"type": "object"
},
"token": {
"type": "string",
"example": "1|LNEBIslIcADi7yjPgHPxNZ0EfFdRrHG5g3KJw1Bd"
},
"expires_at": {
"type": "string",
"format": "date-time",
"example": "2023-07-05T12:00:00Z"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Invalid token",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Invalid token"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthenticated",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Unauthenticated"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Failed to refresh token"
},
"error": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"exactToolName": "provider_create_token_refresh",
"detailedDescription": "Refresh current token"
}
}
]