Whether you need simple data access or full bi-directional synchronization, our API solutions help you connect with confidence.
API Endpoints for axiUm
The following axiUm APIs are available, offering a range of integration options to fit your needs. Whether you’re looking for read-only access, data input capabilities, or full synchronization, our API solutions ensure seamless connection within the dental academic market.
Entry
✔ Auth
✔ Clinic
✔ HealthCheck
✔ PatientProviderAssignment
✔ Patient
✔ Status
✔ TimeZone
✔ TreatmentDiscipline
✔ Version
✔ User
Essential
✔ Everything in Entry
✔ Appointment
✔ AppointmentCode
✔ PatientConsent
✔ PatientDocument
Enhanced
✔ Everything in Entry & Essential
✔ ClinicalSummary
✔ MedicalTest
✔ PatientAllergy
✔ PatientASAScore
✔ PatientBalance
✔ PatientMedication
✔ PatientPayment
| Category/Endpoint | Description | Entry | Essential | Enhanced |
|---|---|---|---|---|
|
Appointment
GET/appointments/changelog/{since}
|
Gets all Appointments that have been added, deleted, or modified since the specified UTC date and time | ✗ | ✓ | ✓ |
|
Appointment
GET/appointments/{id}
|
Gets an Appointment by axiUm Id | ✗ | ✓ | ✓ |
|
Appointment
GET/appointments
|
Gets all Appointments matching filter criteria and pagination inputs | ✗ | ✓ | ✓ |
|
Appointment
POST/appointments/{id}/cancel
|
Cancels an Appointment by axiUm Id | ✗ | ✓ | ✓ |
|
Appointment
POSTappointments/{id}/confirm
|
Confirms an Appointment by axiUm Id | ✗ | ✓ | ✓ |
|
AppointmentCode
GET/appointmentCodes
|
Gets all appointment codes matching filter criteria and pagination inputs | ✗ | ✓ | ✓ |
|
Auth
POST/auth
|
Authenticate yourself and retrieve an access token that can be used to call other API endpoints | ✓ | ✓ | ✓ |
|
Clinic
GET/clinics
|
Gets all clinics matching filter criteria and pagination inputs | ✓ | ✓ | ✓ |
|
ClinicalSummary
GET/clinicalSummaries/{id}
|
Returns a CCD for the patient identified by id | ✗ | ✗ | ✓ |
|
HealthCheck
GET/healthCheck
|
Performs a health check of the API | ✓ | ✓ | ✓ |
|
MedicalTest
GET/patientMedicalTests
|
Gets all Medical Tests matching filter criteria | ✗ | ✗ | ✓ |
|
MedicalTest
POST/patientMedicalTests
|
Adds a Medical Test | ✗ | ✗ | ✓ |
|
MedicalTest
GET/patientMedicalTests/{id}
|
Gets a Medical Test by axiUm id | ✗ | ✗ | ✓ |
|
PatientAllergy
GET/patientAllergies
|
Gets all Patient Allergies matching filter criteria and pagination inputs | ✗ | ✗ | ✓ |
|
PatientAllergy
POST/patientAllergies
|
Creates a Patient Allergy in axiUm | ✗ | ✗ | ✓ |
|
PatientAllergy
GET/patientAllergies/{id}
|
Gets a Patient Allergy by axiUm Id | ✗ | ✗ | ✓ |
|
PatientASAScores
POST/patientASAScores
|
Saves a patient ASA score for a patient in axiUm | ✗ | ✗ | ✓ |
|
PatientBalance
GET/patientBalances/{id}
|
Gets a Patient Balance by id | ✗ | ✗ | ✓ |
|
PatientConsents
POST/patientConsents
|
Adds a Patient Consent | ✗ | ✓ | ✓ |
|
PatientDocument
POST/patientDocuments
|
Adds a Patient Document | ✗ | ✓ | ✓ |
|
PatientDocument
DELETE/patientDocuments/{id}
|
Removes (soft delete) the Patient Document identified by |
✗ | ✓ | ✓ |
|
PatientMedication
GET/patientMedications
|
Finds patientMedications | ✗ | ✗ | ✓ |
|
PatientMedication
POST/patientMedications
|
Creates a Patient Medication in axiUm | ✗ | ✗ | ✓ |
|
PatientMedication
GET/patientMedications/{id}
|
Gets a Patient Medication by id | ✗ | ✗ | ✓ |
|
PatientPayment
POST/patientPayments
|
Adds a Patient Payment | ✗ | ✗ | ✓ |
|
PatientProviderAssignment
GET/patientProviderAssignments
|
Gets all patient provider assignments matching filter criteria and pagination inputs | ✓ | ✓ | ✓ |
|
PatientStatement
GET/patientStatements/{id}
|
Gets a Patient's most recent statement | ✗ | ✗ | ✓ |
|
Patient
GET/patients/changelog/{since}
|
Gets all patients that have been added or modified since the specified UTC date and time | ✓ | ✓ | ✓ |
|
Patient
GET/patients
|
Gets all patients matching filter criteria and pagination inputs | ✓ | ✓ | ✓ |
|
Patient
POST/patients
|
Creates a patient in axiUm | ✓ | ✓ | ✓ |
|
Patient
GET/patients/{id}
|
Gets a patient by axiUm Id | ✓ | ✓ | ✓ |
|
Patient
PUT/patients/{id}
|
Updates a patient in axiUm | ✓ | ✓ | ✓ |
|
Status
GET/statuses
|
Gets all status codes matching filter criteria and pagination inputs | ✓ | ✓ | ✓ |
|
TimeZone
GET/timeZones
|
Gets all valid time zones for use in creating dates and times in local time zone | ✓ | ✓ | ✓ |
|
TreatmentDiscipline
GET/treatmentDisciplines
Gets all treatment disciplines matching filter criteria and pagination inputs |
✓ |
✓ |
✓ |
|
Version
GET/version
|
Returns the version of the API and connected axiUm instance | ✓ | ✓ | ✓ |
|
User
GET/users
|
Gets all users matching filter criteria and pagination inputs | ✓ | ✓ | ✓ |
|
User
GET/users/{id}
|
Gets a user by axiUm Id | ✓ | ✓ | ✓ |
|
User
PUT/users/password
|
Changes the password for the logon user | ✓ | ✓ | ✓ |
