Buktor - HIS Integration API Documentation
Buktor simplifies and streamlines appointment management by providing a ready-to-use widget that HIS platforms can seamlessly embed into their systems. This approach ensures that HIS vendors don't need to develop or maintain separate user interfaces for managing doctors, schedules, holidays, or reminders.
Key Benefits for HIS Vendors
1. Simplified Appointment Workflow
- HIS platforms no longer need to build complex appointment booking or management modules.
- All appointment-related activities—such as doctor schedules, patient bookings, cancellations, or rescheduling—are managed directly through the Buktor widget.
2. Seamless Embedding
- The Buktor widget is fully customizable to blend with the HIS interface, providing a unified experience for end-users.
- HIS vendors can focus on core operations without the overhead of developing appointment management UIs.
3. Post-Appointment Control by HIS
- Once the patient visit is completed, the HIS can take over by managing patient records, follow-ups, lab tests, or billing.
- This ensures HIS vendors retain control over patient care beyond the appointment.
4. Reduced Maintenance Effort
- Buktor manages updates, reminders, doctor availability, and notifications, removing the need for HIS vendors to maintain separate systems.
- All features—such as doctor schedules, holidays, and late arrivals—are handled within the widget, further reducing complexity.
5. Advanced Features without Extra Development
- Buktor offers built-in features such as automated reminders and 24/7 appointment availability through WhatsApp.
- HIS vendors no longer need to develop or maintain such features independently.
Why Use Buktor’s Widget Approach?
-
Faster Implementation
- Embedding the Buktor widget enables quick deployment with minimal coding effort.
-
Improved User Experience
- End-users benefit from a smooth and reliable booking process managed by Buktor, without interrupting HIS workflows.
-
Scalable Solution
- HIS vendors can offer hospitals and clinics advanced appointment management without increasing development or maintenance costs.
Buktor WhatsApp Notifications API
HIS platforms can use Buktor’s WhatsApp Notifications API for post-appointment follow-ups and notifications. This API enables the HIS to send follow-up messages, reminders for lab tests, prescription refills, or other patient engagements directly via WhatsApp, enhancing patient care and ensuring continuous communication.
Refer to the WhatsApp Notifications API section in the documentation for detailed API usage and integration instructions.
Base URL
https://api.buktor.com/his/v1All API endpoints follow the versioned path /his/v1 to ensure future-proofing and backward compatibility.
Authentication
Buktor APIs require Bearer Token Authentication. You must include a Bearer Token in the headers of all requests.
Obtaining the Bearer Token
Endpoint:
POST /his/v1/auth/tokenRequest Body:
{
"client_id": "your-client-id",
"client_secret": "your-client-secret",
"grant_type": "client_credentials"
}Response:
{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"token_type": "Bearer",
"expires_in": 3600
}Usage Example
Include the token in the Authorization header for all API requests:
Authorization: Bearer <your-access-token>1. Appointment Lookup API
Retrieve a list of appointments based on optional filters like phone number, patient name, or date.
Endpoint:
GET /his/v1/appointmentsOptional Query Parameters:
phone_number: Filter by patient phone number.patient_name: Filter by patient name.date: Filter by appointment date.
Sample Request:
GET /his/v1/appointments?phone_number=+911234567890&date=2024-10-15Response:
{
"data": [
{
"appointment_id": "123",
"appointment_date": "2024-10-15",
"appointment_time": "
```json
"10:30",
"patient_name": "John Doe",
"patient_phone": "+911234567890",
"service_name": "Consultation",
"location_name": "City Hospital",
"visit_status": "Visited",
"patient_info": {
"patient_id": "1",
"patient_age": 45,
"patient_gender": "Male",
"patient_email": "john@example.com"
}
}
],
"pagination": {
"current_page": 1,
"from": 1,
"last_page": 5,
"per_page": 10,
"to": 10,
"total": 50
}
}2. Daily Appointment Summary API
Retrieve a summary of all appointments for a specific date to monitor performance and trends.
Endpoint:
GET /his/v1/appointments/summaryQuery Parameters:
date(required): Date for which the summary is needed.
Sample Request:
GET /his/v1/appointments/summary?date=2024-10-15Response:
{
"total_booked": 25,
"total_visited": 20,
"total_no_show": 3,
"total_canceled": 2
}3. Embedding Buktor Widget
Embed the Buktor widget in the HIS interface for direct access to appointment management.
Sample Widget Embedding Code:
<div id="buktor-widget-container"></div>
<script>
(function() {
var widget = document.createElement('script');
widget.src = 'https://api.buktor.com/his/v1/widget.js';
widget.async = true;
widget.onload = function() {
BuktorWidget.init({
container: '#buktor-widget-container',
clinic_id: '1234', // Replace with actual clinic ID
token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' // Bearer Token
});
};
document.body.appendChild(widget);
})();
</script>4. Error Handling
Buktor API uses standard HTTP status codes to indicate success or failure.
Sample Error Responses
-
Unauthorized (401):
{ "error": "Unauthorized", "message": "Invalid or expired token." } -
Not Found (404):
{ "error": "Not Found", "message": "Appointment not found." }
Conclusion
This API documentation ensures seamless integration between Buktor and HIS platforms by providing secure access to appointment data through Bearer Token Authentication. With version control, Buktor ensures future compatibility as new features are introduced.
By embedding Buktor's widget, HIS developers can avoid redundant development, while focusing on post-appointment processes, analytics, and patient care workflows.
