Dental Api Doc - Dentistry Automation

Dentistry Automation DentalBridge API Guidelines

Introduction

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.

Intended Audience

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.

Technical Support

For any technical assistance, you can send an email to [email protected].

Getting Started

You can make many types of HTTPs requests using the Dentistry Automation’s REST APIs. Before you start, you must consider the following:

Read the basics: If you are new to REST APIs, make sure that you understand the basics of REST and JSON.
Understand roles and privileges: You must have the required security roles and privileges to use the GET and POST methods on your APIs.
Select a REST client: Typically, REST APIs use HTTP and HTƒTPs protocols to connect software programs. You need a software client to send the HTTP requests. In the sample request codes in this document, cURL is used. You can test REST APIs using any programming language or tool that supports sending and receiving HTTP messages. Make sure you have a good understanding of how your REST client works.

KPI and API

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.

Accessing the APIs and KPIs

For information about how to access the APIs and KPIs, contact Dentistry Automation at
[email protected].

Authorization

To authorize:

After logging into Dentistry Automation portal, click DentalBridge API
Provide the User Name and Password, and then click Sign In. You can also click Login as Current User.

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.

Running the API/KPIs

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.

KPI Reports

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

Appointment KPI Details

Description

Endpoint

Method Type

Provides the appointment details for a patient.

/kpi/appointments

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	From the drop-down menu, select a dental office.	Select the dental office nearest to you..
Practice Location	From the drop-down menu, select a practice location.	Select the location of the clinic.
Page Size	int	Number of records in a page
Page Index	int	Index of the page (example 1,2,3).
Start Date	datetime	Date from when you want the data to be included in the report. The format is yyyy-mm-dd.
End Date	datetime	Date until you want the data to be included the report. The format is yyyy-mm-dd.
Patient Id	string	Unique identifier of the patient from the source.
Appointment Type Id	string	Unique identifier about the type of appointment.
Provider Id	string	Unique ID of the provider.
Operatory Id	string	Unique ID of a user identifier (ID).
Appointment Date Time	datetime	Date and time of the appointment.
Created By API	string	Details of the user who has created the appointment
Cancelled	bit	Cancel operation is requested through API.
Appointment Start Date	date	Only appointments with the specified start date are returned.
Appointment End Date	date	Only appointments with the specified end date are returned.

Response Parameters

Parameter	Data Type	Description
clinicServerId	GUID	Unique identifier of the clinic’s server.
procedureDate	datetime	Date when the doctor has performed a treatment to the patient.
procedureNumber	string	Unique identifier for the treatment plan. It is system-generated.
appointmentDateTime	datetime	Date and time of the appointment.
patientId	string	Unique identifier for patient. It is system-generated. Links to the patient record.
isNewPatient	string	Indicates whether it is the patient’s first visit at this clinic.
appointmentStatus	string	Appointment status.
duration	string	Treatment or procedure duration.
typeOfVisit	string	Type of visit can be Doctor visit, or Hygienist visit, or any other visit.
appointmentId	string	Unique identifier for the appointment that the patient has taken with the clinic. It is system-generated.
appointmentTypetId	string	Unique identifier for the appointment type that the patient has taken with the clinic. It is system-generated.
Isbroken	bit	Indicates if the view is displayed broken.
IsCancel	bit	Indicates whether the appointment is cancelled.
IsShortNoticeCancel	bit	Indicates whether the appointment is cancelled at short notice.
providerId	string	Unique identifier for the provider. Links to the provider record.
provider	string	Provider’s full name
providerFName	string	Provider’s first name. Links to the provider record.
providerLName	string	Provider’s last name. Links to the provider record.
providerMName	string	Provider’s middle name. Links to the provider record.
providerCategory	string	Specialty of the provider.
clinicNum	string	Unique identifier for the clinic.
reasonForVisit	string	Reason for the patient’s visit to the clinic.
patientFirstName	string	Patient’s first name. Links to the patient record.
patientLastName	string	Patient’s last name. Links to the patient record.
patientMiddleName	string	Patient’s middle name. Links to the patient record.
address1	string	Patient’s address one.
address2	string	Patient’s address two.
city	string	Patient’s city.
state	string	Patient’s state.
zipCode	string	Patient’s postal code.
homePhone	string	Patient’s home phone number.
workPhone	string	Patient’s work phone number.
sourceCreatedUserId	string	ID of the user who created the record in the source PMS.
etlDataLoadedDate	datetime	Date when the data was loaded to Dentistry Automation.
appointmentAmount	string	Amount for the scheduled appointment.
isSourceDeleted	bit	Indicates whether the record was deleted at source.
sourceCreatedDate	datetime	Date when the source was created.
sourceModifiedUserId	string	Date when the record was modified at source.
sourceUpdatedDate	datetime	Date when the record was updated at source.
etlDataUpdatedDate	datetime	Date when the data was updated in Dentistry Automation.

Sample Response

   {
  "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, "
    }
  ]
}

Response Codes

Response Code	Description
200	Success. Indicates the API is executed successfully and has sent the response.
401	Unauthorized
400	Bad request
500	Internal server error

Collection KPI Details

Description

Endpoint

Method Type

Amount received from the insurance or patient.

/kpi/collection

POST

Request Parameters

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.

Response Parameters

Parameter	Data Type	Description
clinicServerId	GUID	Unique identifier of the clinic’s server
clinicNum	varchar (100)	Unique identifier for the clinic.
claimPaymentNumber	varchar (100)	Insurance claim ID (link to the claim record of the medical claim for the procedure).
patientCollection	Decimal (18,2)	Amount paid directly by the patient (does not include insurance amount).
insuranceCollection	Decimal (18,2)	Amount paid using the patient’s insurance.
procedureDate	datetimeoffset	Date when the doctor has given a treatment to the patient.
procedureNumber	varchar (100)	Unique identifier for the treatment plan. It is system-generated.
adaCode	Varchar (20)	Procedure code or ADA code based on CDA. For example, D1101
procedureDescription	varchar (100)	Brief description about the treatment.
patientId	varchar (100)	Unique identifier for patient. It is system-generated.
patientFirstName	varchar (100)	Patient’s first name.
patientLastName	varchar (100)	Patient’s last name.
patientMiddleName	varchar (100)	Patient’s middle name.
appointmentId	varchar (100)	Unique identifier for the appointment that the patient has taken with the clinic. It is system-generated.
providerId	varchar (100)	Unique identifier for the provider. Links to the provider record.
providerFName	varchar (100)	Provider’s first name. Links to the provider record.
providerLName	varchar (100)	Provider’s last name. Links to the provider record.
providerMName	varchar (100)	Provider’s middle name. Links to the provider record.
providerCategory	varchar (100)	Specialty of the provider.
paymentDate	datetimeoffset	Payment date
collectionNumber	varchar (100)	Unique identifier for collection.
carrierId	varchar (100)	Insurance Carrier/Payor ID.
carrierName	varchar (100)	Insurance Carrier/Payor name.
paymentType	varchar (100)	Type of payment the user (patient or insurance) has used to make the payment. (check/credit card/EFT etc.)
checkNumber	Varchar (50)	Check number for ID if payment type is check.
sourceCreatedUserId	varchar (100)	ID of the user who created the record in the source PMS.
etlDataLoadedDate	datetimeoffset	Date when the data was loaded to Dentistry Automation.
isSourceDeleted	bit	Indicates whether the record was deleted at source.

Sample Response

{
  "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, "
    }
  ]
}

Response Codes

For information about the response codes, see Response Codes in Appointment KPI Details section.

Production KPI Details

Description

Endpoint

Method Type

Gross production is the total revenue generated for various treatments provided at the clinic.

/kpi/production

POST

Request Parameters

The request parameters are:

Dental Office
Practice Location
Page Size
Page Index
Start Date
End Date
Patient Id
Procedure Date: Date when the doctor has given a treatment plan to the patient.

For the description about each parameter, see Request Parameters in Appointment API section.

Response Parameters

Parameter	Data Type	Description
clinicServerId	GUID	Unique identifier of the clinic’s server.
id	GUID	Unique indentifier number.
procedureDate	datetime	Date when the doctor has given a treatment plan to the patient.
procedureNumber	string	Unique identifier for the treatment plan. It is system-generated.
patientId	string	Unique identifier for patient. It is system-generated.
patientFirstName	string	Patient’s first name.
patientLastName	string	Patient’s last name.
patientMiddleName	string	Patient’s middle name.
appointmentId	string	Unique identifier for the appointment that the patient has taken with the clinic. It is system-generated.
productionAmount	float	Total production amount that must be received from the patient and/or insurance.
providerId	varchar (100)	Unique identifier for the provider. Links to the provider record.
providerFName	string	Provider’s first name. Links to the provider record.
provider	string	Provider’s full name
providerLName	string	Provider’s last name. Links to the provider record.
providerMName	string	Provider’s middle name. Links to the provider record.
clinicNum	string	Unique identifier for the clinic.
adaCode	string	Procedure code or ADA code based on CDA. For example, D1101
procedureDesc	string	Brief description about the treatment.
sourceCreatedUserId	string	ID of the user who created the record in the source PMS.
etlDataLoadedDate	datetime	Date when the data was loaded to Dentistry Automation.
providerCategory	string	Specialty of the provider.
invoiceId	string	Unique identifier for the invoice.
isSourceDeleted	bit	Indicates whether the record was deleted at source.
procedureStatus	varchar (100)	Procedure status such as completed, planned, deleted, and so on.
ResponsiblePartyId	GUID	Unique ID of the party responsible for your treatment or guardian.
etlDataUpdatedDate	datetime	Date when the data was updated in Dentistry Automation.
sourceUpdatedDate	datetime	Date when the record was updated at source.
sourceModifiedUserId	string	Date when the record was modified at source.
sourceCreatedDate	datetime	Date when the record was created at source.

Sample Response

{
  "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, "
    }
  ]
}

Response Codes

For information about the response codes, see Response Codes in Appointment KPI Details section.

Adjustment KPI Details

Description

Endpoint

Method Type

Adjustment is considered as the amount that will be adjusted on a procedure or treatment.

/kpi/adjustment

POST

Request Parameters

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.

Response Parameters

Parameter	Data Type	Description
clinicServerId	GUID	Unique identifier of the clinic’s server.
adjustmentType	varchar (100)	Adjustment type for the treatment plan.
adjustmentNumber	varchar (100)	Unique identifier for the adjustment on a treatment that the patient has taken with the clinic. It is system-generated.
adjustmentDate	datetimeoffset	Date when there is an adjustment that has happened on a treatment.
adjustmentAmount	Decimal (18,2)	Adjusted amount on a procedure.
procedureDate	datetimeoffset	Date when the doctor has performed a treatment to the patient.
procedureNumber	varchar (100)	Unique identifier for the treatment plan. It is system-generated.
adaCode	Varchar (20)	Procedure code or ADA code based on CDA. For example, D1101
procedureDescription	varchar (100)	Details of the procedure or treatment service.
patientId	varchar (100)	Unique identifier for patient. It is system-generated. Links to the patient record.
patientFirstName	varchar (100)	Patient’s first name. Links to the patient record.
patientLastName	varchar (100)	Patient’s last name. Links to the patient record.
patientMiddleName	varchar (100)	Patient’s middle name. Links to the patient record.
providerId	varchar (100)	Unique identifier for the provider. Links to the provider record.
providerFName	varchar (100)	Provider’s first name. Links to the provider record.
providerLName	varchar (100)	Provider’s last name. Links to the provider record.
providerMName	varchar (100)	Provider’s middle name. Links to the provider record.
providerCategory	varchar (100)	Specialty of the provider.
sourceCreatedUserId	varchar (100)	ID of the user who created the record in the source PMS.
clinicNum	varchar (100)	Unique identifier for the clinic.
etlDataLoadedDate	datetimeoffset	Date when the data was loaded to Dentistry Automation.
isSourceDeleted	bit	Indicates whether this record was deleted at source.

Sample Response

 {
  "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
    }
  ]
}

Response Codes

For information about the response codes, see Response Codes in Appointment KPI Details section.

NewPatients KPI Details

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

Request Parameters

Parameter	Data Type	Description
Dental Office	From the drop-down menu, select a dental office.	Select the dental office nearest to you.
Practice Location	From the drop-down menu, select a practice location.	Select the location of the clinic.
Page Size	int	Number of records in a page
Page Index	int	Index of the page (example 1,2,3).
Start Date	datetime	Date from when you want the data to be included the report. The format is yyyy-mm-dd.
End Date	datetime	Date until when you want the data to be included the report. The format is yyyy-mm-dd.
Patient Id	string	Unique identifier of the patient from the source.
Provider Id	string	Unique ID of the provider.
Provider Category	string	The type of facility in which a client receives services.
First Visit Start Date	date	The first date the patient visited the doctor.
First Visit End Date	date	The last date the patient visited the doctor.

Response Parameters

Parameter	Data Type	Description
id	GUID	Primary key of the data context.
patientId	string	Unique identifier for patient. It is system-generated.
patientFirstName	string	Patient’s first name.
patientLastName	string	Patient’s last name.
firstVisitDate	datetime	Date when the patient visited the clinic for the first time.
providerId	string	Unique identifier for the provider. Links to the provider record.
providerFirstName	string	Provider’s first name. Links to the provider record.
providerLastName	string	Provider’s last name. Links to the provider record.
clinicNum	string	Unique identifier for the clinic.
providerCategory	string	Specialty of the provider.
sourceCreatedUserId	string	ID of the user who created the record in the source PMS.
sourceCreatedDate	datetime	Date when the record was created at source.
sourceModifiedUserId	string	ID of the user who modified the record in the source PMS.
sourceUpdatedDate	datetime	Date when the record was updated at source.
clinicServerId	GUID	Unique identifier of the clinic’s server.
etlDataLoadedDate	datetime	Date when the data was loaded to Dentistry Automation.
etlDataUpdatedDate	datetime	Date when the data was updated in Dentistry Automation.

Sample Response

{
  "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
    },
   ]
}

}

Response Codes

For information about the response codes, see Response Codes in Appointment KPI Details section.

Doctor Production KPI Details

Description

Path

Method Type

Amount generated by doctor or dentist.

/kpi/doctor-production

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	From the drop-down menu, select a dental office.	Select the dental office nearest to you..
Practice Location	From the drop-down menu, select a practice location.	Select the location of the clinic.
Page Size	int	Number of records in a page
Page Index	int	Index of the page (example 1,2,3).
Start Date	datetime	Date from when you want the data to be included the report. The format is yyyy-mm-dd.
End Date	datetime	Date until when you want the data to be included the report. The format is yyyy-mm-dd.
Provider Id	string	Unique ID of the provider.
Procedure Date	date	The start date of the procedure.

Response Parameters

Parameter	Data Type	Description
Id	GUID	Unique identifier of the data context.
clinicServerId	GUID	Unique identifier of the clinic’s server.
procedureDate	datetime	Date when the doctor has given a treatment to the patient.
procedureNumber	string	Unique identifier for the treatment plan. It is system-generated.
patientId	string	Unique identifier for patient. It is system-generated. Links to the patient record.
patientFirstName	string	Patient’s first name. Links to the patient record.
patientLastName	string	Patient’s last name. Links to the patient record.
patientMiddleName	string	Patient’s middle name. Links to the patient record.
appointmentId	string	Unique identifier for the appointment that the patient has taken with the clinic. It is system-generated.
doctorProduction	float	Amount generated by doctor or Dentist
providerId	string	Unique identifier for the provider. Links to the provider record.
provider	string	Provider’s full name
providerFName	string	Provider’s first name. Links to the provider record.
providerLName	string	Provider’s last name. Links to the provider record.
providerMName	string	Provider’s middle name. Links to the provider record.
providerCategory	string	Specialty of the provider.
ResponsiblePartyId	GUID	Unique ID of the party responsible for your treatment or guardian.
clinicNum	string	Unique identifier for the clinic.
adaCode	string	Procedure code or ADA code based on CDA. For example, D1101
procedureDescription	string	Details of the procedure or treatment service.
sourceCreatedUserId	string	ID of the user who created the record in the source PMS.
etlDataLoadedDate	datetime	Date when the data was loaded to Dentistry Automation.
etlDataUpdatedDate	datetime	Date when the data was updated in Dentistry Automation.
invoiceId	string	Unique identifier for the invoice.
sourceUpdatedDate	datetime	Date when the record was updated at source.
procedureStatus	string	Procedure status such as completed, planned, deleted, and so on.
isSourceDeleted	bit	Indicates whether the record was deleted at source.

Sample Response

{
  "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, "
    }
  ]
}

Response Codes

For information about the response codes, see Response Codes in Appointment KPI Details section.

Broken Appointments KPI Details

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

Request Parameters

Parameter	Data Type	Description
Dental Office	From the drop-down menu, select a dental office.	Select the dental office nearest to you..
Practice Location	From the drop-down menu, select a practice location.	Select the location of the clinic.
Page Size	int	Number of records in a page
Page Index	int	Index of the page (example 1,2,3).
Start Date	datetime	Date from when you want the data to be included the report. The format is yyyy-mm-dd.
End Date	datetime	Date until when you want the data to be included the report. The format is yyyy-mm-dd.
Provider Id	string	Unique ID of the provider.
Procedure Date	date	The start date of the procedure.

Response Parameters

Parameter	Data Type	Description
Id	GUID	Unique identifier of the data context.
clinicServerId	GUID	Unique identifier of the clinic’s server.
procedureDate	datetime	Date when the doctor has given a treatment to the patient.
procedureNumber	string	Unique identifier for the treatment plan. It is system-generated.
patientId	string	Unique identifier for patient. It is system-generated. Links to the patient record.
patientFirstName	string	Patient’s first name. Links to the patient record.
patientLastName	string	Patient’s last name. Links to the patient record.
patientMiddleName	string	Patient’s middle name. Links to the patient record.
appointmentId	string	Unique identifier for the appointment that the patient has taken with the clinic. It is system-generated.
doctorProduction	float	Amount generated by doctor or Dentist
providerId	string	Unique identifier for the provider. Links to the provider record.
provider	string	Provider’s full name
providerFName	string	Provider’s first name. Links to the provider record.
providerLName	string	Provider’s last name. Links to the provider record.
providerMName	string	Provider’s middle name. Links to the provider record.
providerCategory	string	Specialty of the provider.
ResponsiblePartyId	GUID	Unique ID of the party responsible for your treatment or guardian.
clinicNum	string	Unique identifier for the clinic.
adaCode	string	Procedure code or ADA code based on CDA. For example, D1101
procedureDescription	string	Details of the procedure or treatment service.
sourceCreatedUserId	string	ID of the user who created the record in the source PMS.
etlDataLoadedDate	datetime	Date when the data was loaded to Dentistry Automation.
etlDataUpdatedDate	datetime	Date when the data was updated in Dentistry Automation.
invoiceId	string	Unique identifier for the invoice.
sourceUpdatedDate	datetime	Date when the record was updated at source.
procedureStatus	string	Procedure status such as completed, planned, deleted, and so on.
isSourceDeleted	bit	Indicates whether the record was deleted at source.

Sample Response

{
  "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, "
    }
  ]
}

Response Codes

For information about the response codes, see Response Codes in Appointment KPI Details section.

Cancel Appointments KPI Details

Description

Path

Method Type

Appointments that are cancelled by patients.

/kpi/cancel-appointments

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	From the drop-down menu, select a dental office.	Select the dental office nearest to you..
Practice Location	From the drop-down menu, select a practice location.	Select the location of the clinic.
Page Size	int	Number of records in a page
Page Index	int	Index of the page (example 1,2,3).
Start Date	datetime	Date from when you want the data to be included the report. The format is yyyy-mm-dd.
End Date	datetime	Date until when you want the data to be included the report. The format is yyyy-mm-dd.
Provider Id	string	Unique ID of the provider.
Procedure Date	date	The start date of the procedure.

Response Parameters

Parameter	Data Type	Description
id	PK	Unique identifier of the data context.
clinicServerId	GUID	Unique identifier of the clinic’s server.
patientId	varchar (2000)	Unique identifier for patient. It is system-generated. Links to the patient record.
patientFirstName	varchar (100)	Patient’s first name. Links to the patient record.
patientLastName	varchar (100)	Patient’s last name. Links to the patient record.
patientMiddleName	varchar (100)	Patient’s middle name. Links to the patient record.
address1	varchar (100)	Patient’s address one.
address2	varchar (100)	Patient’s address two.
city	varchar (100)	Patient’s city.
state	varchar (100)	Patient’s State
zipCode	varchar (100)	Patient’s postal code.
homePhone	Varchar (30)	Patient’s home phone number.
workPhone	Varchar (30)	Patient’s work phone number
responsiblePartyId	varchar (100)	ID of the responsible party or guardian for the patient.
appointmentId	varchar (100)	Unique identifier for the appointment that the patient has taken with the clinic. It is system-generated.
appointmentDateTime	Datetime	Date and time of the appointment.
isNewPatient	tinyint	Indicates whether it is patient’s first visit at this clinic.
appointmentStatus	varchar (100)	Appointment status
typeOfVisit	Varchar (50)	Type of visit can be Doctor visit, or Hygienist visit, or any other visit.
providerId	varchar (100)	Unique identifier for the provider. Links to the provider record.
providerFName	varchar (100)	Provider’s first name. Links to the provider record.
providerLName	varchar (100)	Provider’s last name. Links to the provider record.
providerMName	varchar (100)	Provider’s middle name. Links to the provider record.
providerCategory	varchar (100)	Specialty of the provider.
clinicNum	varchar (100)	Unique identifier for the clinic.
reasonForVisit	Varchar (MAX)	Reason for the patient’s visit to the clinic.
sourceCreatedUserId	varchar (100)	ID of the user who created the record in the source PMS.
etlDataLoadedDate	datetimeoffset	Date when the data was loaded to Dentistry Automation.
etlDataUpdatedDate	datetimeoffset	Date when the data was updated in Dentistry Automation.

Sample Response


{
  "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, "
    }
  ]
}

Response Codes

For information about the response codes, see Response Codes in Appointment KPI Details section.

Hygiene Production KPI Details

Description

Path

Method Type

Amount generated by Hygienist.

/kpi/hygiene-production

POST

Request Parameters

Parameter	Data Type	Description
Clinic	From the drop-down menu, select a clinic server.	Clinic server name.
PageSize	int	Number of records in a page
PageIndex	int	Index of the page (example 1,2,3).
StartDate	Datetime	Date from when you want the data to be included the report. The format is yyyy-mm-dd.
EndDate	Datetime	Date until when you want the data to be included the report. The format is yyyy-mm-dd.
ProviderId	string	Unique identifier of the provider.
ClinicNum	Datetime	Unique identifier of the clinic from the source.
ProcedureDate	Datetime	Date when the doctor has given a treatment to the patient.

Response Parameters

Parameter	Data Type	Description
id	PK	Unique identifier of the data context.
clinicServerId	GUID	Unique identifier of the clinic’s server.
procedureDate	datetimeoffset	Date when the doctor has given a treatment to the patient.
procedureNumber	varchar (100)	Unique identifier for the treatment plan. It is system-generated.
patientId	varchar (2000)	Unique identifier for patient. It is system-generated. Links to the patient record.
patientFirstName	varchar (100)	Patient’s first name. Links to the patient record.
patientLastName	varchar (100)	Patient’s last name. Links to the patient record.
patientMiddleName	varchar (100)	Patient’s middle name. Links to the patient record.
responsiblePartyId	varchar (100)	ID of the responsible party or guardian for the patient.
appointmentId	varchar (100)	Unique identifier for the appointment that the patient has taken with the clinic. It is system-generated.
hygieneProduction	varchar (100)	Revenue generated by Hygienist for the clinic.
providerId	varchar (100)	Unique identifier for the provider. Links to the provider record.
providerFName	varchar (100)	Provider’s first name. Links to the provider record.
providerLName	varchar (100)	Provider’s last name. Links to the provider record.
providerMName	varchar (100)	Provider’s middle name. Links to the provider record.
providerCategory	varchar (100)	Specialty of the provider.
clinicNum	varchar (100)	Unique identifier for the clinic.
adaCode	Varchar (20)	Procedure code or ADA code based on CDA. For example, D1101
procedureDesc	varchar (100)	Details of the procedure or treatment service.
sourceCreatedUserId	varchar (100)	ID of the user who created the record in the source PMS.
etlDataLoadedDate	datetimeoffset	Date when the data was loaded to Dentistry Automation.
etlDataUpdatedDate	datetimeoffset	Date when the data was updated in Dentistry Automation.
invoiceId	Varchar (100)	Unique identifier for the invoice.
sourceUpdatedDate	datetimeoffset	Date when the record was updated at source.
procedureStatus	varchar (100)	Procedure status such as completed, planned, deleted, and so on.
isSourceDeleted	bit	Indicates whether the record was deleted at source.

Sample Response

 {
  "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, "
    }
  ]
}

Response Codes

For information about the response codes, see Response Codes in Appointment KPI Details section.

Short Notice Cancel KPI Details

Description

Path

Method Type

Appointments that are cancelled by patient within short notice.

/kpi/short-notice-cancel

POST

Request Parameters

Parameter	Data Type	Description
Clinic	From the drop-down menu, select a clinic server.	Clinic server name.
PageSize	int	Number of records in a page
PageIndex	int	Index of the page (example 1,2,3).
StartDate	datetimeoffset	Date from when you want the data to be included the report. The format is yyyy-mm-dd.
EndDate	datetimeoffset	Date until when you want the data to be included the report. The format is yyyy-mm-dd.
ClinicNum	string	Unique identifier of the clinic from the source.
Providercategory	string	Specialty of the provider.
AppointmentDateTime	Datetime	Date and time of the appointment.

Response Parameters

Parameter	Data Type	Description
id	PK	Unique identifier of the data context.
clinicServerId	GUID	Unique identifier of the clinic’s server.
patientId	varchar (2000)	Unique identifier for patient. It is system-generated. Links to the patient record.
patientFirstName	varchar (100)	Patient’s first name. Links to the patient record.
patientLastName	varchar (100)	Patient’s last name. Links to the patient record.
patientMiddleName	varchar (100)	Patient’s middle name. Links to the patient record.
address1	varchar (100)	Patient’s address one.
address2	varchar (100)	Patient’s address two.
city	varchar (100)	Patient’s city.
state	varchar (100)	Patient’s state.
zipCode	varchar (100)	Patient’s postal code.
homePhone	Varchar (30)	Patient’s home phone number.
workPhone	Varchar (30)	Patient’s work phone number
responsiblePartyId	Varchar (100)	Unique identifier of the responsible Party Id or Guardian
appointmentId	varchar (100)	Unique identifier for the appointment that the patient has taken with the clinic. It is system-generated.
appointmentDateTime	Datetime	Date and time of the appointment.
isNewPatient	tinyint	Indicates whether it is patient’s first visit at this clinic.
appointmentStatus	varchar (100)	Appointment status.
typeOfVisit	Varchar (50)	Type of visit can be Doctor visit, or Hygienist visit, or any other visit.
providerId	varchar (100)	Unique identifier for the provider. Links to the provider record.
providerFName	varchar (100)	Provider’s first name. Links to the provider record.
providerLName	varchar (100)	Provider’s last name. Links to the provider record.
providerMName	varchar (100)	Provider’s middle name. Links to the provider record.
providerCategory	varchar (100)	Specialty of the provider.
clinicNum	varchar (100)	Unique identifier for the clinic.
reasonForVisit	Varchar (MAX)	Reason for the patient’s visit to the clinic.
sourceCreatedUserId	varchar (100)	ID of the user who created the record in the source PMS.
etlDataLoadedDate	datetimeoffset	Date when the data was loaded to Dentistry Automation.
etlDataUpdatedDate	datetimeoffset	Date when the data was updated in Dentistry Automation.

Sample Response

{
  "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, "
    }
  ]
}

Response Codes

For information about the response codes, see Response Codes in Appointment KPI Details section.

AR aging balances by Guarantor KPI Details

Description

Path

Method Type

Provides account receivables aging balances based on guarantor.

/kpi/agingbalancesbyguarantor

POST

Request Parameters

Parameter	Data Type	Description
Clinic	From the drop-down menu, select a clinic server.	Clinic server name.
PageSize	Int	Number of records in a page.
PageIndex	Int	Index of the page (example 1,2,3).
ClinicNum	String	Unique identifier of the clinic.
Clinic Name	String	Name of the clinic.
GuarantorId	String	Unique ID of the guarantor.
GuarantorFirstName	String	First name of the guarantor.
GuarantorLastName	String	Last name of the guarantor.
NonzeroArOnly	Bit	Account receivable with only non- zero values.

Response Parameters

Parameter	Data Type	Description
Id	PK	Unique identifier of the data context.
clinicServerId	GUID	Unique identifier of the clinic’s server.
guarantorId	string	Unique identifier for the guarantor. It is system-generated. Links to the patient record.
guarantorFirstName	string	Guarantor’s first name. Links to the patient record.
guarantorLastName	string	Guarantor’s last name. Links to the patient record.
guarantorMiddleName	string	Guarantor’s middle name. Links to the patient record.
birthdate	datetime	Guarantor’s date of birth.
firstVisitDate	datetime	Date when the patient visited the clinic for the first time.
lastVisitDate	datetime	Date when the patient visited the clinic for the last time.
clinicNum	string	Unique identifier for the clinic.
arLess30	decimal	Amount due for the past 30 days.
ar30To60	decimal	Amount due for the past 60 days.
ar60To90	decimal	Amount due for the past 90 days.
arAbove90	decimal	Amount due for more than 90 days.
totalAR	decimal	Total due from patient.
primaryInsuranceId	string	Primary insurance ID of the guarantor.
secondaryInsuranceId	string	Secondary insurance ID of the guarantor.
clinicName	string	Name of the clinic.
clinicCity	string	City where the clinic is located.
clinicState	string	State where the clinic is located.
clinicZipCode	string	Zip code where the clinic is located.
primaryInsuranceCompany	string	Primary insurance company name, which pays the insurance amount.
secondaryInsuranceCompany	string	Secondary insurance company name, which pays the insurance amount.
arGenerationDate	datetime	Account receivable calculation date.
etlDataUpdatedDate	datetimeoffset	Date when the data was updated in Dentistry Automation.

Sample Response

 {
  "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, "
    }
  ]
}

Response Codes

For information about the response codes, see Response Codes in Appointment KPI Details section.

Guarantor wise total AR by Date (End date of a month) KPI Details

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

Request Parameters

Parameter	Data Type	Description
Clinic	From the dropdown menu,	Clinic server name.
	select a clinic server.
ArDate (Date)	datetime	End date of the month for AR calculation.
PageSize	int	Number of records in a page
Pageindex	int	Index of the page (example 1,2,3).
ClinicNum	string	Unique identifier of the clinic from the source.
ClinicName	string	Name of the clinic.
GuarantorId	string	Unique ID of the guarantor.
GuarantorFirstName	string	First name of the guarantor.
GuarantorLastName	string	Last name of the guarantor.
NonzeroArOnly	bit	Account receivable with only non- zero values.

Response Parameters

Parameter	Data Type	Description
id	PK	Unique identifier of the data context.
clinicServerId	GUID	Unique identifier of the clinic’s server.
guarantorId	string	Unique ID for the patient’s guarantor. It is system-generated. Links to the patient record.
guarantorFirstName	string	Guarantor’s first name. Links to the patient record.
guarantorLastName	string	Guarantor’s last name. Links to the patient record.
guarantorMiddleName	string	Guarantor’s middle name. Links to the patient record.
birthdate	datetime	Guarantor’s date of birth.
firstVisitDate	datetime	Date when the guarantor visited the clinic for the first time.
lastVisitDate	datetime	Date when the guarantor visited the clinic for the last time.
clinicNum	string	Unique identifier for the clinic.
arLess30	decimal	Amount due for the past 30 days.
ar30To60	decimal	Amount due for the past 60 days.
ar60To90	decimal	Amount due for the past 90 days.
arAbove90	decimal	Amount due for more than 90 days.
totalAR	decimal	Total amount due from guarantor.
patientPortion	decimal	Amount due only from guarantor.
insurancePortion	decimal	Amount due only from the insurance company.
primaryInsuranceId	string	ID of the primary insurance company, which pays the insurance amount.
secondaryInsuranceId	decimal	ID of the secondary insurance company, which pays the insurance amount.
clinicName	string	Name of the clinic.
clinicCity	string	City where the clinic is located.
clinicState	string	State where the clinic is located.
clinicZipCode	string	Zip code where the clinic is located.
primaryInsuranceCompany	string	Primary insurance company name, which pays the insurance amount.
secondaryInsuranceCompany	string	Secondary insurance company name, which pays the insurance amount.
arGenerationDate	datetime	Account receivable calculation date.
etlDataUpdatedDate	datetimeoffset	Date when the data was updated in Dentistry Automation.

Sample Response


{
  "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, "
    }
  ]
}

Response Codes

For information about the response codes, see Response Codes in Appointment KPI Details section.

Patient aging and insurance aging balances by Guarantor KPI Details

Description

Path

Method Type

Patient aging and insurance aging split by guarantor

/kpi/patientagingandinsuranceagingbyguarantor

POST

Request Parameters

Parameter	Data Type	Description
Clinic	From the drop-down menu, select a clinic server.	Clinic server name.
PageSize	int	Number of records in a page.
PageIndex	int	Index of the page (example 1,2,3).
ClinicNum	string	Unique identifier of the clinic.
ClinicName	string	Name of the clinic.
GuarantorId	string	Unique ID of the guarantor.
GuarantorFirstName	string	First name of the guarantor.
GuarantorLastName	string	Last name of the guarantor.
NonzeroArOnly	Bit	Account receivable with only non- zero values.

Response Parameters

Parameter	Data Type	Description
id	PK	Unique identifier of the data context.
clinicServerId	GUID	Unique identifier of the clinic’s server.
guarantorId	string	Unique ID for the patient’s guarantor. It is systemgenerated. Links to the patient record.
guarantorFirstName	string	Guarantor’s first name. Links to the patient record.
guarantorLastName	string	Guarantor’s last name. Links to the patient record.
guarantorMiddleName	string	Guarantor’s middle name. Links to the patient record.
birthdate	datetime	Guarantor’s date of birth.
firstVisitDate	datetime	Date when the guarantor visited the clinic for the first time.
lastVisitDate	datetime	Date when the guarantor visited the clinic for the last time.
clinicNum	string	Unique identifier for the clinic.
totalPatientAR	decimal	Total amount due from patient.
totalInsuranceAR	decimal	Total amount due from insurance company.
insPortionLess30	decimal	Insurance portion amount due for the past 30 days.
insPortion30To60	decimal	Insurance portion amount due for the past 60 days.
insPortion60To90	decimal	Insurance portion amount due for the past 90 days.
insPortionAbove90	decimal	Insurance portion amount due for more than 90 days.
patPortionLess30	decimal	Patient portion amount due for the past 30 days.
patPortion30To60	decimal	Patient portion amount due for the past 60 days.
patPortion60To90	decimal	Patient portion amount due for the past 90 days.
patPortionAbove90	decimal	Patient portion amount due for more than 90 days.
primaryInsuranceId	string	Primary insurance ID of the patient.
secondaryInsuranceId	string	Secondary insurance ID of the patient.
clinicName	string	Name of the clinic.
clinicCity	string	City where the clinic is located.
clinicState	string	State where the clinic is located.
clinicZipCode	string	Zip code where the clinic is located.
primaryInsuranceCompany	string	Primary insurance company name, which pays the insurance amount.
secondaryInsuranceCompany	string	Secondary insurance company name, which pays the insurance amount.
arGenerationDate	datetime	Account receivable calculation date.
etlDataUpdatedDate	datetimeoffset	Date when the data was updated in Dentistry Automation.

Sample Response

{
 "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, "
 }
 ]
}

Response Codes

For information about the response codes, see Response Codes in Appointment KPI Details section.

Total Account Receivable by Guarantor KPI Details

Description

Path

Method Type

Provides the total account receivable by guarantor

/kpi/TotalARByGuarantor

POST

Request Parameters

Parameter	Data Type	Description
Clinic	From the drop-down menu, select a clinic server.	Clinic server name.
PageSize	int	Number of records in a page
PageIndex	int	Index of the page (example 1,2,3).
ClinicNum	string	Unique identifier of the clinic.
ClinicName	string	Name of the clinic.
GuarantorId	string	Unique ID of the guarantor.
GuarantorFirstName	string	First name of the guarantor.
GuarantorLastName	string	Last name of the guarantor.
NonzeroArOnly	bit	Account receivable with only non- zero values.

Response Parameters

Parameter	Data Type	Description
Id	PK	Unique identifier of the data context.
clinicServerId	GUID	Unique identifier of the clinic’s server.
guarantor Id	string	Unique identifier for the guarantor. It is system-generated. Links to the patient record.
guarantorFirstName	string	Guarantor’s first name. Links to the patient record.
guarantorLastName	string	Guarantor’s last name. Links to the patient record.
guarantorMiddleName	string	Guarantor’s middle name. Links to the patient record.
birthdate	datetime	Guarantor’s date of birth.
firstVisitDate	datetime	Date when the patient visited the clinic for the first time.
lastVisitDate	datetime	Date when the patient visited the clinic for the last time.
clinicNum	string	Unique identifier for the clinic.
arLess30	decimal	Amount due for the past 30 days.
ar30To60	decimal	Amount due for the past 60 days.
ar60To90	decimal	Amount due for the past 90 days.
arAbove90	decimal	Amount due for more than 90 days.
totalAR	decimal	Total due from patient.
totalPatientAR	decimal	Total amount due from patient.
totalInsuranceAR	decimal	Total amount due from insurance company.
insPortionLess30	decimal	Insurance portion amount due for the past 30 days.
insPortion30To60	decimal	Insurance portion amount due for the past 60 days.
insPortion60To90	decimal	Insurance portion amount due for the past 90 days.
insPortionAbove90	decimal	Insurance portion amount due for more than 90 days.
patPortionLess30	decimal	Patient portion amount due for the past 30 days.
patPortion30To60	decimal	Patient portion amount due for the past 60 days.
patPortion60To90	decimal	Patient portion amount due for the past 90 days.
patPortionAbove90	decimal	Patient portion amount due for more than 90 days.
primaryInsuranceId	string	Primary insurance ID of the guarantor.
secondaryInsuranceId	string	Secondary insurance ID of the guarantor.
clinicName	string	Name of the clinic.
clinicCity	string	City where the clinic is located.
clinicState	string	State where the clinic is located.
clinicZipCode	string	Zip code where the clinic is located.
primaryInsuranceCompany	string	Primary insurance company name, which pays the insurance amount.
secondaryInsuranceCompany	string	Secondary insurance company name, which pays the insurance amount.
arGenerationDate	datetime	Account receivable calculation date.
etlDataUpdatedDate	datetimeoffset	Date when the data was updated in Dentistry Automation.

Sample Response

{
  "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, "
    }
  ]
}

Response Codes

For information about the response codes, see Response Codes in Appointment KPI Details section.

APIs

This section provides information for the following KPIs:

Accounts API
Types of Appointment API
Claim-Procedures Details API
Insurance Claim Details API
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

Accounts API

Description

Endpoint

Method Type

Provides information about the accounts.

/appointment-types

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	string	Name of the dental clinic.
Practice Location	string	Location of the clinic.
PageSize	int	Number of records in a page.
PageIndex	int	Index of the page (example 1,2,3).
StartDate	datetime	Date from when you want the data to be included in the report. The format is yyyy-mm-dd.
EndDate	datetime	Date until when you want the data to be included in the report. The format is yyyy-mm-dd.
Patient ID	string	Unique identifier of the patient.
Account Number	string	Account number of the patient.
End Time	string	End time of the appointment.

Response Parameters

Parameter	Data Type	Description
Id	GUID	Unique identifier of the data context.
Account Number	string	Account number of the patient.
Bank Name	string	Name of the bank of the account holder.
Account Type ID	string	Unique identifier used to differentiate various types of accounts in the system.
BankID	string	Unique identifier assigned to a specific bank.
IsActive	string	Status of the bank account whether the bank account is active or inactive.
AccountColor	string	Refers to a visual identifier or theme used differentiate between various account types.
PatientId	string	Unique identifier of the patient.
sourceCreatedUserId	string	ID of the user who created the record in the source PMS.
sourceCreatedDate	datetime	Date when the record was created at source.
sourceModifiedUserId	datetime	ID of the user who modified the record in the source PMS.
sourceUpdatedDate	datetime	Date when the record was updated at source.
clinicServerId	GUID	Unique identifier of the clinic’s server.
ETLDataLoadedDate	datetime	Date when the data was loaded to Dentistry Automation.
ETLDataUpdatedDate	datetime	Date when the data was updated in Dentistry Automation.

Sample Response

{
  "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, "
    }
  ]
}

Response Codes

For information about the response codes, see Response Codes in Appointment KPI Details section.

Claim-Procedures Details API

Description

Path

Method Type

User can add a new claim, view individual claims, or a list of closed patient claims.

/claim-procedures

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	string	Name of the dental clinic.
Practice Location	string	Location of the dental clinic.
PageSize	int	Number of records in a page
PageIndex	int	Index of the page (example 1,2,3).
StartDate	datetime	Date from when you want the data to be included in the report. The format is yyyy-mm-dd.
EndDate	datetime	Date until when you want the data to be included in the report. The format is yyyy-mm-dd.
Patient ID	string	Unique identifier of the patient.
Provider ID	string	Unique identifier for the provider. Links to the provider record.
Claim Procedure Id	string	Unique identifier of the claim procedure.
Provider Category	string	Specialty of the provider.
Procedure Date	string	Date when the doctor has performed a treatment to the patient.
AdaCode	string	Procedure code or ADA code based on CDA. For example, D1101.

Response Parameters

Parameter	Data Type	Description
id	GUID	Unique identifier of the data context
claimProcedureId	strng	Unique identifier of the claim procedure.
procedureId	string	Unique identifier of the procedure.
claimId	string	Unique identifier of the claim.
patientId	string	Unique ID of the patient.
patientFirstName	string	First name of the patient.
patientLastName	string	Last name of the patient.
patientMiddleName	string	Middle name of the patient.
providerId	string	Specialty of the provider.
provider	string	Name of the provider
providerFName	string	First name of the provider.
providerLName	string	Last name of the provider.
providerMName	string	Middle name of the provider.
providerCategory	string	Specialty of the provider.
feeBilled	string	Cost of the treatment that’s added to the bill.
status	string	Status of the claimed procedure.
claimPaymentId	varchar (100)	Unique dentifier for the claim payment (link to the claim record of the medical claim for the procedure).
dateofClaim	datetime	Date when the claim was initiated.
procedureDate	datetime	Date when the doctor has given a treatment to the patient.
dateEntry	string	Entry date
clinicNum	varchar (100)	Unique identifier for the clinic.
clinicName	varchar (100)	Name of the clinic.
insSubNum	string	Insurance Subscription Number
paymentPlanNum	string	Payment Plan Number
claimPaymentTracking	string	Claim Payment Tracking
insuranceCarrierId	string	Insurance Company ID of the patient.
insuranceCarrierName	string	Insurance Company name of the patient.
insuranceType	string	Type of insurance
dateSent	string	Date when the claim is sent.
totalReceived	string	Amount received from the insurance company based on the requested claim amount.
guardianId	Varchar (50)	Unique ID for the patient’s guardian.
chartStatus	string	Determines the chart status of a patient.
amountPrimaryInsurancePaid	String	Amount paid by the primary insurance company.
procedureCodeId	string	Unique identifier of the procedure or treatment. It is system-generated. Links to the patient record.
adaCode	string	Procedure code or ADA code based on CDA. For example, D1101.
procedureDescription	varchar (100)	Details of the procedure or treatment service.
procedureAmount	String	Cost of the procedure or treatment.
dateReceived	datetime	Date when claim is received by the clinics.
sourceCreatedUserId	string	ID of the user who created the record in the source PMS.
sourceCreatedDate	datetime	Date when the record was created at source.
sourceUpdatedDate	datetime	Date when the record was updated at source.
clinicServerId	GUID	Unique identifier of the clinic’s server.
etlDataLoadedDate	datetime	Date when the data was loaded to Dentistry Automation.
etlDataUpdatedDate	datetime	Date when the data was updated in Dentistry Automation.

Sample Response

{
  "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, "
    }
  ]
}

Response Codes

For information about the response codes, see Response Codes in Appointment KPI Details section.

Type of Appointment API

Description

Path

Method Type

Provides information about the type of appointment.

/appointment-types

POST

Request Parameters

Parameter	Data Type	Description
Id	GUID	Unique identifier of the data context.
Account Number	string	Account number of the patient.
Bank Name	string	Name of the bank of the account holder.
Account Type ID	string	Unique identifier used to differentiate various types of accounts in the system.
BankID	string	Unique identifier assigned to a specific bank.
IsActive	string	Status of the bank account whether the bank account is active or inactive.
AccountColor	string	Refers to a visual identifier or theme used differentiate between various account types.
PatientId	string	Unique identifier of the patient.
sourceCreatedUserId	string	ID of the user who created the record in the source PMS.
sourceCreatedDate	datetime	Date when the record was created at source.
sourceModifiedUserId	datetime	ID of the user who modified the record in the source PMS.
sourceUpdatedDate	datetime	Date when the record was updated at source.
clinicServerId	GUID	Unique identifier of the clinic’s server.
ETLDataLoadedDate	datetime	Date when the data was loaded to Dentistry Automation.
ETLDataUpdatedDate	datetime	Date when the data was updated in Dentistry Automation.

Response Parameters

Parameter	Data Type	Description
Id	GUID	Unique identifier of the data context.
AppointmentTypeId	string	Unique identifier of the appointment type.
AppointmentTypeName	string	Type of appointment.
AppointmentTypeColor	string	Appointments labelled in color determine priorities.
ItemOrder	string	Individual items of a clinical order.
IsHidden	string	Is Hidden appointment
Pattern	string	Categories based on the purpose or the nature of treatment.
Codestring	string	List of procedure codes
Amount	string	Cost of the service.
NumberOfUnits	string	Unit count
TicMarks	string	Refers to actions, or statuses associated with an appointment.
CentralId	string	Refers to an identifier that is used to manage or track appointments.
RecallId	string	Unique identifier associated with a appointment recall.
FontColor	string	Helps to distinguish different types of appointments.
UsePtCleaningTime	string	Patient cleaning time
UpdateNextAppt	string	Update next Appointment
IsPerformedBy	string	Provides information about the health care professional.
AppointmentMinutes	string	Duration of the appointment.
Active	string	Status of the appointment is active.
ClinicserverID	GUID	Unique identifier of the clinic’s server.
ETLDataLoadedDate	datetime	Date when the data was loaded to Dentistry Automation.
ETLDataUpdatedDate	datetime	Date when the data was updated in Dentistry Automation.

Sample Response

{
  "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, "
    }
  ]
}

Response Codes

For information about the response codes, see Response Codes in Appointment KPI Details section.

Get Clinic By Name API

Description

Path

Method Type

Get specific clinic details.

/write/get-clinic

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	string	Name of the dental office.
Practice Location	string	Location of the dental office.

Sample Response

 {
  "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
    }
  ]
}

Insurance Claim Details API

Description

Path

Method Type

Provides details about the insurance claim.

/claims

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	string	Unique ID of the server associated with the clinic.
Practice Location	string	Location of the dental clinic.
Page Size	int	Number of records in a page
Page Index	int	Index of the page (example 1,2,3).
Start Date	datetime	Date from when you want the data to be included in the report. The format is yyyy-mm-dd.
End Date	datetime	Date until when you want the data to be included in the report. The format is yyyy-mm-dd.
Patient ID	string	Unique identifier for patient. It is system-generated.
Claim Date Sent	datetime	Date when claim was sent to the insurance company
Claim Number	datetime	Insurance claim number.

Response Parameters

Parameter	Data Type	Description
id	GUID	Unique identifier of the data context.
ClaimNum	string	Unique identifier of the claim.
PatientId	string	Unique identifier of the patient.
ServiceDate	datetime	Date when the treatment was availed.
ClaimDateSent	datetime	Date when the claim was sent.
ClaimStatus	string	Status of the claim.
InsuranceCarrierId	string	Primary Insurance Company ID of the patient.
ClaimFee	string	Fee incurred for the claim.
InsurancePayEstimation	string	Estimated Insurance amount to be paid by insurance company.
ClaimType	string	Type of claim (primary, secondary, tertiary, and so on).
SourceCreatedUserId	string	ID of the user who created the record in the source PMS.
SourceCreatedDate	datetime	Date when the record was created at source.
SourceModifiedUserId	string	ID of the user who modified the record at source PMS.
SourceUpdatedDate	datetime	Date when the record was updated at source.
ClinicServerId	GUID	Unique identifier of the clinic’s server.
ETLDataLoadedDate	datetime	Date when the data was loaded to Dentistry Automation.
ETLDataUpdatedDate	datetime	Date when the data was updated in Dentistry Automation.
InsurancePlanNum	string	Number of the insurance plan associated with the patient.
ClaimDateReceived	datetime	Date when claim is received by the clinics.
ClinicNum	string	Unique identifier for the clinic.
ClaimUCRAmount	string	Claim UCR amount.
ClaimBilledAmount	string	Claim billed amount.
ClaimReceivedAmount	string	Claim received amount.
CheckNumber	string	Check number for ID if payment type is check.
ProviderId	string	Unique identifier for provider. It is system-generated.
GuarantorId	string	Unique ID for the patient’s guarantor.
StatusCategory	string	A simiple category of all status.

Sample Response

{
  "isSucceed": true,
  "errorMessages": null,
  "exception": null,
  "totalCount": 1,
  "data": [
    {
      "Id": "00000000-0000-0000-0000-000000000000, ",
      "ClaimNum": "11521, ",
      "PatientId": "101, ",
      "ServiceDate": "2022-10-12 10:17:33.097, ",
      "ClaimDateSent": "2022-10-12 10:17:33.097, ",
      "ClaimStatus": "S, ",
      "InsuranceCarrierId": "18006, ",
      "ClaimFee": "500, ",
      "InsurancePayEstimation": "500, ",
      "ClaimType": "Primary, ",
      "SourceCreatedUserId": "0, ",
      "SourceCreatedDate": "2022-10-12 10:17:01.620, ",
      "SourceModifiedUserId": "11521, ",
      "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, ",
      "InsurancePlanNum": "12099, ",
      "ClaimDateReceived": "2022-10-12 10:17:33.097, ",
      "ClinicNum": "2, ",
      "ClaimUCRAmount": "400, ",
      "ClaimBilledAmount": "500, ",
      "ClaimReceivedAmount": "500, ",
      "CheckNumber": "14231, ",
      "ProviderId": "1, ",
      "GuarantorId": "10324, ",
      "StatusCategory": "OPEN, "
    }
  ]
}

Response Codes

For information about the response codes, see Response Codes in Appointment KPI Details section.

Clinic/Practice Details API

Description

Path

Method Type

Provides the details of the clinic.

/clinics

POST

Request Parameters

Parameter	Data Type	Description
Provider Id	string	Unique identifier for the provider.
Dental Office	string	Location of the dental clinic.
Practice Location	string	Clinic server name.
PageSize	int	Number of records in a page
PageIndex	int	Index of the page (example 1,2,3).
StartDate	datetime	Date from when you want the data to be included in the report. The format is yyyy-mm-dd.
EndDate	datetime	Date until when you want the data to be included in the report. The format is yyyy-mm-dd.
IsActive	string	Status of the patient whether the patient is active or inactive.
Appointment Type Id	string	Unique identifier about the type of appointment.
Operatory Id	string	Unique identifier of the operatory.

Response Parameters

Sample Response

{
  "isSucceed": true,
  "errorMessages": null,
  "exception": null,
  "totalCount": 1,
  "data": [
    {
      "id": "A284A008-D8CA-43E7-BBE0-00003FED01AD, ",
      "clinicNum": "2, ",
      "clinicName": "Dental Clinic Name, ",
      "address1": "#867-859 Sit Rd, ",
      "address2": "Suit #10, ",
      "city": "Arizona, ",
      "DsoId": "234,",
      "PmsName": "Smile Dental,",
      "state": "Phoenix, ",
      "IsSdEnabled": "Phoenix, ",
      "zipCode": "85001, ",
      "phoneNumber": "(372) 587-2335, ",
      "phoneExt": "101, ",
      "email": "[email protected], ",
      "isActive": "1, ",
      "clinicServerId": "3818F9FE-4066-4948-80FB-0000E462FCF8, ",
      "comments": "comments, ",
      "sourceCreatedUserId": "TXC1, ",
      "sourceCreatedDate": "2022-10-12 10:17:01.620, ",
      "sourceModifiedUserId": "TXC2, ",
      "sourceUpdatedDate": "2022-10-12 10:17:33.097, ",
      "etlDataLoadedDate": "2022-10-12 10:17:16.753, ",
      "etlDataUpdatedDate": "2022-10-12 10:17:33.097, "
    }
  ]
}

Response Codes

For information about the response codes, see Response Codes in Appointment KPI Details section.

Coverage Details API

Description

Path

Method Type

Provides details of the coverage in the patient’s insurance.

/coverages

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	string	Name of the dental clinic.
Practice Location	string	Location of the clinic.
Page Size	Int	Number of records in a page.
Page Index	Date	Index of the page (example 1,2,3).
Start Date	Date	Date from when you want the data to be included in the report. The format is yyyy-mm-dd.
End Date	Date	Date until when you want the data to be included in the report. The format is yyyy-mm-dd.
Patient ID	String	Unique identifier of the patient.
Coverage ID	String	Unique identifier of the coverage.

Response Parameters

Parameter	Data Type	Description
Id	GUID	Unique identifier of the data context.
CoverageId	string	Unique identifier of the coverage.
Description	string	Dental treatments that are covered in the insurance.
CoveragePercentage	string	Percentage of amount covered in the insurance for the dental treatments.
CoverageOrder	string	Consists of limit order placed along with a mandatory stop loss order within a specified range.
IsHidden	string	Is Hidden
Category	String	Category of the coverage.
RangeStart	string	Represents the date when a policy, plan, or coverage period begins.
RangeEnd	string	Represents the date when a policy, plan, or coverage period ends.
CoPayment	string	Refers to a fixed amount that the insured person is required to pay for a covered healthcare service or treatment at the time of receiving the service.
RequiresPreAuth	string	Indicates whether the coverage requires preauthorization.
CutOffAge	string	Age of the patient until when the coverage is applicable.
DeductibleType	string	Amount you pay out-of-pocket for expenses before your insurance provider starts to pay.
ServiceCode	string	Standardized code that represents specific services or procedures.
Dollars	string	Unit of currency.
UCRFees	int	This is the maximum amount an insurance company will allow for a particular dental procedure.
DollarsOrPercent	string	When a dental deductible is met, most policies only cover a percentage of the remaining costs. The remaining balance must be paid by the patient.
ForgiveDiffererence	string	An adjustment where the insurer adjusts the variance between two amounts, usually for invoice, or balance sheet entry.
RangeStartExtension	string	Broadens the scope of a policy that includes additional protection or benefits beyond the original terms.
RangeEndExtension	string	Refers to a modification or extension of coverage that extends the end date or termination point of an insurance policy.
CarrierInsurancePlanId	string	Unique identifier of the insurance provider or a specific type of coverage option.
SubscriberId	string	Refers to who the primary insured person is and the number that is required to file the claim.
Patientid	String	Unique identifier of the patient.
SourceUpdatedDate	datetime	Date when the record was updated at source.
ClinicServerId	GUID	Unique identifier of the clinic’s server.
ETLDataLoadedDate	datetime	Date when the data was loaded to Dentistry Automation.
ETLDataUpdatedDate	datetime	Date when the data was updated in Dentistry Automation.

Sample Response

{
  "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, "
    }
  ]
}

Response Codes

For information about the response codes, see Response Codes in Appointment KPI Details section.

Employers Details API

Description

Path

Method Type

Provides details of the employers

/employers

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	string	Name of the dental clinic.
Practice Location	string	Location of the dental clinic.
Page Size	int	Number of records in a page
Page Index	int	Index of the page (example 1,2,3).
Start Date	datetime	Date from when you want the data to be included in the report. The format is yyyy-mm-dd.
End Date	datetime	Date until when you want the data to be included in the report. The format is yyyy-mm-dd.
Employer ID	String	Unique identifier of the employer in the dental clinic.
Employer Name	String	Name of the employer in the dental clinic.

Response Parameters

Parameter	Data Type	Description
Id	GUID	Unique identifier of the data context.
EmployerId	String	Unique identifier of the employee in the dental clinic.
EmployerName	String	Name of the employer in the dental clinic.
Address1	String	Address of the employer.
Address2	String	Address of the employer.
City	String	City of the employer.
State	String	State of the employer.
ZipCode	String	Zip code of the employer.
Phone1	Int	Phone number of the employer.
Phone1Ext	Int	Extension number of the employer.
Phone2	Int	Alternate phone number of the employer.
Phone2Ext	Int	Alternate extension number of the employer.
Fax	int	Fax number of the employer.
ClinicServerId	GUID	Unique identifier of the clinic’s server.
ETLDataLoadedDate	datetime	Date when the data was loaded to Dentistry Automation.
ETLDataUpdatedDate	datetime	Date when the data was updated in Dentistry Automation.

Sample Response

{
  "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, "
    }
  ]
}

Response Codes

For information about the response codes, see Response Codes in Appointment KPI Details section.

Fee Schedule Details API

Description

Path

Method Type

List of charges for services or products offered by the healthcare provider

/fee-schedules

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	string	Name of the dental clinic.
Practice Location	string	Location of the dental clinic.
Page Size	int	Number of records in a page
Page Index	int	Index of the page (example 1,2,3).
Start Date	datetime	Date from when you want the data to be included in the report. The format is yyyy-mm-dd.
End Date	datetime	Date until when you want the data to be included in the report. The format is yyyy-mm-dd.
Fee Sched Num	String	Set of fees for specific services or products.
Fee Sched Type	String	Type of fee schedule.

Response Parameters

Id	GUID	Unique identifier of the data context.
FeeSchedNum	int	Set of fees for specific services or products.
Description	string	List of prices for specific treatments and services that insurers pay dentists, other providers, and suppliers.
FeeSchedType	string	Type of fee schedule.
ItemOrder	string	Individual items of a clinical order.
IsHidden	string	Is Fee schedule Hidden
IsGlobal	string	Indicates that the fee or pricing rule applies universally across all regions.
CentralId	string	Unique identifier associated with a specific fee schedule or pricing structure.
TrojanId	string
Amount	int	Specific cost or charge associated with a service, product, or transaction.
SourceCreatedUserId	string	User ID of the person who has created the source.
SourceCreatedDate	datetime	Date when the record was created at source.
SourceModifiedUserId	string	User ID of the person who has modified the source.
SourceUpdatedDate	datetime	Date when the record was updated at source.
ClinicServerId	GUID	Unique identifier of the clinic’s server.
ETLDataLoadedDate	datetime	Date when the data was loaded to Dentistry Automation.
ETLDataUpdatedDate	datetime	Date when the data was updated in Dentistry Automation.

Sample Response

{
  "isSucceed": true,
  "errorMessages": null,
  "exception": null,
  "totalCount": 1,
  "data": [
    {
      "Id": "00000000-0000-0000-0000-000000000000, ",
      "FeeSchedNum": "null, ",
      "Description": "null, ",
      "FeeSchedType": "null, ",
      "ItemOrder": "null, ",
      "IsHidden": "null, ",
      "IsGlobal": "null, ",
      "CentralId": "null, ",
      "TrojanId": "null, ",
      "Pre13": "null, ",
      "Amount": "180, ",
      "Amount1": "200, ",
      "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, "
    }
  ]
}

Response Codes

For information about the response codes, see Response Codes in Appointment KPI Details section.

Fee Details API

Description

Path

Method Type

Manage fee information related to a specific service

/fees

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	string	Name of the dental clinic.
Practice Location	string	Location of the dental clinic.
PageSize	int	Number of records in a page
PageIndex	int	Index of the page (example 1,2,3).
StartDate	datetime	Date from when you want the data to be included in the report. The format is yyyy-mm-dd.
EndDate	datetime	Date until when you want the data to be included in the report. The format is yyyy-mm-dd.
Fee Num	String	Unique identifier assigned to a particular fee type.
Code Num	String	Unique identifier used to categorize, track, or reference a specific fee.

Response Parameters

Parameter	Data Type	Description
Id	GUID	Unique identifier of the data context.
FeeNum	int	Unique identifier of the data context.
Amount	int	Specific cost or charge associated with a service, product, or transaction.
Code	string	Unique identifier used to distinguish between different types of fees.
FeeSchedNum	string	Set of fees for specific services or products.
UseDefaultFee	string	Determines whether the default fee is applied to a transaction, service, or product.
UseDefaultCov	string	Determines whether a default coverage is applied automatically in a particular transaction.
CodeNum	string	Unique identifier used to categorize, track, or reference a specific fee.
ClinicNum	string	Unique identifier for the clinic.
ProvNum	string	Unique identifier that links a fee to the specific provider.
LabAmount	string	Refers to the specific amount charged for laboratory services or lab-related costs.
PreFee	string	Refers to a fee that is applied before other charges or fees are considered.
ExpenseAmount	string	Refers to the total amount of money spent or incurred as part of a fee or cost breakdown.
AllowWriteOff	string	This allows an amount deducted by the provider from a medical bill and does not expect to collect payment owned by patients or payers.
CopayAmount	string	This is a fixed dollar amount a patient must pay upfront for medical services as part of their health insurance coverage.
SourceCreatedUserId	string	User ID of the person who has created the source.
SourceCreatedDate	datetime	Date when the record was created at source.
SourceModifiedUserId	string	User ID of the person who has modified the source.
SourceUpdatedDate	datetime	Date when the record was updated at source.
ClinicServerId	GUID	Unique identifier of the clinic’s server.
ETLDataLoadedDate	datetime	Date when the data was loaded to Dentistry Automation.
ETLDataUpdatedDate	datetime	Date when the data was updated in Dentistry Automation.

Sample Response

{
  "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, "
    }
  ]
}

Response Codes

For information about the response codes, see Response Codes in Appointment KPI Details section.

OAS APIs

This section provides information for the following APIs:

Create Patient

Edit Patient
Create Appointment
Edit Appointment
Create Appointment Type
Edit Appointment Type

Create Patient

Description

Path

Method Type

Create a patient record.

/oas/create-patient

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	string	Name of the dental clinic.
Practice Location	string	Location of the clinic.
Unique Key	string	A key that identifies the record
First Name	string	First name of the patient.
Last Name	string	Last name of the patient.
Provider Id	string	Unique identifier of the provider.
Patient D O B (Date)	datetime	Date of birth of the patient.
Street1	string	Address of the patient.
Street2	string	Address of the patient.
City	string	City of the patient.
State	string	State of the patient.
Zip code	string	Zip code of the patient.
S S N	string	SSN of the patient
Gender	string	Gender of the patient.
Fam Pos	string	Whether the family person is a child, parent or spouse
Fee Sched	string	Fee schedule
Home Phone Number	string	Residence phone number of the patient.
Work Phone Number	string	Work phone number of the patient.
Mobile Phone Number	string	Mobile number of the patient.
Other Contact Number	string	Alternate contact number of the patient.
Email	string	Email ID of the patient.

Sample Response

{
  "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
	}
  ]
}

Edit Patient

Description

Path

Method Type

Edit the patient record.

/oas/edit-patient

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	string	Name of the dental clinic.
Practice Location	string	Location of the clinic.
Unique Key	string	A key that identifies the record
First Name	string	First name of the patient.
Last Name	string	Last name of the patient.
Provider Id	string	Unique identifier of the provider.
Patient D O B (Date)	datetime	Date of birth of the patient.
Street1	string	Address of the patient.
Street2	string	Address of the patient.
City	string	City of the patient.
State	string	State of the patient.
Zip code	string	Zip code of the patient.
S S N	string	SSN of the patient
Gender	string	Gender of the patient.
Fam Pos	string	Whether the family person is a child, parent or spouse
Fee Sched	string	Fee schedule
Home Phone Number	string	Residence phone number of the patient.
Work Phone Number	string	Work phone number of the patient.
Mobile Phone Number	string	Mobile number of the patient.
Other Contact Number	string	Alternate contact number of the patient.
Email	string	Email ID of the patient.
PatientId	string	Unique identifier of the patient record.

Sample Response

{
  "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
	}
  ]
}

Create Appointment

Description

Path

Method Type

Create an appointment for the patient.

/oas/create-appointment

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	string	Name of the dental clinic.
Practice Location	string	Location of the clinic.
Unique Key	string	A key that identifies the record
First Name	string	First name of the patient.
Last Name	string	Last name of the patient.
Patient D O B (Date)	datetime	Date of birth of the patient.
Gender	string	Gender of the patient.
PatientId	string	Unique identifier of the patient record.
Is New Patient	string	Indicate whether the patient is new or existing.
Confirmed	string	Indicate if the appointment is confirmed.
Appointment Date	datetime	Date of the appointment.
Appointment Type Id	string	Unique identifier for the appointment type.
Operatory Id	string	Unique identifier of the operatory.
Provider Id	string	Unique identifier of the provider.
Start Time	datetime	Start time of the appointment.
End Time	datetime	End time of the appointment.
Appointment Reason	string	Reason for the appointment.
Notes	string	Any additional information for this appointment.
Procedure Code Ids	string	Unique identifier of the procedure or treatment. It is system-generated. Links to the patient record.
Other Contact Number	string	Alternate contact number of the patient.
Email	string	Email ID of the patient.
PatientId	string	Unique identifier of the patient record.

Sample Response

{
  "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
	}
  ]
}

Edit Appointment

Description

Path

Method Type

Edit the appointment for the patient.

/oas/edit-appointment

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	string	Name of the dental clinic.
Practice Location	string	Location of the clinic.
Unique Key	string	A key that identifies the record
Appointment Id	string	Unique identifier for the appointment that the patient has taken with the clinic.
Confirmed	bit	Indicate if the appointment is confirmed.
Cancelled	bit	Indicate if the appointment is cancelled.
Appointment Date	date	Date of the appointment.
Start Time	string	Start time of the appointment.
End Time	string	End time of the appointment.

Sample Response

{
  "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
	}
  ]
}

Create Appointment Type

Description

Path

Method Type

Create the type of appointment.

/oas/create-appointment-type

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	string	Name of the dental clinic.
Practice Location	string	Location of the clinic.
Unique Key	string	A key that identifies the record
Appointment Type Name	string	Name of the appointment type.
Appointment Minutes	int	Minutes for Appoinment scheduled.
Procedure Code Ids	string	Unique identifier of the procedure or treatment. It is system-generated. Links to the patient record.
Start Time	string	Start time of the appointment.
End Time	string	End time of the appointment.

Sample Response

{
  "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
	}
  ]
}

Edit Appointment Type

Description

Path

Method Type

Edit the type of appointment.

/oas/edit-appointment-type

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	string	Name of the dental clinic.
Practice Location	string	Location of the clinic.
Unique Key	string	A key that identifies the record
Appointment Type Id	string	Unique identifier for the appointment that the patient has taken with the clinic.
Appointment Type Name	string	Name of the appointment type.
Appointment Minutes	int	Duration of appointment in minutes
Procedure Code Ids	string	Unique identifier of the procedure or treatment. It is system-generated. Links to the patient record.
End Time	string	End time of the appointment.

Sample Response

{
  "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
	}
  ]
}

Write APIs

This section provides information for the following Write APIs:

Add Clinic API
Get Clinic By Name API
Update Clinic API
Add Provider API
Get Provider API
Update Provider API
Add Payor API
Get Payor API
Update Payor API
Add Payor Credentials API
Get Payor Credentials API
Update Payor Credential API

Add Clinic API

Description

Path

Method Type

Adds a clinic to the database.

/write/Clinic

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	string	Name of the dental office.
Clinic Num	string	Unique identifier of the clinic.
Clinic Name	string	Name of the clinic.
Address	string	Address of the clinic.
City	string	City of the clinic.
Country	string	County of the clinic.
State	string	State of the clinic.
Zipcode	string	Zipcode of the clinic.
Tax ID	string	Tax ID of the clinic.

Sample Response

{
  "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
    }
  ]
}

Get Clinic By Name API

Description

Path

Method Type

Get specific clinic details.

/write/get-clinic

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	string	Name of the dental office.
Practice Location	string	Location of the dental office.

Sample Response

 {
  "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
    }
  ]
}

Update Clinic API

Description

Path

Method Type

Update the clinic information in the database.

/write/update-clinic

POST

Request Parameters

Parameter	Data Type	Description
Payload	JSON	Payload that contains the information to be updated for the clinic.

Sample Response

 {
  "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
    }
  ]
}

Add Provider API

Description

Path

Method Type

Add provider details to the database.

/write/provider

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	string	Name of the dental office.
First Name	string	First name of the provider.
Last Name	string	Last name of the provider.
Provider ID	string	Unique identifier of the provider.
NPI	string	National Provider Identification number of the provider.
Tax ID	string	Tax ID of the provider.

Sample Response

 {
  "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
    }
  ]
}

Get Provider API

Description

Path

Method Type

Get provider information.

/write/get-provider

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	string	Name of the dental office.
Provider ID	string	Unique identifier of the provider.

Sample Response

{
  "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
    }
  ]
}

Update Provider API

Description

Path

Method Type

Update the provider information in the database.

/write/update-provider

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	string	Name of the dental office.
Provider ID	string	Unique identifier of the provider.

Sample Response

{
  "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
    }
  ]
}

Add Payor Credentials API

Description

Path

Method Type

Add payor credentials to the database.

/add-payor-credential

POST

Request Parameters

Parameter	Data Type	Description
User Name	string	Username of the payor.
Password	string	Password of the payor.
U R L	string	URL of the payor.
Integrated Products	string	Internal product id for VOIB, Claims PP etc
Dental Office	string	Name of the dental office associated with the payor.
Practice Location	string	Location of the
Payor	string	Name of the payor.
Provider ID	string	Unique identifier of the provider associated with the payor.
Image URL	string	Refers to a image file link used for identification purposes or for verifying information related to the payor.
Notes	string	Add any additional information.

Sample Response

{
  "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
    }
  ]
}

Get Payor Credentials API

Description

Path

Method Type

Get payor credentials.

/write/get-payor-credential

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	string	Name of the dental office.
Practice Location	string	Location of the clinic.
Payor	string	Name of the payor.
Integrated Products	string	Internal product id for VOIB, Claims PP etc

Sample Response

{
  "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
    }
  ]
}

Update Payor Credential API

Description

Path

Method Type

Update the payor credential information in the database.

/write/update-payor-credential

POST

Request Parameters

Parameter	Data Type	Description
Payload	JSON	Payload that contains the payor credentials information to be updated.

Sample Response

{
  "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
    }
  ]
}

Upload Document API

Description

Path

Method Type

Updates the payor credentials information.

/write/upload-document

POST

Request Parameters

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.
base64 Format File	Base64	Used for encoding files or data that need to be transmitted over mediums that handle text, such as emails or URLs.
File Extension	string	Suffix at the end of a file name that indicates the type of file and which program can open it.
Document Category	string	Refers to the classification or grouping of documents based on specific criteria, such as content, purpose, or format.
If Other Please Specify	string	Refers to other type of doc category apart from what is mentioned in the doc category column
File Type	string	Refers to the format or type of a file.
Document Description	string	Summary of the document.
Date	date	Date the document is uploaded.
Tooth number	string	The tooth number for which the treatment is done.

Sample Response

{
  "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
    }
  ]
}

Revenue Cycle Management (RCM) APIs

This section provides information for the following KPIs:

Get Eligibility Verification API
Update Verification API
Claim Follow-up up API

Add Eligibility Verification API

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

Request Parameters

Parameter	Data Type	Description
Relationship To Subscriber	string	Relationship of the patient with the subscriber.
Dental Office	string	Name of the dental office.
Practice Location	string	Location of the dental clinic.
Patient First Name	string	First name of the patient.
Patient Last Name	string	Last name of the patient.
Provider Id	string	Unique ID of the provider who has rendered the service.
Patient D O B	date	Date of birth of the patient.
Payor	string	Name of the insurer company.
Type	string	Type of claim (primary, secondary, tertiary, and so on).
Appointment Date Time	date	Appointment date for the patient.
Subscriber First Name	string	First name of the subscriber.
Subscriber Last Name	string	Last name of the subscriber.
Subscriber D O B	date	Date of birth of the subscriber.
Subscriber ID	string	Unique ID of the subscriber.
Patient Insured ID	string	Insurance ID of the patient.
Medicaid Id	string	Code that uniquely identifies the geographic location where the provider's services were performed.
Gender	string	Patient’s gender.
Appointment Amount	float	Amount to be paid for the scheduled appointment.

Sample Response

{
  "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
    }
  ]
}

Get Eligibility Verification API

Description

Path

Method Type

End point for Patient Insurance Verifications

/rcm/get-verification

POST

Request Parameters

Parameter	Data Type	Description
Page Size	int	Number of records in a page.
End Date	date	Date until when you want the data to be included in the report. The format is yyyy-mm-dd.
Page Index	int	Index of the page (example 1,2,3).
Practice Location	int	Location of the dental clinic.
Dental Office	From the drop-down menu, select a dental office.	Name of the dental clinic.
Start Date	date	Date from when you want the data to be included in the report. The format is yyyy-mm-dd.
Patient First Name	string	First name of the patient.
Patient Last Name	string	Last name of the patient.
Patient D O B	datetime	Date of birth of the patient. The format must be in mm/dd/yyyy format, where mm is month, dd is day, and yyyy is year.
Patient Insured Id	string	Insurance ID of the patient.

Sample Response

{
  "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
    }
  ]
}

Update Verification API

Description

Path

Method Type

Allows for the validation and verification of various data points.

/rcm/update-verification

POST

Request Parameters

Parameter	Data Type	Description
Payload	Json	Payload that contains the payor credentials information to be updated.

Sample Response

{
  "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
    }
  ]
}

Claim Follow up API

Description

Path

Method Type

Follow up on the claims that are already submitted by the clinic.

/rcm/claims-verification

POST

Request Parameters

Parameter	Data Type	Description
Dental Office	string	Name of the dental clinic.
Practice Location	string	Location of the dental clinic.
Provider ID	string	Unique ID of the provider.
First Name	string	First name of the patient.
Middle Name	string	Middle name of the patient.
Last Name	string	Last name of the patient.
Patient D O B	date	Date of the birth of the patient.
Payor	string	Name of the insurer company.
Claim Type	string	Type of claim (primary, secondary, tertiary, and so on).
Date Of Service	date	Date when the treatment was availed.
Claim Date Sent	date	Date when the claim was sent.
Subscriber First Name	string	Subscriber’s first name.
Subscriber Last Name	string	Subscriber’s last name.
Subscriber D O B	date	Subscriber’s date of birth.
Subscriber ID	string	Unique ID of the subscriber.
Total Submitted Amount	float	Total claim amount submitted.
Claims Procedures	Jsonarray	Sample JSON: [{"procedureCode": "string","procedureFee":0,"procedureDate":"2024-07-09T09:27:56.346Z"}]

Sample Response

{
  "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
    }
  ]
}

Write Back Patient Payments API

Description

Path

Method Type

Writes back patient payments into PMS.

/rcm/patientpaymentswriteback

POST

Request Parameters

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.
Payment Amount	double	Patient Payment Amount
Payment Date	date	Date when the payment for the treatment was done.
Date Of Service	date	Date the treatment was availed.
Provider Id	string	Unique ID of the dentist or provider who rendered the service.
Payment Type	string	Payment was done through cash or cheque.
Cheque Number	string	If payment was done through cheque, specify the cheque number.
C D T Code	string	Code on dental procedures and nomenclature.

Sample Response

{
  "isSucceed": true,
  "errorMessages": null,
  "exception": null,
  "data": true,
  "totalCount": 0
}