Skip to main content
search

API Access, Tailored to Your Needs

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

POST/auth

✔ Clinic

GET/clinics

✔ HealthCheck

GET/healthCheck

✔ Language

GET/languages

✔ PatientProviderAssignment

GET/patientProviderAssignments

✔ Patient

GET/patients/changelog/{since}
GET/patients
GET/patients/{id}

✔ PatientTitle

GET/patientTitles

✔ Status

GET/statuses

✔ TimeZone

GET/timeZones

✔ TreatmentDiscipline

GET/treatmentDisciplines

✔ Version

GET/version

✔ User

GET/users
GET/users/{id}
PUT/users/password

Essential

✔ Everything in Entry

✔ Appointment

GET/appointments/changelog/{since}
GET/appointments/{id}
GET/appointments
POST/appointments/{id}/cancel
POST/appointments/{id}/confirm

✔ AppointmentCode

GET/appointmentCodes
GET/appointmentCodes/access/{providerId}

✔ PatientConsent

POST/patientConsents

✔ PatientDocument

POST/patientDocuments
DELETE/patientDocuments/{id}
✔ Patient
      PUT /patients
      POST /patients {id]
✔ UserClinic
    GET/userClinics
✔ PatientTreatmentPlan
    GET/patientTreatmentPlans

✔ PatientStatement

GET/patientStatements
GET/patientStatements/{id}
GET/patientStatements/changelog/{since}
✔ PatientReceipt
    GET/patientReceipts
✔ PatientPaymentPlan
    GET/patientPaymentPlans
✔ PatientEstimate
    GET/patientEstimates

✔ PatientContract

GET/patientContracts/{id}

Enhanced

✔ Everything in Entry & Essential

✔ ClinicalSummary

GET/clinicalSummaries/{id}

✔ MedicalTest

GET/patientMedicalTests
POST/patientMedicalTests
GET/patientMedicalTests/{id}

✔ PatientAllergy

GET/patientAllergies
POST/patientAllergies
GET/patientAllergies/{id}

✔ PatientASAScore

POST/patientASAScores

✔ PatientBalance

GET/patientBalances/{id}

✔ PatientMedication

GET/patientMedications
POST/patientMedications
GET/patientMedications/{id}

✔ PatientInsurance

GET/patientInsurance/{id}

✔ PatientMedicalProblem

GET/patientMedicalProblems
POST/patientMedicalProblems
GET/patientMedicalProblems/{id}

✔ PatientPayment

POST/patientPayments

Compare the options side by side

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 ✗ ✓ ✓
AppointmentCode
GET/appointmentCodes/access/{providerId}
 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 id from axiUm ✗ ✓ ✓
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 x ✓ ✓
Patient
GET/patients/{id}
 Gets a patient by axiUm Id ✓ ✓ ✓
Patient
PUT/patients/{id}
 Updates a patient in axiUm x ✓ ✓
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 ✓ ✓ ✓
Language
GET/languages
 Gets all languages ✓ ✓ ✓
PatientTitle
GET/patientTitles
 Gets all patient titles ✓ ✓ ✓
UserClinic
GET/userClinics
 Gets clinics for the logged-in user ✗ ✓ ✓
PatientTreatmentPlan
GET/patientTreatmentPlans
 Gets patient treatment plans ✗ ✓ ✓
PatientStatement
GET/patientStatements
 Gets all patient statements ✗ ✓ ✓
PatientStatement
GET/patientStatements/{id}
 Gets a patient statement by ID ✗ ✓ ✓
PatientStatement
GET/patientStatements/changelog/{since}
 Gets patient statements changed since a date ✗ ✓ ✓
PatientReceipt
GET/patientReceipts
 Gets patient receipts ✗ ✓ ✓
PatientPaymentPlan
GET/patientPaymentPlans
 Gets patient payment plans ✗ ✓ ✓
PatientEstimate
GET/patientEstimates
 Gets patient estimates ✗ ✓ ✓
PatientContract
GET/patientContracts/{id}
 Gets a patient contract by ID ✗ ✓ ✓
PatientInsurance
GET/patientInsurance/{id}
 Gets patient insurance by ID ✗ ✗ ✓
PatientMedicalProblem
GET/patientMedicalProblems
 Gets all patient medical problems ✗ ✗ ✓
PatientMedicalProblem
POST/patientMedicalProblems
 Posts all patient medical problems ✗ ✗ ✓
PatientMedicalProblem
GET/patientMedicalProblems/{id}
 Gets all patient medical problems ✗ ✗ ✓
    • Appointment
      GET/appointments/changelog/{since}

    • Gets all Appointments that have been added, deleted, or modified since the specified UTC date and time

    • Entry

      ✗

    • Essential

      ✓

    • Enhanced

      ✓
    • Appointment
      GET/appointments/{id}

    • Gets an Appointment by axiUm Id

    • Entry

      ✗

    • Essential

      ✓

    • Enhanced

      ✓
    • Appointment
      GET/appointments

    • Gets all Appointments matching filter criteria and pagination inputs

    • Entry

      ✗

    • Essential

      ✓

    • Enhanced

      ✓
    • Appointment
      POST/appointments/{id}/cancel

    • Cancels an Appointment by axiUm Id

    • Entry

      ✗

    • Essential

      ✓

    • Enhanced

      ✓
    • Appointment
      POSTappointments/{id}/confirm

    • Confirms an Appointment by axiUm Id

    • Entry

      ✗

    • Essential

      ✓

    • Enhanced

      ✓
    • AppointmentCode
      GET/appointmentCodes

    • Gets all appointment codes matching filter criteria and pagination inputs

    • Entry

      ✗

    • Essential

      ✓

    • Enhanced

      ✓
    • AppointmentCode
      GET/appointmentCodes/access/{providerId}

    • Gets all appointment codes matching filter criteria and pagination inputs

    • Entry

      ✗

    • Essential

      ✓

    • Enhanced

      ✓
    • Auth
      POST/auth

    • Authenticate yourself and retrieve an access token that can be used to call other API endpoints

    • Entry

      ✓

    • Essential

      ✓

    • Enhanced

      ✓
    • Clinic
      GET/clinics

    • Gets all clinics matching filter criteria and pagination inputs

    • Entry

      ✓

    • Essential

      ✓

    • Enhanced

      ✓
    • ClinicalSummary
      GET/clinicalSummaries/{id}

    • Returns a CCD for the patient identified by id

    • Entry

      ✗

    • Essential

      ✗

    • Enhanced

      ✓
    • HealthCheck
      GET/healthCheck

    • Performs a health check of the API

    • Entry

      ✓

    • Essential

      ✓

    • Enhanced

      ✓
    • MedicalTest
      GET/patientMedicalTests

    • Gets all Medical Tests matching filter criteria

    • Entry

      ✗

    • Essential

      ✗

    • Enhanced

      ✓
    • MedicalTest
      POST/patientMedicalTests

    • Adds a Medical Test

    • Entry

      ✗

    • Essential

      ✗

    • Enhanced

      ✓
    • MedicalTest
      GET/patientMedicalTests/{id}

    • Gets a Medical Test by axiUm id

    • Entry

      ✗

    • Essential

      ✗

    • Enhanced

      ✓
    • PatientAllergy
      GET/patientAllergies

    • Gets all Patient Allergies matching filter criteria and pagination inputs

    • Entry

      ✗

    • Essential

      ✗

    • Enhanced

      ✓
    • PatientAllergy
      POST/patientAllergies

    • Creates a Patient Allergy in axiUm

    • Entry

      ✗

    • Essential

      ✗

    • Enhanced

      ✓
    • PatientAllergy
      GET/patientAllergies/{id}

    • Gets a Patient Allergy by axiUm Id

    • Entry

      ✗

    • Essential

      ✗

    • Enhanced

      ✓
    • PatientASAScores
      POST/patientASAScores

    • Saves a patient ASA score for a patient in axiUm

    • Entry

      ✗

    • Essential

      ✗

    • Enhanced

      ✓
    • PatientBalance
      GET/patientBalances/{id}

    • Gets a Patient Balance by id

    • Entry

      ✗

    • Essential

      ✗

    • Enhanced

      ✓
    • PatientConsents
      POST/patientConsents

    • Adds a Patient Consent

    • Entry

      ✗

    • Essential

      ✓

    • Enhanced

      ✓
    • PatientDocument
      POST/patientDocuments

    • Adds a Patient Document

    • Entry

      ✗

    • Essential

      ✓

    • Enhanced

      ✓
    • PatientDocument
      DELETE/patientDocuments/{id}

    • Removes (soft delete) the Patient Document identified by id from axiUm

    • Entry

      ✗

    • Essential

      ✓

    • Enhanced

      ✓
    • PatientMedication
      GET/patientMedications

    • Finds patientMedications

    • Entry

      ✗

    • Essential

      ✗

    • Enhanced

      ✓
    • PatientMedication
      POST/patientMedications

    • Creates a Patient Medication in axiUm

    • Entry

      ✗

    • Essential

      ✗

    • Enhanced

      ✓
    • PatientMedication
      GET/patientMedications/{id}

    • Gets a Patient Medication by id

    • Entry

      ✗

    • Essential

      ✗

    • Enhanced

      ✓
    • PatientPayment
      POST/patientPayments

    • Adds a Patient Payment

    • Entry

      ✗

    • Essential

      ✗

    • Enhanced

      ✓
    • PatientProviderAssignment
      GET/patientProviderAssignments

    • Gets all patient provider assignments matching filter criteria and pagination inputs

    • Entry

      ✓

    • Essential

      ✓

    • Enhanced

      ✓
    • Patient
    GET/patients/changelog/{since}

  • Gets all patients that have been added or modified since the specified UTC date and time

  • Entry

    ✓

  • Essential

    ✓

  • Enhanced

    ✓
    • Patient
      GET/patients

    • Gets all patients matching filter criteria and pagination inputs

    • Entry

      ✓

    • Essential

      ✓

    • Enhanced

      ✓
    • Patient
      POST/patients

    • Creates a patient in axiUm

    • Entry

      ✗

    • Essential

      ✓

    • Enhanced

      ✓
    • Patient
      GET/patients/{id}

    • Gets a patient by axiUm Id

    • Entry

      ✓

    • Essential

      ✓

    • Enhanced

      ✓
    • Patient
      PUT/patients/{id}

    • Updates a patient in axiUm

    • Entry

      ✗

    • Essential

      ✓

    • Enhanced

      ✓
    • Status
      GET/statuses

    • Gets all status codes matching filter criteria and pagination inputs

    • Entry

      ✓

    • Essential

      ✓

    • Enhanced

      ✓
    • TimeZone
      GET/timeZones

    • Gets all valid time zones for use in creating dates and times in local time zone

    • Entry

      ✓

    • Essential

      ✓

    • Enhanced

      ✓
    • TreatmentDiscipline
      GET/treatmentDisciplines

    • Gets all treatment disciplines matching filter criteria and pagination inputs

    • Entry

      ✓

    • Essential

      ✓

    • Enhanced

      ✓
    • Version
      GET/version

    • Returns the version of the API and connected axiUm instance

    • Entry

      ✓

    • Essential

      ✓

    • Enhanced

      ✓
    • User
      GET/users

    • Gets all users matching filter criteria and pagination inputs

    • Entry

      ✓

    • Essential

      ✓

    • Enhanced

      ✓
    • User
      GET/users/{id}

    • Gets a user by axiUm Id

    • Entry

      ✓

    • Essential

      ✓

    • Enhanced

      ✓
    • User
      PUT/users/password

    • Changes the password for the logon user

    • Entry

      ✓

    • Essential

      ✓

    • Enhanced

      ✓
      • Language
        GET/languages

      • Gets all languages

      • Entry

        ✓

      • Essential

        ✓

      • Enhanced

        ✓
      • PatientTitle
        GET/patientTitles

      • Gets all patient titles

      • Entry

        ✓

      • Essential

        ✓

      • Enhanced

        ✓
      • UserClinic
        GET/userClinics

      • Gets clinics for the logged-in user

      • Entry

        ✗

      • Essential

        ✓

      • Enhanced

        ✓
      • PatientTreatmentPlan
        GET/patientTreatmentPlans

      • Gets patient treatment plans

      • Entry

        ✗

      • Essential

        ✓

      • Enhanced

        ✓
      • PatientStatement
        GET/patientStatements

      • Gets all patient statements

      • Entry

        ✗

      • Essential

        ✓

      • Enhanced

        ✓
      • PatientStatement
        GET/patientStatements/{id}

      • Gets a patient statement by ID

      • Entry

        ✗

      • Essential

        ✓

      • Enhanced

        ✓
      • PatientStatement
        GET/patientStatements/changelog/{since}

      • Gets patient statements changed since a date

      • Entry

        ✗

      • Essential

        ✓

      • Enhanced

        ✓
      • PatientReceipt
        GET/patientReceipts

      • Gets patient receipts

      • Entry

        ✗

      • Essential

        ✓

      • Enhanced

        ✓
      • PatientPaymentPlan
        GET/patientPaymentPlans

      • Gets patient payment plans

      • Entry

        ✗

      • Essential

        ✓

      • Enhanced

        ✓
      • PatientEstimate
        GET/patientEstimates

      • Gets patient estimates

      • Entry

        ✗

      • Essential

        ✓

      • Enhanced

        ✓
      • PatientContract
        GET/patientContracts/{id}

      • Gets a patient contract by ID

      • Entry

        ✗

      • Essential

        ✓

      • Enhanced

        ✓
      • PatientInsurance
        GET/patientInsurance/{id}

      • Gets patient insurance by ID

      • Entry

        ✗

      • Essential

        ✗

      • Enhanced

        ✓
      • PatientMedicalProblem
        GET/patientMedicalProblems

      • Gets all patient medical problems

      • Entry

        ✗

      • Essential

        ✗

      • Enhanced

        ✓
      • PatientMedicalProblem
        POST/patientMedicalProblems

      • Creates a patient medical problem

      • Entry

        ✗

      • Essential

        ✗

      • Enhanced

        ✓
      • PatientMedicalProblem
        GET/patientMedicalProblems/{id}

      • Gets a patient medical problem by ID

      • Entry

        ✗

      • Essential

        ✗

      • Enhanced

        ✓
      • PatientPayment
        POST/patientPayments

      • Adds a patient payment

      • Entry

        ✗

      • Essential

        ✗

      • Enhanced

        ✓
    • Close Menu