Dentistry Automation DentalBridge APIs are used to expose the data, which is extracted from source PMS and loaded into Dentistry Automation. This data can give the end-user all the information with respect to the APIs and KPIs mentioned in this document. The use of API data will be more relevant and beneficial to the DSOs, where the data from all the source PMS will show up in a PMS agnostic way. The APIs are best way for the third-party developers to use the data exposed from the source PMS.
This document is intended for the end users who want to understand about the various APIs and KPIs in
detail. It is mainly for developers who consume these APIs.
For any technical assistance, you can send an email to hello@dentistryautomation.com.
You can make many types of HTTPs requests using the Dentistry Automation’s REST APIs. Before you start, you must consider the following:
An Application Programming Interface (API) allows two applications to talk to each other. It contains a
set of protocols, procedures, and tools that allow interaction between two applications. It delivers your
request to the server and then sends a response back to the client.
The Key Performance Indicators (KPIs) for APIs help in understanding how the APIs work and the impact
they have on your services, users, or partners. KPIs enable you to focus on streamlining the process and
maintaining the patient’s processed data. It provides a straightforward way to track the performance of
your various key business entities. They reflect the business value that APIs provide for your
organization.
In other words, KPIs are aggregated indicators of business performance and APIs are raw data set from
each of the data contexts of your practice. However, the KPIs can be used as APIs if your practice is
intending to use them in another application. For simplicity, all are treated as APIs in this document.
For information about how to access the APIs and KPIs, contact Dentistry Automation at
hello@dentistryautomation.com.
The Status is displayed as Authorized and the KPIs and APIs are displayed by default. To view the KPIs and APIs for a specific clinic, select the required client and clinic from the Clinic drop-down menu.
You are now authorized to view and use the KPIs and APIs.
To run the APIs/KPIs, click the required API/KPI, provide the request parameters, and click Execute. The response is displayed in the black box. To view the sample response, click Sample Response.
The following screenshot shows a sample response for Appointment KPI Details.
The final data is loaded in KPIs and is verified with the customer’s data to present the final output. You can view the various KPI reports using the following APIs:
Appointment KPI
Adjustment KPI Details
Collection KPI Details
Production KPI Details
NewPatients KPI Details
Doctor Production KPI Details
Broken Appointments KPI Details
Cancel Appointments KPI Details
Hygiene Production KPI Details
Short Notice Cancel KPI Details
AR aging balances by Guarantor
Guarantor wise total AR by Date (End date of a month) KPI Details
Patient Aging and Insurance Aging Balances by Guarantor
Total AR by Guarantor KPI Details
Contract Starts KPI Details
Other Charges KPI Details
Description
Endpoint
Method Type
Provides the appointment details for a patient.
/kpi/appointments
POST
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"totalCount": 1,
"data": [
{
"clinicServerId": "00000000-0000-0000-0000-000000000000, ",
"procedureDate": "2022-10-10 08:24:17.687, ",
"procedureNumber": "1101, ",
"appointmentdatetime": "2022-10-12 10:17:33.097, ",
"patientId": "101, ",
"isNewPatient": "null, ",
"appointmentStatus": "null, ",
"duration": "null, ",
"typeOfVisit": "null, ",
"appointmentId": "101, ",
"appointmentTypeId": "1234, ",
"IsBroken": "1,",
"IsCancel": "0,",
"IsShortNoticeCancel": "0,",
"providerId": "1, ",
"provider": "null, ",
"providerFName": "Cris, ",
"providerLName": "R, ",
"providerMName": "Watson, ",
"providerCategory": "null, ",
"clinicNum": "2, ",
"reasonForVisit": "null, ",
"patientFirstName": "John, ",
"patientLastName": "R, ",
"patientMiddleName": "Chisolm, ",
"address1": "#867-859 Sit Rd, ",
"address2": "null, ",
"city": "Arizona, ",
"state": "Phoenix, ",
"zipCode": "85001, ",
"homePhone": "(372) 587-2335, ",
"workPhone": "(786) 713-8616, ",
"sourceCreatedUserId": "0, ",
"etlDataLoadedDate": "2022-10-12 10:17:16.753, ",
"appointmentAmount": "100, ",
"isSourceDeleted": "null, ",
"sourceCreatedDate": "2022-10-12 10:17:01.620, ",
"sourceModifiedUserId": "null, ",
"sourceUpdatedDate": "2022-10-12 10:17:33.097, ",
"etlDataUpdatedDate": "2022-10-12 10:17:33.097, "
}
]
}
Description
Endpoint
Method Type
Amount received from the insurance or patient.
/kpi/collection
POST
The request parameters are:
Dental Office
Practice Location
Page Size
Page Index
Start Date
End Date
Patient Id
Payment Date: Provides information about the payment date.
For the description about each parameter, see Request Parameters in Appointment API section.
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"totalCount": 1,
"data": [
{
"id": "A284A008-D8CA-43E7-BBE0-00003FED01AD, ",
"clinicServerId": "3818F9FE-4066-4948-80FB-0000E462FCF8, ",
"clinicNum": "2, ",
"claimPaymentNumber": "10101, ",
"patientCollection": "100, ",
"insuranceCollection": "20, ",
"procedureDate": "2022-10-10 08:24:17.687, ",
"procedureNumber": "1101, ",
"procedureStatus": "Completed, ",
"adaCode": "D0000, ",
"procedureDescription": "Dental Procedure, ",
"patientId": "101, ",
"patientFirstName": "John, ",
"patientLastName": "R, ",
"patientMiddleName": "Chisolm, ",
"appointmentId": "101, ",
"providerId": "1, ",
"provider": "Dr., ",
"providerFName": "Aidan, ",
"providerLName": "K, ",
"providerMName": "Butler, ",
"providerCategory": "Dentist, ",
"paymentDate": "2022-10-01 08:24:17.687, ",
"collectionNumber": "101, ",
"carrierId": "1234, ",
"carrierName": "DELTA, ",
"paymentType": "Check, ",
"checkNumber": "345678901234, ",
"sourceCreatedUserId": "TXC1, ",
"etlDataLoadedDate": "2022-10-12 08:24:17.687, ",
"isSourceDeleted": "0, ",
"SourceCreatedDate": "2022-10-12 08:22:40.240, ",
"sourceModifiedUserId": "TXC2, ",
"sourceUpdatedDate": "2022-10-12 08:23:54.153, ",
"etlDataUpdatedDate": "2022-10-12 08:24:29.497, "
}
]
}
For information about the response codes, see Response Codes in Appointment KPI Details section.
Description
Endpoint
Method Type
Gross production is the total revenue generated for various treatments provided at the clinic.
/kpi/production
POST
The request parameters are:
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"totalCount": 1,
"data": [
{
"id": "A284A008-D8CA-43E7-BBE0-00003FED01AD, ",
"clinicServerId": "3818F9FE-4066-4948-80FB-0000E462FCF8, ",
"procedureDate": "2022-10-10 08:24:17.687, ",
"procedureNumber": "1101, ",
"patientId": "101, ",
"patientFirstName": "John, ",
"patientLastName": "Ralph, ",
"patientMiddleName": "Chisolm, ",
"appointmentId": "101, ",
"productionAmount": "1000, ",
"providerId": "1, ",
"provider": "Dr., ",
"providerFName": "Aidan, ",
"providerLName": "K, ",
"providerMName": "Butler, ",
"clinicNum": "2, ",
"ResponsiblePartyId": "4119796, ",
"adaCode": "D0000, ",
"procedureDesc": "Dental Procedure, ",
"sourceCreatedUserId": "TXC1, ",
"etlDataLoadedDate": "2022-10-12 08:24:17.687, ",
"providerCategory": "Dentist, ",
"invoiceId": "12345678, ",
"isSourceDeleted": "0, ",
"procedureStatus": "Completed, ",
"sourceCreatedDate": "2022-10-12 08:22:40.240, ",
"sourceModifiedUserId": "TXC2, ",
"sourceUpdatedDate": "2022-10-12 08:23:54.153, ",
"etlDataUpdatedDate": "2022-10-12 08:24:29.497, "
}
]
}
For information about the response codes, see Response Codes in Appointment KPI Details section.
Description
Endpoint
Method Type
Adjustment is considered as the amount that will be adjusted on a procedure or treatment.
/kpi/adjustment
POST
The request parameters are:
Dental Office
Practice Location
Page Size
Page Index
Start Date
End Date
Patient Id
Adjustment Date: Date when there is an adjustment that has happened on a treatment.
For the description about each parameter, see Request Parameters in Appointment API section.
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"totalCount": 111005,
"data": [
{
"clinicServerId": "ba4664b2-1296-63ad-c5d1-91c81aec486b",
"adjustmentType": "pc",
"adjustmentNumber": "82586",
"adjustmentDate": "2014-08-18T00:00:00+00:00",
"adjustmentAmount": 114,
"procedureDate": null,
"procedureNumber": "268177",
"adaCode": "D0330",
"procedureDescription": "Panoramic X-Ray",
"patientId": "21142",
"patientFirstName": null,
"patientLastName": null,
"patientMiddleName": null,
"providerId": "GRH",
"provider": null,
"providerFName": "RQWCj5keHlPijF5MpnhqNA==",
"providerLName": "L8kaJpUThshJipmaORUB2g==",
"providerMName": "Michael",
"providerCategory": "OSY",
"sourceCreatedUserId": null,
"clinicNum": null,
"etlDataLoadedDate": "2022-04-22T07:55:26+00:00"
"isSourceDeleted": false
}
]
}
For information about the response codes, see Response Codes in Appointment KPI Details section.
Description
Path
Method Type
Patients who are seen at the clinic for the first time in the given time range for any procedure code.
kpi/new-patients
POST
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"totalCount": 2455,
"data": [
{
"id": "83455841-03f4-4988-a915-00056edcf6eb",
"patientId": "267655",
"patientFirstName": "Sarah",
"patientLastName": "Oyler",
"firstVisitDate": "2021-12-10T00:00:00+00:00",
"providerId": "2",
"providerFirstName": "Gary",
"providerLastName": "Crawford",
"clinicNum": "01",
"providerCategory": "OSY",
"sourceCreatedUserId": null,
"sourceCreatedDate": null,
"sourceModifiedUserId": null,
"sourceUpdatedDate": null,
"clinicServerId": "d95b7ed8-69fa-56f7-afda-f8b47a1850b1",
"etlDataLoadedDate": "2022-05-13T09:44:01",
"etlDataUpdatedDate": null
},
]
}
}
For information about the response codes, see Response Codes in Appointment KPI Details section.
Description
Path
Method Type
Amount generated by doctor or dentist.
/kpi/doctor-production
POST
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"totalCount": 1,
"data": [
{
"id": "A284A008-D8CA-43E7-BBE0-00003FED01AD, ",
"clinicServerId": "3818F9FE-4066-4948-80FB-0000E462FCF8, ",
"procedureDate": "2022-10-10 08:24:17.687, ",
"procedureNumber": "1101, ",
"patientId": "101, ",
"patientFirstName": "John, ",
"patientLastName": "R, ",
"patientMiddleName": "Chisolm, ",
"appointmentId": "101, ",
"doctorProduction": "1000, ",
"providerId": "1, ",
"provider": "Dr., ",
"providerFName": "Aidan, ",
"providerLName": "K, ",
"providerMName": "Butler, ",
"providerCategory": "Dentist, ",
"ResponsiblePartyId": "4110796, ",
"clinicNum": "2, ",
"adaCode": "D0000, ",
"procedureDescription": "Dental Procedure, ",
"sourceCreatedUserId": "TXC1, ",
"etlDataLoadedDate": "2022-10-12 08:24:17.687, ",
"etlDataUpdatedDate": "2022-10-12 08:24:29.497, ",
"invoiceId": "12345678, ",
"sourceUpdatedDate": "2022-10-12 08:23:54.153, ",
"procedureStatus": "Completed, ",
"isSourceDeleted": "0, "
}
]
}
For information about the response codes, see Response Codes in Appointment KPI Details section.
Description
Path
Method Type
Provides a list of patients who have broken the appointment. A broken appointment is when a patient reschedules an. appointment with less than 48 hour notice or does not show up for the scheduled appointment.
/kpi/broken-appointments
POST
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"totalCount": 1,
"data": [
{
"id": "A284A008-D8CA-43E7-BBE0-00003FED01AD, ",
"clinicServerId": "3818F9FE-4066-4948-80FB-0000E462FCF8, ",
"patientId": "101, ",
"patientFirstName": "John, ",
"patientLastName": "R, ",
"patientMiddleName": "Chisolm, ",
"address1": "#867-859 Sit Rd, ",
"address2": "Suite #10, ",
"city": "Arizona, ",
"state": "Phoenix, ",
"zipCode": "85001, ",
"homePhone": "(372) 587-2335, ",
"workPhone": "(786) 713-8616, ",
"responsiblePartyId": "102, ",
"appointmentId": "101, ",
"appointmentdatetime": "2020-07-30 13:52:14, ",
"ssNewPatient": "1, ",
"appointmentStatus": "Broken, ",
"typeOfVisit": "RET-CHK, ",
"providerId": "1, ",
"provider": "Dr., ",
"providerFName": "Aidan, ",
"providerLName": "K, ",
"providerMName": "Butler, ",
"providerCategory": "Dentist, ",
"clinicNum": "2, ",
"reasonForVisit": "Appointment, ",
"sourceCreatedUserId": "TXC1, ",
"etlDataLoadedDate": "2022-10-12 08:24:17.687, ",
"etlDataUpdatedDate": "2022-10-12 08:24:29.497, ",
"appointmentAmount": "100, ",
"duration": "50, ",
"isSourceDeleted": "1, "
}
]
}
For information about the response codes, see Response Codes in Appointment KPI Details section.
Description
Path
Method Type
Appointments that are cancelled by patients.
/kpi/cancel-appointments
POST
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"totalCount": 1,
"data": [
{
"id": "A284A008-D8CA-43E7-BBE0-00003FED01AD, ",
"clinicServerId": "3818F9FE-4066-4948-80FB-0000E462FCF8, ",
"patientId": "101, ",
"patientFirstName": "John, ",
"patientLastName": "R, ",
"patientMiddleName": "Chisolm, ",
"address1": "#867-859 Sit Rd, ",
"address2": "Suite #10, ",
"city": "Arizona, ",
"state": "Phoenix, ",
"zipCode": "85001, ",
"homePhone": "(372) 587-2335, ",
"workPhone": "(786) 713-8616, ",
"responsiblePartyId": "102, ",
"appointmentId": "101, ",
"appointmentdatetime": "2020-07-30 13:52:14, ",
"ssNewPatient": "1, ",
"appointmentStatus": "Cancelled, ",
"typeOfVisit": "RET-CHK, ",
"providerId": "1, ",
"provider": "Dr., ",
"providerFName": "Aidan, ",
"providerLName": "K, ",
"providerMName": "Butler, ",
"providerCategory": "Dentist, ",
"clinicNum": "2, ",
"reasonForVisit": "Appointment, ",
"sourceCreatedUserId": "TXC1, ",
"etlDataLoadedDate": "2022-10-12 08:24:17.687, ",
"etlDataUpdatedDate": "2022-10-12 08:24:29.497, ",
"appointmentAmount": "100, ",
"duration": "50, ",
"isSourceDeleted": "1, "
}
]
}
For information about the response codes, see Response Codes in Appointment KPI Details section.
Description
Path
Method Type
Amount generated by Hygienist.
/kpi/hygiene-production
POST
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"totalCount": 1,
"data": [
{
"id": "A284A008-D8CA-43E7-BBE0-00003FED01AD, ",
"clinicServerId": "3818F9FE-4066-4948-80FB-0000E462FCF8, ",
"procedureDate": "2022-10-10 08:24:17.687, ",
"procedureNumber": "1101, ",
"patientId": "101, ",
"patientFirstName": "John, ",
"patientLastName": "R, ",
"patientMiddleName": "Chisolm, ",
"appointmentId": "101, ",
"hygieneProduction": "100, ",
"providerId": "1, ",
"provider": "Dr., ",
"providerFName": "Aidan, ",
"providerLName": "K, ",
"providerMName": "Butler, ",
"providerCategory": "Hygienist, ",
"ResponsiblePartyId": "4009796, ",
"clinicNum": "2, ",
"adaCode": "D0000, ",
"procedureDescription": "Dental Procedure, ",
"sourceCreatedUserId": "TXC1, ",
"etlDataLoadedDate": "2022-10-12 08:24:17.687, ",
"etlDataUpdatedDate": "2022-10-12 08:24:29.497, ",
"invoiceId": "12345678, ",
"sourceUpdatedDate": "2022-10-12 08:23:54.153, ",
"procedureStatus": "Completed, ",
"isSourceDeleted": "0, "
}
]
}
For information about the response codes, see Response Codes in Appointment KPI Details section.
Description
Path
Method Type
Appointments that are cancelled by patient within short notice.
/kpi/short-notice-cancel
POST
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"totalCount": 1,
"data": [
{
"id": "A284A008-D8CA-43E7-BBE0-00003FED01AD, ",
"clinicServerId": "3818F9FE-4066-4948-80FB-0000E462FCF8, ",
"patientId": "101, ",
"patientFirstName": "John, ",
"patientLastName": "R, ",
"patientMiddleName": "Chisolm, ",
"address1": "#867-859 Sit Rd, ",
"address2": "Suite #10, ",
"city": "Arizona, ",
"state": "Phoenix, ",
"zipCode": "85001, ",
"homePhone": "(372) 587-2335, ",
"workPhone": "(786) 713-8616, ",
"responsiblePartyId": "102, ",
"appointmentId": "101, ",
"appointmentdatetime": "2020-07-30 13:52:14, ",
"isNewPatient": "1, ",
"appointmentStatus": "Short Notice Cancel, ",
"typeOfVisit": "RET-CHK, ",
"providerId": "1, ",
"provider": "Dr., ",
"providerFName": "Aidan, ",
"providerLName": "K, ",
"providerMName": "Butler, ",
"providerCategory": "Dentist, ",
"clinicNum": "2, ",
"reasonForVisit": "Appointment, ",
"sourceCreatedUserId": "TXC1, ",
"etlDataLoadedDate": "2022-10-12 08:24:17.687, ",
"etlDataUpdatedDate": "2022-10-12 08:24:29.497, ",
"appointmentAmount": "100, ",
"duration": "50, ",
"isSourceDeleted": "1, "
}
]
}
For information about the response codes, see Response Codes in Appointment KPI Details section.
Description
Path
Method Type
Provides account receivables aging balances based on guarantor.
/kpi/agingbalancesbyguarantor
POST
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"totalCount": 1,
"data": [
{
"id": "4818F9FE-4126-4948-80FB-0000E462FCF8, ",
"clinicServerId": "B284A008-D8MA-43E7-BBE0-00003FED01AD, ",
"guarantorId": "131, ",
"guarantorFirstName": "Harix, ",
"guarantorLastName": "R, ",
"guarantorMiddleName": "M, ",
"birthDate": "02-06-1930, ",
"firstVisitDate": "2022-10-1 08:22:40.240, ",
"lastVisitDate": "2023-12-11 09:22:40.240, ",
"clinicNum": "1, ",
"arLess30": "0, ",
"ar30To60": "0, ",
"ar60To90": "20.4, ",
"arAbove90": "20.4, ",
"totalAR": "40.8, ",
"primaryInsuranceId": "58665, ",
"secondaryInsuranceId": "0, ",
"clinicName": "Childrens Dentistry, ",
"clinicCity": "Park, ",
"clinicState": "AZ, ",
"clinicZipCode": "85048, ",
"primaryInsuranceCompany": "AETNA, ",
"secondaryInsuranceCompany": "CIGNA, ",
"arGenerationDate": "2023-10-12 09:24:17.687, ",
"etlDataUpdatedDate": "2023-10-12 09:24:29.497, "
}
]
}
For information about the response codes, see Response Codes in Appointment KPI Details section.
Description
Path
Method Type
Account receivable for the past months for guarantor (displaying AR only at the end of month – Jan 31st , Feb 28th or 29th, Mar 31st, and so on.)
/kpi/GuarantorArByDate
POST
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"totalCount": 1,
"data": [
{
"id": "4818F9FE-4126-4948-80FB-0000E462FCF8, ",
"clinicServerId": "B284A008-D8MA-43E7-BBE0-00003FED01AD, ",
"guarantorId": "111, ",
"guarantorFirstName": "Harry, ",
"guarantorLastName": "R, ",
"guarantorMiddleName": "Jose, ",
"birthDate": "02-06-1930, ",
"firstVisitDate": "2022-11-1 08:22:40.240, ",
"lastVisitDate": "2022-12-11 09:22:40.240, ",
"clinicNum": "1, ",
"arLess30": "0, ",
"ar30To60": "0, ",
"ar60To90": "20.4, ",
"arAbove90": "20.4, ",
"totalAR": "40.8, ",
"patientPortion": "40.8, ",
"insurancePortion": "0, ",
"primaryInsuranceId": "58665, ",
"secondaryInsuranceId": "0, ",
"clinicName": "Dental Clinic Name, ",
"clinicCity": "Park Place, ",
"clinicState": "AZ, ",
"clinicZipCode": "85048, ",
"primaryInsuranceCompany": "AETNA, ",
"secondaryInsuranceCompany": "CIGNA, ",
"arGenerationDate": "2023-10-12 09:24:17.687, ",
"etlDataUpdatedDate": "2023-10-12 09:24:29.497, "
}
]
}
For information about the response codes, see Response Codes in Appointment KPI Details section.
Description
Path
Method Type
Patient aging and insurance aging split by guarantor
/kpi/patientagingandinsuranceagingbyguarantor
POST
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"totalCount": 1,
"data": [
{
"id": "3818F9FE-4066-4948-80FB-0000E462FCF8, ",
"clinicServerId": "A284A008-D8CA-43E7-BBE0-00003FED01AD, ",
"guarantorId": "101, ",
"guarantorFirstName": "John, ",
"guarantorLastName": "Cherry, ",
"guarantorMiddleName": "R, ",
"birthDate": "02-05-1930 12:00:00 AM, ",
"firstVisitDate": "2022-10-1 08:22:40.240, ",
"lastVisitDate": "2022-12-11 09:22:40.240, ",
"clinicNum": "2, ",
"totalPatientAR": "20.0, ",
"totalInsuranceAR": "20.0, ",
"insPortionLess30": "0, ",
"insPortion30To60": "10.0, ",
"insPortion60To90": "10.0, ",
"insPortionAbove90": "0, ",
"patPortionLess30": "0, ",
"patPortion30To60": "10.0, ",
"patPortion60To90": "10.0, ",
"patPortionAbove90": "0, ",
"primaryInsuranceId": "58465, ",
"secondaryInsuranceId": "0, ",
"clinicName": "Dental Clinic Name, ",
"clinicCity": "Phoenix, ",
"clinicState": "AZ, ",
"clinicZipCode": "85048, ",
"primaryInsuranceCompany": "AETNA, ",
"secondaryInsuranceCompany": "CIGNA, ",
"arGenerationDate": "2023-10-12 09:24:17.687, ",
"etlDataUpdatedDate": "2023-10-12 09:24:29.497, "
}
]
}
For information about the response codes, see Response Codes in Appointment KPI Details section.
Description
Path
Method Type
Provides the total account receivable by guarantor
/kpi/TotalARByGuarantor
POST
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"totalCount": 1,
"data": [
{
"id": "3818F9FE-4066-4948-80FB-0000E462FCF8, ",
"clinicServerId": "A284A008-D8CA-43E7-BBE0-00003FED01AD, ",
"guarantorId": "101, ",
"guarantorFirstName": "John, ",
"guarantorLastName": "Cherry, ",
"guarantorMiddleName": "R, ",
"birthDate": "02-05-1930 12:00:00 AM, ",
"firstVisitDate": "2022-10-1 08:22:40.240, ",
"lastVisitDate": "2022-12-11 09:22:40.240, ",
"clinicNum": "2, ",
"arLess30": "0, ",
"ar30To60": "0, ",
"ar60To90": "40.4, ",
"arAbove90": "40.4, ",
"totalAR": "80.8, ",
"patientPortion": "80.8, ",
"insurancePortion": "0, ",
"primaryInsuranceId": "58465, ",
"secondaryInsuranceId": "0, ",
"clinicName": "Dental Clinic Name, ",
"clinicCity": "Phoenix, ",
"clinicState": "AZ, ",
"clinicZipCode": "85048, ",
"primaryInsuranceCompany": "AETNA, ",
"secondaryInsuranceCompany": "CIGNA, ",
"arGenerationDate": "2023-10-12 09:24:17.687, ",
"etlDataUpdatedDate": "2023-10-12 09:24:29.497, "
}
]
}
For information about the response codes, see Response Codes in Appointment KPI Details section.
This section provides information for the following KPIs:
Clinic/Practice Details API
Coverage Details API
Employers Details API
Fee Schedule Details API
Fee Details API
Insurance Plan Details API
Operatories Details API
Patient Details API
Payment Plan Details API
Payment Details API
Insurance Payor/Carrier Details API
Prescription Details API
Procedure Codes/Service Codes API
Procedure Log Details API
Provider Details API
Referral Details API
Schedule Details API
Transaction Details API
Treatment Plan Details API
Appointment Details API
Provider Availability Details API
Provider Schedule Exception Details API
Dental Office API
Description
Endpoint
Method Type
Provides information about the accounts.
/appointment-types
POST
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"totalCount": 1,
"data": [
{
"Id": "00000000-0000-0000-0000-000000000000, ",
"AccountNumber": "9864-2525-1118-1365, ",
"BankName": "Bank of America, ",
"AccountTypeId": "null, ",
"BankId": "11, ",
"IsActive": "1, ",
"AccountColor": "null, ",
"PatientId": "101, ",
"SourceCreatedUserId": "null, ",
"SourceCreatedDate": "2022-10-12 10:17:01.620, ",
"SourceModifiedUserId": "null, ",
"SourceUpdatedDate": "2022-10-12 10:17:33.097, ",
"ClinicServerId": "00000000-0000-0000-0000-000000000000, ",
"ETLDataLoadedDate": "2022-10-12 10:17:16.753, ",
"ETLDataUpdatedDate": "2022-10-12 10:17:33.097, "
}
]
}
Description
Path
Method Type
User can add a new claim, view individual claims, or a list of closed patient claims.
/claim-procedures
POST
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"totalCount": 1,
"data": [
{
"id": "A25A008-D8CA-43E7-BBE0-00003FED01AD, ",
"claimProcedureId": "123159, ",
"procedureId": "1001, ",
"claimId": "1011, ",
"patientId": "101, ",
"patientFirstName": "John, ",
"patientLastName": "R, ",
"patientMiddleName": "Chisolm, ",
"providerId": "1, ",
"provider": "Dr., ",
"providerFName": "Aidan, ",
"providerLName": "K, ",
"providerMName": "Butler, ",
"providerCategory": "Dentist, ",
"feeBilled": "78.00, ",
"status": "1, ",
"claimPaymentId": "0, ",
"dateofClaim": "2022-10-12, ",
"procedureDate": "2022-10-10 10:17:16.753, ",
"dateEntry": "2022-10-01 10:17:16.753, ",
"clinicNum": "2, ",
"clinicName": "Delta, ",
"insSubNum": "101, ",
"paymentPlanNum": "21, ",
"claimPaymentTracking": "1, ",
"insuranceCarrierId": "189, ",
"insuranceCarrierName": "null, ",
"insuranceType": "Primary, ",
"dateSent": "2021-11-01 10:17:16.753, ",
"totalReceived": "null, ",
"guardianId": "2345, ",
"chartStatus": "12, ",
"amountPrimaryInsurancePaid": "12.30, ",
"procedureCodeId": "null, ",
"adaCode": "D12, ",
"procedureDescription": "null, ",
"procedureAmount": "null, ",
"dateReceived": "2022-10-12 10:17:01.620, ",
"sourceCreatedUserId": "0, ",
"sourceCreatedDate": "2022-10-12 10:17:01.620, ",
"sourceUpdatedDate": "2022-10-12 10:17:33.097, ",
"clinicServerId": "C4284A008-D8CA-43E7-BBE0-00003FED04AE, ",
"etlDataLoadedDate": "2022-10-12 10:17:16.753, ",
"etlDataUpdatedDate": "2022-10-12 10:17:33.097, "
}
]
}
For information about the response codes, see Response Codes in Appointment KPI Details section.
Description
Path
Method Type
Provides information about the type of appointment.
/appointment-types
POST
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"totalCount": 1,
"data": [
{
"Id": "00000000-0000-0000-0000-000000000000, ",
"AppointmentTypeId": "2, ",
"AppointmentTypeName": "hygiene, ",
"AppointmentTypeColor": "-83232, ",
"ItemOrder": "1, ",
"IsHidden": "0, ",
"Pattern": "///X, ",
"Codestring": "null, ",
"Amount": "180, ",
"NumberOfUnits": "D1122,D1111, ",
"TicMarks": "null, ",
"CentralId": "null, ",
"RecallId": "null, ",
"FontColor": "black, ",
"UsePtCleaningTime": "null, ",
"UpdateNextAppt": "null, ",
"IsPerformedBy": "null, ",
"AppointmentMinutes": "null, ",
"Active": "1, ",
"ClinicServerId": "00000000-0000-0000-0000-000000000000, ",
"ETLDataLoadedDate": "2022-10-12 10:17:16.753, ",
"ETLDataUpdatedDate": "2022-10-12 10:17:33.097, "
}
]
}
For information about the response codes, see Response Codes in Appointment KPI Details section.
Description
Path
Method Type
Get specific clinic details.
/write/get-clinic
POST
{
"isSucceed": true,
"pageSize": 0,
"currentPageIndex": 0,
"maxPageIndex": 0,
"totalCount": 0,
"resultCount": 0,
"errorMessages": null,
"exception": null,
"data": [
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"data": 1,
"totalCount": 0
}
]
}
Description
Path
Method Type
Provides details of the coverage in the patient’s insurance.
/coverages
POST
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"totalCount": 1,
"data": [
{
"Id": "00000000-0000-0000-0000-000000000000, ",
"CoverageId": "null, ",
"Description": "null, ",
"CoveragePercentage": "null, ",
"CoverageOrder": "null, ",
"IsHidden": "null, ",
"Category": "null, ",
"RangeStart": "null, ",
"RangeEnd": "null, ",
"CoPayment": "null, ",
"RequiresPreAuth": "null, ",
"CutOffAge": "null, ",
"DeductibleType": "null, ",
"ServiceCode": "null, ",
"Dollars": "null, ",
"UCRFees": "null, ",
"DollarsOrPercent": "null, ",
"ForgiveDiffererence": "null, ",
"RangeStartExtension": "null, ",
"RangeEndExtension": "null, ",
"CarrierInsurancePlanId": "null, ",
"SubscriberId": "null, ",
"Patientid": "101, ",
"SourceUpdatedDate": "2022-10-12 10:17:33.097, ",
"ClinicServerId": "00000000-0000-0000-0000-000000000000, ",
"ETLDataLoadedDate": "2022-10-12 10:17:16.753, ",
"ETLDataUpdatedDate": "2022-10-12 10:17:33.097, "
}
]
}
For information about the response codes, see Response Codes in Appointment KPI Details section.
Description
Path
Method Type
Provides details of the employers
/employers
POST
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"totalCount": 1,
"data": [
{
"Id": "00000000-0000-0000-0000-000000000000, ",
"EmployerId": "null, ",
"EmployerName": "null, ",
"Address1": "#867-859 Sit Rd, ",
"Address2": "null, ",
"City": "Arizona, ",
"State": "Phoenix, ",
"ZipCode": "85001, ",
"Phone1": "(372) 587-2335, ",
"Phone1Ext": "null, ",
"Phone2": "(372) 587-3662, ",
"Phone2Ext": "null, ",
"Fax": "null, ",
"ClinicServerId": "00000000-0000-0000-0000-000000000000, ",
"ETLDataLoadedDate": "2022-10-12 10:17:16.753, ",
"ETLDataUpdatedDate": "2022-10-12 10:17:33.097, "
}
]
}
For information about the response codes, see Response Codes in Appointment KPI Details section.
Description
Path
Method Type
Manage fee information related to a specific service
/fees
POST
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"totalCount": 1,
"data": [
{
"Id": "00000000-0000-0000-0000-000000000000, ",
"FeeNum": "null, ",
"Amount": "180, ",
"Code": "null, ",
"FeeSchedNum": "null, ",
"UseDefaultFee": "null, ",
"UseDefaultCov": "null, ",
"CodeNum": "null, ",
"ClinicNum": "2, ",
"ProvNum": "null, ",
"LabAmount": "100, ",
"LabFee2": "null, ",
"PreFee": "null, ",
"ExpenseAmount": "300, ",
"AllowWriteOff": "null, ",
"CopayAmount": "null, ",
"SourceCreatedUserId": "0, ",
"SourceCreatedDate": "2022-10-12 10:17:01.620, ",
"SourceModifiedUserId": "null, ",
"SourceUpdatedDate": "2022-10-12 10:17:33.097, ",
"ClinicServerId": "00000000-0000-0000-0000-000000000000, ",
"ETLDataLoadedDate": "2022-10-12 10:17:16.753, ",
"ETLDataUpdatedDate": "2022-10-12 10:17:33.097, "
}
]
}
For information about the response codes, see Response Codes in Appointment KPI Details section.
This section provides information for the following APIs:
Create Patient
Edit Patient
Create Appointment
Edit Appointment
Create Appointment Type
Edit Appointment Type
Description
Path
Method Type
Create a patient record.
/oas/create-patient
POST
{
"isSucceed": true,
"pageSize": 1,
"currentPageIndex": 1,
"maxPageIndex": 1,
"totalCount": 1,
"resultCount": 1,
"errorMessages": null,
"exception": null,
"data": [
{
"isSucceed": "true",
"errorMessages": "null",
"exception": null,
"data": "true",
"totalCount": 0
}
]
}
Description
Path
Method Type
Edit the patient record.
/oas/edit-patient
POST
{
"isSucceed": true,
"pageSize": 1,
"currentPageIndex": 1,
"maxPageIndex": 1,
"totalCount": 1,
"resultCount": 1,
"errorMessages": null,
"exception": null,
"data": [
{
"isSucceed": "true",
"errorMessages": "null",
"exception": null,
"data": "true",
"totalCount": 0
}
]
}
Description
Path
Method Type
Create an appointment for the patient.
Create an appointment for the patient.
/oas/create-appointment
POST
{
"isSucceed": true,
"pageSize": 1,
"currentPageIndex": 1,
"maxPageIndex": 1,
"totalCount": 1,
"resultCount": 1,
"errorMessages": null,
"exception": null,
"data": [
{
"isSucceed": "true",
"errorMessages": "null",
"exception": null,
"data": "true",
"totalCount": 0
}
]
}
Description
Path
Method Type
Edit the appointment for the patient.
/oas/edit-appointment
POST
{
"isSucceed": true,
"pageSize": 1,
"currentPageIndex": 1,
"maxPageIndex": 1,
"totalCount": 1,
"resultCount": 1,
"errorMessages": null,
"exception": null,
"data": [
{
"isSucceed": "true",
"errorMessages": "null",
"exception": null,
"data": "true",
"totalCount": 0
}
]
}
Description
Path
Method Type
Create the type of appointment.
/oas/create-appointment-type
POST
{
"isSucceed": true,
"pageSize": 1,
"currentPageIndex": 1,
"maxPageIndex": 1,
"totalCount": 1,
"resultCount": 1,
"errorMessages": null,
"exception": null,
"data": [
{
"isSucceed": "true",
"errorMessages": "null",
"exception": null,
"data": "true",
"totalCount": 0
}
]
}
Description
Path
Method Type
Edit the type of appointment.
/oas/edit-appointment-type
POST
{
"isSucceed": true,
"pageSize": 1,
"currentPageIndex": 1,
"maxPageIndex": 1,
"totalCount": 1,
"resultCount": 1,
"errorMessages": null,
"exception": null,
"data": [
{
"isSucceed": "true",
"errorMessages": "null",
"exception": null,
"data": "true",
"totalCount": 0
}
]
}
Description
Path
Method Type
Updates the payor credentials information.
/write/upload-document
POST
{
"isSucceed": true,
"pageSize": 0,
"currentPageIndex": 0,
"maxPageIndex": 0,
"totalCount": 0,
"resultCount": 0,
"errorMessages": null,
"exception": null,
"data": [
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"data": 1,
"totalCount": 0
}
]
}
Description
Path
Method Type
Add provider details to the database.
/write/provider
POST
{
"isSucceed": true,
"pageSize": 0,
"currentPageIndex": 0,
"maxPageIndex": 0,
"totalCount": 0,
"resultCount": 0,
"errorMessages": null,
"exception": null,
"data": [
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"data": 1,
"totalCount": 0
}
]
}
Description
Path
Method Type
Write back Medical Observations
/write/medical-observations-write-back
POST
| Parameter | Data Type | Description |
|---|---|---|
| Dental Office | From the drop-down menu, select a dental office. | Name of the dental office |
| Practice Location | int | Location of the dental office. |
| Unique Key | string | Unique ID of the for the batch of the records to be posted back |
| Patient Id | string | Unique ID for the patient. |
| Medical Observation Type | string | Medical Observation Type |
| Notes | string |
{
"isSucceed": true,
"pageSize": 0,
"currentPageIndex": 0,
"maxPageIndex": 0,
"totalCount": 0,
"resultCount": 0,
"errorMessages": null,
"exception": null,
"data": [
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"data": 1,
"totalCount": 0
}
]
}
Description
Path
Method Type
Provides eligibility information for the patient, whether the patient has healthcare coverage with a specific insurance company (payor).
/rcm/eligibility-verification
POST
{
"isSucceed": true,
"pageSize": 0,
"currentPageIndex": 0,
"maxPageIndex": 0,
"totalCount": 0,
"resultCount": 0,
"errorMessages": null,
"exception": null,
"data": [
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"data": 1,
"totalCount": 0
}
]
}
Description
Path
Method Type
Adds a clinic to the database.
/write/Clinic
POST
{
"isSucceed": true,
"pageSize": 0,
"currentPageIndex": 0,
"maxPageIndex": 0,
"totalCount": 0,
"resultCount": 0,
"errorMessages": null,
"exception": null,
"data": [
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"data": 1,
"totalCount": 0
}
]
}
Description
Path
Method Type
Get specific clinic details.
/write/get-clinic
POST
{
"isSucceed": true,
"pageSize": 0,
"currentPageIndex": 0,
"maxPageIndex": 0,
"totalCount": 0,
"resultCount": 0,
"errorMessages": null,
"exception": null,
"data": [
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"data": 1,
"totalCount": 0
}
]
}
Description
Path
Method Type
Get provider information.
/write/get-provider
POST
{
"isSucceed": true,
"pageSize": 0,
"currentPageIndex": 0,
"maxPageIndex": 0,
"totalCount": 0,
"resultCount": 0,
"errorMessages": null,
"exception": null,
"data": [
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"data": 1,
"totalCount": 0
}
]
}
Description
Path
Method Type
End point for Patient Insurance Verifications
/rcm/get-verification
POST
{
"isSucceed": true,
"pageSize": 0,
"currentPageIndex": 0,
"maxPageIndex": 0,
"totalCount": 0,
"resultCount": 0,
"errorMessages": null,
"exception": null,
"data": [
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"data": 1,
"totalCount": 0
}
]
}
Description
Path
Method Type
Update the clinic information in the database.
/write/update-clinic
POST
{
"isSucceed": true,
"pageSize": 0,
"currentPageIndex": 0,
"maxPageIndex": 0,
"totalCount": 0,
"resultCount": 0,
"errorMessages": null,
"exception": null,
"data": [
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"data": 1,
"totalCount": 0
}
]
}
Description
Path
Method Type
Allows for the validation and verification of various data points.
/rcm/update-verification
POST
{
"isSucceed": true,
"pageSize": 0,
"currentPageIndex": 0,
"maxPageIndex": 0,
"totalCount": 0,
"resultCount": 0,
"errorMessages": null,
"exception": null,
"data": [
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"data": 1,
"totalCount": 0
}
]
}
Description
Path
Method Type
Add payor credentials to the database.
/add-payor-credential
POST
{
"isSucceed": true,
"pageSize": 0,
"currentPageIndex": 0,
"maxPageIndex": 0,
"totalCount": 0,
"resultCount": 0,
"errorMessages": null,
"exception": null,
"data": [
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"data": 1,
"totalCount": 0
}
]
}
Description
Path
Method Type
Get payor credentials.
/write/get-payor-credential
POST
{
"isSucceed": true,
"pageSize": 0,
"currentPageIndex": 0,
"maxPageIndex": 0,
"totalCount": 0,
"resultCount": 0,
"errorMessages": null,
"exception": null,
"data": [
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"data": 1,
"totalCount": 0
}
]
}
Description
Path
Method Type
Update the payor credential information in the database.
/write/update-payor-credential
POST
{
"isSucceed": true,
"pageSize": 0,
"currentPageIndex": 0,
"maxPageIndex": 0,
"totalCount": 0,
"resultCount": 0,
"errorMessages": null,
"exception": null,
"data": [
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"data": 1,
"totalCount": 0
}
]
}
Description
Path
Method Type
Follow up on the claims that are already submitted by the clinic.
/rcm/claims-verification
POST
{
"isSucceed": true,
"pageSize": 0,
"currentPageIndex": 0,
"maxPageIndex": 0,
"totalCount": 0,
"resultCount": 0,
"errorMessages": null,
"exception": null,
"data": [
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"data": 1,
"totalCount": 0
}
]
}
Description
Path
Method Type
Writes back patient payments into PMS.
/rcm/patientpaymentswriteback
POST
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"data": true,
"totalCount": 0
}
Description
Path
Method Type
Update the provider information in the database.
/write/update-provider
POST
{
"isSucceed": true,
"pageSize": 0,
"currentPageIndex": 0,
"maxPageIndex": 0,
"totalCount": 0,
"resultCount": 0,
"errorMessages": null,
"exception": null,
"data": [
{
"isSucceed": true,
"errorMessages": null,
"exception": null,
"data": 1,
"totalCount": 0
}
]
}