Centaur Software APIs

<html>
<h2>1. Overview</h2>
<p>
  The Dental4Web API provides secure, read-only access to dental practice management data stored in
the Dental4Web practice management system. This REST API enables third-party applications to
integrate with practice data while maintaining strict security and privacy controls.
</p>
<h2>2. Multi-tenant Architecture </h2>
<h3>2.1 Infrastructure Overview</h3>
<p>
    • Each Dental4Web customer maintains a dedicated Sybase SQL Anywhere database on AWS EC2 <br>
    • A central configuration database manages <br>
        - Organisation ID to Database Mappings: Links each unique Organisation ID to its  corresponding database.<br>
        - Database Connection Details: Stores connection parameters such as hostname and port for each customer database. <br>
    <i>(Please see Appendix 1 for Enterprise Architecture diagram)</i> <br>
</p>
<h3>2.2 Request Flow</h3>
<p>

1. Request Initiation- A third-party application sends a request to the API, including the
Organisation ID in the request headers.
2. Authentication and Authorization- The API Gateway validates the provided authentication
credentials and authorises the request based on the supplied token.
3. Configuration Lookup- The system queries the central configuration database to retrieve the
connection details associated with the Organisation ID.
4. Database Routing- The request is routed to the appropriate customer database based on the
retrieved connection details.
5. Query Execution- The required query is executed against the customer's database, fetching the
requested data.
6. Response Formation- A standardised response is constructed and returned to the client
application

    ........... <br>
</p>

</html>

Contact Support:
 Name: Support Team
 Email: support@example.com

Introduction to Dental API

Getting Started

Authentication

Find Your Use Case

API Response Formats

FHIR Capabilities

Rate Limits

Filtering & Date Ranges

### **1\. Appointment Resources**

**Provides access to appointment data from the Dental4Web Practice Management System. Developers can fetch schedules, statuses, and details for patients, practitioners, and clinic locations**

**Supports FHIR-compliant Appointment resources when the fhir parameter is enabled for healthcare system interoperability.**

#### **1.1. Get Appointment List**

**End points:****GET /api/v1/appointments****FHIR: GET /api/v1/fhir/appointments**

**Use Cases:**

- **Display all upcoming appointments for a practitioner in a given week.**
    
- **Pulling appointment schedules for syncing with third-party scheduling tools.**
    
- **Filtering past appointments for attendance and cancellation reporting.**
    

**Parameters:**

| **Name** | **Type** | **Required** | **Description** |  
| **patient_id** | **int** | **No** | **Filter by patient** |  
| **practitioner_id** | **int** | **No** | **Filter by practitioner** |  
| **location_id** | **int** | **No** | **Filter by location** |  
| **appointment_id** | **int** | **No** | **Filter by appointment ID** |  
| **appt_book_id** | **int** | **No** | **Filter by appointment book** |  
| **from_date** | **date** | **No** | **Inclusive lower bound (YYYY-MM-DD)** |  
| **to_date** | **date** | **No** | **Inclusive upper bound (YYYY-MM-DD)** |  
| **page** | **int** | **No** | **Pagination, default 1** |  
| **per_page** | **int** | **No** | **Default 10, max 500** |

**Response Field Mapping**

**appointment_id, appointment_status, appointment_status_codes, cancelled, failed, attended, online, confirmed, appointment_type, appointment_date, start_time, end_time, appointment_arrival_time, actual_start_time, actual_end_time, duration, recall_set_linked, patient_id, practitioner_id, location_id, appt_book_id, created_date, updated_date**

**FHIR Mapping**

**Appointment Resource: resourceType: "Appointment", id: appointment_id, status: appointment_status, start: start_time, end: end_time, participant: \[{actor:{reference:"Patient/{patient_id}"}, status:"accepted"}, {actor:{reference:"Practitioner/{practitioner_id}"}, status:"accepted"}, {actor:{reference:"Location/{location_id}"}, status:"accepted"}\]**

**Rules:**

- **At least one filter parameter is required.**
    
- **Date format: YYYY-MM-DD.**
    

#### **1.2. Get Appointment By Id**

**Overview:****Fetches detailed information for a specific appointment using its unique ID. This is particularly useful when displaying appointment details on patient portals, updating an existing booking, or confirming details before a consultation.**

**END Points:****GET /api/v1/appointments/{appointment_id}****FHIR: GET /api/v1/fhir/appointments/{appointment_id}**

**Use Cases:**

- **Displaying appointment details to a patient through an online portal.**
    
- **Retrieving a single appointment to confirm timing and location before sending reminders.**
    
- **Reviewing details before modifying or cancelling a booking.**
    

**Parameters:**

| **Name** | **Type** | **Required** | **Description** |
| --- | --- | --- | --- |
| **appointment_id** | **int** | **No** | **Filter by appointment ID** |

**  
Response Field Mapping**

**appointment_id, appointment_status, appointment_status_codes, cancelled, failed, attended, online, confirmed, appointment_type, appointment_date, start_time, end_time, appointment_arrival_time, actual_start_time, actual_end_time, duration, recall_set_linked, patient_id, practitioner_id, location_id, appt_book_id, created_date, updated_date**

**FHIR Mapping**

**Appointment Resource: resourceType: "Appointment", id: appointment_id, status: appointment_status, start: start_time, end: end_time, participant: \[{actor:{reference:"Patient/{patient_id}"}, status:"accepted"}, {actor:{reference:"Practitioner/{practitioner_id}"}, status:"accepted"}, {actor:{reference:"Location/{location_id}"}, status:"accepted"}\]**

**Rules:**

- **Single record response**
    
- **404 if not found**
    

#### **1.3. Get Cancelled Appointments**

**Overview:****Retrieves a list of cancelled appointments within a given date range and optional filters. This helps track patient no-shows, cancellations, and related operational impact. It can also support follow-up actions such as rescheduling or analysing cancellation trends.**

**End Points:****GET /api/v1/appointments/cancelled**

**Use Cases:**

- **Generating a monthly report of cancelled appointments for operational review.**
    
- **Identifying patients who frequently cancel to address retention or policy issues.**
    
- **Automatically triggering rescheduling workflows when an appointment is cancelled.**
    

**Parameters**

| **Name** | **Type** | **Required** | **Description** |  
| **patient_id** | **int** | **No** | |  
| **practitioner_id** | **int** | **No** | |  
| **location_id** | **int** | **No** | |  
| **appt_book_id** | **int** | **No** | |  
| **from_date** | **date** | **No** | **YYYY-MM-DD** |  
| **to_date** | **date** | **No** | |  
| **mode** | **int** | **No** | **0=appointment date, 1=cancel date** |  
| **page** | **int** | **No** | |  
| **per_page** | **int** | **No** | |

**Response Field Mapping**

**appointment_id, appointment_date, appointment_time, appointment_duration, patient_id, practitioner_id, location_id, appt_book_id, cancel_date, cancel_type**

**Rules:**

- **Requires at least one parameter**
    
- **mode: 0=by appointment date, 1=by cancel date**

Appointment Resources

This endpoint retrieves a list of appointments based on optional filter criteria.<br>
You can filter by parameters such as `patient_id`, `practitioner_id`, `location_id`,
`appointment_id`, `appt_book_id`, `from_date` and `to_date`.

- FHIR - False
- Requires at least one parameter
- Date format: YYYY-MM-DD

GET Appointments

This endpoint retrieves appointment details based on `appointment_id`.

- FHIR - False
- Single record response
- 404 if not found

GET Appointment By Id

This endpoint retrieves a list of cancelled appointments based on optional filter criteria.<br>
You can filter by parameters such as `patient_id`, `practitioner_id`, `location_id`,
`mode`, `appt_book_id`, `from_date` and `to_date`.

- FHIR - False
- Requires at least one parameter
- mode: 0=by appointment date, 1=by cancel date

GET Cancelled Appointments

### **2\. Financial Resources**

**The Financial Resources API provides secure access to billing and payment data stored in the Dental4Web Practice Management System. It enables third-party applications to retrieve transaction histories, invoice details, receipt records, and other financial information to support accounting, reporting, and integration with external financial systems. These endpoints are especially useful for practice owners and accountants managing revenue tracking, third-party billing systems needing to reconcile payments, insurance integration platforms that require payment and invoice data, patient portals showing billing history and payment receipts.**

#### **2.1. Get Financials List**

**Overview:  
This API retrieves financial transaction records within a given date range, optionally filtered by patient, practitioner, or location. It provides a detailed breakdown of invoices, receipts, discounts, refunds, and health fund rebates, allowing practices to track revenue, outstanding balances, and payment activity. This is essential for billing teams, financial reporting, and reconciling accounts.**

**End Point:  
GET /api/v1/financials**

**Use Cases:**

- **Generating monthly revenue reports filtered by practitioner.**
    
- **Reviewing financial performance per location.**
    
- **Identifying outstanding invoices for follow-up.**
    
- **Analysing the ratio of refunds or discounts to total income.**
    

**Parameters:**

| **Name** | **Type** | **Required** | **Description** |
| **patient_id** | **int** | **No** | **Filter** |
| **practitioner_id** | **int** | **No** | **Filter** |
| **location_id** | **int** | **No** | **Filter** |
| **from_date** | **date** | **Yes** | **Mandatory** |
| **to_date** | **date** | **No** |  |
| **page** | **int** | **No** |  |
| **per_page** | **int** | **No** |  |

**Response Field Mapping**

**location_id, practitioner_id, patient_id, date, trans_type, invoice_id, receipt_id, invoice, discount, refund, receipt, health_fund_rebate**

**Rules:**

-  **from_date is mandatory** 
    
-  **trans_type: 1=invoice, 2=discount, 3=refund, 4=payment** 
    
-  **Use location_id=-1 for all locations**
    
-   **Use practitioner_id=-1 for all practitioners"**
    

#### **2.2. Get Receipt Data**

**Overview:  
Retrieves detailed payment information for a specific receipt, including payment types, cheque details, banking information, and deposit status. This is particularly useful for reconciliation, auditing, and resolving payment disputes. It allows administrators to verify how payments were made and ensure that deposits match records.**

**End Point:  
GET /api/v1/receipts/{receipt_id}**

**Use Cases:**

- **Confirming payment method for a specific transaction.**
    
- **Auditing banking details to prevent reconciliation errors.**
    
- **Investigating discrepancies between payment records and bank deposits.**
    
- **Generating reports for cheque-based or EFT payments.**
    

**Parameters:**

| **Name** | **Type** | **Required** | **Description** |
| **receipt_id** | **int** | **Yes** | **Receipt unique identifier** |

**Response Field Mapping**

**receipt_id, detail_id, payment_type_id, receipt_date, cheque_name, bank_name, banked, bank_branch**

**Rules:**

- **receipt_id is required** 
    
-  **Single record response**

Financial Resources

This endpoint retrieves a list of financial based data on optional filter criteria.<br>
You can filter by parameters such as `patient_id`,`from_date`,`to_date`,
    `practitioner_id`,`location_id`,`page`,`per_page`.

- from_date is mandatory
- trans_type: 1=invoice, 2=discount, 3=refund, 4=payment
- Use location_id=-1 for all locations
- Use practitioner_id=-1 for all practitioners

GET Financials

This endpoint retrieves a single record of financial receipt based data `receipt_id`.

- receipt_id is required
- Single record response

GET Receipts

### **3\. Patient Resources**

**The Patient Resources API provides access to patient-related data stored within the Dental4Web Practice Management System. It allows external applications to retrieve details about patients, their recall schedules, and associated practitioners and clinic locations enabling rich, integrated experiences for both clinical and administrative tools.**

**This resource is designed to align with the FHIR standard, making it easier to integrate with healthcare systems and ensure interoperability. Whenever the fhir parameter is enabled, the API structures patient data in FHIR-compliant format for standardised use across medical software.**

#### **3.1. Get Patient List**

**Overview:  
This API retrieves a list of patient records from the Dental4Web system based on given filters such as patient ID, practitioner association, location, and name search. It is designed to give clinical staff and integrated systems access to essential patient demographics and contact information for day-to-day operations, patient communication, and reporting. By returning a paginated list, it also supports large patient databases efficiently.**

**End Points:  
GET /api/v1/patients-list  
FHIR: GET /api/v1/fhir/patients-list**

**Use Cases:**

- **Searching for a patient’s profile before booking an appointment.**
    
- **Syncing patient demographic data to an external CRM.**
    
- **Displaying patient lists for reception or admin dashboards.**
    

**Parameters:**

| **Name** | **Type** | **Required** | **Description** |
| **patient_id** | **int** | **No** | **Filter** |
| **patient_card** | **str** | **No** | **Filter** |
| **first_name** | **str** | **No** | **Filter** |
| **surname** | **str** | **No** | **Filter** |
| **practitioner_id** | **int** | **No** | **Filter** |
| **location_id** | **int** | **No** | **Filter** |
| **page** | **int** | **No** | **Default 1, max 500** |
| **per_page** | **int** | **No** |  |

**Response Field Mapping**

**Direct mapping: patient_id, family_head_id, patient_card, patient_status, title, first_name, middle_name, surname, preferred_name, address1, address2, suburb, state, postcode, gender, birthdate, email, phone, mobile, practitioner_id, location_id, created_date, updated_date**

**FHIR Mapping**

**Patient Resource: resourceType: "Patient", id: patient_id, identifier: {system:"http://example.org/fhir/identifier/patient-card", value:patient_card}, active: (patient_status=="Active"), name: \[{use:"official", family:surname, given:\[first_name,middle_name\], prefix:\[title\]}, {use:"usual", family:surname, given:\[preferred_name\]}\], telecom: phone/mobile entries, gender, birthDate, address: {line:\[address1,address2\], city:suburb, state, postalCode:postcode, country:"Australia"}, generalPractitioner: reference to Practitioner/{practitioner_id}**

**Rules:**

- **Requires at least one parameter** 
    
-  **Null/empty params omitted from Call • Defaults: page=1, per_page=10 (max 500)"**
    

#### **3.2. Get Single Patient**

**Overview:  
Fetches detailed information for a specific patient, including full demographic details, contact information, and identifiers. This is commonly used in patient profile pages, before a consultation, or when updating a patient’s record.**

**End Point:  
GET /api/v1/get_patient/{patient_id}  
FHIR: GET /api/v1/fhir/get_patient/{patient_id}**

**Use Cases:**

- **Displaying patient details on a clinician’s dashboard prior to an appointment.**
    
- **Retrieving a patient’s full contact information to send appointment reminders.**
    
- **Verifying identity before updating medical or billing records.**
    

**Parameter:**

| **Name** | **Type** | **Required** | **Description** |
| **patient_id** | **int** | **No** | **Filter** |

**Response Field Mapping**

**Direct mapping: patient_id, family_head_id, patient_card, patient_status, title, first_name, middle_name, surname, preferred_name, address1, address2, suburb, state, postcode, gender, birthdate, email, phone, mobile, practitioner_id, location_id, created_date, updated_date**

**FHIR Mapping**

**Patient Resource: resourceType: "Patient", id: patient_id, identifier: {system:"http://example.org/fhir/identifier/patient-card", value:patient_card}, active: (patient_status=="Active"), name: \[{use:"official", family:surname, given:\[first_name,middle_name\], prefix:\[title\]}, {use:"usual", family:surname, given:\[preferred_name\]}\], telecom: phone/mobile entries, gender, birthDate, address: {line:\[address1,address2\], city:suburb, state, postalCode:postcode, country:"Australia"}, generalPractitioner: reference to Practitioner/{practitioner_id}**

**Rules:**

- **Single record response** 
    
-  **404 if not found**
    

#### **3.3. Patient Recalls**

**Overview:  
\-**

**End Point:  
GET /api/v1/patients/{patient_id}/recalls  
  
**

**Use Cases:**

- **\-**
    

**Parameters:**

| **Name** | **Type** | **Required** | **Description** |
| **patient_id** | **int** | **No** | **Filter** |
| **from_date** | **date** | **Yes** |  |
| **to_date** | **date** | **No** |  |
| **page** | **int** | **No** | **Default 1, max 500** |
| **per_page** | **int** | **No** |  |

**Response Field Mapping**

**recall_type_id, patient_id, recall_date, reminder_date, reminder_type, reminder_no, practitioner_id, location_id, created_date, updated_date**

**Rules:**

- **Date format: YYYY-MM-DD** 
    
- **Optional date filters**

Patient Resources

This endpoint retrieves a list of patients based on optional filter criteria.<br>
You can filter by parameters such as `patient_id`, `patient_card`, `first_name`,
`surname`, `practitioner_id`, and `location_id`.

- FHIR - False
- Requires at least one parameter
- Null/empty params omitted from Call
- Defaults: page=1, per_page=10 (max 500)

GET Patients

This endpoint retrieves data of patients based on `patient_id`.

- FHIR - False
- Single record response

GET Patient By ID

This endpoint retrieves data of patients recall.<br>
 You can filter by parameters such as `patient_id`, `from_date`, `to_date`.

- <b>FHIR - False</b>
- Date format: YYYY-MM-DD
- Optional date filters

GET Patient Recalls

GET Patients Extended

GET Patient Extended By ID

### **4\. Treatment & Clinical Resources**

**The Treatment & Clinical Resources API gives access to core clinical records in the Dental4Web Practice Management System. It enables third-party systems to retrieve treatment histories, upcoming planned treatments, and clinical notes while maintaining patient privacy and security. These endpoints are designed for integration with external EHR systems, automated reporting and analytics, building patient-facing treatment history views, supporting compliance and audit needs.**

#### **4.1. Treatments Data List**

**Overview:  
\-**

**End Point:  
GET /api/v1/treatments**

**Use Cases:**

- **\-**
    

**Parameters:**

| **Name** | **Type** | **Required** | **Description** |
| **patient_id** | **int** | **No** | **Filter** |
| **practitioner_id** | **int** | **No** | **Filter** |
| **location_id** | **int** | **No** | **Filter** |
| **page** | **int** | **No** | **Default 1, max 500** |
| **per_page** | **int** | **No** |  |

**Response Field Mapping**

**treatment_id, patient_id, treatment_date, item_code, item_qty, tooth, surface, item_fee, fee_discount, item_paid, practitioner_id, location_id, plan_id, created_date, updated_date**

**Rules:**

- **Requires at least one parameter** 
    
- **Use location_id=-1 for all locations** 
    
- **Use practitioner_id=-1 for all practitioners"**
    

#### **4.2. Treatment Plan Data List**

**Overview:  
Provides access to treatment plan details for patients, including planned procedures, associated costs, and statuses. This is vital for clinical staff to review and update proposed treatments and for administrative teams to generate cost estimates for patients. It supports better treatment coordination and transparency for patients.**

**End Point:  
GET /api/v1/treatment-plans  
  
Use Cases:**

- **Reviewing a patient’s pending and completed treatment plans.**
    
- **Sharing cost estimates with patients.**
    
- **Generating clinical workload reports by practitioner.**
    
- **Tracking acceptance rates of proposed treatments.**
    

**Parameters:**

| **Name** | **Type** | **Required** | **Description** |
| **patient_id** | **int** | **No** | **Filter** |
| **practitioner_id** | **int** | **No** | **Filter** |
| **location_id** | **int** | **No** | **Filter** |
| **from_date** | **date** | **Yes** |  |
| **to_date** | **date** | **No** |  |
| **page** | **int** | **No** | **Default 1, max 500** |
| **per_page** | **int** | **No** |  |

**Response Field Mapping**

**treatment_plan_id, treatment_plan_item_id, patient_id, planned_date, item_code, item_qty, tooth, surface, item_fee, practitioner_id, location_id, treatment_plan_status, is_alt_plan, is_plan_active, appointment_id, treatment_id, treatment_date, created_date, updated_date**

**Rules:**

- **Requires at least one parameter** 
    
- **Use location_id=-1 for all locations** 
    
- **Use practitioner_id=-1 for all practitioners**
    

#### **4.3. Clinical Notes**

**Overview:  
Retrieves clinical notes recorded by practitioners for a patient, including visit details, observations, diagnoses, and procedural notes. This is critical for maintaining accurate patient medical records and ensuring continuity of care across multiple practitioners.**

**End Points:  
GET /api/v1/clinical-notes  
FHIR: GET /api/v1/fhir/clinical-notes**

**Use Cases:**

- **Reviewing historical clinical notes before an upcoming appointment.**
    
- **Pulling patient records into an integrated EHR system.**
    
- **Tracking specific conditions or treatment progress over time.**
    
- **Supporting legal or insurance claims requiring medical history.**
    

**Parameters:**

| **Name** | **Type** | **Required** | **Description** |
| **patient_id** | **int** | **No** | **Filter** |
| **practitioner_id** | **int** | **No** | **Filter** |
| **location_id** | **int** | **No** | **Filter** |
| **from_date** | **date** | **Yes** |  |
| **to_date** | **date** | **No** |  |
| **page** | **int** | **No** | **Default 1, max 500** |
| **per_page** | **int** | **No** |  |

**Response Field Mapping**

**note_id, treatment_id, patient_id, note_date, note_source, item_code, tooth, surface, notes, practitioner_id, location_id, created_date, updated_date**

**FHIR Mapping**

**Observation Resource: resourceType: "Observation", id: note_id, status: "final", category: \[{coding:\[{system:"http://terminology.hl7.org/CodeSystem/observation-category", code:"procedure", display:"Procedure"}\]}\], code: {coding:\[{system:"http://loinc.org", code:item_code, display:"Clinical Note"}\]}, subject: {reference:"Patient/{patient_id}"}, performer: \[{reference:"Practitioner/{practitioner_id}"}\], effectiveDateTime: note_date, valueString: notes, bodySite: {text:"tooth, surface"}**

**Rules:**

- **Requires at least one parameter** 
    
-  **Use location_id=-1 for all locations** 
    
-  **Use practitioner_id=-1 for all practitioners"**

Treatment & Clinical Resources

This endpoint retrieves a list of treatment data based on optional filter criteria.<br>
You can filter by parameters such as `patient_id`, `practitioner_id`, `location_id`,
`from_date` and `to_date`.

- Requires at least one parameter
- Use location_id=-1 for all locations
- Use practitioner_id=-1 for all practitioners

GET Treatments

This endpoint retrieves a list of treatment plan data based on optional filter criteria.<br>
You can filter by parameters such as `patient_id`, `practitioner_id`, `location_id`,
`from_date` and `to_date`.

- Requires at least one parameter
- Use location_id=-1 for all locations
- Use practitioner_id=-1 for all practitioners

GET Treatment Plans

This endpoint retrieves a list of treatment plan data based on optional filter criteria.<br>
You can filter by parameters such as `patient_id`, `practitioner_id`, `location_id`,
`from_date` and `to_date`.

- FHIR - False
- Requires at least one parameter
- Use location_id=-1 for all locations
- Use practitioner_id=-1 for all practitioners

GET Clinical Notes

POST Clinical Notes

### **5\. Reference Data Resources**

**The Reference Data Resources API provides access to essential configuration and operational data in the Dental4Web Practice Management System. These resources are not patient treatment records, but rather supporting datasets that define the structure, people, and reference data used across other APIs. They are especially important for linking appointments, treatments, and financial transactions to the correct practitioner, location, or appointment book, integrating reference data like procedure codes and payment types, managing user and recall reminder records.**

#### **5.1. Practitioners**

**Overview:  
Retrieves a list of practitioners within the organisation, including their active status, personal details, role, location, and provider numbers. This API is crucial for linking appointments, treatments, and billing information to the correct healthcare provider. It ensures that all related patient records, invoices, and clinical data correctly reference the appropriate practitioner.**

**End Point:  
GET /api/v1/practitioners  
FHIR: GET /api/v1/fhir/practitioners**

**Use Cases:**

- **Populating a dropdown list of practitioners in appointment booking forms.**
    
- **Filtering reports by practitioner to assess productivity or revenue.**
    
- **Synchronising practitioner data with an external HR or scheduling system.**
    
- **Ensuring correct provider details are shown on patient invoices and receipts.**
    

**Parameters:**

| **Name** | **Type** | **Required** | **Description** |
| **location_id** | **int** | **No** | **Filter** |
| **page** | **int** | **No** | **Default 1, max 500** |
| **per_page** | **int** | **No** |  |

**Response Field Mapping**

**practitioner_id, is_active, practitioner_code, full_name, first_name, surname, title, role, location_id, provider_number, qualifications**

**FHIR Mapping**

**Referenced in FHIR (as Practitioner/{practitioner_id})**

**Rules:**

- **location_id is optional** 
    
-  **Returns all practitioners if no location specified"**
    

#### **5.2. Locations**

**Overview:  
Returns a list of locations within the organisation, including their active status. Locations are essential for multi-site practices where patient records, appointments, and billing must be tied to the correct branch or clinic. This ensures accurate operational reporting and avoids misallocations.**

**End Point:  
GET /api/v1/locations  
FHIR: GET /api/v1/fhir/locations**

**Use Cases:**

- **Assigning appointments or invoices to the correct branch.**
    
- **Generating location-specific performance and revenue reports.**
    
- **Filtering available appointment slots by location in booking systems.**
    
- **Integrating with facility management or resource scheduling tools.**
    

**Parameters:**

| **Name** | **Type** | **Required** | **Description** |
| **page** | **int** | **No** | **Default 1, max 500** |
| **per_page** | **int** | **No** |  |

**Response Field Mapping**

**location_id, location_name, is_active**

**FHIR Mapping**

**Referenced in FHIR (as Location/{location_id})**

**Rules:**

-  **No parameters required** 
    
-  **Returns all locations"**
    

#### **5.3. Appointment Books**

**Overview:  
Provides a list of appointment books configured within the system, including their associated location, operating hours, and active status. Appointment books are essential for managing multiple schedules within a single location, such as separate books for different practitioners, rooms, or services.**

**HTTP Request:  
GET /api/v1/appointment-books**

**Use Cases:**

- **Assigning patient bookings to the correct appointment book based on service type.**
    
- **Managing practitioner or room availability in a clinic.**
    
- **Creating a customised calendar view for a specific service or department.**
    
- **Separating clinical and administrative appointment schedules.**
    

**Parameters:**

| **Name** | **Type** | **Required** | **Description** |
| **page** | **int** | **No** | **Default 1, max 500** |
| **per_page** | **int** | **No** |  |

**Response Field Mapping**

**appt_book_id, appt_book_name, location_id, start_time, end_time, is_active**

**Rules:**

- **No parameters required**
    

#### **5.4. Procedure Codes (Items)**

**Overview:  
Retrieves a list of procedure codes and descriptions, including ADA codes and categories. This data ensures consistent billing, reporting, and treatment descriptions across the organisation. It also supports compliance with dental coding standards in Australia.**

**End Point:  
GET /api/v1/items**

**Use Cases:**

- **Populating treatment plan forms with standard procedure codes.**
    
- **Mapping treatments to billing and insurance claim submissions.**
    
- **Ensuring uniform terminology in patient records.**
    
- **Enabling reporting by procedure category for business analysis.**
    

**Parameters:**

| **Name** | **Type** | **Required** | **Description** |
| **page** | **int** | **No** | **Default 1, max 500** |
| **per_page** | **int** | **No** |  |

**Response Field Mapping**

**item_code, ADA_Code, description, category, sub_category, non_reporting, non_treatment**

**Rules:**

- **No parameters required** 
    
- **Returns all procedure/item codes**
    

#### **5.5. Payment Types**

**Overview:  
Provides a list of available payment methods in the system, such as cash, credit card, EFTPOS, or health fund rebates. This ensures all payments are recorded consistently and can be accurately reported in financial statements.**

**End Points:  
GET /api/v1/payment-types**

**Use Cases:**

- **Allowing front desk staff to select the correct payment method during transaction entry.**
    
- **Filtering revenue reports by payment type.**
    
- **Integrating payment methods with external POS or accounting systems.**
    
- **Analysing payment method trends for operational planning.**
    

**Parameters:**

| **Name** | **Type** | **Required** | **Description** |
| **page** | **int** | **No** | **Default 1, max 500** |
| **per_page** | **int** | **No** |  |

**Response Field Mapping**

**payment_type_id, payment_type, reporting_name, show_in_reports, is_deleted**

**Rules:**

- **No parameters required** 
    

#### **5.6. Users**

**Overview:  
Retrieves details of system users, including their role, active status, and associated location. This API helps manage user permissions, track activity logs, and ensure accountability for transactions and patient data updates.**

**End Point:  
GET /api/v1/users**

**Use Cases:**

- **Controlling access to sensitive data by role and location.**
    
- **Tracking who created or updated patient records.**
    
- **Linking logged-in user details to audit logs.**
    
- **Synchronising user data with an HR or identity management system.**
    

**Parameters:**

| **Name** | **Type** | **Required** | **Description** |
| **page** | **int** | **No** | **Default 1, max 500** |
| **per_page** | **int** | **No** |  |

**Response Field Mapping**

**user_id, user_code, firstname, surname, location_id, is_active, user_type**

**Rules:**

-  **No parameters required** 
    
-  **user_type: 'Provider' or 'Staff'"**
    

#### **5.7. Recalls**

**Overview:  
All recalls (multiple patients, practitioners, locations, dates).**

**End Points:  
GET /api/v1/recalls**

**Parameters:**

| **Name** | **Type** | **Required** | **Description** |
| **patient_id** | **int** | **No** | **Filter** |
| **practitioner_id** | **int** | **No** | **Filter** |
| **location_id** | **int** | **No** | **Filter** |
| **from_date** | **date** | **Yes** |  |
| **to_date** | **date** | **No** |  |
| **page** | **int** | **No** | **Default 1, max 500** |
| **per_page** | **int** | **No** |  |

**Response Field Mapping**

**recall_type_id, patient_id, recall_date, reminder_date, reminder_type, reminder_no, practitioner_id, location_id, created_date, updated_date**

**Rules:**

- **Requires at least one parameter**

Reference Data Resources

This endpoint retrieves a list of practitioners based on optional filter criteria.<br>
You can filter by parameter `location_id`.

- FHIR - False
- location_id is optional
- Returns all practitioners if no location specified

GET Practitioners

This endpoint retrieves a list of appointment books.<br>

- FHIR - False
- No parameters required

GET Locations

GET Appointment Books

GET Procedure Codes

GET Payment Types

GET Users

GET Recalls

MediaWeb PACS Resources

GET Image Search

GET Single Image

GET Patient Images (Bulk)

FHIR Resources

This endpoint retrieves a list of patients based on optional filter criteria.<br>
You can filter by parameters such as `patient_id`, `patient_card`, `first_name`,
`surname`, `practitioner_id`, and `location_id`.

- FHIR - True
- Requires at least one parameter
- Null/empty params omitted from Call
- Defaults: page=1, per_page=10 (max 500)

GET Patients - FHIR

GET Treatments -FHIR

This endpoint retrieves data of patients based on `patient_id`.

- FHIR - True
- Single record response

GET Patient By ID - FHIR

This endpoint retrieves a list of appointments based on optional filter criteria.<br>
You can filter by parameters such as `patient_id`, `practitioner_id`, `location_id`,
`appointment_id`, `appt_book_id`, `from_date` and `to_date`.

- FHIR - True
- Requires at least one parameter
- Date format: YYYY-MM-DD

GET Appointments - FHIR

This endpoint retrieves appointment details based on `appointment_id`.

- FHIR - True
- Single record response
- 404 if not found

GET Appointment By ID - FHIR

GET Clinical Notes - FHIR

GET Treatments - FHIR

GET Practitioners - FHIR

GET Locations  - FHIR

D4WEB API - Swagger

D4Web API

from_date

Production

Sandbox

<p class="slate-p " ><p class="slate-p " >The Dental API provides secure, programmatic access to dental practice management data. Built for third-party integrators, healthcare platforms, and custom applications, this API enables seamless integration with practice data while maintaining strict security and privacy controls.</p><p class="slate-p " ></p><h2 class="slate-h2 " >Connectivity Beyond the Cloud</h2><p class="slate-p " >While designed for Dental4Web (cloud) and MediaWeb PACS, this API is not limited to cloud deployments. Practices running <strong class="slate-bold">Dental4Windows on-premise</strong> can also connect via secure data pipelines provided by <a href="https://haloconnect.io" target="_blank">Halo Connect</a>. This enables a unified API experience regardless of whether your practice data resides in the cloud or on local servers.</p><p class="slate-p " ></p><h2 class="slate-h2 " >What You Can Do</h2><p class="slate-p " >The API provides read access to core practice data across five resource domains:</p><p class="slate-p " ></p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:254px;">Resource Domain</div><div style="width:605px;">Description</div></div><colgroup ><col style="width:254px"><col style="width:605px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Patient Records</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Demographics, contact details, health fund information, and recall schedules</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Appointments</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Scheduled, confirmed, cancelled, and attended appointments with full status tracking</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Financial Transactions</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Invoices, payments, discounts, refunds, and health fund rebates</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Treatments &amp; Clinical</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Completed treatments, treatment plans, and clinical notes</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Medical Imaging</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >DICOM images via MediaWeb PACS integration (online deployments only)</p></td></div></tr></tbody></table></div></div><p class="slate-p " ></p><p class="slate-p " ></p><h2 class="slate-h2 " >Key Features</h2><p class="slate-p " ></p><h3 class="slate-h3 " >Multi-Tenant Architecture</h3><p class="slate-p " >Access data from multiple dental practices using a single API key. Each request specifies the target organisation via the <code class="slate-code">org-id</code> header, ensuring complete data isolation between tenants.</p><p class="slate-p " ></p><h3 class="slate-h3 " >FHIR R4 Support</h3><p class="slate-p " >Selected endpoints support HL7® FHIR® R4 output for healthcare interoperability. Add <code class="slate-code">/fhir/</code> to supported endpoint paths to receive data formatted as FHIR resources. See FHIR Capabilities for details.</p><p class="slate-p " ></p><h3 class="slate-h3 " >Incremental Sync</h3><p class="slate-p " >Use the <code class="slate-code">mode=1</code> parameter to filter by modification timestamp instead of business date. This enables efficient delta synchronisation—fetch only records that have changed since your last sync.</p><p class="slate-p " ></p><h3 class="slate-h3 " >Flexible Filtering</h3><p class="slate-p " >All list endpoints support comprehensive filtering by patient, practitioner, location, and date range. Use the <code class="slate-code">include</code> parameter to embed related resources and reduce API calls.</p><p class="slate-p " ></p><h2 class="slate-h2 " >API Access</h2><p class="slate-p " ></p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:323px;">Title</div><div style="width:0px;">Details</div></div><colgroup ><col style="width:323px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Base URL</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">https://api.dental4web.com.au</code></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Protocol</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >HTTPS only (TLS 1.2+)</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Format</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >JSON (with optional FHIR R4 output)</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Authentication</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >API key + organisation ID headers</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Rate Limit</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >100,000 requests per day per API key</p></td></div></tr></tbody></table></div></div><p class="slate-p " ></p><h2 class="slate-h2 " >Current Capabilities</h2><p class="slate-p " ></p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:100px;">Capability</div><div style="width:100px;">Status</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Read access to all resources</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >✅ Available</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >FHIR R4 formatted responses</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >✅ Available (selected endpoints)</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Write access (POST clinical notes)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >✅ Available</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Additional write endpoints</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >🔜 Planned for future releases</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Webhook notifications</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >🔜 Planned for future releases</p></td></div></tr></tbody></table></div></div><p class="slate-p " ></p><h2 class="slate-h2 " >Prerequisites</h2><p class="slate-p " >Before integrating with the Dental4Web API, you should have:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Technical knowledge</strong>: Understanding of REST APIs, HTTP methods, and JSON format</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Healthcare context</strong>: Familiarity with dental practice workflows and healthcare data standards</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Credentials</strong>: A valid API key and organisation ID(s) from Centaur Software</div></li></ul><p class="slate-p " ></p><h2 class="slate-h2 " >Getting Help</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Integration support</strong>: Contact Centaur Software for API access and integration assistance</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Documentation feedback</strong>: Report issues or suggest improvements via your Centaur Software contact</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Book a demo</strong>: <a href="https://dental4web.com.au/book-a-demo/" target="_blank">dental4web.com.au/book-a-demo</a></div></li></ul><p class="slate-p " ></p><h2 class="slate-h2 " >Quick Links</h2><p class="slate-p " ></p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:327px;">I want to...</div><div style="width:0px;">Go to...</div></div><colgroup ><col style="width:327px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Set up authentication</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="68ad8e6204623ea220b96483" target="">Getting Started</a></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Understand the response format</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="68a46e03e170520954aed6a4" target="">API Response Formats</a></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Find the right endpoint for my use case</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="68ad840ba69ca8296a62d6e0" target="">Find Your Use Case</a></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Learn about FHIR support</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="698c5820964682a825f67b0a" target="">FHIR Capabilities</a></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >See all available endpoints</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="68afcc3d3ea0e312f3764921" target="">Appointment Resources</a>, <a href="68afcc3d3ea0e312f376492d" target="">Patient Resources</a>, <a href="68afcc3d3ea0e312f3764943" target="">Financial Resources</a>, <a href="68afcc3d3ea0e312f3764939" target="">Treatment Resources</a>, <a href="68afcc3d3ea0e312f3764949" target="">Reference Data</a></p></td></div></tr></tbody></table></div></div><p class="slate-p " >
</p></p><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p " ></p><div class="steps-widget" style="width:100%;
  	min-width:100%;"><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >1</h6><h3 class="slate-h3 " >Obtain Credentials</h3><p class="slate-p " ></p><div class="slate-div"><p class="slate-p " ><span style="background-color:transparent;color:#434343">To gain API access, an integrator must contact </span><a href="https://dental4web.com.au/book-a-demo/" target="_blank"><span style="background-color:transparent;color:#1155CB"><u class="slate-underline">Centaur Software</u></span></a><span style="background-color:transparent;color:#434343"> to set up an integration account. This request should state the intended use case, the scope of required data, and the organisation(s) for which access is being sought.</span></p><p class="slate-p " ><span style="background-color:transparent;color:#434343">Once the account is created, the integrator will be provided with an API key and given access to Dental4Web tenants. All API requests require a unique organisation ID to identify the specific tenant.</span></p></div><p class="slate-p " ></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><h3 class="slate-h3 " >Add Authentication</h3><p class="slate-p " ></p><div class="slate-div"><p class="slate-p " ><span style="background-color:transparent;color:#434343">All HTTP requests must include the following headers:</span></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:#000000">x-api-key</span></div></li></ul><p class="slate-p " ><span style="background-color:transparent;color:#434343"><em class="slate-italic">This is the integrator’s API key.</em></span></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="background-color:transparent;color:#000000">org-id</span></div></li></ul><p class="slate-p " ><span style="background-color:transparent;color:#434343">The organisation ID identifies a specific organisation within Dental4Web. Note that an integrator&apos;s API key can be used to access multiple organisations, so both the organisation ID and the API key are required for all requests.</span></p><p class="slate-p " ><span style="background-color:transparent;color:#434343">The API token grants access only to the data of the mapped org-id. Any attempt to retrieve information for a tenant other than the current one will be rejected by the API.</span></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="background-color:transparent;color:#000000">Accept: application/json</span></div></li></ul><p class="slate-p " ><span style="background-color:transparent;color:#434343"><em class="slate-italic">All requests must specify the expected response format.</em></span></p><p class="slate-p " ></p></div></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><h3 class="slate-h3 " >Try it Out</h3><p class="slate-p " ></p><div class="slate-div"><p class="slate-p " ><span style="background-color:transparent;color:#434343">Once you have all the required details, you can test your connection using the curl example below.</span></p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden">curl -X GET "https://api.dental4web.com.au/api/v1/practitioners" \
  -H "org-id: YOUR_ORG_ID" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json" </textarea><code class="language-plainText keep-markup drop-tokens"></code></pre></div></div></div></div></div><p class="slate-p " ></p><p class="slate-p " ></p></p><p class="slate-p " ></p>

<p class="slate-p " >All requests to the Dental4Web API require authentication via API keys. Authentication credentials are provided when your integration account is created by Centaur Software.</p><p class="slate-p " ></p><h1 class="slate-h1 " ><strong class="slate-bold">Required Headers</strong></h1><p class="slate-p " >Every API request must include these three headers:</p><p class="slate-p " ></p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:250px;">Header</div><div style="width:285px;">Value</div><div style="width:808px;">Description</div></div><colgroup ><col style="width:250px"><col style="width:285px"><col style="width:808px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#434343"><code class="slate-code">x-api-key</code></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Your API key</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Authenticates the integrator. Provided by Centaur Software during account setup.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#434343"><code class="slate-code">org-id</code></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Organisation ID</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Identifies which Dental4Web tenant (organisation) to access. A single API key can be mapped to multiple organisations.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">Accept</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">application/json</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Specifies the expected response format.</p></td></div></tr></tbody></table></div></div><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">Multi-Tenancy Model</strong></h3><p class="slate-p " >The Dental4Web API uses a multi-tenant architecture:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">One API key, multiple organisations</strong>: A single integrator API key can be authorised to access data from multiple dental practices.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Organisation isolation</strong>: The <code class="slate-code">org-id </code>header in each request determines which tenant&apos;s data is returned. The API strictly enforces tenant isolation; you cannot access data for an organisation your key isn&apos;t mapped to.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Request scoping</strong>: All data returned is scoped to the specified organisation only.</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">Sandbox Environment</strong></h3><p class="slate-p " >A sandbox environment is available for development and testing:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Sandbox org-id</strong>: Use <code class="slate-code">sandbox</code> as your <code class="slate-code">org-id</code> value to route requests to the sandbox environment</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Like-for-like</strong>: The sandbox environment mirrors production functionality</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Test data</strong>: Contains realistic sample patient, appointment, and treatment records</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Safe testing</strong>: Ideal for developing and testing integrations before switching to production credentials</div></li></ul><p class="slate-p " ></p><h4 class="slate-h4 " ><strong class="slate-bold">Example sandbox request:</strong></h4><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden">curl -X GET "https://api.dental4web.com.au/api/v1/practitioners" \
  -H "org-id: sandbox" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json" </textarea><code class="language-plainText keep-markup drop-tokens"></code></pre></div><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">Security Best Practices</strong></h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Keep credentials confidential</strong>: Never embed API keys in client-side code, mobile apps, or public repositories</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Use HTTPS only</strong>: All API traffic must use HTTPS. HTTP requests will be rejected</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Rotate keys periodically</strong>: Contact Centaur Software to rotate API keys if you suspect a compromise</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Minimal scope</strong>: Request access only to the organisations you need</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">Authentication Errors</strong></h3><p class="slate-p " ></p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:357px;">Satus Code</div><div style="width:453px;">Meaning</div><div style="width:400px;">What to Check</div></div><colgroup ><col style="width:357px"><col style="width:453px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >401 Unauthorized</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Your <code class="slate-code">x-api-key</code> is missing, invalid, or expired</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Verify the API key value is correct and has not been revoked</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >403 Forbidden</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Your API key does not have access to the specified <code class="slate-code">org-id</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Confirm your key is mapped to this organisation. Contact Centaur Software if needed</p></td></div></tr></tbody></table></div></div><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">Example Request</strong></h3><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden">curl -X GET "https://api.dental4web.com.au/api/v1/patients?patient_id=12345" \
  -H "org-id: YOUR_ORG_ID" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json" </textarea><code class="language-plainText keep-markup drop-tokens"></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p>

All requests to the Dental4Web API require authentication via API keys. Authentication credentials are provided when your integration account is created by Centaur Software.

Every API request must include these three headers:

Header

Value

Description

The Dental4Web API uses a multi-tenant architecture:

A sandbox environment is available for development and testing:

Satus Code

Meaning

What to Check

<h4 class="slate-h4 " ></h4><h4 class="slate-h4 " ><span style="color:#000000"><strong class="slate-bold">Choose your primary integration scenario to jump to the most relevant sections:</strong></span></h4><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Patient Data Integration</strong>: Synchronise patient demographics, contact info, and medical history into your system. → <a href="68afcc3d3ea0e312f376492d" target="">View Patient Resources</a></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Appointment Synchronisation</strong>: Pull appointment schedules, status updates, and practitioner assignments for calendar apps. → <a href="68afcc3d3ea0e312f3764921" target="">View Appointment Resources</a></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Billing &amp; Payment Systems</strong>: Extract transaction data, payment records, and financial reports for accounting software. → <a href="68afcc3d3ea0e312f3764943" target="">View Financial Resources</a></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">EHR/EMR Connectivity</strong>: FHIR R4 endpoints for healthcare interoperability and clinical data exchange. → <a href="68afcc3d3ea0e312f376492d/68afcc3d3ea0e312f3764931" target="">View FHIR Endpoints</a></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Development &amp; Testing</strong>: Quick authentication setup and endpoint testing for proof-of-concept builds. → <a href="68ad8e6204623ea220b96483" target="">Getting Started</a></div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p>

Choose your primary integration scenario to jump to the most relevant sections:

<p class="slate-p " ></p><h3 class="slate-h3 " ><span style="color:#000000">Required Headers</span></h3><p class="slate-p " ></p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:253px;">Header</div><div style="width:202px;">Type</div><div style="width:166px;">Required</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:253px"><col style="width:202px"><col style="width:166px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#434343"><code class="slate-code">org-id</code></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#434343">string</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#434343">yes</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Identifies the Dental4Web tenant organisation. This determines which practice&apos;s data is returned.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#434343"><code class="slate-code">x-api-key</code></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#434343">string</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#434343">yes</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Your integrator API key. Provided by Centaur Software during account setup.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#434343"><code class="slate-code">Accept</code></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#434343">string</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#434343">yes</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Response format. Must be set to <code class="slate-code">application/json</code>.</p></td></div></tr></tbody></table></div></div><h3 class="slate-h3 " ><span style="color:#000000">Sample Response:</span></h3><p class="slate-p " ></p><h4 class="slate-h4 " ><span style="color:#000000"><strong class="slate-bold">Response Field Mapping</strong></span><span style="background-color:transparent;color:rgb(0, 0, 0)"><strong class="slate-bold">
</strong></span></h4><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
    &quot;data&quot;: [],
    &quot;pagination&quot;: {
        &quot;page&quot;: 1,
        &quot;per_page&quot;: 10,
        &quot;total_rows&quot;: 0,
        &quot;total_pages&quot;: 0
    },
}</div></div></code></pre></div><h3 class="slate-h3 " ><span style="background-color:transparent;color:rgb(0, 0, 0)">
</span></h3><h4 class="slate-h4 " ><span style="background-color:transparent;color:rgb(0, 0, 0)"><strong class="slate-bold">FHIR Mapping</strong></span></h4><p class="slate-p " ></p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line"> {
    &quot;data&quot;: [],
    &quot;pagination&quot;: {
        &quot;page&quot;: 1,
        &quot;per_page&quot;: 10,
        &quot;total_rows&quot;: 0,
        &quot;total_pages&quot;: 0
    }
}</div></div></code></pre></div><p class="slate-p " ></p><h4 class="slate-h4 " ><span style="background-color:transparent;color:rgb(0, 0, 0)"><strong class="slate-bold">Error Codes</strong></span></h4><p class="slate-p " ></p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:197px;"> Code </div><div style="width:218px;">Reason</div><div style="width:1055px;">Description</div></div><colgroup ><col style="width:197px"><col style="width:218px"><col style="width:1055px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > 400 </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > Bad Request </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > Missing or malformed required parameters. Check your query string and request body. </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > 401 </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > Unauthorized </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > Invalid or missing API key. Verify your `x-api-key` and `org-id` headers are correct. </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > 403 </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > Forbidden </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > Your API key does not have access to the specified organisation. Contact Centaur Software. </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > 404 </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > Not Found </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > The requested resource does not exist. Verify the ID in your request path. </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > 422 </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > Unprocessable Entity </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > Parameter validation failed. Check parameter types, formats, and allowed values. </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > 429 </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > Too Many Requests </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > Rate limit exceeded. See Rate Limits section. Retry after the time specified in the `Retry-After` header. </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > 500 </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > Internal Server Error </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > An unexpected server-side error occurred. Retry the request or contact support. </p></td></div></tr></tbody></table></div></div><p class="slate-p " ></p><p class="slate-p " ></p>

Type

Required

 Code 

Reason

Dental API supports HL7® FHIR® R4 (Release 4.0.1) output for healthcare interoperability. FHIR (Fast Healthcare Interoperability Resources) is an international standard for exchanging healthcare information electronically.

FHIR is a standard developed by HL7 International that defines how healthcare information can be exchanged between systems. It uses modern web technologies (REST, JSON, XML) and provides a set of standardised "resources" representing clinical concepts like patients, appointments, and observations.

The following endpoints support FHIR R4 output. Add 

 to the path to receive FHIR-formatted responses:

Standard Endpoint

FHIR Endpoint

FHIR Resource Type

Endpoint

When using a FHIR endpoint, responses are returned as a FHIR Bundle of type 

Feild

Dental4Web Field

FHIR Path

Notes

Practice Management System (PMS) patient data maps to FHIR Patient as follows:

PMS Database Field

PMS treatment data maps to FHIR Procedure as follows:

 uses a practice-specific namespace (e.g., 

). ADA codes may be included as an additional coding entry when available.

FHIR responses include inline references to related resources. For example, an Appointment resource will include references to the Patient, Practitioner, and Location:

<p class="slate-p " >To ensure fair usage and system stability, Dental API enforces rate limits on all requests.</p><p class="slate-p " ><strong class="slate-bold">Current Limits</strong></p><p class="slate-p " ></p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:100px;">Limit Type</div><div style="width:100px;">Threshold</div><div style="width:100px;">Window</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Per API Key</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >100,000 requests</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Per day (24 hours, rolling)</p></td></div></tr></tbody></table></div></div><p class="slate-p " ><strong class="slate-bold">Rate Limit Behaviour</strong></p><p class="slate-p " >When you exceed the rate limit:</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">The API returns a <code class="slate-code">429 Too Many Requests</code> response</div></li><li class="slate-li " ><div style="position:relative">The response includes a <code class="slate-code">Retry-After</code> header indicating seconds to wait</div></li><li class="slate-li " ><div style="position:relative">Requests resume normally after the rate limit window resets</div></li></ol><p class="slate-p " ></p><p class="slate-p " ><strong class="slate-bold">Rate Limit Response Example</strong></p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden">{
  "status": false,
  "message": "Rate limit exceeded. Please retry after the specified time.",
  "detail": {
    "limit": 100000,
    "remaining": 0,
    "reset_at": "2026-02-12T00:00:00Z"
  }
} </textarea><code class="language-plainText keep-markup drop-tokens"></code></pre></div><p class="slate-p " ></p><p class="slate-p " ><strong class="slate-bold">Best Practices to Avoid Rate Limits</strong></p><p class="slate-p " ><strong class="slate-bold">Cache Reference Data</strong></p><p class="slate-p " >Reference data (practitioners, locations, procedure codes, appointment books, payment types) changes infrequently. Cache these locally and refresh periodically (e.g., daily) rather than fetching on every request.</p><p class="slate-p " ><strong class="slate-bold">Use Pagination Wisely</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Default <code class="slate-code">per_page</code> is 10, maximum is 500</div></li><li class="slate-li " ><div style="position:relative">For large data sets, use reasonable page sizes (10-50 records)</div></li><li class="slate-li " ><div style="position:relative">Avoid repeatedly fetching the same pages</div></li></ul><p class="slate-p " ><strong class="slate-bold">Implement Exponential Backoff</strong></p><p class="slate-p " >When receiving a <code class="slate-code">429</code> response, implement exponential backoff:</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden">Wait 1 second, retry
If still 429, wait 2 seconds, retry
If still 429, wait 4 seconds, retry
...continue doubling up to 32 seconds </textarea><code class="language-plainText keep-markup drop-tokens"></code></pre></div><p class="slate-p " ></p><p class="slate-p " ><strong class="slate-bold">Use Date Range Filters</strong></p><p class="slate-p " >Always specify <code class="slate-code">from_date</code> and <code class="slate-code">to_date</code> to limit result sets. Smaller, targeted queries are more efficient than fetching all data.</p><p class="slate-p " ><strong class="slate-bold">Leverage the </strong><code class="slate-code"><strong class="slate-bold">mode</strong></code><strong class="slate-bold"> Parameter for Sync Operations</strong></p><p class="slate-p " >Use <code class="slate-code">mode=1</code> with date filters to fetch only records modified since your last sync, rather than fetching all records repeatedly.</p><p class="slate-p " ></p><p class="slate-p " ></p>

To ensure fair usage and system stability, Dental API enforces rate limits on all requests.

Limit Type

Threshold

Window

Reference data (practitioners, locations, procedure codes, appointment books, payment types) changes infrequently. Cache these locally and refresh periodically (e.g., daily) rather than fetching on every request.

 response, implement exponential backoff:

 to limit result sets. Smaller, targeted queries are more efficient than fetching all data.

 with date filters to fetch only records modified since your last sync, rather than fetching all records repeatedly.

This page explains how date filtering and the 

 parameter work across all Dental API endpoints. Understanding these concepts is essential for building efficient sync workflows and delta queries.

 parameter controls how date filters are interpreted. It appears on most list endpoints.

Name

Behaviour

Example: Business Date vs Modification Timestamp

 in January. The second returns appointments that were 

 in January—including future appointments booked during that period.

, the API applies automatic date range defaults to prevent unbounded queries. Each endpoint has its own default range optimised for typical use cases.

Condition

Total Range

Past Days

Future Days

The API handles three scenarios when dates are omitted:

from_date = TODAY - [Past Days]
to_date   = TODAY + [Future Days]

 would attempt to return the entire appointment history—potentially millions of records. Defaults protect both API performance and your application from timeout errors.

Simply provide explicit date parameters to override:

The MediaWeb PACS image search endpoint (

Scenario

Resulting Dates

Cancelled Appointments: Special Behaviour

Mode

Filters By

This is intentional: when syncing cancellations, you typically want to know which appointments were cancelled during a period, not when they were originally scheduled.

Mode 0 Filters By

Mode 1 Filters By

Fetch all historical data with explicit, wide date ranges:

Large result sets are paginated. Always check for pagination and loop until complete:

<p class="slate-p slate-indent-0" style="0px"></p><p class="slate-p slate-indent-0" style="0px"><span style="color:#434343">The Appointment Resources API provides appointment-related information stored within the Dental4Web Practice Management System. It enables third-party applications to retrieve appointment schedules, statuses, and related details for patients, practitioners, and clinic locations. Designed for interoperability, the API supports FHIR-compliant Appointment resources when the FHIR parameter is enabled, ensuring compatibility with healthcare industry standards.</span></p><p class="slate-p " ></p>

The Appointment Resources API provides appointment-related information stored within the Dental4Web Practice Management System. It enables third-party applications to retrieve appointment schedules, statuses, and related details for patients, practitioners, and clinic locations. Designed for interoperability, the API supports FHIR-compliant Appointment resources when the FHIR parameter is enabled, ensuring compatibility with healthcare industry standards.

<p class="slate-p " >
<span style="background-color:rgb(255, 255, 255);color:rgb(67, 67, 67)">The Financial Resources API provides secure access to billing and payment data stored in the Dental4Web Practice Management System. It enables third-party applications to retrieve transaction histories, invoice details, receipt records, and other financial information to support accounting, reporting, and integration with external financial systems. These endpoints are especially useful for practice owners and accountants managing revenue tracking, third-party billing systems needing to reconcile payments, insurance integration platforms that require payment and invoice data, and patient portals showing billing history and payment receipts.</span></p>

The Financial Resources API provides secure access to billing and payment data stored in the Dental4Web Practice Management System. It enables third-party applications to retrieve transaction histories, invoice details, receipt records, and other financial information to support accounting, reporting, and integration with external financial systems. These endpoints are especially useful for practice owners and accountants managing revenue tracking, third-party billing systems needing to reconcile payments, insurance integration platforms that require payment and invoice data, and patient portals showing billing history and payment receipts.

<p class="slate-p " ><span style="color:#434343">The Patient Resources API provides access to patient-related data stored within the Dental4Web Practice Management System. It allows external applications to retrieve details about patients, their recall schedules, and associated practitioners and clinic locations, enabling rich, integrated experiences for both clinical and administrative tools.</span></p><p class="slate-p " ><span style="color:#434343">This resource is designed to align with the FHIR standard, making it easier to integrate with healthcare systems and ensure interoperability. Whenever the FHIR parameter is enabled, the API structures patient data in FHIR-compliant format for standardised use across medical software.</span></p><p class="slate-p " ></p>

The Patient Resources API provides access to patient-related data stored within the Dental4Web Practice Management System. It allows external applications to retrieve details about patients, their recall schedules, and associated practitioners and clinic locations, enabling rich, integrated experiences for both clinical and administrative tools.

This resource is designed to align with the FHIR standard, making it easier to integrate with healthcare systems and ensure interoperability. Whenever the FHIR parameter is enabled, the API structures patient data in FHIR-compliant format for standardised use across medical software.

<p class="slate-p " ><span style="background-color:transparent;color:#434343">The Treatment &amp; Clinical Resources API gives access to core clinical records in the Dental4Web Practice Management System. It enables third-party systems to retrieve treatment histories, upcoming planned treatments, and clinical notes while maintaining patient privacy and security. These endpoints are designed for integration with external EHR systems, automated reporting and analytics, building patient-facing treatment history views, and supporting compliance and audit needs.</span></p><p class="slate-p " ></p><p class="slate-p " ></p>

The Treatment & Clinical Resources API gives access to core clinical records in the Dental4Web Practice Management System. It enables third-party systems to retrieve treatment histories, upcoming planned treatments, and clinical notes while maintaining patient privacy and security. These endpoints are designed for integration with external EHR systems, automated reporting and analytics, building patient-facing treatment history views, and supporting compliance and audit needs.

<p class="slate-p " ><span style="background-color:transparent;color:#434343">The Reference Data Resources API provides access to essential configuration and operational data in the Dental4Web Practice Management System. These resources are not patient treatment records, but rather supporting datasets that define the structure, people, and reference data used across other APIs. They are especially important for linking appointments, treatments, and financial transactions to the correct practitioner, location, or appointment book, integrating reference data like procedure codes and payment types, and managing user and recall reminder records.</span></p><p class="slate-p " ></p>

The Reference Data Resources API provides access to essential configuration and operational data in the Dental4Web Practice Management System. These resources are not patient treatment records, but rather supporting datasets that define the structure, people, and reference data used across other APIs. They are especially important for linking appointments, treatments, and financial transactions to the correct practitioner, location, or appointment book, integrating reference data like procedure codes and payment types, and managing user and recall reminder records.

<p class="slate-p " >Retrieves a list of practitioners (dentists, hygienists, and other clinical staff) within the organisation. Practitioners are essential for linking appointments, treatments, and billing to the correct healthcare provider.</p><p class="slate-p " ><strong class="slate-bold">Use Cases:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Build practitioner selection dropdowns for booking interfaces</div></li><li class="slate-li " ><div style="position:relative">Display practitioner information on appointment confirmations</div></li><li class="slate-li " ><div style="position:relative">Map appointment data to correct practitioners for reporting</div></li><li class="slate-li " ><div style="position:relative">Sync practitioner directory to external systems</div></li></ul><p class="slate-p " ><strong class="slate-bold">Important Notes:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Optional filter:</strong> Use <code class="slate-code">location_id</code> to filter by specific location</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">All practitioners:</strong> Omit <code class="slate-code">location_id</code> to retrieve all across organisation</div></li></ul><p class="slate-p " ></p><h4 class="slate-h4 " >Response Field Mapping</h4><p class="slate-p " ></p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
  &quot;practitioner_id&quot;: &quot;integer — Practitioner identifier&quot;,
  &quot;is_active&quot;: &quot;boolean — Active status&quot;,
  &quot;practitioner_code&quot;: &quot;string — Short code&quot;,
  &quot;full_name&quot;: &quot;string — Full display name&quot;,
  &quot;first_name&quot;: &quot;string — First name&quot;,
  &quot;surname&quot;: &quot;string — Surname&quot;,
  &quot;title&quot;: &quot;string — Title (Dr/Mr/Ms)&quot;,
  &quot;role&quot;: &quot;string — Role (Dentist/Hygienist)&quot;,
  &quot;location_id&quot;: &quot;integer — Primary location&quot;,
  &quot;provider_number&quot;: &quot;string | null — Provider number&quot;,
  &quot;qualifications&quot;: &quot;string | null — Qualifications&quot;,
  &quot;updated_date&quot;: &quot;datetime — Last modification timestamp&quot;
}</div></div></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p>

Retrieves a list of practitioners (dentists, hygienists, and other clinical staff) within the organisation. Practitioners are essential for linking appointments, treatments, and billing to the correct healthcare provider.

string — Title (Dr/Mr/Ms)

org-id

x-api-key

Accept

The unique identifier for a practice location. Use `-1` to return data for all locations.

location_id

Page number for paginated results (1-indexed). Default: `1`.

page

Number of records per page. Default: `10`. Maximum: `500`.

per_page

Comma-separated list of related resources to embed in the response. Available values vary by endpoint. Example: `practitioners,locations`.

include

detail

<p class="slate-p " >Retrieves a list of practice locations (clinics, branches) within the organisation. Locations are essential for multi-site practices where patient records, appointments, and billing must be associated with the correct branch.</p><p class="slate-p " ><strong class="slate-bold">Use Cases:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Build location selection dropdowns for booking interfaces</div></li><li class="slate-li " ><div style="position:relative">Display practice addresses on appointment confirmations</div></li><li class="slate-li " ><div style="position:relative">Filter reports and data by location</div></li><li class="slate-li " ><div style="position:relative">Sync location directory to external systems</div></li></ul><p class="slate-p " ><strong class="slate-bold">Important Notes:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">No parameters:</strong> Returns all locations for the organisation</div></li></ul><p class="slate-p " ></p><h4 class="slate-h4 " >Response Field Mapping</h4><p class="slate-p " ></p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
  &quot;location_id&quot;: &quot;integer — Primary identifier&quot;,
  &quot;location_name&quot;: &quot;string — Location/branch name&quot;,
  &quot;address&quot;: &quot;string — Full street address&quot;,
  &quot;phone&quot;: &quot;string — Contact phone number&quot;,
  &quot;email&quot;: &quot;string — Contact email&quot;,
  &quot;is_active&quot;: &quot;boolean — Active status&quot;
}</div></div></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p>

Retrieves a list of practice locations (clinics, branches) within the organisation. Locations are essential for multi-site practices where patient records, appointments, and billing must be associated with the correct branch.

<p class="slate-p " >Retrieves appointment book configurations for the organisation. Appointment books represent schedulable resources—typically a practitioner&apos;s chair or room. Each book has operating hours and is associated with a location.</p><p class="slate-p " ><strong class="slate-bold">Use Cases:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Map appointments to the correct practitioner/resource</div></li><li class="slate-li " ><div style="position:relative">Build scheduling interfaces that respect operating hours</div></li><li class="slate-li " ><div style="position:relative">Manage multiple schedules within a single location</div></li><li class="slate-li " ><div style="position:relative">Display available booking slots</div></li></ul><p class="slate-p " ><strong class="slate-bold">Important Notes:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">No parameters:</strong> Returns all appointment books for the organisation</div></li></ul><p class="slate-p " ></p><h4 class="slate-h4 " >Response Field Mapping</h4><p class="slate-p " ></p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
  &quot;appt_book_id&quot;: &quot;integer — Primary identifier&quot;,
  &quot;appt_book_name&quot;: &quot;string — Book/resource name&quot;,
  &quot;location_id&quot;: &quot;integer — Associated location&quot;,
  &quot;start_time&quot;: &quot;time — Operating start time&quot;,
  &quot;end_time&quot;: &quot;time — Operating end time&quot;,
  &quot;is_active&quot;: &quot;boolean — Active status&quot;
}</div></div></code></pre></div><p class="slate-p " ></p>

Retrieves appointment book configurations for the organisation. Appointment books represent schedulable resources—typically a practitioner's chair or room. Each book has operating hours and is associated with a location.

<p class="slate-p " >Retrieves procedure codes (item codes) used for treatments and billing. Each item includes its ADA code, description, category, and reporting flags. This reference data ensures consistent treatment descriptions and billing across integrations.</p><p class="slate-p " ><strong class="slate-bold">Use Cases:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Map item codes to procedure descriptions for display</div></li><li class="slate-li " ><div style="position:relative">Build treatment selection interfaces</div></li><li class="slate-li " ><div style="position:relative">Validate item codes during data import</div></li><li class="slate-li " ><div style="position:relative">Generate procedure category reports</div></li></ul><p class="slate-p " ><strong class="slate-bold">Important Notes:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">No parameters:</strong> Returns all items for the organisation</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Large dataset:</strong> May return 1000+ records — use pagination</div></li></ul><p class="slate-p " ></p><h4 class="slate-h4 " >Response Field Mapping</h4><p class="slate-p " ></p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
  &quot;item_code&quot;: &quot;string — Procedure code&quot;,
  &quot;description&quot;: &quot;string — Procedure description&quot;,
  &quot;category&quot;: &quot;string — Category/grouping&quot;,
  &quot;ada_code&quot;: &quot;string — ADA (Australian Dental Association) code&quot;,
  &quot;fee&quot;: &quot;decimal — Standard fee&quot;,
  &quot;is_active&quot;: &quot;boolean — Active status&quot;
}</div></div></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p>

Retrieves procedure codes (item codes) used for treatments and billing. Each item includes its ADA code, description, category, and reporting flags. This reference data ensures consistent treatment descriptions and billing across integrations.

<p class="slate-p " >Retrieves available payment methods configured in the practice system. Use this reference data to correctly interpret payment records and build payment interfaces.</p><p class="slate-p " ><strong class="slate-bold">Use Cases:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Map payment type IDs to display names</div></li><li class="slate-li " ><div style="position:relative">Build payment method selection interfaces</div></li><li class="slate-li " ><div style="position:relative">Generate payment method breakdown reports</div></li></ul><p class="slate-p " ><strong class="slate-bold">Important Notes:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">No parameters:</strong> Returns all payment types for the organisation</div></li></ul><p class="slate-p " ></p><h4 class="slate-h4 " >Response Field Mapping<span style="color:#000000"><strong class="slate-bold"> </strong></span></h4><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
  &quot;payment_type_id&quot;: &quot;integer — Primary identifier&quot;,
  &quot;payment_type&quot;: &quot;string — Payment method name&quot;,
  &quot;is_active&quot;: &quot;boolean — Active status&quot;
}</div></div></code></pre></div><p class="slate-p " ></p>

Retrieves available payment methods configured in the practice system. Use this reference data to correctly interpret payment records and build payment interfaces.

<p class="slate-p " >Retrieves system user accounts including receptionists, practice managers, and administrative staff. Users are distinct from practitioners—they represent login accounts and system permissions rather than clinical providers.</p><p class="slate-p " ><strong class="slate-bold">Use Cases:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Audit user activity and permissions</div></li><li class="slate-li " ><div style="position:relative">Track which user created or modified records</div></li><li class="slate-li " ><div style="position:relative">Build user management interfaces</div></li><li class="slate-li " ><div style="position:relative">Map <code class="slate-code">created_user_id</code> from other endpoints to user names</div></li></ul><p class="slate-p " ><strong class="slate-bold">Important Notes:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">No parameters:</strong> Returns all users for the organisation</div></li></ul><p class="slate-p " ></p><h4 class="slate-h4 " >Response Field Mapping</h4><p class="slate-p " ></p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
  &quot;user_id&quot;: &quot;integer — Primary identifier&quot;,
  &quot;first_name&quot;: &quot;string — Given name&quot;,
  &quot;surname&quot;: &quot;string — Family name&quot;,
  &quot;email&quot;: &quot;string — Email address&quot;,
  &quot;role&quot;: &quot;string — User role&quot;,
  &quot;location_id&quot;: &quot;integer|null — Associated location (null for all locations)&quot;,
  &quot;is_active&quot;: &quot;boolean — Active status&quot;,
  &quot;created_date&quot;: &quot;datetime — Record creation timestamp&quot;,
  &quot;updated_date&quot;: &quot;datetime — Record modification timestamp&quot;
}</div></div></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p>

Retrieves system user accounts including receptionists, practice managers, and administrative staff. Users are distinct from practitioners—they represent login accounts and system permissions rather than clinical providers.

<p class="slate-p " >Retrieves recall records across multiple patients, practitioners, and locations. Unlike the patient-specific <code class="slate-code">/patients/{id}/recalls</code> endpoint, this endpoint supports organisation-wide recall queries with comprehensive filtering.</p><p class="slate-p " ><strong class="slate-bold">Use Cases:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Generate practice-wide recall due lists for outreach campaigns</div></li><li class="slate-li " ><div style="position:relative">Build recall management dashboards showing upcoming reminders</div></li><li class="slate-li " ><div style="position:relative">Analyse recall compliance rates across locations or practitioners</div></li><li class="slate-li " ><div style="position:relative">Identify overdue recalls requiring urgent follow-up</div></li></ul><p class="slate-p " ><strong class="slate-bold">Important Notes:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Required parameters:</strong> At least one filter parameter required</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Date filtering:</strong> Supports <code class="slate-code">mode</code> parameter. See <a href="698c6f6fe88dee4569648037" target="">Filtering &amp; Date Ranges</a></div></li></ul><p class="slate-p " ></p><h4 class="slate-h4 " ><strong class="slate-bold">Response Field Mapping</strong></h4><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
  &quot;recall_type_id&quot;: &quot;integer — Recall type identifier&quot;,
  &quot;patient_id&quot;: &quot;integer — Patient identifier&quot;,
  &quot;recall_date&quot;: &quot;date — Scheduled recall date&quot;,
  &quot;reminder_date&quot;: &quot;date — Reminder sent/due date&quot;,
  &quot;reminder_type&quot;: &quot;string — Reminder method (SMS, Email, Letter)&quot;,
  &quot;reminder_no&quot;: &quot;integer — Reminder sequence number&quot;,
  &quot;practitioner_id&quot;: &quot;integer — Associated practitioner&quot;,
  &quot;location_id&quot;: &quot;integer — Associated location&quot;,
  &quot;created_date&quot;: &quot;datetime — Record creation timestamp&quot;,
  &quot;updated_date&quot;: &quot;datetime — Record modification timestamp&quot;
}</div></div></code></pre></div><p class="slate-p " ></p>

Retrieves recall records across multiple patients, practitioners, and locations. Unlike the patient-specific 

 endpoint, this endpoint supports organisation-wide recall queries with comprehensive filtering.

to_date

practitioner_id

patient_id

<p class="slate-p " >MediaWeb PACS endpoints provide access to Dental4Web&apos;s digital imaging platform. These endpoints enable searching, retrieving, and bulk-downloading dental images in DICOM format or converted to JPEG.</p><p class="slate-p " ><strong class="slate-bold">Key Features:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">DICOM native storage</strong>: All images are stored in DICOM format for diagnostic quality</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Optional JPEG conversion</strong>: Request JPEG format for viewing/display use cases (quality level 98)</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Pre-signed URLs</strong>: Secure, time-limited download links (no additional authentication required)</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Bulk retrieval</strong>: Efficiently download all images for a patient in a single request</div></li></ul><p class="slate-p " ><strong class="slate-bold">Image Format Recommendations:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Use DICOM format for diagnostic purposes and archival</div></li><li class="slate-li " ><div style="position:relative">Use JPEG for display in non-diagnostic applications and patient portals</div></li><li class="slate-li " ><div style="position:relative">If JPEG conversion fails to meet quality thresholds, the original DICOM is returned</div></li></ul><p class="slate-p " ><strong class="slate-bold">Pre-signed URL Expiry:</strong> </p><p class="slate-p " ></p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:555px;">Operation</div><div style="width:0px;">Expiry Time</div></div><colgroup ><col style="width:555px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Single image (<code class="slate-code">GET /mwp/images/{image_id}</code>)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >5 minutes</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Bulk patient images (<code class="slate-code">GET /mwp/images/patient/{patient_id}</code>)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >10 minutes</p></td></div></tr></tbody></table></div></div><p class="slate-p " ></p>

MediaWeb PACS endpoints provide access to Dental4Web's digital imaging platform. These endpoints enable searching, retrieving, and bulk-downloading dental images in DICOM format or converted to JPEG.

Operation

Expiry Time

<p class="slate-p " >is section documents all FHIR R4-compliant endpoints. These endpoints return data in standard FHIR Bundle format for healthcare interoperability.</p><p class="slate-p " ><strong class="slate-bold">For detailed FHIR documentation, see the </strong><a href="698c5820964682a825f67b0a" target=""><strong class="slate-bold">FHIR Capabilities page</strong></a><strong class="slate-bold">.</strong></p><p class="slate-p " >All FHIR endpoints:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Return data wrapped in a FHIR Bundle with <code class="slate-code">resourceType: &quot;Bundle&quot;</code></div></li><li class="slate-li " ><div style="position:relative">Include inline references to related resources (Patient, Practitioner, Location)</div></li><li class="slate-li " ><div style="position:relative">Follow FHIR R4 specification naming conventions</div></li><li class="slate-li " ><div style="position:relative">Accept the same query parameters as their standard counterparts</div></li></ul><p class="slate-p " ></p>

is section documents all FHIR R4-compliant endpoints. These endpoints return data in standard FHIR Bundle format for healthcare interoperability.

Sections