API Specification

About

The Open Dental API allows developers to safely interact with an Open Dental database. This page describes the Open Dental RESTful API service. This is different from the FHIR API, which is targeted toward interfacing with medical systems. The API and the FHIR API share some of the same codebase, especially security, but the target audience is different. This API is generally recommended for most interfaces, unless you are connecting to an existing FHIR interface.

API developers should have a Business Associate Agreement (BAA) in place with their clients.

The following http method types are supported:
GET: Retrieves either one or multiple items.
POST: Creates a new item. Typically returns a "location" header and the object.
PUT: Updates an item. Returns 200 OK.
DELETE: Removes an entry from the database. Returns 200 OK.

These methods act on Resources, such as Patient or Appointment, which generally have a 1:1 relationship with Open Dental database tables. These methods frequently correspond to CRUD commands that get sent to the database such as Select, Insert, or Update. Many methods will result in multiple database commands. A failure should return an explanation of why it failed. If a field is not included in a PUT (update), then it will not change the original field in the database.

Visit our API Forum for questions & answers or to request new features.

API Setup

API Implementation

API Permissions, Pricing tiers for API developers are available on this page.

API Modes - Local, Service, and Cloud

API Events

Resources

API AccountModules

API Adjustments

API Allergies

API AllergyDefs

API Appointments

API AppointmentTypes

API ApptFields

API ApptFieldDefs

API AsapComms

API AutoNoteControls

API AutoNotes

API Benefits

API Carriers

API ChartModules

API ClaimPayments

API ClaimProcs

API Claims

API ClaimTrackings

API Clinics

API Commlogs

API Computers

API CovCats

API Definitions

API DiscountPlans

API DiscountPlanSubs

API DiseaseDefs

API Diseases

API Documents

API EobAttaches

API Employees

API Employers

API EtransMessageTexts

API Etranss

API FamilyModules

API Fees

API FeeScheds

API HistAppointments

API InsPlans

API InsSubs

API InsVerifies

API MedicationPats

API Medications

API Operatories

API PatFieldDefs

API PatFields

API PatientNotes

API PatientRaces

API Patients

API PatPlans

API Payments

API PayPlanCharges

API PayPlans

API PaySplits

API PerioExams

API PerioMeasures

API Popups

API Preferences

API ProcedureCodes

API ProcedureLogs

API ProcNotes

API ProcTPs

API Providers

API Queries

API QuickPasteCats

API QuickPasteNotes

API Recalls

API RefAttaches

API Referrals

API Reports

API ScheduleOps

API Schedules

API SecurityLogs

API SecurityPerms

API Sheets

API SheetFields

API Signalods

API Subscriptions

API SubstitutionLinks

API TaskLists

API Tasks

API TreatPlanAttaches

API TreatPlans

API UserGroupAttaches

API UserGroups

API Userods