One API Guide - Dentistry Automation

Dentistry Automation OneAPI Guidelines

Introduction

Dentistry Automation One 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 hello@dentistryautomation.com.

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 HTTPs 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
hello@dentistryautomation.com.

Authorization

To authorize:

After logging into Dentistry Automation portal, click One API on the left pne.
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 Details
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
Total Account Receivable by Guarantor KPI Details
Guarantor wise total AR by Date (End date of a month) KPI Details

Appointment KPI Details

Description

Endpoint

Method Type

Provides the appointment details for a patient.

/oneapi/kpi/appointments

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.
PatientId	string	Unique identifier of the patient from the source.
ClinicNum	string	Unique identifier of the clinic
AppointmentDateTime	datetime	Date and time of the appointment.

Response Parameters

Parameter	Data Type	Description
clinicServerId	GUID	Unique identifier of the clinic’s server.
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.
appointmentDateTime	datetimeoffset	Date and time of the appointment.
patientId	Varchar (2000)	Unique identifier for patient. It is system-generated. Links to the patient record.
isNewPatient	tinyint	Indicates whether it is patient’s first visit at this clinic.
appointmentStatus	varchar (100)	Appointment status.
duration	varchar (255)	Treatment or procedure duration.
typeOfVisit	varchar(50)	Type of visit can be Doctor visit, or Hygienist visit, or any other visit.
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.
clinicNum	varchar (100)	Unique identifier for the clinic.
reasonForVisit	Varchar (MAX)	Reason for the patient’s visit to the clinic.
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.
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.
appointmentAmount	decimal(18,2)	Amount for the scheduled appointment.

Sample Response

    
  "isSucceed": true,
  "errorMessages": null,
  "exception": null,
  "totalCount": 80523,
  "data": [
    {
      "clinicServerId": "ba4664b2-1296-63ad-c5d1-91c81aec486b",
      "procedureDate": null,
      "procedureNumber": null,
      "appointmentDateTime": "2022-07-27T00:00:00+00:00",
      "patientId": "33283",
      "isNewPatient": false,
      "appointmentStatus": "Completed",
      "duration": 60,
      "typeOfVisit": "3RDSG",
      "appointmentId": "85566",
      "providerId": "DRT",
      "provider": null,
      "providerFName": "3LCG0VjX/lJWEs0DKUH+XA==",
      "providerLName": "Vhl9ze0IhmoKnu78Jqnc9g==",
      "providerMName": null,
      "providerCategory": null,
      "clinicNum": "1",
      "reasonForVisit": "Arrive at 8:00am to meet Dr. Tyler.
      mom is cool with him doing surg. just wanted to meet him 1st",
      "patientFirstName": null,
      "patientLastName": null,
      "patientMiddleName": null,
      "address1": null,
      "address2": null,
      "city": null,
      "state": null,
      "zipCode": null,
      "homePhone": null,
      "workPhone": null,
      "sourceCreatedUserId": null,
      "etlDataLoadedDate": "2022-04-21T09:15:14+00:00",
      "appointmentAmount": 0
    }
  ]

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.

/oneapi/kpi/collection

POST

Request Parameters

The request parameters are:
• Clinic
• Pagesize
• Pageindex
• Startdate
• Enddate
• Patientid
• ClinicNum
• PaymentDate

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": 380503,
  "data": [
    {
      "clinicServerId": "ba4664b2-1296-63ad-c5d1-91c81aec486b",
      "clinicNum": "1",
      "claimPaymentNumber": 0,
      "patientCollection": -77,
      "insuranceCollection": 0,
      "procedureDate": null,
      "procedureNumber": "207815",
      "procedureStatus": null,
      "adaCode": "D9230",
  "procedureDescription": "Analgesia N20-O2",
      "patientId": "17410",
      "patientFirstName": null,
      "patientLastName": null,
      "patientMiddleName": null,
      "appointmentId": null,
      "providerId": "GRH",
      "provider": null,
      "providerFName": "RQWCj5keHlPijF5MpnhqNA==",
      "providerLName": "L8kaJpUThshJipmaORUB2g==",
      "providerMName": "Michael",
      "providerCategory": "OSY",
      "paymentDate": "2012-04-05T00:00:00+00:00",
      "collectionNumber": "63971-207815-P",
      "carrierId": null,
      "carrierName": null,
      "paymentType": "Cash",
      "checkNumber": "",
      "sourceCreatedUserId": null,
      "etlDataLoadedDate": "2022-04-22T06:15:25+00:00"
      "isSourceDeleted": false
    }
  ]
}

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.

/oneapi/kpi/production

POST

Request Parameters

The request parameters are:

Clinic
PageSize
PageIndex
StartDate
EndDate
PatientId
ClinicNum
ProcedureDate

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.
procedureDate	datetimeoffset	Date when the doctor has given a treatment plan to the patient.
procedureNumber	varchar (100)	Unique identifier for the treatment plan. It is system-generated.
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.
productionAmount	Decimal (18, 2)	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	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.
clinicNum	varchar (100)	Unique identifier for the clinic.
adaCode	varchar (100)	Procedure code or ADA code based on CDA. For example, D1101
procedureDesc	varchar (100)	Brief description about the treatment.
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.
providerCategory	varchar (100)	Specialty of the provider.
invoiceId	varchar (100)	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.

Sample Response

{
  "isSucceed": true,
  "errorMessages": null,
  "exception": null,
  "totalCount": 197674,
  "data": [
    {
      "clinicServerId": "d95b7ed8-69fa-56f7-afda-f8b47a1850b1",
      "procedureDate": "2019-07-08T00:00:00+00:00",
      "procedureNumber": "140463",
      "patientId": "256321",
      "patientFirstName": "Kampton",
      "patientLastName": "Fuller",
      "patientMiddleName": "",
      "appointmentId": null,
      "productionAmount": "449.00",
      "providerId": "3",
      "provider": "DDS",
      "providerFName": "William       ",
      "providerLName": "McBee",
      "providerMName": "L.",
      "clinicNum": "01",
      "adaCode": "D7240",
      "procedureDesc": "Impacted Tooth-completely bony",
      "sourceCreatedUserId": null,
      "etlDataLoadedDate": "2022-05-13T09:41:18+00:00",
      "providerCategory": "OSY",
      "invoiceId": "78874",
      "isSourceDeleted": false,
      "procedureStatus": null
    }
  ]
}

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.

/oneapi/kpi/adjustment

POST

Request Parameters

The request parameters are:

Clinic
Pagesize
Pageindex
Startdate
Enddate
Patientid
ClinicNum
AdjustmentDate

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.

/oneapi/kpi/new-patients

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.
PatientId	string	Unique identifier of the patient from the source.
ProviderId	string	Unique identifier for the provider. Links to the provider record.
ClinicNum	string	Unique identifier of the clinic from the source.
ProviderCategory	string	Specialty of the provider.
First visit start date	datetime	Start date to check how many patients visited the clinic for the first time
First visit end date	datetime	End date to check how many patients visited the clinic for the first time.

Response Parameters

Parameter	Data Type	Description
id	PK	Primary key of the data context.
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.
firstVisitDate	datetimeoffset	Date when the patient visited the clinic for the first time.
providerId	varchar (100)	Unique identifier for the provider. Links to the provider record.
providerFirstName	varchar (100)	Provider’s first name. Links to the provider record.
providerLastName	varchar (100)	Provider’s last name. Links to the provider record.
clinicNum	varchar (100)	Unique identifier for the clinic.
providerCategory	varchar (100)	Specialty of the provider.
sourceCreatedUserId	varchar (100)	ID of the user who created the record in the source PMS.
sourceCreatedDate	datetimeoffset	Date when the record was created at source.
sourceModifiedUserId	varchar (100)	ID of the user who modified the record in the source PMS.
sourceUpdatedDate	datetimeoffset	Date when the record was updated at source.
clinicServerId	GUID	Unique identifier of the clinic’s server.
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": 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.

oneapi/kpi/doctor-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 for the provider. Links to the provider record.
ClinicNum	string	Unique identifier of the clinic.
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.
appointmentId	varchar (100)	Unique identifier for the appointment that the patient has taken with the clinic. It is system-generated.
doctorProduction	Decimal (18,2)	Amount generated by doctor or Dentist
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
procedureDescription	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": 0,
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "clinicServerId": "00000000-0000-0000-0000-000000000000",
      "procedureDate": "0001-01-01T00:00:00+00:00",
      "procedureNumber": null,
      "patientId": null,
      "patientFirstName": null,
      "patientLastName": null,
      "patientMiddleName": null,
      "appointmentId": null,
      "doctorProduction": 0,
      "providerId": null,
      "provider": null,
      "providerFName": null,
      "providerLName": null,
      "providerMName": null,
      "providerCategory": null,
      "clinicNum": null,
      "adaCode": null,
      "procedureDescription": null,
      "sourceCreatedUserId": null,
      "etlDataLoadedDate": "0001-01-01T00:00:00+00:00",
      "etlDataUpdatedDate": "0001-01-01T00:00:00+00:00",
      "invoiceId": null,
      "sourceUpdatedDate": "0001-01-01T00:00:00+00:00",
      "procedureStatus": null,
      "isSourceDeleted": false
    }
  ]
}

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.

oneapi/kpi/broken-appointments

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.
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)	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	string	Unique identifier of 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": 0,
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "clinicServerId": "00000000-0000-0000-0000-000000000000",
      "patientId": null,
      "patientFirstName": null,
      "patientLastName": null,
      "patientMiddleName": null,
      "address1": null,
      "address2": null,
      "city": null,
      "state": null,
      "zipCode": null,
      "homePhone": null,
      "workPhone": null,
      "responsiblePartyId": null,
      "appointmentId": null,
      "appointmentDateTime": null,
      "isNewPatient": null,
      "appointmentStatus": null,
      "typeOfVisit": null,
      "providerId": null,
      "provider": null,
      "providerFName": null,
      "providerLName": null,
      "providerMName": null,
      "providerCategory": null,
      "clinicNum": null,
      "reasonForVisit": null,
      "sourceCreatedUserId": null,
      "etlDataLoadedDate": "0001-01-01T00:00:00+00:00",
      "etlDataUpdatedDate": "0001-01-01T00:00:00+00:00"
    }
  ]
}

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.

oneapi/kpi/cancel-appointments

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)	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": 0,
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "clinicServerId": "00000000-0000-0000-0000-000000000000",
      "patientId": null,
      "patientFirstName": null,
 "patientLastName": null,
      "patientMiddleName": null,
      "address1": null,
      "address2": null,
      "city": null,
      "state": null,
      "zipCode": null,
      "homePhone": null,
      "workPhone": null,
      "responsiblePartyId": null,
      "appointmentId": null,
      "appointmentDateTime": null,
      "isNewPatient": null,
      "appointmentStatus": null,
      "typeOfVisit": null,
      "providerId": null,
      "provider": null,
      "providerFName": null,
      "providerLName": null,
      "providerMName": null,
      "providerCategory": null,
      "clinicNum": null,
      "reasonForVisit": null,
      "sourceCreatedUserId": null,
      "etlDataLoadedDate": "0001-01-01T00:00:00+00:00",
      "etlDataUpdatedDate": "0001-01-01T00:00:00+00:00"
    }
  ]
}

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.

oneapi/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": 0,
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "clinicServerId": "00000000-0000-0000-0000-000000000000",
      "procedureDate": "0001-01-01T00:00:00+00:00",
      "procedureNumber": null,
      "patientId": null,
      "patientFirstName": null,
      "patientLastName": null,
      "patientMiddleName": null,
      "responsiblePartyId": null,
      "appointmentId": null,
      "hygieneProduction": 0,
      "providerId": null,
      "provider": null,
      "providerFName": null,
      "providerLName": null,
      "providerMName": null,
      "providerCategory": null,
      "clinicNum": null,
      "adaCode": null,
      "procedureDesc": null,
      "sourceCreatedUserId": null,
      "etlDataLoadedDate": "0001-01-01T00:00:00+00:00",
      "etlDataUpdatedDate": "0001-01-01T00:00:00+00:00",
      "invoiceId": null,
      "sourceUpdatedDate": "0001-01-01T00:00:00+00:00",
      "procedureStatus": null,
      "isSourceDeleted": false
    }
  ]
}

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.

/oneapi/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": 0,
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "clinicServerId": "00000000-0000-0000-0000-000000000000",
      "patientId": null,
      "patientFirstName": null,
      "patientLastName": null,
      "patientMiddleName": null,
      "address1": null,
      "address2": null,
      "city": null,
      "state": null,
      "zipCode": null,
      "homePhone": null,
      "workPhone": null,
      "responsiblePartyId": null,
      "appointmentId": null,
      "appointmentDateTime": null,
      "isNewPatient": null,
      "appointmentStatus": null,
      "typeOfVisit": null,
      "providerId": null,
      "provider": null,
      "providerFName": null,
      "providerLName": null,
      "providerMName": null,
      "providerCategory": null,
      "clinicNum": null,
      "reasonForVisit": null,
      "sourceCreatedUserId": null,
      "etlDataLoadedDate": "0001-01-01T00:00:00+00:00",
      "etlDataUpdatedDate": "0001-01-01T00:00:00+00:00"
    }
  ]
}

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.

/oneapi/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.)

/oneapi/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

/oneapi/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

/oneapi/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:

Practice Details API
Patient Details API
Carrier Details API
Service Codes API
Provider Details API
Insurance Claim Details API

Practice Details API

Description

Endpoint

Method Type

Provides the details of the clinic.

/oneapi/clinics

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.
ClinicNum	string	Unique identifier of the clinic from the source.
ClinicName	string	Name of the clinic.
IsActive	string	Status of the patient whether the patient is active or inactive.

Response Parameters

Parameter	Data Type	Description
id	PK	Unique identifier for the data context.
clinicNum	varchar (100)	Unique identifier for the clinic.
clinicName	varchar (100)	Name of the clinic.
address1	varchar (100)	Clinic’s address 1.
address2	varchar (100)	Clinic’s address 2.
city	varchar (100)	Clinic’s city.
state	varchar (100)	Clinic’s state.
zipCode	varchar (100)	Clinic’s zip code.
phoneNumber	Varchar (30)	Clinic’s phone number.
phoneExt	Varchar (30)	Clinic’s extension number.
email	Varchar (255)	Clinic’s email ID.
isActive	varchar (100)	Status of the Clinic whether the clinic is active or inactive.
clinicServerId	GUID	Unique identifier of the clinic’s server.
comments	Varchar (MAX)	comments
sourceCreatedUserId	varchar (100)	ID of the user who created the record in the source PMS.
sourceCreatedDate	datetimeoffset	Date when the record was created at source.
sourceModifiedUserId	varchar (100)	ID of the user who modified the record at source PMS.
sourceUpdatedDate	datetimeoffset	Date when the record was updated at source.
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": 31,
  "data": [
    {
      "id": "ccaa52e0-f46f-48f5-98c3-02b77247329e",
      "clinicNum": "123",
      "clinicName": "Creek Dental Group Surgical Arts",
      "address1": "530 EAST 500 SOUTH",
      "address2": "",
      "city": "Salt Lake City",
      "state": "UT",
      "zipCode": "84102",
      "phoneNumber": "8017478017",
      "phoneExt": null,
      "email": "",
  "isActive": null,
      "clinicServerId": "4126d728-5076-54dd-9078-b2eecafc4ee8",
      "comments": null,
      "sourceCreatedUserId": "BURGADMIN",
      "sourceCreatedDate": "2020-02-26T10:19:00+00:00",
      "sourceModifiedUserId": "SCOON",
      "sourceUpdatedDate": "2021-11-09T10:44:00+00:00",
      "eTLDataLoadedDate": "2022-05-20T03:20:04",
      "eTLDataUpdatedDate": null
    }
  ]
}

Response Codes

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

Patient Details API

Description

Path

Method Type

Provides the details of the patient.

/oneapi/patients

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.
PatientId	varchar (2000)	Unique identifier for patient. It is system-generated. Links to the patient record.
ClinicNum	string	Unique identifier of the clinic from the source.
Firstname	string	Patient’s first name.
LastName	string	Patient’s last name.
PatientStatus	string	Status of the patient-active or inactive.

Response Parameters

Parameter	Data Type	Description
id	PK	Unique identifier of the data context
patientId	varchar (2000)	Unique identifier for patient. It is system-generated. Links to the patient record.
firstName	varchar (100)	Patient’s first name. Links to the patient record.
lastName	varchar (100)	Patient’s last name. Links to the patient record.
middleName	varchar (100)	Patient’s middle name. Links to the patient record.
salutation	varchar (100)	Title of the patient’s name such as Mr., Miss., Mrs., Dr., and so on.
preferredName	varchar (100)	Preferred name of the patient.
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 zip code.
homePhone	Varchar (30)	Patient’s home phone number.
workPhone	Varchar (30)	Patient’s work phone number
patientStatus	Varchar (10)	Status of the patient whether the patient is active or inactive.
birthDate	varchar (100)	Patient’s date of birth.
accountBalance	Decimal (18,2)	Patients account balance
recallMethod	Varchar (50)	Patients recall method
guardianID	Varchar (50)	Unique ID for the patient’s guardian.
sSN	Varchar (50)	Social Security Number
genderInfo	Varchar (10)	Patient’s gender info
emailID	Varchar (255)	Patient’s email ID.
thirtyDay	Decimal (18, 2)	Due amount that must be received by the clinic in 30 days.
sixtyDay	Decimal (18, 2)	Due amount that must be received by the clinic in 60 days.
ninetyDay	Decimal (18, 2)	Due amount that must be received by the clinic in 90 days.
overNinety	Decimal (18, 2)	Due amount that must be received by the clinic in 90+ days.
estimatedInsurance	Decimal (18, 2)	Estimated insurance of the patient.
contractBalance	Decimal (18, 2)	Balance remaining in the insurance contract.
firstVisitDate	datetimeoffset	Date when the patient visited the clinic for the first time.
lastDateSeen	datetimeoffset	Date when the patient completed the treatment or service.
employerId	Bigint (20)	Unique identifier of the patient’s employer
responsible	Varchar (50)	Person responsible for medical decisions other than finances. Guarantor is responsible for finances. This is useful for nursing home residents. Part of public health.
chartNumber	Varchar (50)	Chart number
primaryProviderId	Varchar (100)	Unique identifier for the primary provider.
sourceCreatedUserId	varchar (100)	ID of the user who created the record in the source PMS.
sourceCreatedDate	datetimeoffset	Date when the record was created at source.
sourceModifiedUserId	varchar (100)	ID of the user who modified the record at source PMS.
sourceUpdatedDate	datetimeoffset	Date when the record was updated at source.
clinicServerId	[int]	Unique identifier of the clinic’s server.
eTLDataLoadedDate	datetimeoffset	Date when the data was loaded to Dentistry Automation.
eTLDataUpdatedDate	datetimeoffset	Date when the data was updated in Dentistry Automation.
clinicNum	varchar (100)	Unique identifier for the clinic.

Sample Response


{
  "isSucceed": true,
  "errorMessages": null,
  "exception": null,
  "totalCount": 85947,
  "data": [
    {
      "id": "5e274460-5bbd-4da1-b68c-e8dad164cfdc",
      "patientId": "141854",
      "firstName": "Tina",
      "lastName": "Edmunds",
      "middleName": null,
      "salutation": null,
      "preferredName": null,
      "address1": "1275 E 530 N",
      "address2": null,
      "city": "Orem",
      "state": "UT",
      "zipCode": "84097",
      "homePhone": "8012210000",
      "workPhone": null,
      "patientStatus": "1",
      "birthDate": "02/21/1988 12:00:00 AM",
      "accountBalance": 0,
      "recallMethod": null,
      "guardianID": null,
      "sSN": null,
      "genderInfo": "F",
      "emailID": null,
      "thirtyDay": null,
      "sixtyDay": null,
      "ninetyDay": null,
      "overNinety": null,
      "estimatedInsurance": null,
      "contractBalance": null,
      "firstVisitDate": null,
      "lastDateSeen": null,
      "employerId": null,
      "responsible": null,
      "chartNumber": null,
      "primaryProviderId": null,
      "sourceCreatedUserId": null,
      "sourceCreatedDate": null,
      "sourceModifiedUserId": null,
      "sourceUpdatedDate": null,
      "clinicServerId": "d95b7ed8-69fa-56f7-afda-f8b47a1850b1",
      "eTLDataLoadedDate": "2022-05-13T09:39:13",
      "eTLDataUpdatedDate": null,
      "clinicNum": null
    }
  ]
}

Response Codes

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

Carrier Details API

Description

Path

Method Type

Insurance company details

/oneapi/payors

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.
IsActive	string	Status of the Payor whether the patient is active or inactive.
CarrierId	string	Insurance carrier ID.
CarrierName	string	Insurance carrier name.

Response Parameters

Parameter	Data Type	Description
id	PK	Unique identifier of the data context.
carrierId	varchar (100)	Insurance carrier ID.
companyName	varchar (255)	Insurance carrier name.
address1	Varchar [(255)	Carrier’s address one.
address2	varchar (255)	Carrier’s address two.
city	varchar (255)	Carrier’s city.
state	varchar (255)	Carrier’s state.
zipCode	varchar (255)	Carrier’s Postal code.
phoneNumber	varchar (255)	Carrier’s phone number.
phoneExt	Varchar (30)	Carrier’s phone extension number.
carrierGroupId	varchar (100)	Carrier Group Id.
isActive	Varchar (10)	Status of the Payor whether the Payor is active or inactive.
sourceCreatedUserId	varchar (100)	ID of the user who created the record in the source PMS.
sourceCreatedDate	datetimeoffset	Date when the record was created at source.
sourceModifiedUserId	varchar (100)	ID of the user who modified the record at source PMS.
sourceUpdatedDate	datetimeoffset	Date when the record was updated at source.
clinicServerId	GUID	Unique identifier of the clinic’s server.
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": 449,
  "data": [
    {
      "id": "b06ca3a0-d499-4505-9c6c-00ca43a6a761",
      "carrierId": "MOUNT",
      "companyName": "Mountain States",
      "address1": null,
      "address2": null,
      "city": null,
      "state": null,
      "zipCode": null,
      "phoneNumber": null,
      "phoneExt": null,
      "carrierGroupId": null,
      "isActive": "1",
      "sourceCreatedUserId": null,
      "sourceCreatedDate": null,
      "sourceModifiedUserId": null,
      "sourceUpdatedDate": null,
      "clinicServerId": "ba4664b2-1296-63ad-c5d1-91c81aec486b",
      "eTLDataLoadedDate": "2022-04-21T09:00:01",
      "eTLDataUpdatedDate": null
    }
  ]
}

Response Codes

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

Service Codes API

Description

Path

Method Type

Provides procedure code or service code details.

/oneapi/procedure-codes

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.
ProcedureCodeId	string	Unique identifier of the procedure or treatment. It is system-generated. Links to the patient record.
Status	string	Treatment or procedure status. Values are Accepted, Processed, Completed, and so on.

{
  "isSucceed": true,
  "errorMessages": null,
  "exception": null,
  "totalCount": 449,
  "data": [
    {
      "id": "b06ca3a0-d499-4505-9c6c-00ca43a6a761",
      "carrierId": "MOUNT",
      "companyName": "Mountain States",
      "address1": null,
      "address2": null,
      "city": null,
      "state": null,
      "zipCode": null,
      "phoneNumber": null,
      "phoneExt": null,
      "carrierGroupId": null,
      "isActive": "1",
      "sourceCreatedUserId": null,
      "sourceCreatedDate": null,
      "sourceModifiedUserId": null,
      "sourceUpdatedDate": null,
      "clinicServerId": "ba4664b2-1296-63ad-c5d1-91c81aec486b",
      "eTLDataLoadedDate": "2022-04-21T09:00:01",
      "eTLDataUpdatedDate": null
    }
  ]
}

Response Parameters

Parameter	Data Type	Description
id	PK	Unique identifier of the data context
procedureCodeId	varchar (100)	Unique identifier of the procedure or treatment. It is system-generated. Links to the patient record.
adaCode	Varchar (20)	Procedure code or ADA code based on CDA.
description	varchar (255)	Brief description about the treatment.
abbrevDescription	varchar (255)	Short description of the procedure/treatment
procedureCategory	Varchar (50)	Category of the procedure.
treatmentArea	Varchar (50)	Procedure or treatment area.
billInsuranceFlag	Varchar (10)	Indicates whether the procedure (treatment) can be billed to insurance or not.
hasProsthesis	Varchar (10)	Indicates whether the procedure is one of the prosthesis types (example, crown, bridge, denture, and so on).
status	Varchar (10)	Treatment or procedure status. Values are Accepted, Processed, Completed, and so on.
note	Varchar (MAX)	comments
sourceUpdatedDate	datetimeoffset	Date when the record was updated at source.
clinicServerId	GUID	Unique identifier of the clinic’s server.
eTLDataLoadedDate	datetimeoffset	Date when the data was loaded to Dentistry Automation.
eTLDataUpdatedDate	datetimeoffset	Date when the data was updated in Dentistry Automation.

Sample Response

Response Codes

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

Provider Details API

Description

Path

Method Type

Provides details about the provider.

/oneapi/providers

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.
ProviderId	string	Unique identifier for provider. It is system-generated.
FirstName	string	Provider’s first name. Links to the provider record.
LastName	string	Provider’s last name. Links to the provider record.
Speciality	string	Specialization area of the provider.

Response Parameters

Parameter	Data Type	Description
id	PK	Unique identifier of the data context.
providerId	varchar (100)	Unique identifier for provider. It is system-generated.
firstName	varchar (100)	Provider’s first name. Links to the provider record.
lastName	varchar (100)	Provider’s last name. Links to the provider record.
middleInitial	varchar (100)	Provider’s middle name. Links to the provider record.
suffix	varchar (100)	Provider’s suffix
address1	varchar (100)	Provider’s address one.
address2	varchar (100)	Provider’s address two.
city	Varchar (30)	Provider’s city.
state	Varchar (30)	Provider’s state.
zipCode	Varchar (20)	Provider’s postal code.
workPhone	Varchar (50)	Provider’s phone number.
workPhoneExt	Varchar (30)	Provider’s phone extension number.
ssn	Varchar (20)	Social Security Number.
isActive	Varchar (10)	Status of the provider whether the provider is active or inactive.
medicaidId	Varchar (50)	Medical ID of the provider.
taxId	Varchar (50)	Tax ID of the provider.
npi	Varchar (100)	National Provider Identifier.
stateId	Varchar (20)	State ID of the provider.
blueCrossId	Varchar (30)	Blue Cross ID of the provider.
isPrimaryProvider	Varchar (0)	Indicates whether the provider is the primary provider for the patient or not.
speciality	Varchar (50)	Provider specialty such as Dentist, Hygienist, and so on.
providerNumber	varchar (100)	Provider number (alternate to provider ID).
isNotPerson	Varchar (50)	Indicates whether provider is not an actual provider but billing person.
sourceCreatedDate	datetimeoffset	Date when the record was created at source.
sourceUpdatedDate	datetimeoffset	Date when the record was updated at source.
clinicServerId	GUID	Unique identifier of the clinic’s server.
etlDataLoadedDate	datetimeoffset	Date when the data was loaded to Dentistry Automation.
etlDataUpdatedDate	datetimeoffset	Date when the data was updated in Dentistry Automation.
abbreviation	Varchar (MAX)	Abbreviation of provider (max of 5 characters).
totalCount	Int	Total count of records.

{
  "isSucceed": true,
  "errorMessages": null,
  "exception": null,
  "totalCount": 17,
  "data": [
    {
      "id": "4a51300a-666d-4e3c-902e-1127c0d604b3",
      "providerId": "115",
      "firstName": "Gregory",
 "lastName": "Biddulph",
      "middleInitial": null,
      "suffix": null,
      "address1": "1275 E Fort Union Blvd",
      "address2": "Ste 100",
      "city": "Midvale",
      "state": "UT",
      "zipCode": "84047",
      "workPhone": "8012681135",
      "workPhoneExt": null,
      "ssn": null,
      "isActive": "Y",
      "medicaidId": null,
      "taxId": "854364176",
      "npi": "1932237856",
      "stateId": null,
      "blueCrossId": null,
      "isPrimaryProvider": null,
      "speciality": "Dentist",
      "providerNumber": null,
      "isNotPerson": null,
      "sourceCreatedDate": "2019-09-23T12:00:00+00:00",
      "sourceUpdatedDate": "2022-05-16T14:43:00+00:00",
      "clinicServerId": "4126d728-5076-54dd-9078-b2eecafc4ee8",
      "etlDataLoadedDate": "2022-05-24T10:40:06",
      "etlDataUpdatedDate": "2022-05-24T13:00:02",
      "abbreviation": "DRGB",
      "totalCount": 17
    }
  ]
}

Sample Response

Response Codes

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

Insurance Claim Details API

Description

Path

Method Type

Provides details about the insurance claim.

/oneapi/claims

POST

Request Parameters

Parameter	Data Type	Description
Clinic Server Id	string	Unique ID of the server associated with the clinic.
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.
Patientid	string	Unique identifier for patient. It is system-generated.
ClinicNum	varchar	Unique identifier of the clinic from the source.
ClaimDateSent	datetime	Date when claim was sent to the insurance company
StartTime	datetime	Date range to search the data.
EndTime	datetime	Date range to search the data.

Response Parameters

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

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, ",
      "PrimaryInsuranceCarrierId": "18006, ",
      "ClaimFee": "500, ",
      "InsurancePayEstimation": "500, ",
      "ClaimType": "P, ",
      "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, ",
      "SecondaryInsuranceCarrierId": "11806, ",
      "ClaimDateReceived": "2022-10-12 10:17:33.097, ",
      "ClinicNum": "2, ",
      "ClaimUCRAmount": "400, ",
      "ClaimBilledAmount": "500, ",
      "ClaimReceivedAmount": "500, ",
      "CheckNumber": "14231, ",
      "ProviderId": "1, ",
      "GuarantorId": "10324, "
    }
  ]
}

Response Codes

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