Exchange your API key for a JWT token required for all authenticated requests.

API Key Access: API keys must be requested through support channels by the organization owner. The organization ID (id_organization) will be provided alongside the API key.

Usage:

1. Include the returned JWT token in the Authorization header: Bearer {token}
2. Include the organization ID in the id_organization header for request scoping

Most endpoints require the id_organization header to validate the request scope.

Retrieve organization information including healthcare professionals.

Authorization Details: Use the expand=AUTHORIZATION query parameter to retrieve detailed authorization information, including the idGrantor fields which contain the doctor user IDs associated with the organization. This provides access to healthcare professional identifiers for further API operations.

Create a new patient file in the Master Patient Index (MPI). This endpoint creates a comprehensive patient record including personal data, contact information, insurance details, and emergency contacts.

The patient file serves as the central record for all patient-related information across the Huli platform.

List all patient files accessible to the user within their organization

Retrieve a specific patient file by ID

Upload a document to a specific patient file

Retrieve a patient's complete medical record.

Note: This endpoint uses v1 format. The response format follows v1 conventions rather than the standardized v2 format used by other endpoints.

Retrieve complete checkup information

Retrieve prescription details from a checkup

Retrieve vital signs recorded during a checkup

Retrieve diagnosis information from a checkup

Retrieve lab procedure requests from a checkup

Retrieve patient suffering or symptoms from a checkup

Retrieve reason for visit from a checkup

Retrieve physical examination notes from a checkup

Retrieve systematic examination details from a checkup

Retrieve review of systems from a checkup

Retrieve sleep pattern information from a checkup

Retrieve anthropometric measurements from a checkup

Retrieve last menstrual cycle information from a checkup

Retrieve general notes from a checkup

Retrieve bowel habit information from a checkup

Retrieve treatment plan notes from a checkup

Retrieve custom questions and answers from a checkup

Get available time slots for a doctor at a specific clinic

Schedule a new appointment between patients and doctors.

Required fields: id_doctor, id_clinic, start_date, time_from

Appointment Duration Options:

• Provide source_event (availability slot ID) - system calculates end_date and time_to automatically
• OR provide end_date and time_to manually
• One of these approaches is required

Recommendation: Using source_event is recommended to ensure the appointment is created during an available time slot. Query availability endpoints first to get valid slot IDs.

Core Requirements:

• Doctor must be associated with the specified clinic

Permission-Based Restrictions: Some users may have additional business rules enforced, such as:

• Appointments must be scheduled at least 1 hour in advance
• Patient cannot have multiple appointments with same doctor on same day
• Maximum 3 appointments per patient per day (when patient file provided)

Important: Business rules and validation requirements vary significantly based on user-specific permissions. The above restrictions are examples that may or may not apply to your API key.

Retrieve appointment details by event ID

Update appointment details.

Requirements:

• Appointment must have status BOOKED
• Field availability depends on user permissions

Cancel an appointment, changing its status to CANCELLED and availability to IGNORE.

Effects:

• Status changes from BOOKED to CANCELLED
• Availability changes from BUSY to IGNORE
• Sets isStatusModifiedByPatient flag based on request

Mark an appointment as confirmed by patient.

Effects:

• Sets isConfirmedByPatient to true
• Appointment status remains BOOKED