13668 lines
348 KiB
JSON
13668 lines
348 KiB
JSON
{
|
|
"summary": {
|
|
"totalApiEndpoints": 234,
|
|
"totalCurrentTools": 158,
|
|
"missingEndpoints": 152,
|
|
"parameterMismatches": 49,
|
|
"newToolsGenerated": 152
|
|
},
|
|
"missingEndpoints": [
|
|
{
|
|
"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",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Meeting ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Meeting ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "agent_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Agent ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "appointment_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "call_type",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "appointment_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/appointment-status/{id}/{status}",
|
|
"method": "POST",
|
|
"operationId": "markAppointmentsStatus",
|
|
"summary": "Mark appointment status",
|
|
"description": "Updates the status of an appointment",
|
|
"tags": [
|
|
"Appointments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "status",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "New status for the appointment",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/appointment-participants/{appointmentId}",
|
|
"method": "GET",
|
|
"operationId": "getAppointmentParticipants",
|
|
"summary": "Get appointment participants",
|
|
"description": "Retrieve appointment details including participant name, patient name, patient ID, and patient email",
|
|
"tags": [
|
|
"Appointments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "appointmentId",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [],
|
|
"authType": "public"
|
|
},
|
|
{
|
|
"path": "/start-record/{appointment}",
|
|
"method": "POST",
|
|
"operationId": "startRecording",
|
|
"summary": "Start recording",
|
|
"description": "Start recording for an appointment",
|
|
"tags": [
|
|
"Meetings"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "appointment",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [],
|
|
"authType": "public"
|
|
},
|
|
{
|
|
"path": "/emr/patients-list",
|
|
"method": "GET",
|
|
"operationId": "getPatientsList",
|
|
"summary": "Get patients list",
|
|
"description": "Retrieve a paginated list of patients for the authenticated provider",
|
|
"tags": [
|
|
"Patients"
|
|
],
|
|
"parameters": [],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/emr/patient-data/{id}",
|
|
"method": "GET",
|
|
"operationId": "getPatientData",
|
|
"summary": "Get patient data",
|
|
"description": "Retrieve detailed patient information by ID",
|
|
"tags": [
|
|
"Patients"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/dashboard-states",
|
|
"method": "GET",
|
|
"operationId": "getDashboardStates",
|
|
"summary": "Get dashboard states",
|
|
"description": "Retrieve dashboard state information including patient counts, appointments, revenue, and other statistics",
|
|
"tags": [
|
|
"Dashboard"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "start_date",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Start date for the dashboard data range",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "end_date",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "End date for the dashboard data range",
|
|
"location": "query"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/emr/get-patient-data/{id}",
|
|
"method": "GET",
|
|
"operationId": "getPatientDataById",
|
|
"summary": "Get patient data by ID",
|
|
"description": "Retrieve patient data by ID from EMR system",
|
|
"tags": [
|
|
"Patients"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/emr/patients/profile-image/{pid}",
|
|
"method": "GET",
|
|
"operationId": "getProfileImage",
|
|
"summary": "Get patient profile image",
|
|
"description": "Retrieve patient profile image by patient ID",
|
|
"tags": [
|
|
"Patients"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "pid",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/emr/patients/store-document/{pid}",
|
|
"method": "POST",
|
|
"operationId": "storeDocumentsEmr",
|
|
"summary": "Store patient document",
|
|
"description": "Upload and store a document for a patient",
|
|
"tags": [
|
|
"Patients"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "pid",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/emr/patients/get-document/{pid}",
|
|
"method": "GET",
|
|
"operationId": "getDocumentEmr",
|
|
"summary": "Get patient documents",
|
|
"description": "Retrieve documents for a patient",
|
|
"tags": [
|
|
"Patients"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "pid",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/emr/register-patients",
|
|
"method": "POST",
|
|
"operationId": "registerPatient",
|
|
"summary": "Register new patient",
|
|
"description": "Register a new patient in the EMR system",
|
|
"tags": [
|
|
"Patients"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "firstName",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "lastName",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "dateOfBirth",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "phone",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "address",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "public"
|
|
},
|
|
{
|
|
"path": "/emr/update-patient/{id}",
|
|
"method": "POST",
|
|
"operationId": "updatePatient",
|
|
"summary": "Update patient",
|
|
"description": "Update patient information in EMR system",
|
|
"tags": [
|
|
"Patients"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "firstName",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "lastName",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "dateOfBirth",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "phone",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "address",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/emr/guardian-update/{id}",
|
|
"method": "POST",
|
|
"operationId": "guardianUpdate",
|
|
"summary": "Update patient guardian information",
|
|
"description": "Update guardian/next of kin information for a patient",
|
|
"tags": [
|
|
"Patients"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "nextKinRelation",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "nextkinPhone",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "nextkinAddress",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "nextkinCity",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "nextkinState",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "nextkinZipCode",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "nextkinFirstName",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "nextkinLastName",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/store-insurance/{patientId}",
|
|
"method": "POST",
|
|
"operationId": "insuranceStore",
|
|
"summary": "Store patient insurance",
|
|
"description": "Store insurance information for a patient",
|
|
"tags": [
|
|
"Insurance"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patientId",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "insuredPlanOrProgramName",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredIDNumber",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredGroupNameNo",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "payerName",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "relationshiptoInsured",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredDateOfBirth",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredAddress",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredZip",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredCity",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredState",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredPhone",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "coPayment",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/get-insurance/{patientId}",
|
|
"method": "GET",
|
|
"operationId": "getInsurance",
|
|
"summary": "Get patient insurance",
|
|
"description": "Retrieve insurance information for a patient",
|
|
"tags": [
|
|
"Insurance"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patientId",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/update-insurance/{patientId}",
|
|
"method": "POST",
|
|
"operationId": "updateInsurance",
|
|
"summary": "Update patient insurance",
|
|
"description": "Update insurance information for a patient",
|
|
"tags": [
|
|
"Insurance"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patientId",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "insuredPlanOrProgramName",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredIDNumber",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredGroupNameNo",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "payerName",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "relationshiptoInsured",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredDateOfBirth",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredAddress",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredZip",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredCity",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredState",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredPhone",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "coPayment",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/locations",
|
|
"method": "GET",
|
|
"operationId": "getLocations",
|
|
"summary": "Get locations",
|
|
"description": "Retrieve all locations for the provider",
|
|
"tags": [
|
|
"Locations"
|
|
],
|
|
"parameters": [],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/add-location",
|
|
"method": "POST",
|
|
"operationId": "addLocation",
|
|
"summary": "Add location",
|
|
"description": "Add a new location",
|
|
"tags": [
|
|
"Locations"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "address",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "city",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "state",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "postal_code",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "phone",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/update-location/{id}",
|
|
"method": "POST",
|
|
"operationId": "updateLocation",
|
|
"summary": "Update location",
|
|
"description": "Update an existing location",
|
|
"tags": [
|
|
"Locations"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Location ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "address",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "city",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "state",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "postal_code",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "phone",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/get-location/{uuid}",
|
|
"method": "GET",
|
|
"operationId": "getLocationById",
|
|
"summary": "Get location by UUID",
|
|
"description": "Retrieve a specific location by UUID",
|
|
"tags": [
|
|
"Locations"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "uuid",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Location UUID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/patient-nextofskin",
|
|
"method": "POST",
|
|
"operationId": "addNextOfKin",
|
|
"summary": "Add next of kin",
|
|
"description": "Add next of kin information for a patient",
|
|
"tags": [
|
|
"Patients"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patient_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "nextKinRelation",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "nextkinPhone",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "nextkinAddress",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "nextkinCity",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "nextkinState",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "nextkinZipCode",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "nextkinFirstName",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "nextkinLastName",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/patient-insurance",
|
|
"method": "POST",
|
|
"operationId": "addPatientInsurance",
|
|
"summary": "Add patient insurance",
|
|
"description": "Add insurance information for a patient",
|
|
"tags": [
|
|
"Insurance"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patient_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredPlanOrProgramName",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredIDNumber",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredGroupNameNo",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "payerName",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "relationshiptoInsured",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredDateOfBirth",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredAddress",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredZip",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredCity",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredState",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insuredPhone",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "coPayment",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/patient-eligibility-check",
|
|
"method": "POST",
|
|
"operationId": "checkPatientEligibility",
|
|
"summary": "Check patient eligibility",
|
|
"description": "Check insurance eligibility for a patient",
|
|
"tags": [
|
|
"Insurance"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patient_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "insurance_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/emr/get-products",
|
|
"method": "GET",
|
|
"operationId": "getProducts",
|
|
"summary": "Get products",
|
|
"description": "Retrieve all products",
|
|
"tags": [
|
|
"Products"
|
|
],
|
|
"parameters": [],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/emr/save-product",
|
|
"method": "POST",
|
|
"operationId": "saveProduct",
|
|
"summary": "Save product",
|
|
"description": "Create a new product",
|
|
"tags": [
|
|
"Products"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "price",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "category_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/emr/update-product",
|
|
"method": "POST",
|
|
"operationId": "updateProduct",
|
|
"summary": "Update product",
|
|
"description": "Update an existing product",
|
|
"tags": [
|
|
"Products"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "price",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "category_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/emr/get-categories",
|
|
"method": "GET",
|
|
"operationId": "getCategories",
|
|
"summary": "Get categories",
|
|
"description": "Retrieve all categories",
|
|
"tags": [
|
|
"Categories"
|
|
],
|
|
"parameters": [],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/emr/save-category",
|
|
"method": "POST",
|
|
"operationId": "saveCategory",
|
|
"summary": "Save category",
|
|
"description": "Create a new category",
|
|
"tags": [
|
|
"Categories"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/emr/update-category",
|
|
"method": "POST",
|
|
"operationId": "updateCategory",
|
|
"summary": "Update category",
|
|
"description": "Update an existing category",
|
|
"tags": [
|
|
"Categories"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/text-messages",
|
|
"method": "GET",
|
|
"operationId": "getTextMessages",
|
|
"summary": "Get text messages",
|
|
"description": "Retrieve text messages for a patient",
|
|
"tags": [
|
|
"Messages"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patient_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "query"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/text-messages",
|
|
"method": "POST",
|
|
"operationId": "sendTextMessage",
|
|
"summary": "Send text message",
|
|
"description": "Send a text message to a patient",
|
|
"tags": [
|
|
"Messages"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patient_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "message",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "phone_number",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/patient-history",
|
|
"method": "GET",
|
|
"operationId": "getPatientHistory",
|
|
"summary": "Get patient history",
|
|
"description": "Retrieve comprehensive patient medical history",
|
|
"tags": [
|
|
"Patients"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patient_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "query"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/emr/tags/list",
|
|
"method": "GET",
|
|
"operationId": "getTagsList",
|
|
"summary": "Get tags list",
|
|
"description": "Retrieve all available tags",
|
|
"tags": [
|
|
"Tags"
|
|
],
|
|
"parameters": [],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/emr/tags/store",
|
|
"method": "POST",
|
|
"operationId": "storeTags",
|
|
"summary": "Store tags",
|
|
"description": "Create or update tags for a patient",
|
|
"tags": [
|
|
"Tags"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patient_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "tags",
|
|
"type": "array",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "city",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "state",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "address",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "zip_code",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "dob",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "country",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Date (YYYY-MM-DD)",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/assistant/update-form/{id}",
|
|
"method": "PUT",
|
|
"operationId": "updateAssistantForm",
|
|
"summary": "Update form",
|
|
"description": "Updates an existing form template",
|
|
"tags": [
|
|
"Forms"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "type",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "data",
|
|
"type": "object",
|
|
"required": true,
|
|
"description": "Form structure and fields",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/update-category/{id}",
|
|
"method": "POST",
|
|
"operationId": "updateCategory",
|
|
"summary": "Update product category",
|
|
"description": "Updates an existing product category",
|
|
"tags": [
|
|
"Products"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Category ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/update-product/{id}",
|
|
"method": "POST",
|
|
"operationId": "updateProduct",
|
|
"summary": "Update product",
|
|
"description": "Updates an existing product",
|
|
"tags": [
|
|
"Products"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Product ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "price",
|
|
"type": "number",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "category_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "sku",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "stock_quantity",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Setup status (complete or incomplete)",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/get-patient-summary/{patientId}",
|
|
"method": "GET",
|
|
"operationId": "getPatientSummary",
|
|
"summary": "Get patient summary",
|
|
"description": "Retrieves the patient summary information",
|
|
"tags": [
|
|
"Patient Summary"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patientId",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [],
|
|
"authType": "public"
|
|
},
|
|
{
|
|
"path": "/api/update-patient-summary/{patientId}",
|
|
"method": "POST",
|
|
"operationId": "updatePatientSummary",
|
|
"summary": "Update patient summary",
|
|
"description": "Updates the summary information for a patient",
|
|
"tags": [
|
|
"Patient Summary"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patientId",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "summary",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [],
|
|
"authType": "public"
|
|
},
|
|
{
|
|
"path": "/api/generate-patient-summary/{patientId}",
|
|
"method": "GET",
|
|
"operationId": "generatePatientSummary",
|
|
"summary": "Generate AI summary for patient",
|
|
"description": "Generates an AI-powered summary for a patient based on their data",
|
|
"tags": [
|
|
"Patient Summary"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patientId",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [],
|
|
"authType": "public"
|
|
},
|
|
{
|
|
"path": "/api/get-patient-full-details/{patientId}",
|
|
"method": "GET",
|
|
"operationId": "getPatientFullDetails",
|
|
"summary": "Get comprehensive patient details",
|
|
"description": "Retrieves comprehensive patient details including forms, appointments, and medical history",
|
|
"tags": [
|
|
"Patient Data"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patientId",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [],
|
|
"authType": "public"
|
|
},
|
|
{
|
|
"path": "/api/get-patient-forms-list/{patientId}",
|
|
"method": "GET",
|
|
"operationId": "getPatientFormsList",
|
|
"summary": "Get patient forms list",
|
|
"description": "Retrieves a list of all forms submitted by a patient",
|
|
"tags": [
|
|
"Forms"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patientId",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [],
|
|
"authType": "public"
|
|
},
|
|
{
|
|
"path": "/api/download/pdf/{id}/{type}",
|
|
"method": "GET",
|
|
"operationId": "downloadPdfFile",
|
|
"summary": "Download or view PDF file",
|
|
"description": "Downloads or renders a PDF file for a form",
|
|
"tags": [
|
|
"Forms"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "type",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Action type (download or view)",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [],
|
|
"authType": "public"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Setup status (1 for complete, 0 for incomplete)",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "data",
|
|
"type": "object",
|
|
"required": false,
|
|
"description": "Meeting analytics data",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/refresh-token",
|
|
"method": "POST",
|
|
"operationId": "refresh",
|
|
"summary": "Refresh authentication token",
|
|
"description": "Refresh an existing authentication token using a refresh token",
|
|
"tags": [
|
|
"Authentication"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "refresh_token",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [],
|
|
"authType": "public"
|
|
},
|
|
{
|
|
"path": "/api/set-password/{token}",
|
|
"method": "POST",
|
|
"operationId": "setPassword",
|
|
"summary": "Set password for patient account",
|
|
"description": "Set a new password for a patient account using a token",
|
|
"tags": [
|
|
"Patient Authentication"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "token",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Password reset token",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "password",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "password_confirmation",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [],
|
|
"authType": "public"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the intake form record",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "key",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Key identifier for the document in the form data",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the intake form record",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/get/document/{userId}/{rowId}/{key}",
|
|
"method": "GET",
|
|
"operationId": "createPublicLink",
|
|
"summary": "Create a public link to access a document",
|
|
"description": "Creates a public link to access a document from patient intake form data for a specific user",
|
|
"tags": [
|
|
"Documents"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "userId",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "User ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "rowId",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the intake form record",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "key",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Key identifier for the document in the form data",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [],
|
|
"authType": "public"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "practitioner",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "User ID of the practitioner",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "messageText",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "to_email",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "from_email",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "emailTemplate",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Template name used for the email",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "subject",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "draw",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables draw counter",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "start",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables start offset",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "length",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables page length",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "search[value]",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "DataTables search value",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "order[0][column]",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables column index for ordering",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "order[0][dir]",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "DataTables order direction (asc/desc)",
|
|
"location": "query"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the email to retrieve",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Form type (simple-forms, consent-forms, charting-forms, etc.)",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/get-form-without-auth/{id}",
|
|
"method": "GET",
|
|
"operationId": "getFormByIdwithouthAuth",
|
|
"summary": "Get form by ID without authentication",
|
|
"description": "Retrieves a specific form by its ID without requiring authentication",
|
|
"tags": [
|
|
"Forms Management"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [],
|
|
"authType": "public"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "type",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Form type (simple-forms, consent-forms, charting-forms, etc.)",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "data",
|
|
"type": "object",
|
|
"required": true,
|
|
"description": "Form structure and fields",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/update-intake-form-data/{id}",
|
|
"method": "POST",
|
|
"operationId": "updatesIntakeFormData",
|
|
"summary": "Update intake form data",
|
|
"description": "Updates patient intake form data with support for file uploads",
|
|
"tags": [
|
|
"Patient Forms"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Intake form record ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [],
|
|
"authType": "public"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "pid",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "rowId",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Row ID of the specific form submission",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "pid",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Form type (simple-forms, consent-forms, charting-forms, etc.)",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "pid",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/get-signed-patient-data/{id}",
|
|
"method": "GET",
|
|
"operationId": "getSignedData",
|
|
"summary": "Get signed patient form data",
|
|
"description": "Retrieves patient form data using a signed URL",
|
|
"tags": [
|
|
"Patient Forms"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form submission ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "signature",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "URL signature for validation",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "expires",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "URL expiration timestamp",
|
|
"location": "query"
|
|
}
|
|
],
|
|
"security": [],
|
|
"authType": "public"
|
|
},
|
|
{
|
|
"path": "/api/get-pdf-url/{id}",
|
|
"method": "GET",
|
|
"operationId": "getPdfUrl",
|
|
"summary": "Get PDF URL",
|
|
"description": "Retrieves the PDF URL for a form submission",
|
|
"tags": [
|
|
"Patient Forms"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form submission ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [],
|
|
"authType": "public"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Intake question ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Question ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the inventory item",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/update-inventory/{id}",
|
|
"method": "PUT",
|
|
"operationId": "updateInventoryItem",
|
|
"summary": "Update inventory item",
|
|
"description": "Updates an existing inventory item",
|
|
"tags": [
|
|
"Inventory"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the inventory item to update",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "inventoryType",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "item_name",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "price",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "expirationDate",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/delete-inventory/{id}",
|
|
"method": "DELETE",
|
|
"operationId": "deleteInventoryItem",
|
|
"summary": "Delete inventory item",
|
|
"description": "Deletes an existing inventory item",
|
|
"tags": [
|
|
"Inventory"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the inventory item to delete",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the location to retrieve",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "UUID of the location to retrieve",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the location to update",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "npiNumber",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "phoneNumber",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "address",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "city",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "state",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "zipcode",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "country",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "UUID of the location to update",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "npiNumber",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "phoneNumber",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "address",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "city",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "state",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "zipcode",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "country",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the patient",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "lastDate",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "nextDate",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "screeningDetails",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "flag",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Status flag for the medical problem",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "typeOfItem",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Type of medical problem",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the medical problem to update",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "lastDate",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "nextDate",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "screeningDetails",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "flag",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Status flag for the medical problem",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "typeOfItem",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Type of medical problem",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "medical_problem_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the medical problem",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the medical problem to retrieve",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the patient",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "provider",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Name of the provider who made/received the call",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "message",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Details about the phone call",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the user who logged the call",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the patient",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "draw",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Draw counter for DataTables",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "start",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Paging first record indicator for DataTables",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "length",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Number of records per page for DataTables",
|
|
"location": "query"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "tags",
|
|
"type": "array",
|
|
"required": true,
|
|
"description": "Array of tag names to be associated with the patient",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "tags",
|
|
"type": "array",
|
|
"required": true,
|
|
"description": "Array of tag names to be associated with the patient",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the patient",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "task_title",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "task_body",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "task_due_date",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "task_assigned_to",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "task_watchers",
|
|
"type": "array",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "sendEmailtoPatientApplicationForTask",
|
|
"type": "boolean",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "task_priority",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "task_status",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the task to update",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "task_title",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "task_body",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "task_due_date",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "task_assigned_to",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "task_watchers",
|
|
"type": "array",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "sendEmailtoPatientApplicationForTask",
|
|
"type": "boolean",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "task_priority",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "task_status",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the task to retrieve",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the patient",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "draw",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables draw counter",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "start",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables start offset",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "length",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables page length",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "search[value]",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "DataTables search value",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "order[0][column]",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables column index for ordering",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "order[0][dir]",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "DataTables order direction (asc/desc)",
|
|
"location": "query"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "User ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "User ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "firstName",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "lastName",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "textMessageNumber",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "timezone",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "dateOfBirth",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "gender",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "city",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "state",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "zipcode",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "type",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "role_id",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "username",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "newUserPassword",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/user-list-profile/{id}",
|
|
"method": "GET",
|
|
"operationId": "getUserProfileById",
|
|
"summary": "Get user profile by ID",
|
|
"description": "Returns user profile information for display",
|
|
"tags": [
|
|
"User Management"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "User ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [],
|
|
"authType": "public"
|
|
},
|
|
{
|
|
"path": "/api/user/set-password/{token}",
|
|
"method": "POST",
|
|
"operationId": "setUserPassword",
|
|
"summary": "Set user password",
|
|
"description": "Sets a password for a user with a valid token",
|
|
"tags": [
|
|
"User Management"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "token",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Password set token",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "password",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [],
|
|
"authType": "public"
|
|
},
|
|
{
|
|
"path": "/api/redirect-with-auth/{pid}",
|
|
"method": "GET",
|
|
"operationId": "redirectWithAuth",
|
|
"summary": "Get authentication token for redirect",
|
|
"description": "Creates an authentication token for a patient to be used in redirects",
|
|
"tags": [
|
|
"Authentication"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "pid",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [],
|
|
"authType": "public"
|
|
},
|
|
{
|
|
"path": "/api/patient/available-slots/{date}",
|
|
"method": "POST",
|
|
"operationId": "availableSlotsForPatient",
|
|
"summary": "Get available appointment slots for a specific date",
|
|
"description": "Returns a list of available time slots for a given date.",
|
|
"tags": [
|
|
"Appointment"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "date",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Date in YYYY-MM-DD format",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [],
|
|
"authType": "public"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "did",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Document ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "provider_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "blood_presssure",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "diastolic",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "weight_lbs",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "height_ft",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "height_in",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "temperature",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "pulse",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "respiratory_rate",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "saturation",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "waist_in",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "headCircumference_in",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "note",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "provider",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "weight_oz",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "bmi",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "bloodSugar",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "fasting",
|
|
"type": "boolean",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "neck_in",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "shoulders_in",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "chest_in",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "hips_in",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "lean_body_mass_lbs",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "body_fat",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "notes",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "subjective_notes",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Medical problem ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Medical problem ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "date_of_onset",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "status",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "date_of_onset",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "status",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Subscription ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "reason",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "feedback",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/generate-permanent-token/{userId}",
|
|
"method": "GET",
|
|
"operationId": "generatePermanentToken",
|
|
"summary": "Generate a permanent API token for a user",
|
|
"description": "Creates a permanent API token with full abilities for the specified user",
|
|
"tags": [
|
|
"Token Management"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "userId",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "User ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [],
|
|
"authType": "public"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "User ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "User ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/dashboard-states",
|
|
"method": "GET",
|
|
"operationId": "getDashboardStates",
|
|
"summary": "Get dashboard statistics",
|
|
"description": "Retrieve dashboard statistics and states for the EMR system",
|
|
"tags": [
|
|
"Dashboard"
|
|
],
|
|
"parameters": [],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/get-appointments/{patient_id}",
|
|
"method": "GET",
|
|
"operationId": "getPatientAppointments",
|
|
"summary": "Get patient appointments",
|
|
"description": "Retrieve all appointments for a specific patient",
|
|
"tags": [
|
|
"Appointment"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patient_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/cancel-appointment/{id}",
|
|
"method": "PUT",
|
|
"operationId": "cancelAppointment",
|
|
"summary": "Cancel appointment",
|
|
"description": "Cancel an existing appointment",
|
|
"tags": [
|
|
"Appointment"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "reason",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/emr/prescription/store/{patientId}",
|
|
"method": "POST",
|
|
"operationId": "storePrescription",
|
|
"summary": "Create prescription",
|
|
"description": "Create a new prescription for a patient",
|
|
"tags": [
|
|
"Prescriptions"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patientId",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "medication_name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "dosage",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "frequency",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "duration",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "instructions",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/emr/prescriptions/{patientId}",
|
|
"method": "GET",
|
|
"operationId": "getPatientPrescriptions",
|
|
"summary": "Get patient prescriptions",
|
|
"description": "Retrieve all prescriptions for a specific patient",
|
|
"tags": [
|
|
"Prescriptions"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patientId",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/emr/invoice-create",
|
|
"method": "POST",
|
|
"operationId": "createInvoice",
|
|
"summary": "Create invoice",
|
|
"description": "Create a new invoice for a patient",
|
|
"tags": [
|
|
"Invoices"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patient_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "amount",
|
|
"type": "number",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "due_date",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/emr/invoices",
|
|
"method": "GET",
|
|
"operationId": "getInvoices",
|
|
"summary": "Get invoices",
|
|
"description": "Retrieve all invoices",
|
|
"tags": [
|
|
"Invoices"
|
|
],
|
|
"parameters": [],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/emr/invoice-payment",
|
|
"method": "POST",
|
|
"operationId": "processInvoicePayment",
|
|
"summary": "Process invoice payment",
|
|
"description": "Process payment for an invoice with card details masking for security",
|
|
"tags": [
|
|
"Payments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "invoice_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "payment_method",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "amount",
|
|
"type": "number",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "card_details",
|
|
"type": "object",
|
|
"required": false,
|
|
"description": "Card details (will be masked in response)",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/emr/roles-create",
|
|
"method": "POST",
|
|
"operationId": "createRole",
|
|
"summary": "Create role",
|
|
"description": "Create a new role with permissions",
|
|
"tags": [
|
|
"Role Management"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "permissions",
|
|
"type": "array",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/emr/roles",
|
|
"method": "GET",
|
|
"operationId": "getRoles",
|
|
"summary": "Get roles",
|
|
"description": "Retrieve all roles",
|
|
"tags": [
|
|
"Role Management"
|
|
],
|
|
"parameters": [],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/appointment-participants/{appointmentId}",
|
|
"method": "GET",
|
|
"operationId": "getAppointmentParticipants",
|
|
"summary": "Get appointment participants",
|
|
"description": "Public endpoint that returns appointment details including participant name, patient name, patient ID, and patient email",
|
|
"tags": [
|
|
"Public APIs"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "appointmentId",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [],
|
|
"authType": "public"
|
|
},
|
|
{
|
|
"path": "/api/emr/patients/store-document/{pid}",
|
|
"method": "POST",
|
|
"operationId": "storeDocumentsEmr",
|
|
"summary": "Store patient document in EMR",
|
|
"description": "Upload and store a document for a patient in the EMR system",
|
|
"tags": [
|
|
"Patients"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "pid",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/api/emr/patients/get-document/{pid}",
|
|
"method": "GET",
|
|
"operationId": "getDocumentEmr",
|
|
"summary": "Get patient documents from EMR",
|
|
"description": "Retrieve documents for a patient from the EMR system",
|
|
"tags": [
|
|
"Patients"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "pid",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/get-intake-questions",
|
|
"method": "GET",
|
|
"operationId": "getIntakeQuestions",
|
|
"summary": "Get intake questions",
|
|
"description": "Retrieve all intake questions for forms",
|
|
"tags": [
|
|
"Forms"
|
|
],
|
|
"parameters": [],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/get-consent-forms",
|
|
"method": "GET",
|
|
"operationId": "getConsentForms",
|
|
"summary": "Get consent forms",
|
|
"description": "Retrieve all consent forms",
|
|
"tags": [
|
|
"Forms"
|
|
],
|
|
"parameters": [],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/get-message-list/{patient_id}",
|
|
"method": "GET",
|
|
"operationId": "getMessageList",
|
|
"summary": "Get message list for patient",
|
|
"description": "Retrieve all messages for a specific patient",
|
|
"tags": [
|
|
"Messages"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patient_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/emr/get-vital/{pid}",
|
|
"method": "GET",
|
|
"operationId": "getVitalsEmr",
|
|
"summary": "Get patient vitals from EMR",
|
|
"description": "Retrieve vital signs for a patient from the EMR system",
|
|
"tags": [
|
|
"Vitals"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "pid",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/emr/patients/save-clinical-profile/{pid}",
|
|
"method": "POST",
|
|
"operationId": "saveClinicalProfile",
|
|
"summary": "Save clinical profile for patient",
|
|
"description": "Store clinical profile information including immunizations for a patient",
|
|
"tags": [
|
|
"Clinical Information"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "pid",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "immunizations",
|
|
"type": "array",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "allergies",
|
|
"type": "array",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/emr/patients/store-vitals/{pid}",
|
|
"method": "POST",
|
|
"operationId": "storeVitalsEmr",
|
|
"summary": "Store patient vitals in EMR",
|
|
"description": "Store vital signs for a patient in the EMR system",
|
|
"tags": [
|
|
"Vitals"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "pid",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "temperature",
|
|
"type": "number",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "blood_pressure",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "heart_rate",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "weight",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "height",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "notes",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
},
|
|
{
|
|
"path": "/emr/family-history/allergies/{patientId}",
|
|
"method": "POST",
|
|
"operationId": "storeAllergies",
|
|
"summary": "Store patient allergies",
|
|
"description": "Store allergy information for a patient",
|
|
"tags": [
|
|
"Family History"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patientId",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "path"
|
|
},
|
|
{
|
|
"name": "allergies",
|
|
"type": "array",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true,
|
|
"authType": "provider"
|
|
}
|
|
],
|
|
"parameterMismatches": [
|
|
{
|
|
"endpoint": {
|
|
"path": "/room-joined/event",
|
|
"method": "POST",
|
|
"operationId": "livekitWebhook",
|
|
"summary": "LiveKit webhook handler",
|
|
"description": "Handles LiveKit room events and recording operations",
|
|
"tags": [
|
|
"LiveKit"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "event",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "room",
|
|
"type": "object",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "egressInfo",
|
|
"type": "object",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": []
|
|
},
|
|
"tool": {
|
|
"authType": "public",
|
|
"path": "/room-joined/event",
|
|
"method": "POST",
|
|
"description": "LiveKit webhook handler",
|
|
"parameters": [],
|
|
"toolName": "public_post_roomjoinedevent"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "event",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "room",
|
|
"type": "object",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "egressInfo",
|
|
"type": "object",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/room-joined/event-transcription",
|
|
"method": "POST",
|
|
"operationId": "getRecordingUrl",
|
|
"summary": "Get recording URL",
|
|
"description": "Retrieves the URL for a meeting recording",
|
|
"tags": [
|
|
"LiveKit"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "egressInfo",
|
|
"type": "object",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": []
|
|
},
|
|
"tool": {
|
|
"authType": "public",
|
|
"path": "/room-joined/event-transcription",
|
|
"method": "POST",
|
|
"description": "Get recording URL",
|
|
"parameters": [],
|
|
"toolName": "public_post_roomjoinedeventtranscription"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "egressInfo",
|
|
"type": "object",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"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": [
|
|
{
|
|
"name": "address",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/labs/search",
|
|
"method": "POST",
|
|
"description": "Search labs by address",
|
|
"parameters": [],
|
|
"toolName": "provider_post_labssearch"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "address",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/book-appointment",
|
|
"method": "POST",
|
|
"operationId": "bookAppointment",
|
|
"summary": "Book an appointment",
|
|
"description": "Books a new appointment with a doctor",
|
|
"tags": [
|
|
"Appointments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patient_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "start_time",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Appointment start time",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "end_time",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Appointment end time",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "practitioner_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Practitioner/Doctor ID",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "title",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Appointment title",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "timezone",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Timezone for the appointment",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "status",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Appointment status",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "service",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Service type",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "location",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Appointment location",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "room",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Room number",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "payment_type",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Payment type",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "appointment_type",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Type of appointment",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "notes",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Additional notes",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "affiliate_email",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Affiliate email (optional)",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "order_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Order ID (optional)",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/book-appointment",
|
|
"method": "POST",
|
|
"description": "Book an appointment",
|
|
"parameters": [],
|
|
"toolName": "provider_post_bookappointment"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "patient_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "start_time",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Appointment start time",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "end_time",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Appointment end time",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "practitioner_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Practitioner/Doctor ID",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "title",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Appointment title",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "timezone",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Timezone for the appointment",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "status",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Appointment status",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "service",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Service type",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "location",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Appointment location",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "room",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Room number",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "payment_type",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Payment type",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "appointment_type",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Type of appointment",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "notes",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Additional notes",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "affiliate_email",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Affiliate email (optional)",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "order_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Order ID (optional)",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"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": [
|
|
{
|
|
"name": "note",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "note_type",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/add-note-patient",
|
|
"method": "POST",
|
|
"description": "Add a note for patient",
|
|
"parameters": [],
|
|
"toolName": "provider_post_addnotepatient"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "note",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "note_type",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/assistant/store-form",
|
|
"method": "POST",
|
|
"operationId": "assistantFormDataStore",
|
|
"summary": "Store form data",
|
|
"description": "Creates a new form template",
|
|
"tags": [
|
|
"Forms"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "type",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "data",
|
|
"type": "object",
|
|
"required": true,
|
|
"description": "Form structure and fields",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/assistant/store-form",
|
|
"method": "POST",
|
|
"description": "Store form data",
|
|
"parameters": [],
|
|
"toolName": "provider_post_assistantstoreform"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "type",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "data",
|
|
"type": "object",
|
|
"required": true,
|
|
"description": "Form structure and fields",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/save-category",
|
|
"method": "POST",
|
|
"operationId": "storeCategory",
|
|
"summary": "Store product category",
|
|
"description": "Creates a new product category",
|
|
"tags": [
|
|
"Products"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/save-category",
|
|
"method": "POST",
|
|
"description": "Store product category",
|
|
"parameters": [],
|
|
"toolName": "provider_post_savecategory"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/save-product",
|
|
"method": "POST",
|
|
"operationId": "assistantSaveProduct",
|
|
"summary": "Save product",
|
|
"description": "Creates a new product",
|
|
"tags": [
|
|
"Products"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "price",
|
|
"type": "number",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "category_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "sku",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "stock_quantity",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/save-product",
|
|
"method": "POST",
|
|
"description": "Save product",
|
|
"parameters": [],
|
|
"toolName": "provider_post_saveproduct"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "price",
|
|
"type": "number",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "category_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "sku",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "stock_quantity",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"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": [
|
|
{
|
|
"name": "signature_data",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Base64 encoded signature image",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "provider_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/assistant/save-signature",
|
|
"method": "POST",
|
|
"description": "Store signature",
|
|
"parameters": [],
|
|
"toolName": "provider_post_assistantsavesignature"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "signature_data",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Base64 encoded signature image",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "provider_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/save-payment-method",
|
|
"method": "POST",
|
|
"operationId": "storePaymentMethodConfigAssistant",
|
|
"summary": "Store payment method configuration",
|
|
"description": "Stores payment method configuration settings",
|
|
"tags": [
|
|
"Assistant"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "payment_method",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "api_key",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "secret_key",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "is_active",
|
|
"type": "boolean",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/save-payment-method",
|
|
"method": "POST",
|
|
"description": "Store payment method configuration",
|
|
"parameters": [],
|
|
"toolName": "provider_post_savepaymentmethod"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "payment_method",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "api_key",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "secret_key",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "is_active",
|
|
"type": "boolean",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/check-user",
|
|
"method": "POST",
|
|
"operationId": "checkProvider",
|
|
"summary": "Check if provider exists",
|
|
"description": "Checks if a provider exists with the given email",
|
|
"tags": [
|
|
"Provider"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": []
|
|
},
|
|
"tool": {
|
|
"authType": "public",
|
|
"path": "/api/check-user",
|
|
"method": "POST",
|
|
"description": "Check if provider exists",
|
|
"parameters": [],
|
|
"toolName": "public_post_checkuser"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"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": [
|
|
{
|
|
"name": "date",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "practitioner_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/get-appointment-list-date",
|
|
"method": "POST",
|
|
"description": "Get appointment list by date",
|
|
"parameters": [],
|
|
"toolName": "provider_post_getappointmentlistdate"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "date",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "practitioner_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"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": [
|
|
{
|
|
"name": "appointment_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/get-appointment-by-id",
|
|
"method": "POST",
|
|
"description": "Get appointment by ID",
|
|
"parameters": [],
|
|
"toolName": "provider_post_getappointmentbyid"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "appointment_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"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": [
|
|
{
|
|
"name": "form_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "pid",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "data",
|
|
"type": "object",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/update-intake-form-data",
|
|
"method": "POST",
|
|
"description": "Update intake form data",
|
|
"parameters": [],
|
|
"toolName": "provider_post_updateintakeformdata"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "form_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "pid",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "data",
|
|
"type": "object",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"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": [
|
|
{
|
|
"name": "form_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "pdf_data",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Base64 encoded PDF data",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/form-pdf-save",
|
|
"method": "POST",
|
|
"description": "Save form file",
|
|
"parameters": [],
|
|
"toolName": "provider_post_formpdfsave"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "form_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "pdf_data",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Base64 encoded PDF data",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"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": [
|
|
{
|
|
"name": "title",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "start",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "end",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "type",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "availability or event",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "comment",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "practitioner_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/provider-add-availability",
|
|
"method": "POST",
|
|
"description": "Store provider availability",
|
|
"parameters": [],
|
|
"toolName": "provider_post_provideraddavailability"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "title",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "start",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "end",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "type",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "availability or event",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "comment",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "practitioner_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/emr-api/provider-register",
|
|
"method": "POST",
|
|
"operationId": "registerProvider",
|
|
"summary": "Register a new provider",
|
|
"description": "Register a new provider and their company",
|
|
"tags": [
|
|
"Provider",
|
|
"Authentication"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "firstName",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "lastName",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "username",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "emailAddress",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "textMessageNumber",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "newUserPassword",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "company_name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "on_your_domain",
|
|
"type": "boolean",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": []
|
|
},
|
|
"tool": {
|
|
"authType": "public",
|
|
"path": "/emr-api/provider-register",
|
|
"method": "POST",
|
|
"description": "Register a new provider",
|
|
"parameters": [],
|
|
"toolName": "public_post_emrapiproviderregister"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "firstName",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "lastName",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "username",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "emailAddress",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "textMessageNumber",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "newUserPassword",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "company_name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "on_your_domain",
|
|
"type": "boolean",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"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": [
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "config",
|
|
"type": "object",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/save-payment-method",
|
|
"method": "POST",
|
|
"description": "Save payment method configuration",
|
|
"parameters": [],
|
|
"toolName": "provider_post_savepaymentmethod"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "config",
|
|
"type": "object",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/save-signature",
|
|
"method": "POST",
|
|
"operationId": "storeSignature",
|
|
"summary": "Save provider signature",
|
|
"description": "Store or update the provider's signature",
|
|
"tags": [
|
|
"Provider"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "signature",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/save-signature",
|
|
"method": "POST",
|
|
"description": "Save provider signature",
|
|
"parameters": [],
|
|
"toolName": "provider_post_savesignature"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "signature",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"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",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Start date (YYYY-MM-DD)",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "end_date",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "End date (YYYY-MM-DD)",
|
|
"location": "query"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/emr/appointment/list-by-date",
|
|
"method": "GET",
|
|
"description": "Get appointments by date range",
|
|
"parameters": [],
|
|
"toolName": "provider_get_emrappointmentlistbydate"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "start_date",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Start date (YYYY-MM-DD)",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "end_date",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "End date (YYYY-MM-DD)",
|
|
"location": "query"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"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",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Start date (YYYY-MM-DD)",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "end_date",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "End date (YYYY-MM-DD)",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "provider",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Provider ID or 'all' for all providers",
|
|
"location": "query"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/emr/appointment/report/last-30-days",
|
|
"method": "GET",
|
|
"description": "Get appointment data for last 30 days",
|
|
"parameters": [],
|
|
"toolName": "provider_get_emrappointmentreportlast30days"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "start_date",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Start date (YYYY-MM-DD)",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "end_date",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "End date (YYYY-MM-DD)",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "provider",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Provider ID or 'all' for all providers",
|
|
"location": "query"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/login",
|
|
"method": "POST",
|
|
"operationId": "adminPanelAuthenticate",
|
|
"summary": "Authenticate admin panel users",
|
|
"description": "Authenticate providers, practitioners, and admins for the admin panel",
|
|
"tags": [
|
|
"Authentication"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "username",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "password",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": []
|
|
},
|
|
"tool": {
|
|
"authType": "public",
|
|
"path": "/api/login",
|
|
"method": "POST",
|
|
"description": "General login (uses username field)",
|
|
"parameters": [],
|
|
"toolName": "public_post_login"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "username",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "password",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/login-patient",
|
|
"method": "POST",
|
|
"operationId": "loginPatient",
|
|
"summary": "Patient login",
|
|
"description": "Authenticate a patient with OpenEMR integration",
|
|
"tags": [
|
|
"Patient Authentication"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "password",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": []
|
|
},
|
|
"tool": {
|
|
"authType": "public",
|
|
"path": "/api/login-patient",
|
|
"method": "POST",
|
|
"description": "Patient login",
|
|
"parameters": [],
|
|
"toolName": "public_post_loginpatient"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "password",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/patient/login",
|
|
"method": "POST",
|
|
"operationId": "loginPatientWithoutAuthAuth",
|
|
"summary": "Patient login without authentication middleware",
|
|
"description": "Login a patient without going through the authentication middleware",
|
|
"tags": [
|
|
"Patient Authentication"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "password",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": []
|
|
},
|
|
"tool": {
|
|
"authType": "public",
|
|
"path": "/api/patient/login",
|
|
"method": "POST",
|
|
"description": "Patient login without authentication middleware",
|
|
"parameters": [],
|
|
"toolName": "public_post_patientlogin"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "password",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/change-password",
|
|
"method": "POST",
|
|
"operationId": "updatePasswordAuth",
|
|
"summary": "Update patient password",
|
|
"description": "Update the password for an authenticated patient",
|
|
"tags": [
|
|
"Patient Authentication"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "current_password",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "new_password",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "patient",
|
|
"path": "/api/change-password",
|
|
"method": "POST",
|
|
"description": "Update patient password",
|
|
"parameters": [],
|
|
"toolName": "patient_post_changepassword"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "current_password",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "new_password",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/register-patient",
|
|
"method": "POST",
|
|
"operationId": "registerPatientWithoutAuthAuth",
|
|
"summary": "Register patient without authentication",
|
|
"description": "Register a new patient without requiring authentication",
|
|
"tags": [
|
|
"Patient Authentication"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "firstName",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "lastName",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "password",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "dateOfBirth",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "gender",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "phone",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "username",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "provider_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": []
|
|
},
|
|
"tool": {
|
|
"authType": "public",
|
|
"path": "/api/register-patient",
|
|
"method": "POST",
|
|
"description": "Register patient without authentication",
|
|
"parameters": [],
|
|
"toolName": "public_post_registerpatient"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "firstName",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "lastName",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "password",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "dateOfBirth",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "gender",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "phone",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "username",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "provider_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/forgot-password",
|
|
"method": "POST",
|
|
"operationId": "forgotPassword",
|
|
"summary": "Forgot password functionality",
|
|
"description": "Send a password reset link to the patient's email",
|
|
"tags": [
|
|
"Patient Authentication"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": []
|
|
},
|
|
"tool": {
|
|
"authType": "public",
|
|
"path": "/api/forgot-password",
|
|
"method": "POST",
|
|
"description": "Forgot password functionality",
|
|
"parameters": [],
|
|
"toolName": "public_post_forgotpassword"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/password-reset",
|
|
"method": "POST",
|
|
"operationId": "resetPassword",
|
|
"summary": "Reset password functionality",
|
|
"description": "Reset password using a token received via email",
|
|
"tags": [
|
|
"Patient Authentication"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "token",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "password",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "password_confirmation",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": []
|
|
},
|
|
"tool": {
|
|
"authType": "public",
|
|
"path": "/api/password-reset",
|
|
"method": "POST",
|
|
"description": "Reset password functionality",
|
|
"parameters": [],
|
|
"toolName": "public_post_passwordreset"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "token",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "password",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "password_confirmation",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"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": [
|
|
{
|
|
"name": "form_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "patient_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "status",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/update-form-status",
|
|
"method": "PUT",
|
|
"description": "Update form request status",
|
|
"parameters": [],
|
|
"toolName": "provider_put_updateformstatus"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "form_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "patient_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "status",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"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": [
|
|
{
|
|
"name": "form_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "pid",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "data",
|
|
"type": "object",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "signature",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/store-patient-consent-form",
|
|
"method": "POST",
|
|
"description": "Store patient consent form",
|
|
"parameters": [],
|
|
"toolName": "provider_post_storepatientconsentform"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "form_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "pid",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "data",
|
|
"type": "object",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "signature",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"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": [
|
|
{
|
|
"name": "type",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Form type (simple-forms, consent-forms, charting-forms, etc.)",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "data",
|
|
"type": "object",
|
|
"required": true,
|
|
"description": "Form structure and fields",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/store-form",
|
|
"method": "POST",
|
|
"description": "Store form",
|
|
"parameters": [],
|
|
"toolName": "provider_post_storeform"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "type",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Form type (simple-forms, consent-forms, charting-forms, etc.)",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "data",
|
|
"type": "object",
|
|
"required": true,
|
|
"description": "Form structure and fields",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"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": [
|
|
{
|
|
"name": "inventoryType",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "item_name",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "price",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "expirationDate",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/add-inventory",
|
|
"method": "POST",
|
|
"description": "Add new inventory item",
|
|
"parameters": [],
|
|
"toolName": "provider_post_addinventory"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "inventoryType",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "item_name",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "price",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "expirationDate",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"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",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables draw counter",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "start",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables start offset",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "length",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables page length",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "search[value]",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "DataTables search value",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "order[0][column]",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables column index for ordering",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "order[0][dir]",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "DataTables order direction (asc/desc)",
|
|
"location": "query"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/locations",
|
|
"method": "GET",
|
|
"description": "Get locations (requires provider authentication)",
|
|
"parameters": [],
|
|
"toolName": "provider_get_locations"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "draw",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables draw counter",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "start",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables start offset",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "length",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables page length",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "search[value]",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "DataTables search value",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "order[0][column]",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables column index for ordering",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "order[0][dir]",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "DataTables order direction (asc/desc)",
|
|
"location": "query"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/add-location",
|
|
"method": "POST",
|
|
"operationId": "addLocation",
|
|
"summary": "Add a new location",
|
|
"description": "Creates a new facility location",
|
|
"tags": [
|
|
"Locations"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "npiNumber",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "phoneNumber",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "address",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "city",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "state",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "zipcode",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "country",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/add-location",
|
|
"method": "POST",
|
|
"description": "Add a new location",
|
|
"parameters": [],
|
|
"toolName": "provider_post_addlocation"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "npiNumber",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "phoneNumber",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "address",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "city",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "state",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "zipcode",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "country",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"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": [
|
|
{
|
|
"name": "builder_id",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Base64 encoded builder ID",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "products",
|
|
"type": "array",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/plans-product-sync",
|
|
"method": "POST",
|
|
"description": "Save multiple products",
|
|
"parameters": [],
|
|
"toolName": "provider_post_plansproductsync"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "builder_id",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Base64 encoded builder ID",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "products",
|
|
"type": "array",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"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": [
|
|
{
|
|
"name": "builder_id",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Base64 encoded builder ID",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "product_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "product_name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "product_price",
|
|
"type": "number",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "product_slug",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "product_category",
|
|
"type": "object",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "product_variation",
|
|
"type": "array",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/plans-product-update",
|
|
"method": "POST",
|
|
"description": "Update product on publish",
|
|
"parameters": [],
|
|
"toolName": "provider_post_plansproductupdate"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "builder_id",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Base64 encoded builder ID",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "product_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "product_name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "product_price",
|
|
"type": "number",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "product_slug",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "product_category",
|
|
"type": "object",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "product_variation",
|
|
"type": "array",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/patient/refresh-token",
|
|
"method": "POST",
|
|
"operationId": "refreshPatientToken",
|
|
"summary": "Refresh patient authentication token",
|
|
"description": "Refreshes the authentication token for the currently authenticated patient",
|
|
"tags": [
|
|
"Patient Authentication"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "refresh_token",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": []
|
|
},
|
|
"tool": {
|
|
"authType": "public",
|
|
"path": "/api/patient/refresh-token",
|
|
"method": "POST",
|
|
"description": "Refresh patient authentication token",
|
|
"parameters": [],
|
|
"toolName": "public_post_patientrefreshtoken"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "refresh_token",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"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",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Filter by patient's first name",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "lastName",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Filter by patient's last name",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "dateOfBirth",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Filter by patient's date of birth (YYYY-MM-DD)",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Filter by patient's email",
|
|
"location": "query"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/patients",
|
|
"method": "GET",
|
|
"description": "Get a list of patients",
|
|
"parameters": [],
|
|
"toolName": "provider_get_patients"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "firstName",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Filter by patient's first name",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "lastName",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Filter by patient's last name",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "dateOfBirth",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Filter by patient's date of birth (YYYY-MM-DD)",
|
|
"location": "query"
|
|
},
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Filter by patient's email",
|
|
"location": "query"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/register-patients",
|
|
"method": "POST",
|
|
"operationId": "registerPatientWithoutAuthPatient",
|
|
"summary": "Register a new patient without authentication",
|
|
"description": "Creates a new patient account without requiring authentication",
|
|
"tags": [
|
|
"Patients"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "first_name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "last_name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "phone_no",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "dob",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "gender",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "provider_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "username",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "isportalAccess",
|
|
"type": "boolean",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": []
|
|
},
|
|
"tool": {
|
|
"authType": "public",
|
|
"path": "/api/register-patients",
|
|
"method": "POST",
|
|
"description": "Register patient with actual parameter names from patient/register.vue",
|
|
"parameters": [],
|
|
"toolName": "public_post_registerpatients"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "first_name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "last_name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "phone_no",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "dob",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "gender",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "provider_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "username",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "isportalAccess",
|
|
"type": "boolean",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/patient-login-api",
|
|
"method": "POST",
|
|
"operationId": "loginPatientWithoutAuthPatient",
|
|
"summary": "Patient login without authentication",
|
|
"description": "Authenticates a patient and returns access token",
|
|
"tags": [
|
|
"Authentication"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "password",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": []
|
|
},
|
|
"tool": {
|
|
"authType": "public",
|
|
"path": "/api/patient-login-api",
|
|
"method": "POST",
|
|
"description": "Patient login API",
|
|
"parameters": [],
|
|
"toolName": "public_post_patientloginapi"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "password",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/patient-order-create",
|
|
"method": "POST",
|
|
"operationId": "patientOrderCreate",
|
|
"summary": "Create a patient order",
|
|
"description": "Create a new order for a patient with products",
|
|
"tags": [
|
|
"Orders"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "patient_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "shipping_address1",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "shipping_address2",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "shipping_city",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "shipping_state",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "shipping_zipcode",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "shipping_country",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "shipping_amount",
|
|
"type": "number",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "total_amount",
|
|
"type": "number",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "practitioner_fee",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "affiliate_email",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "provider_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "appointment_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "pending_task",
|
|
"type": "boolean",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "builder_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "discount_amount",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "coupon_code",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "items",
|
|
"type": "array",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": []
|
|
},
|
|
"tool": {
|
|
"authType": "public",
|
|
"path": "/api/patient-order-create",
|
|
"method": "POST",
|
|
"description": "Create a patient order",
|
|
"parameters": [],
|
|
"toolName": "public_post_patientordercreate"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "patient_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "shipping_address1",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "shipping_address2",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "shipping_city",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "shipping_state",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "shipping_zipcode",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "shipping_country",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "shipping_amount",
|
|
"type": "number",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "total_amount",
|
|
"type": "number",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "practitioner_fee",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "affiliate_email",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "provider_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "appointment_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "pending_task",
|
|
"type": "boolean",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "builder_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "discount_amount",
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "coupon_code",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "items",
|
|
"type": "array",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/patient-book-appointment",
|
|
"method": "POST",
|
|
"operationId": "bookAppointmentPatient",
|
|
"summary": "Book a patient appointment",
|
|
"description": "Books a new appointment for a patient",
|
|
"tags": [
|
|
"Appointments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "start_time",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "end_time",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "practitioner_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "notes",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "order_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "affiliate_email",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": []
|
|
},
|
|
"tool": {
|
|
"authType": "public",
|
|
"path": "/api/patient-book-appointment",
|
|
"method": "POST",
|
|
"description": "Book a patient appointment",
|
|
"parameters": [],
|
|
"toolName": "public_post_patientbookappointment"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "start_time",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "end_time",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "practitioner_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "notes",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "order_id",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "affiliate_email",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/patient/register-patient",
|
|
"method": "POST",
|
|
"operationId": "registerPatientForPatient",
|
|
"summary": "Register a new patient",
|
|
"description": "Creates a new patient account",
|
|
"tags": [
|
|
"Patients"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "first_name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "last_name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "phone_no",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "dob",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "gender",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "public",
|
|
"path": "/api/patient/register-patient",
|
|
"method": "POST",
|
|
"description": "Register a new patient",
|
|
"parameters": [],
|
|
"toolName": "public_post_patientregisterpatient"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "first_name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "last_name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "phone_no",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "dob",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "gender",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/update-password",
|
|
"method": "POST",
|
|
"operationId": "updatePasswordPatient",
|
|
"summary": "Update patient password",
|
|
"description": "Updates a patient's password",
|
|
"tags": [
|
|
"Authentication"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "new_password",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/update-password",
|
|
"method": "POST",
|
|
"description": "Update patient password",
|
|
"parameters": [],
|
|
"toolName": "provider_post_updatepassword"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "new_password",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/check-email",
|
|
"method": "POST",
|
|
"operationId": "checkEmail",
|
|
"summary": "Check email availability",
|
|
"description": "Check if an email is already registered in the system",
|
|
"tags": [
|
|
"Authentication"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": []
|
|
},
|
|
"tool": {
|
|
"authType": "public",
|
|
"path": "/api/check-email",
|
|
"method": "POST",
|
|
"description": "Check email availability",
|
|
"parameters": [],
|
|
"toolName": "public_post_checkemail"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "email",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"endpoint": {
|
|
"path": "/api/patient/process-payment",
|
|
"method": "POST",
|
|
"operationId": "processPayment",
|
|
"summary": "Process payment",
|
|
"description": "Process a payment for the patient",
|
|
"tags": [
|
|
"Patient Payment"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "amount",
|
|
"type": "number",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "payment_method",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "currency",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "payment_method_id",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "patient",
|
|
"path": "/api/patient/process-payment",
|
|
"method": "POST",
|
|
"description": "Process payment",
|
|
"parameters": [],
|
|
"toolName": "patient_post_patientprocesspayment"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "amount",
|
|
"type": "number",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "payment_method",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "currency",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "payment_method_id",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"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": [
|
|
{
|
|
"name": "user_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "expires_in_hours",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "abilities",
|
|
"type": "array",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/token/generate-temporary",
|
|
"method": "POST",
|
|
"description": "Generate a temporary API token",
|
|
"parameters": [],
|
|
"toolName": "provider_post_tokengeneratetemporary"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "user_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "expires_in_hours",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "abilities",
|
|
"type": "array",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"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": [
|
|
{
|
|
"name": "token_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/token/revoke",
|
|
"method": "DELETE",
|
|
"description": "Revoke a specific token",
|
|
"parameters": [],
|
|
"toolName": "provider_delete_tokenrevoke"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "token_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
},
|
|
{
|
|
"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": [
|
|
{
|
|
"name": "user_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "token_name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "abilities",
|
|
"type": "array",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "expires_in_hours",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"authRequired": true
|
|
},
|
|
"tool": {
|
|
"authType": "provider",
|
|
"path": "/api/token/create-with-abilities",
|
|
"method": "POST",
|
|
"description": "Create a token with specific abilities",
|
|
"parameters": [],
|
|
"toolName": "provider_post_tokencreatewithabilities"
|
|
},
|
|
"hasDifferences": true,
|
|
"missing": [
|
|
{
|
|
"name": "user_id",
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "token_name",
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "abilities",
|
|
"type": "array",
|
|
"required": true,
|
|
"description": "",
|
|
"location": "body"
|
|
},
|
|
{
|
|
"name": "expires_in_hours",
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "",
|
|
"location": "body"
|
|
}
|
|
],
|
|
"extra": [],
|
|
"different": []
|
|
}
|
|
],
|
|
"newTools": [
|
|
{
|
|
"toolName": "provider_get_createmeeting",
|
|
"authType": "provider",
|
|
"path": "/create-meeting/{meeting_id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@showMeeting",
|
|
"category": "ENDPOINT_CATEGORIES.MEETINGS",
|
|
"description": "Show meeting details",
|
|
"parameters": {
|
|
"meeting_id": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Meeting ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_joinmeeting",
|
|
"authType": "provider",
|
|
"path": "/join-meeting/{meeting_id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@joinMeeting",
|
|
"category": "ENDPOINT_CATEGORIES.MEETINGS",
|
|
"description": "Join a meeting",
|
|
"parameters": {
|
|
"meeting_id": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Meeting ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_startcall",
|
|
"authType": "provider",
|
|
"path": "/api/start-call/{patient_id}/{agent_id}/{appointment_id}",
|
|
"method": "POST",
|
|
"controller": "ApiController@startCall",
|
|
"category": "ENDPOINT_CATEGORIES.MEETINGS",
|
|
"description": "Start a call",
|
|
"parameters": {
|
|
"patient_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
},
|
|
"agent_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Agent ID"
|
|
},
|
|
"appointment_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID"
|
|
},
|
|
"call_type": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getrealtimequestions",
|
|
"authType": "provider",
|
|
"path": "/get-realtime-questions/{appointmentId}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getRealtimeQuestions",
|
|
"category": "ENDPOINT_CATEGORIES.MEETINGS",
|
|
"description": "Get real-time questions",
|
|
"parameters": {
|
|
"appointmentId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_endcall",
|
|
"authType": "provider",
|
|
"path": "/api/end-call/{patient_id}/{appointment_id}",
|
|
"method": "POST",
|
|
"controller": "ApiController@endCall",
|
|
"category": "ENDPOINT_CATEGORIES.MEETINGS",
|
|
"description": "End a call",
|
|
"parameters": {
|
|
"patient_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
},
|
|
"appointment_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_appointmentstatus",
|
|
"authType": "provider",
|
|
"path": "/appointment-status/{id}/{status}",
|
|
"method": "POST",
|
|
"controller": "ApiController@markAppointmentsStatus",
|
|
"category": "ENDPOINT_CATEGORIES.APPOINTMENT_SCHEDULING",
|
|
"description": "Mark appointment status",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "New status for the appointment"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "public_get_appointmentparticipants",
|
|
"authType": "public",
|
|
"path": "/appointment-participants/{appointmentId}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getAppointmentParticipants",
|
|
"category": "ENDPOINT_CATEGORIES.APPOINTMENT_SCHEDULING",
|
|
"description": "Get appointment participants",
|
|
"parameters": {
|
|
"appointmentId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "public_post_startrecord",
|
|
"authType": "public",
|
|
"path": "/start-record/{appointment}",
|
|
"method": "POST",
|
|
"controller": "ApiController@startRecording",
|
|
"category": "ENDPOINT_CATEGORIES.MEETINGS",
|
|
"description": "Start recording",
|
|
"parameters": {
|
|
"appointment": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_emrpatientslist",
|
|
"authType": "provider",
|
|
"path": "/emr/patients-list",
|
|
"method": "GET",
|
|
"controller": "ApiController@getPatientsList",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get patients list",
|
|
"parameters": {}
|
|
},
|
|
{
|
|
"toolName": "provider_get_emrpatientdata",
|
|
"authType": "provider",
|
|
"path": "/emr/patient-data/{id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getPatientData",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get patient data",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_dashboardstates",
|
|
"authType": "provider",
|
|
"path": "/dashboard-states",
|
|
"method": "GET",
|
|
"controller": "ApiController@getDashboardStates",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get dashboard states",
|
|
"parameters": {
|
|
"start_date": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Start date for the dashboard data range"
|
|
},
|
|
"end_date": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "End date for the dashboard data range"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_emrgetpatientdata",
|
|
"authType": "provider",
|
|
"path": "/emr/get-patient-data/{id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getPatientDataById",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get patient data by ID",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_emrpatientsprofileimage",
|
|
"authType": "provider",
|
|
"path": "/emr/patients/profile-image/{pid}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getProfileImage",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get patient profile image",
|
|
"parameters": {
|
|
"pid": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_emrpatientsstoredocument",
|
|
"authType": "provider",
|
|
"path": "/emr/patients/store-document/{pid}",
|
|
"method": "POST",
|
|
"controller": "ApiController@storeDocumentsEmr",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Store patient document",
|
|
"parameters": {
|
|
"pid": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_emrpatientsgetdocument",
|
|
"authType": "provider",
|
|
"path": "/emr/patients/get-document/{pid}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getDocumentEmr",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get patient documents",
|
|
"parameters": {
|
|
"pid": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "public_post_emrregisterpatients",
|
|
"authType": "public",
|
|
"path": "/emr/register-patients",
|
|
"method": "POST",
|
|
"controller": "ApiController@registerPatient",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Register new patient",
|
|
"parameters": {
|
|
"firstName": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"lastName": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"dateOfBirth": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"phone": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"address": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_emrupdatepatient",
|
|
"authType": "provider",
|
|
"path": "/emr/update-patient/{id}",
|
|
"method": "POST",
|
|
"controller": "ApiController@updatePatient",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Update patient",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
},
|
|
"firstName": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"lastName": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"dateOfBirth": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"phone": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"address": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_emrguardianupdate",
|
|
"authType": "provider",
|
|
"path": "/emr/guardian-update/{id}",
|
|
"method": "POST",
|
|
"controller": "ApiController@guardianUpdate",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Update patient guardian information",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
},
|
|
"nextKinRelation": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"nextkinPhone": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"nextkinAddress": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"nextkinCity": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"nextkinState": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"nextkinZipCode": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"nextkinFirstName": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"nextkinLastName": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_storeinsurance",
|
|
"authType": "provider",
|
|
"path": "/store-insurance/{patientId}",
|
|
"method": "POST",
|
|
"controller": "ApiController@insuranceStore",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Store patient insurance",
|
|
"parameters": {
|
|
"patientId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
},
|
|
"insuredPlanOrProgramName": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredIDNumber": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredGroupNameNo": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"payerName": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"relationshiptoInsured": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredDateOfBirth": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredAddress": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredZip": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredCity": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredState": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredPhone": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"coPayment": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getinsurance",
|
|
"authType": "provider",
|
|
"path": "/get-insurance/{patientId}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getInsurance",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get patient insurance",
|
|
"parameters": {
|
|
"patientId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_updateinsurance",
|
|
"authType": "provider",
|
|
"path": "/update-insurance/{patientId}",
|
|
"method": "POST",
|
|
"controller": "ApiController@updateInsurance",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Update patient insurance",
|
|
"parameters": {
|
|
"patientId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
},
|
|
"insuredPlanOrProgramName": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredIDNumber": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredGroupNameNo": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"payerName": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"relationshiptoInsured": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredDateOfBirth": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredAddress": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredZip": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredCity": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredState": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredPhone": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"coPayment": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_locations",
|
|
"authType": "provider",
|
|
"path": "/locations",
|
|
"method": "GET",
|
|
"controller": "ApiController@getLocations",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get locations",
|
|
"parameters": {}
|
|
},
|
|
{
|
|
"toolName": "provider_post_addlocation",
|
|
"authType": "provider",
|
|
"path": "/add-location",
|
|
"method": "POST",
|
|
"controller": "ApiController@addLocation",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Add location",
|
|
"parameters": {
|
|
"name": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"address": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"city": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"state": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"postal_code": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"phone": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_updatelocation",
|
|
"authType": "provider",
|
|
"path": "/update-location/{id}",
|
|
"method": "POST",
|
|
"controller": "ApiController@updateLocation",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Update location",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Location ID"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"address": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"city": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"state": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"postal_code": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"phone": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getlocation",
|
|
"authType": "provider",
|
|
"path": "/get-location/{uuid}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getLocationById",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get location by UUID",
|
|
"parameters": {
|
|
"uuid": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Location UUID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_patientnextofskin",
|
|
"authType": "provider",
|
|
"path": "/patient-nextofskin",
|
|
"method": "POST",
|
|
"controller": "ApiController@addNextOfKin",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Add next of kin",
|
|
"parameters": {
|
|
"patient_id": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"nextKinRelation": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"nextkinPhone": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"nextkinAddress": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"nextkinCity": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"nextkinState": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"nextkinZipCode": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"nextkinFirstName": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"nextkinLastName": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_patientinsurance",
|
|
"authType": "provider",
|
|
"path": "/patient-insurance",
|
|
"method": "POST",
|
|
"controller": "ApiController@addPatientInsurance",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Add patient insurance",
|
|
"parameters": {
|
|
"patient_id": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredPlanOrProgramName": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredIDNumber": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredGroupNameNo": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"payerName": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"relationshiptoInsured": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredDateOfBirth": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredAddress": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredZip": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredCity": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredState": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insuredPhone": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"coPayment": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_patienteligibilitycheck",
|
|
"authType": "provider",
|
|
"path": "/patient-eligibility-check",
|
|
"method": "POST",
|
|
"controller": "ApiController@checkPatientEligibility",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Check patient eligibility",
|
|
"parameters": {
|
|
"patient_id": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"insurance_id": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_emrgetproducts",
|
|
"authType": "provider",
|
|
"path": "/emr/get-products",
|
|
"method": "GET",
|
|
"controller": "ApiController@getProducts",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get products",
|
|
"parameters": {}
|
|
},
|
|
{
|
|
"toolName": "provider_post_emrsaveproduct",
|
|
"authType": "provider",
|
|
"path": "/emr/save-product",
|
|
"method": "POST",
|
|
"controller": "ApiController@saveProduct",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Save product",
|
|
"parameters": {
|
|
"name": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"price": {
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"category_id": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_emrupdateproduct",
|
|
"authType": "provider",
|
|
"path": "/emr/update-product",
|
|
"method": "POST",
|
|
"controller": "ApiController@updateProduct",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Update product",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"price": {
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"category_id": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_emrgetcategories",
|
|
"authType": "provider",
|
|
"path": "/emr/get-categories",
|
|
"method": "GET",
|
|
"controller": "ApiController@getCategories",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get categories",
|
|
"parameters": {}
|
|
},
|
|
{
|
|
"toolName": "provider_post_emrsavecategory",
|
|
"authType": "provider",
|
|
"path": "/emr/save-category",
|
|
"method": "POST",
|
|
"controller": "ApiController@saveCategory",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Save category",
|
|
"parameters": {
|
|
"name": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_emrupdatecategory",
|
|
"authType": "provider",
|
|
"path": "/emr/update-category",
|
|
"method": "POST",
|
|
"controller": "ApiController@updateCategory",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Update category",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_textmessages",
|
|
"authType": "provider",
|
|
"path": "/text-messages",
|
|
"method": "GET",
|
|
"controller": "ApiController@getTextMessages",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get text messages",
|
|
"parameters": {
|
|
"patient_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_textmessages",
|
|
"authType": "provider",
|
|
"path": "/text-messages",
|
|
"method": "POST",
|
|
"controller": "ApiController@sendTextMessage",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Send text message",
|
|
"parameters": {
|
|
"patient_id": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"message": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"phone_number": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_patienthistory",
|
|
"authType": "provider",
|
|
"path": "/patient-history",
|
|
"method": "GET",
|
|
"controller": "ApiController@getPatientHistory",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get patient history",
|
|
"parameters": {
|
|
"patient_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_emrtagslist",
|
|
"authType": "provider",
|
|
"path": "/emr/tags/list",
|
|
"method": "GET",
|
|
"controller": "ApiController@getTagsList",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get tags list",
|
|
"parameters": {}
|
|
},
|
|
{
|
|
"toolName": "provider_post_emrtagsstore",
|
|
"authType": "provider",
|
|
"path": "/emr/tags/store",
|
|
"method": "POST",
|
|
"controller": "ApiController@storeTags",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Store tags",
|
|
"parameters": {
|
|
"patient_id": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"tags": {
|
|
"type": "array",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_updatepatientinfo",
|
|
"authType": "provider",
|
|
"path": "/api/update-patient-info/{patientId}",
|
|
"method": "POST",
|
|
"controller": "ApiController@updateInfo",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Update patient information",
|
|
"parameters": {
|
|
"patientId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
},
|
|
"city": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"state": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"address": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"zip_code": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"dob": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"country": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_getpatientinfo",
|
|
"authType": "provider",
|
|
"path": "/api/get-patient-info/{patientId}",
|
|
"method": "POST",
|
|
"controller": "ApiController@getInfo",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get patient information",
|
|
"parameters": {
|
|
"patientId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_availableslots",
|
|
"authType": "provider",
|
|
"path": "/api/available-slots/{date}",
|
|
"method": "POST",
|
|
"controller": "ApiController@availableSlots",
|
|
"category": "ENDPOINT_CATEGORIES.MEDICAL_RECORDS",
|
|
"description": "Get available appointment slots",
|
|
"parameters": {
|
|
"date": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Date (YYYY-MM-DD)"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_appointmentdetail",
|
|
"authType": "provider",
|
|
"path": "/api/appointment-detail/{appointment}",
|
|
"method": "POST",
|
|
"controller": "ApiController@appointmentDetail",
|
|
"category": "ENDPOINT_CATEGORIES.APPOINTMENT_SCHEDULING",
|
|
"description": "Get appointment details",
|
|
"parameters": {
|
|
"appointment": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_labdetail",
|
|
"authType": "provider",
|
|
"path": "/api/lab-detail/{appointment}",
|
|
"method": "GET",
|
|
"controller": "ApiController@labDetail",
|
|
"category": "ENDPOINT_CATEGORIES.APPOINTMENT_SCHEDULING",
|
|
"description": "Get lab details for an appointment",
|
|
"parameters": {
|
|
"appointment": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_patientdata",
|
|
"authType": "provider",
|
|
"path": "/api/patient-data/{id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getAssistantPatientData",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get patient data",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getpatientformslist",
|
|
"authType": "provider",
|
|
"path": "/api/get-patient-forms-list/{pid}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getPatientIntakeSimpleFormList",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get patient intake simple forms list",
|
|
"parameters": {
|
|
"pid": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getprescriptionlist",
|
|
"authType": "provider",
|
|
"path": "/api/get-prescription-list/{patient_id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getPrescriptionList",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get patient prescription list",
|
|
"parameters": {
|
|
"patient_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_put_assistantupdateform",
|
|
"authType": "provider",
|
|
"path": "/api/assistant/update-form/{id}",
|
|
"method": "PUT",
|
|
"controller": "ApiController@updateAssistantForm",
|
|
"category": "ENDPOINT_CATEGORIES.FORMS_QUESTIONNAIRES",
|
|
"description": "Update form",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form ID"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"required": true,
|
|
"description": "Form structure and fields"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_updatecategory",
|
|
"authType": "provider",
|
|
"path": "/api/update-category/{id}",
|
|
"method": "POST",
|
|
"controller": "ApiController@updateCategory",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Update product category",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Category ID"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_updateproduct",
|
|
"authType": "provider",
|
|
"path": "/api/update-product/{id}",
|
|
"method": "POST",
|
|
"controller": "ApiController@updateProduct",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Update product",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Product ID"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"price": {
|
|
"type": "number",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"category_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"sku": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"stock_quantity": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_put_companycompletesetup",
|
|
"authType": "provider",
|
|
"path": "/api/company/complete/setup/{status}",
|
|
"method": "PUT",
|
|
"controller": "ApiController@completeSetupAssistant",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Complete company setup",
|
|
"parameters": {
|
|
"status": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Setup status (complete or incomplete)"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "public_get_getpatientsummary",
|
|
"authType": "public",
|
|
"path": "/api/get-patient-summary/{patientId}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getPatientSummary",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get patient summary",
|
|
"parameters": {
|
|
"patientId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "public_post_updatepatientsummary",
|
|
"authType": "public",
|
|
"path": "/api/update-patient-summary/{patientId}",
|
|
"method": "POST",
|
|
"controller": "ApiController@updatePatientSummary",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Update patient summary",
|
|
"parameters": {
|
|
"patientId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
},
|
|
"summary": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "public_get_generatepatientsummary",
|
|
"authType": "public",
|
|
"path": "/api/generate-patient-summary/{patientId}",
|
|
"method": "GET",
|
|
"controller": "ApiController@generatePatientSummary",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Generate AI summary for patient",
|
|
"parameters": {
|
|
"patientId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "public_get_getpatientfulldetails",
|
|
"authType": "public",
|
|
"path": "/api/get-patient-full-details/{patientId}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getPatientFullDetails",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get comprehensive patient details",
|
|
"parameters": {
|
|
"patientId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "public_get_getpatientformslist",
|
|
"authType": "public",
|
|
"path": "/api/get-patient-forms-list/{patientId}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getPatientFormsList",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get patient forms list",
|
|
"parameters": {
|
|
"patientId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "public_get_downloadpdf",
|
|
"authType": "public",
|
|
"path": "/api/download/pdf/{id}/{type}",
|
|
"method": "GET",
|
|
"controller": "ApiController@downloadPdfFile",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Download or view PDF file",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form ID"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Action type (download or view)"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_put_emrapicompanycompletesetup",
|
|
"authType": "provider",
|
|
"path": "/emr-api/company/complete/setup/{status}",
|
|
"method": "PUT",
|
|
"controller": "ApiController@completeSetup",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Complete provider setup",
|
|
"parameters": {
|
|
"status": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Setup status (1 for complete, 0 for incomplete)"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_emrappointmentcancel",
|
|
"authType": "provider",
|
|
"path": "/api/emr/appointment/{id}/cancel",
|
|
"method": "POST",
|
|
"controller": "ApiController@cancelAppointment",
|
|
"category": "ENDPOINT_CATEGORIES.APPOINTMENT_SCHEDULING",
|
|
"description": "Cancel an appointment",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_emrappointmentorder",
|
|
"authType": "provider",
|
|
"path": "/api/emr/appointment/{appointment_id}/order",
|
|
"method": "GET",
|
|
"controller": "ApiController@getAppointmentOrder",
|
|
"category": "ENDPOINT_CATEGORIES.APPOINTMENT_SCHEDULING",
|
|
"description": "Get appointment order details",
|
|
"parameters": {
|
|
"appointment_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_emrappointmenttranscribe",
|
|
"authType": "provider",
|
|
"path": "/api/emr/appointment/transcribe/{patient_id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getAppointmentTranscribe",
|
|
"category": "ENDPOINT_CATEGORIES.APPOINTMENT_SCHEDULING",
|
|
"description": "Get appointment transcriptions",
|
|
"parameters": {
|
|
"patient_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_emrappointmentpatientlist",
|
|
"authType": "provider",
|
|
"path": "/api/emr/appointment/patient/{patient_id}/list",
|
|
"method": "GET",
|
|
"controller": "ApiController@getPatientApptList",
|
|
"category": "ENDPOINT_CATEGORIES.APPOINTMENT_SCHEDULING",
|
|
"description": "Get patient appointment list",
|
|
"parameters": {
|
|
"patient_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_emrappointmentdetail",
|
|
"authType": "provider",
|
|
"path": "/api/emr/appointment/{appointment}/detail",
|
|
"method": "GET",
|
|
"controller": "ApiController@getAppointmentDetailUnique",
|
|
"category": "ENDPOINT_CATEGORIES.APPOINTMENT_SCHEDULING",
|
|
"description": "Get appointment details",
|
|
"parameters": {
|
|
"appointment": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_emrappointmentqueue",
|
|
"authType": "provider",
|
|
"path": "/api/emr/appointment/queue/{patientId}",
|
|
"method": "POST",
|
|
"controller": "ApiController@addPatientToQueue",
|
|
"category": "ENDPOINT_CATEGORIES.APPOINTMENT_SCHEDULING",
|
|
"description": "Add patient to queue",
|
|
"parameters": {
|
|
"patientId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_emrappointmentdoctorpatient",
|
|
"authType": "provider",
|
|
"path": "/api/emr/appointment/doctor/patient/{patientId}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getDoctorAppointmentsByPatientId",
|
|
"category": "ENDPOINT_CATEGORIES.APPOINTMENT_SCHEDULING",
|
|
"description": "Get doctor appointments by patient ID",
|
|
"parameters": {
|
|
"patientId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_emrappointmentagent",
|
|
"authType": "provider",
|
|
"path": "/api/emr/appointment/agent/{appointment}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getAgentAppointment",
|
|
"category": "ENDPOINT_CATEGORIES.APPOINTMENT_SCHEDULING",
|
|
"description": "Get agent appointment details",
|
|
"parameters": {
|
|
"appointment": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_emrappointmentupdatemeetinganalysis",
|
|
"authType": "provider",
|
|
"path": "/api/emr/appointment/{appointment}/update-meeting-analysis",
|
|
"method": "POST",
|
|
"controller": "ApiController@updateMeetingAnalysis",
|
|
"category": "ENDPOINT_CATEGORIES.MEETINGS",
|
|
"description": "Update meeting analysis",
|
|
"parameters": {
|
|
"appointment": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID"
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"required": false,
|
|
"description": "Meeting analytics data"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "public_post_refreshtoken",
|
|
"authType": "public",
|
|
"path": "/api/refresh-token",
|
|
"method": "POST",
|
|
"controller": "ApiController@refresh",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Refresh authentication token",
|
|
"parameters": {
|
|
"refresh_token": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "public_post_setpassword",
|
|
"authType": "public",
|
|
"path": "/api/set-password/{token}",
|
|
"method": "POST",
|
|
"controller": "ApiController@setPassword",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Set password for patient account",
|
|
"parameters": {
|
|
"token": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Password reset token"
|
|
},
|
|
"password": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"password_confirmation": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_documentdownload",
|
|
"authType": "provider",
|
|
"path": "/api/document/download/{rowId}/{key}",
|
|
"method": "GET",
|
|
"controller": "ApiController@downloadDocument",
|
|
"category": "ENDPOINT_CATEGORIES.DOCUMENT_MANAGEMENT",
|
|
"description": "Download a patient document",
|
|
"parameters": {
|
|
"rowId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the intake form record"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Key identifier for the document in the form data"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_renderpdf",
|
|
"authType": "provider",
|
|
"path": "/api/render/pdf/{rowId}",
|
|
"method": "GET",
|
|
"controller": "ApiController@renderPdf",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Render a PDF document",
|
|
"parameters": {
|
|
"rowId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the intake form record"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "public_get_getdocument",
|
|
"authType": "public",
|
|
"path": "/api/get/document/{userId}/{rowId}/{key}",
|
|
"method": "GET",
|
|
"controller": "ApiController@createPublicLink",
|
|
"category": "ENDPOINT_CATEGORIES.DOCUMENT_MANAGEMENT",
|
|
"description": "Create a public link to access a document",
|
|
"parameters": {
|
|
"userId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "User ID"
|
|
},
|
|
"rowId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the intake form record"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Key identifier for the document in the form data"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_addemail",
|
|
"authType": "provider",
|
|
"path": "/api/add-email/{patient_id}",
|
|
"method": "POST",
|
|
"controller": "ApiController@addEmail",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Add a new email for a patient",
|
|
"parameters": {
|
|
"patient_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
},
|
|
"practitioner": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "User ID of the practitioner"
|
|
},
|
|
"messageText": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"to_email": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"from_email": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"emailTemplate": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Template name used for the email"
|
|
},
|
|
"subject": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getemaillist",
|
|
"authType": "provider",
|
|
"path": "/api/get-email-list/{patient_id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getEmailList",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get email list for a patient",
|
|
"parameters": {
|
|
"patient_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
},
|
|
"draw": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables draw counter"
|
|
},
|
|
"start": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables start offset"
|
|
},
|
|
"length": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables page length"
|
|
},
|
|
"search_value_": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "DataTables search value"
|
|
},
|
|
"order_0__column_": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables column index for ordering"
|
|
},
|
|
"order_0__dir_": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "DataTables order direction (asc/desc)"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getemail",
|
|
"authType": "provider",
|
|
"path": "/api/get-email/{id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getEmailById",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get an email by ID",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the email to retrieve"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getforms",
|
|
"authType": "provider",
|
|
"path": "/api/get-forms/{type}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getForms",
|
|
"category": "ENDPOINT_CATEGORIES.FORMS_QUESTIONNAIRES",
|
|
"description": "Get forms by type",
|
|
"parameters": {
|
|
"type": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Form type (simple-forms, consent-forms, charting-forms, etc.)"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getform",
|
|
"authType": "provider",
|
|
"path": "/api/get-form/{id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getFormById",
|
|
"category": "ENDPOINT_CATEGORIES.FORMS_QUESTIONNAIRES",
|
|
"description": "Get form by ID",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "public_get_getformwithoutauth",
|
|
"authType": "public",
|
|
"path": "/api/get-form-without-auth/{id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getFormByIdwithouthAuth",
|
|
"category": "ENDPOINT_CATEGORIES.FORMS_QUESTIONNAIRES",
|
|
"description": "Get form by ID without authentication",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_put_updateform",
|
|
"authType": "provider",
|
|
"path": "/api/update-form/{id}",
|
|
"method": "PUT",
|
|
"controller": "ApiController@updateForm",
|
|
"category": "ENDPOINT_CATEGORIES.FORMS_QUESTIONNAIRES",
|
|
"description": "Update form",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form ID"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Form type (simple-forms, consent-forms, charting-forms, etc.)"
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"required": true,
|
|
"description": "Form structure and fields"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_delete_deleteform",
|
|
"authType": "provider",
|
|
"path": "/api/delete-form/{id}",
|
|
"method": "DELETE",
|
|
"controller": "ApiController@deleteForm",
|
|
"category": "ENDPOINT_CATEGORIES.FORMS_QUESTIONNAIRES",
|
|
"description": "Delete form",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "public_post_updateintakeformdata",
|
|
"authType": "public",
|
|
"path": "/api/update-intake-form-data/{id}",
|
|
"method": "POST",
|
|
"controller": "ApiController@updatesIntakeFormData",
|
|
"category": "ENDPOINT_CATEGORIES.FORMS_QUESTIONNAIRES",
|
|
"description": "Update intake form data",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Intake form record ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getpatientintakeformdata",
|
|
"authType": "provider",
|
|
"path": "/api/get-patient-intake-form-data/{form_id}/{pid}/{rowId}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getIntakeFormData",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get patient intake form data",
|
|
"parameters": {
|
|
"form_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form ID"
|
|
},
|
|
"pid": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
},
|
|
"rowId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Row ID of the specific form submission"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getpatientintakeformlatestdata",
|
|
"authType": "provider",
|
|
"path": "/api/get-patient-intake-form-latest-data/{form_id}/{pid}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getIntakeFormLatestData",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get latest intake form data",
|
|
"parameters": {
|
|
"form_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form ID"
|
|
},
|
|
"pid": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getpatientsubmittedintakeforms",
|
|
"authType": "provider",
|
|
"path": "/api/get-patient-submitted-intake-forms/{pid}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getMergedFormData",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get all submitted forms for a patient",
|
|
"parameters": {
|
|
"pid": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getpatientintakeformlist",
|
|
"authType": "provider",
|
|
"path": "/api/get-patient-intake-form-list/{type}/{pid}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getPatientIntakeFormList",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get patient intake forms by type",
|
|
"parameters": {
|
|
"type": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Form type (simple-forms, consent-forms, charting-forms, etc.)"
|
|
},
|
|
"pid": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "public_get_getsignedpatientdata",
|
|
"authType": "public",
|
|
"path": "/api/get-signed-patient-data/{id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getSignedData",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get signed patient form data",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form submission ID"
|
|
},
|
|
"signature": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "URL signature for validation"
|
|
},
|
|
"expires": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "URL expiration timestamp"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "public_get_getpdfurl",
|
|
"authType": "public",
|
|
"path": "/api/get-pdf-url/{id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getPdfUrl",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get PDF URL",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form submission ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_delete_deleteintakequestion",
|
|
"authType": "provider",
|
|
"path": "/api/delete-intake-question/{form_id}",
|
|
"method": "DELETE",
|
|
"controller": "ApiController@deleteIntakeQuestionById",
|
|
"category": "ENDPOINT_CATEGORIES.FORMS_QUESTIONNAIRES",
|
|
"description": "Delete intake question",
|
|
"parameters": {
|
|
"form_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Intake question ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getintakeformsdata",
|
|
"authType": "provider",
|
|
"path": "/api/get-intake-forms-data/{form_id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getQuestionFormIntakeById",
|
|
"category": "ENDPOINT_CATEGORIES.FORMS_QUESTIONNAIRES",
|
|
"description": "Get intake form data by ID",
|
|
"parameters": {
|
|
"form_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getdocumentvue",
|
|
"authType": "provider",
|
|
"path": "/api/get-document-vue/{patient_id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getDocumentVue",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get documents for Vue component",
|
|
"parameters": {
|
|
"patient_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getpatientforms",
|
|
"authType": "provider",
|
|
"path": "/api/get-patient-forms/{pid}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getPatientFormList",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get all forms for a patient",
|
|
"parameters": {
|
|
"pid": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getpatientquestionnaireformlist",
|
|
"authType": "provider",
|
|
"path": "/api/get-patient-questionnaire-form-list/{pid}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getPatientQuestionairForm",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get patient questionnaire forms",
|
|
"parameters": {
|
|
"pid": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getquestionerformsdata",
|
|
"authType": "provider",
|
|
"path": "/api/get-questioner-forms-data/{form_id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getQuestionFormQuestionerById",
|
|
"category": "ENDPOINT_CATEGORIES.FORMS_QUESTIONNAIRES",
|
|
"description": "Get questionnaire form data",
|
|
"parameters": {
|
|
"form_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Form ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getquestionerquestion",
|
|
"authType": "provider",
|
|
"path": "/api/get-questioner-question/{id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getQuestionQuestionerById",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get questionnaire question by ID",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Question ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getinventory",
|
|
"authType": "provider",
|
|
"path": "/get-inventory/{id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getInventoryItemById",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get inventory item by ID",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the inventory item"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_put_updateinventory",
|
|
"authType": "provider",
|
|
"path": "/update-inventory/{id}",
|
|
"method": "PUT",
|
|
"controller": "ApiController@updateInventoryItem",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Update inventory item",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the inventory item to update"
|
|
},
|
|
"inventoryType": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"item_name": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"price": {
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"expirationDate": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_delete_deleteinventory",
|
|
"authType": "provider",
|
|
"path": "/delete-inventory/{id}",
|
|
"method": "DELETE",
|
|
"controller": "ApiController@deleteInventoryItem",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Delete inventory item",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the inventory item to delete"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_location",
|
|
"authType": "provider",
|
|
"path": "/api/location/{id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getLocationById",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get a location by ID",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the location to retrieve"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getlocation",
|
|
"authType": "provider",
|
|
"path": "/api/get-location/{uuid}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getLocationByUuid",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get a location by UUID",
|
|
"parameters": {
|
|
"uuid": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "UUID of the location to retrieve"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_put_updatelocation",
|
|
"authType": "provider",
|
|
"path": "/api/update-location/{id}",
|
|
"method": "PUT",
|
|
"controller": "ApiController@updateLocation",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Update a location by ID",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the location to update"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"npiNumber": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"phoneNumber": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"address": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"city": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"state": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"zipcode": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"country": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_put_updatelocation",
|
|
"authType": "provider",
|
|
"path": "/api/update-location/{uuid}",
|
|
"method": "PUT",
|
|
"controller": "ApiController@updateLocationByUuid",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Update a location by UUID",
|
|
"parameters": {
|
|
"uuid": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "UUID of the location to update"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"npiNumber": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"phoneNumber": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"address": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"city": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"state": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"zipcode": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"country": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_medicalproblemsstore",
|
|
"authType": "provider",
|
|
"path": "/api/medical-problems-store/{pid}",
|
|
"method": "POST",
|
|
"controller": "ApiController@storeMedicalProblem",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Add a new medical problem for a patient",
|
|
"parameters": {
|
|
"pid": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the patient"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"lastDate": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"nextDate": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"screeningDetails": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"flag": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Status flag for the medical problem"
|
|
},
|
|
"typeOfItem": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Type of medical problem"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_put_medicalproblemsupdate",
|
|
"authType": "provider",
|
|
"path": "/api/medical-problems-update/{id}",
|
|
"method": "PUT",
|
|
"controller": "ApiController@updateMedicalProblemRecord",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Update an existing medical problem",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the medical problem to update"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"lastDate": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"nextDate": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"screeningDetails": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"flag": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Status flag for the medical problem"
|
|
},
|
|
"typeOfItem": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Type of medical problem"
|
|
},
|
|
"medical_problem_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the medical problem"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_medicalproblem",
|
|
"authType": "provider",
|
|
"path": "/api/medical-problem/{id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getMedicalProblemById",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get a medical problem by ID",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the medical problem to retrieve"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_addphonelog",
|
|
"authType": "provider",
|
|
"path": "/add-phone-log/{patient_id}",
|
|
"method": "POST",
|
|
"controller": "ApiController@addPhoneLog",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Add a new phone log for a patient",
|
|
"parameters": {
|
|
"patient_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the patient"
|
|
},
|
|
"provider": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Name of the provider who made/received the call"
|
|
},
|
|
"message": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Details about the phone call"
|
|
},
|
|
"user_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the user who logged the call"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_phoneloglist",
|
|
"authType": "provider",
|
|
"path": "/phone-log-list/{patient_id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getPhoneLogList",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get phone logs for a patient",
|
|
"parameters": {
|
|
"patient_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the patient"
|
|
},
|
|
"draw": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Draw counter for DataTables"
|
|
},
|
|
"start": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Paging first record indicator for DataTables"
|
|
},
|
|
"length": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Number of records per page for DataTables"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_tagsstore",
|
|
"authType": "provider",
|
|
"path": "/tags/store/{pid}",
|
|
"method": "POST",
|
|
"controller": "ApiController@storeTags",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Store tags for a patient",
|
|
"parameters": {
|
|
"pid": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
},
|
|
"tags": {
|
|
"type": "array",
|
|
"required": true,
|
|
"description": "Array of tag names to be associated with the patient"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_storetags",
|
|
"authType": "provider",
|
|
"path": "/store-tags/{patientId}",
|
|
"method": "POST",
|
|
"controller": "ApiController@storeTagsAlternate",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Store tags for a patient (alternate endpoint)",
|
|
"parameters": {
|
|
"patientId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
},
|
|
"tags": {
|
|
"type": "array",
|
|
"required": true,
|
|
"description": "Array of tag names to be associated with the patient"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_tagslist",
|
|
"authType": "provider",
|
|
"path": "/tags/list/{pid}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getTags",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get tags for a patient",
|
|
"parameters": {
|
|
"pid": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_addtask",
|
|
"authType": "provider",
|
|
"path": "/api/add-task/{patient_id}",
|
|
"method": "POST",
|
|
"controller": "ApiController@addTask",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Add a new task for a patient",
|
|
"parameters": {
|
|
"patient_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the patient"
|
|
},
|
|
"task_title": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"task_body": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"task_due_date": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"task_assigned_to": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"task_watchers": {
|
|
"type": "array",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"sendEmailtoPatientApplicationForTask": {
|
|
"type": "boolean",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"task_priority": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"task_status": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_put_updatetask",
|
|
"authType": "provider",
|
|
"path": "/api/update-task/{task_id}",
|
|
"method": "PUT",
|
|
"controller": "ApiController@updateTask",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Update an existing task",
|
|
"parameters": {
|
|
"task_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the task to update"
|
|
},
|
|
"task_title": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"task_body": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"task_due_date": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"task_assigned_to": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"task_watchers": {
|
|
"type": "array",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"sendEmailtoPatientApplicationForTask": {
|
|
"type": "boolean",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"task_priority": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"task_status": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_task",
|
|
"authType": "provider",
|
|
"path": "/api/task/{id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getOneTaskById",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get a task by ID",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the task to retrieve"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_tasks",
|
|
"authType": "provider",
|
|
"path": "/api/tasks/{patient_id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getTasks",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get all tasks for a patient",
|
|
"parameters": {
|
|
"patient_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "ID of the patient"
|
|
},
|
|
"draw": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables draw counter"
|
|
},
|
|
"start": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables start offset"
|
|
},
|
|
"length": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables page length"
|
|
},
|
|
"search_value_": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "DataTables search value"
|
|
},
|
|
"order_0__column_": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "DataTables column index for ordering"
|
|
},
|
|
"order_0__dir_": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "DataTables order direction (asc/desc)"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_userlist",
|
|
"authType": "provider",
|
|
"path": "/api/user-list/{id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getUserById",
|
|
"category": "ENDPOINT_CATEGORIES.USER_MANAGEMENT",
|
|
"description": "Get user by ID",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "User ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_updateuser",
|
|
"authType": "provider",
|
|
"path": "/api/update-user/{id}",
|
|
"method": "POST",
|
|
"controller": "ApiController@updateUser",
|
|
"category": "ENDPOINT_CATEGORIES.USER_MANAGEMENT",
|
|
"description": "Update user",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "User ID"
|
|
},
|
|
"firstName": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"lastName": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"textMessageNumber": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"timezone": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"dateOfBirth": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"gender": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"city": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"state": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"zipcode": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"role_id": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"username": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"newUserPassword": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "public_get_userlistprofile",
|
|
"authType": "public",
|
|
"path": "/api/user-list-profile/{id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getUserProfileById",
|
|
"category": "ENDPOINT_CATEGORIES.USER_MANAGEMENT",
|
|
"description": "Get user profile by ID",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "User ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "public_post_usersetpassword",
|
|
"authType": "public",
|
|
"path": "/api/user/set-password/{token}",
|
|
"method": "POST",
|
|
"controller": "ApiController@setUserPassword",
|
|
"category": "ENDPOINT_CATEGORIES.USER_MANAGEMENT",
|
|
"description": "Set user password",
|
|
"parameters": {
|
|
"token": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Password set token"
|
|
},
|
|
"password": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "public_get_redirectwithauth",
|
|
"authType": "public",
|
|
"path": "/api/redirect-with-auth/{pid}",
|
|
"method": "GET",
|
|
"controller": "ApiController@redirectWithAuth",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get authentication token for redirect",
|
|
"parameters": {
|
|
"pid": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "public_post_patientavailableslots",
|
|
"authType": "public",
|
|
"path": "/api/patient/available-slots/{date}",
|
|
"method": "POST",
|
|
"controller": "ApiController@availableSlotsForPatient",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get available appointment slots for a specific date",
|
|
"parameters": {
|
|
"date": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Date in YYYY-MM-DD format"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_storedocument",
|
|
"authType": "provider",
|
|
"path": "/api/store-document/{patientId}",
|
|
"method": "POST",
|
|
"controller": "ApiController@storeDocuments",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Store patient documents",
|
|
"parameters": {
|
|
"patientId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getdocument",
|
|
"authType": "provider",
|
|
"path": "/api/get-document/{patientId}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getDocuments",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get patient documents",
|
|
"parameters": {
|
|
"patientId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getdocumentbyid",
|
|
"authType": "provider",
|
|
"path": "/api/get-document-by-id/{patientId}/{did}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getDocumentsById",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get a specific patient document by ID",
|
|
"parameters": {
|
|
"patientId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
},
|
|
"did": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Document ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_addvital",
|
|
"authType": "provider",
|
|
"path": "/api/add-vital/{patientId}",
|
|
"method": "POST",
|
|
"controller": "ApiController@addVital",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Add vital signs for a patient",
|
|
"parameters": {
|
|
"patientId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
},
|
|
"provider_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"blood_presssure": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"diastolic": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"weight_lbs": {
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"height_ft": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"height_in": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"temperature": {
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"pulse": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"respiratory_rate": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"saturation": {
|
|
"type": "integer",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"waist_in": {
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"headCircumference_in": {
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"note": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"provider": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"weight_oz": {
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"bmi": {
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"bloodSugar": {
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"fasting": {
|
|
"type": "boolean",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"neck_in": {
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"shoulders_in": {
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"chest_in": {
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"hips_in": {
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"lean_body_mass_lbs": {
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"body_fat": {
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"notes": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"subjective_notes": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getstoredmethods",
|
|
"authType": "provider",
|
|
"path": "/api/get-stored-methods/{id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getStoredMethods",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get stored payment methods",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_patientmedicalproblem",
|
|
"authType": "provider",
|
|
"path": "/api/patient/medical-problem/{id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getPatientMedicalProblemById",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get medical problem by ID",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Medical problem ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_put_patientmedicalproblem",
|
|
"authType": "provider",
|
|
"path": "/api/patient/medical-problem/{id}",
|
|
"method": "PUT",
|
|
"controller": "ApiController@updatePatientMedicalProblem",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Update medical problem",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Medical problem ID"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"date_of_onset": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_patienthistory",
|
|
"authType": "provider",
|
|
"path": "/api/patient/history/{patientId}",
|
|
"method": "GET",
|
|
"controller": "ApiController@patientHistory",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get patient history",
|
|
"parameters": {
|
|
"patientId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_patientmedicalproblem",
|
|
"authType": "provider",
|
|
"path": "/api/patient/medical-problem/{pid}",
|
|
"method": "POST",
|
|
"controller": "ApiController@storePatientMedicalProblem",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Store medical problem",
|
|
"parameters": {
|
|
"pid": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"date_of_onset": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_patientsubscriptioncancel",
|
|
"authType": "provider",
|
|
"path": "/api/patient/subscription/{subscription}/cancel",
|
|
"method": "POST",
|
|
"controller": "ApiController@cancelSubscription",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Cancel subscription",
|
|
"parameters": {
|
|
"subscription": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Subscription ID"
|
|
},
|
|
"reason": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"feedback": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "public_get_generatepermanenttoken",
|
|
"authType": "public",
|
|
"path": "/api/generate-permanent-token/{userId}",
|
|
"method": "GET",
|
|
"controller": "ApiController@generatePermanentToken",
|
|
"category": "ENDPOINT_CATEGORIES.USER_MANAGEMENT",
|
|
"description": "Generate a permanent API token for a user",
|
|
"parameters": {
|
|
"userId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "User ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_tokenlist",
|
|
"authType": "provider",
|
|
"path": "/api/token/list/{userId}",
|
|
"method": "GET",
|
|
"controller": "ApiController@listUserTokens",
|
|
"category": "ENDPOINT_CATEGORIES.USER_MANAGEMENT",
|
|
"description": "List all tokens for a user",
|
|
"parameters": {
|
|
"userId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "User ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_delete_tokenrevokeall",
|
|
"authType": "provider",
|
|
"path": "/api/token/revoke-all/{userId}",
|
|
"method": "DELETE",
|
|
"controller": "ApiController@revokeAllUserTokens",
|
|
"category": "ENDPOINT_CATEGORIES.USER_MANAGEMENT",
|
|
"description": "Revoke all tokens for a user",
|
|
"parameters": {
|
|
"userId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "User ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_dashboardstates",
|
|
"authType": "provider",
|
|
"path": "/api/dashboard-states",
|
|
"method": "GET",
|
|
"controller": "ApiController@getDashboardStates",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get dashboard statistics",
|
|
"parameters": {}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getappointments",
|
|
"authType": "provider",
|
|
"path": "/api/get-appointments/{patient_id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getPatientAppointments",
|
|
"category": "ENDPOINT_CATEGORIES.APPOINTMENT_SCHEDULING",
|
|
"description": "Get patient appointments",
|
|
"parameters": {
|
|
"patient_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_put_cancelappointment",
|
|
"authType": "provider",
|
|
"path": "/api/cancel-appointment/{id}",
|
|
"method": "PUT",
|
|
"controller": "ApiController@cancelAppointment",
|
|
"category": "ENDPOINT_CATEGORIES.APPOINTMENT_SCHEDULING",
|
|
"description": "Cancel appointment",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID"
|
|
},
|
|
"reason": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_emrprescriptionstore",
|
|
"authType": "provider",
|
|
"path": "/api/emr/prescription/store/{patientId}",
|
|
"method": "POST",
|
|
"controller": "ApiController@storePrescription",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Create prescription",
|
|
"parameters": {
|
|
"patientId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
},
|
|
"medication_name": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"dosage": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"frequency": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"duration": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"instructions": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_emrprescriptions",
|
|
"authType": "provider",
|
|
"path": "/api/emr/prescriptions/{patientId}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getPatientPrescriptions",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get patient prescriptions",
|
|
"parameters": {
|
|
"patientId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_emrinvoicecreate",
|
|
"authType": "provider",
|
|
"path": "/api/emr/invoice-create",
|
|
"method": "POST",
|
|
"controller": "ApiController@createInvoice",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Create invoice",
|
|
"parameters": {
|
|
"patient_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"due_date": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_emrinvoices",
|
|
"authType": "provider",
|
|
"path": "/api/emr/invoices",
|
|
"method": "GET",
|
|
"controller": "ApiController@getInvoices",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get invoices",
|
|
"parameters": {}
|
|
},
|
|
{
|
|
"toolName": "provider_post_emrinvoicepayment",
|
|
"authType": "provider",
|
|
"path": "/api/emr/invoice-payment",
|
|
"method": "POST",
|
|
"controller": "ApiController@processInvoicePayment",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Process invoice payment",
|
|
"parameters": {
|
|
"invoice_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"payment_method": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"card_details": {
|
|
"type": "object",
|
|
"required": false,
|
|
"description": "Card details (will be masked in response)"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_emrrolescreate",
|
|
"authType": "provider",
|
|
"path": "/api/emr/roles-create",
|
|
"method": "POST",
|
|
"controller": "ApiController@createRole",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Create role",
|
|
"parameters": {
|
|
"name": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"permissions": {
|
|
"type": "array",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_emrroles",
|
|
"authType": "provider",
|
|
"path": "/api/emr/roles",
|
|
"method": "GET",
|
|
"controller": "ApiController@getRoles",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get roles",
|
|
"parameters": {}
|
|
},
|
|
{
|
|
"toolName": "public_get_appointmentparticipants",
|
|
"authType": "public",
|
|
"path": "/api/appointment-participants/{appointmentId}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getAppointmentParticipants",
|
|
"category": "ENDPOINT_CATEGORIES.APPOINTMENT_SCHEDULING",
|
|
"description": "Get appointment participants",
|
|
"parameters": {
|
|
"appointmentId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Appointment ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_emrpatientsstoredocument",
|
|
"authType": "provider",
|
|
"path": "/api/emr/patients/store-document/{pid}",
|
|
"method": "POST",
|
|
"controller": "ApiController@storeDocumentsEmr",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Store patient document in EMR",
|
|
"parameters": {
|
|
"pid": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_emrpatientsgetdocument",
|
|
"authType": "provider",
|
|
"path": "/api/emr/patients/get-document/{pid}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getDocumentEmr",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get patient documents from EMR",
|
|
"parameters": {
|
|
"pid": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getintakequestions",
|
|
"authType": "provider",
|
|
"path": "/get-intake-questions",
|
|
"method": "GET",
|
|
"controller": "ApiController@getIntakeQuestions",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get intake questions",
|
|
"parameters": {}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getconsentforms",
|
|
"authType": "provider",
|
|
"path": "/get-consent-forms",
|
|
"method": "GET",
|
|
"controller": "ApiController@getConsentForms",
|
|
"category": "ENDPOINT_CATEGORIES.FORMS_QUESTIONNAIRES",
|
|
"description": "Get consent forms",
|
|
"parameters": {}
|
|
},
|
|
{
|
|
"toolName": "provider_get_getmessagelist",
|
|
"authType": "provider",
|
|
"path": "/get-message-list/{patient_id}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getMessageList",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Get message list for patient",
|
|
"parameters": {
|
|
"patient_id": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_get_emrgetvital",
|
|
"authType": "provider",
|
|
"path": "/emr/get-vital/{pid}",
|
|
"method": "GET",
|
|
"controller": "ApiController@getVitalsEmr",
|
|
"category": "ENDPOINT_CATEGORIES.PROVIDER_MANAGEMENT",
|
|
"description": "Get patient vitals from EMR",
|
|
"parameters": {
|
|
"pid": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_emrpatientssaveclinicalprofile",
|
|
"authType": "provider",
|
|
"path": "/emr/patients/save-clinical-profile/{pid}",
|
|
"method": "POST",
|
|
"controller": "ApiController@saveClinicalProfile",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Save clinical profile for patient",
|
|
"parameters": {
|
|
"pid": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
},
|
|
"immunizations": {
|
|
"type": "array",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"allergies": {
|
|
"type": "array",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_emrpatientsstorevitals",
|
|
"authType": "provider",
|
|
"path": "/emr/patients/store-vitals/{pid}",
|
|
"method": "POST",
|
|
"controller": "ApiController@storeVitalsEmr",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Store patient vitals in EMR",
|
|
"parameters": {
|
|
"pid": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
},
|
|
"temperature": {
|
|
"type": "number",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"blood_pressure": {
|
|
"type": "string",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"heart_rate": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Parameter"
|
|
},
|
|
"weight": {
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"height": {
|
|
"type": "number",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
},
|
|
"notes": {
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"toolName": "provider_post_emrfamilyhistoryallergies",
|
|
"authType": "provider",
|
|
"path": "/emr/family-history/allergies/{patientId}",
|
|
"method": "POST",
|
|
"controller": "ApiController@storeAllergies",
|
|
"category": "ENDPOINT_CATEGORIES.PATIENT_MANAGEMENT",
|
|
"description": "Store patient allergies",
|
|
"parameters": {
|
|
"patientId": {
|
|
"type": "integer",
|
|
"required": true,
|
|
"description": "Patient ID"
|
|
},
|
|
"allergies": {
|
|
"type": "array",
|
|
"required": false,
|
|
"description": "Parameter"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"timestamp": "2025-07-18T20:14:21.722Z"
|
|
} |