Open Dental API

https://www.opendental.com/site/
Admin
The Open Dental API is a RESTful service that allows developers to safely interact with an Open...
Tokens:1,938,665
Snippets:17,045
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Download MariaDB repository setup script

Source: https://www.opendental.com/site/linuxinstall.html

Commands to download and run the MariaDB repository setup script for version targeting. Use for new installations to get the correct MariaDB version.

```bash
wget https://downloads.mariadb.com/MariaDB/mariadb_repo_setup
sudo curl -LsS https://r.mariadb.com/downloads/mariadb_repo_setup | sudo bash -s -- --mariadb-server-version="mariadb-10.11.10"
chmod +x mariadb_repo_setup
```

--------------------------------

### Example 1: Direct database connection shortcut

Source: https://www.opendental.com/site/commandline.html

Command line to launch Open Dental with a direct database connection on the current computer. Uses ServerName, DatabaseName, and MySqlUser arguments.

```text
"C:\Program Files (x86)\Open Dental\OpenDental.exe" ServerName=localhost DatabaseName=opendental MySqlUser=root
```

--------------------------------

### GET /patrestrictions - Example Response

Source: https://www.opendental.com/site/apipatrestrictions.html

Example response for a successful GET request, showing an array of patrestriction objects.

```json
[
{
"PatRestrictionNum": 25,
"PatNum": 106,
"PatRestrictType": "ApptSchedule"
},
{
"PatRestrictionNum": 26,
"PatNum": 107,
"PatRestrictType": "ApptSchedule"
},
etc...
]
```

--------------------------------

### Example Response: POST /procedurelogs

Source: https://www.opendental.com/site/apiprocedurelogs.html

Example response body for a successful creation, showing the created procedure log with all fields.

```json
{
  "ProcNum": 301,
  "PatNum": 29,
  "AptNum": 0,
  "ProcDate": "2021-04-25",
  "ProcFee": "125.95",
  "Surf": "MO",
  "ToothNum": "4",
  "ToothRange": "",
  "Priority": 148,
  "priority": "Low",
  "ProcStatus": "TP",
  "ProvNum": 1,
  "provAbbr": "DOC 1",
  "Dx": 126,
  "dxName": "Cracked Tooth",
  "PlannedAptNum": 0,
  "PlaceService": "Office",
  "Prosthesis": "",
  "DateOriginalProsth": "0001-01-01",
  "ClaimNote": "",
  "DateEntryC": "2021-04-17",
  "ClinicNum": 0,
  "DiagnosticCode": "",
  "IsPrincDiag": "false",
  "CodeNum": 33,
  "procCode": "D2331",
  "descript": "resin-based composite - two surfaces, anterior",
  "UnitQty": 1,
  "BaseUnits": 0,
  "DateTP": "2021-04-17",
  "SiteNum": 0,
  "HideGraphics": "false",
  "CanadianTypeCodes": "",
  "ProcTime": "13:45:00",
  "ProcTimeEnd": "00:00:00",
  "DateTStamp": "",
  "Prognosis": 0,
  "IsLocked": "false",
  "BillingNote": "Courtesy discount approved by Dr. Pinciotti for patient loyalty.",
  "SnomedBodySite": "",
  "DiagnosticCode2": "",
  "DiagnosticCode3": "",
  "DiagnosticCode4": "",
  "Discount": 25.99,
  "IsDateProsthEst": "false",
  "IcdVersion": 10,
  "SecDateEntry": "2021-04-17 09:38:21",
  "DiscountPlanAmt": 0.0,
  "serverDateTime": ""
}
```

--------------------------------

### POST /discountplans Example Response

Source: https://www.opendental.com/site/apidiscountplans.html

Example response body after creating a DiscountPlan. Shows the assigned DiscountPlanNum and all fields with their default values.

```json
{
  "DiscountPlanNum": 3,
  "Description": "Happy Smiles Ultra",
  "FeeSchedNum": 54,
  "DefNum": 336,
  "adjustmentType": "Discount Plan",
  "IsHidden": "false",
  "PlanNote": "",
  "ExamFreqLimit": -1,
  "XrayFreqLimit": -1,
  "ProphyFreqLimit": -1,
  "FluorideFreqLimit": -1,
  "PerioFreqLimit": -1,
  "LimitedExamFreqLimit": -1,
  "PAFreqLimit": -1,
  "AnnualMax": -1.0
}
```

--------------------------------

### GET /patfielddefs - Example Response

Source: https://www.opendental.com/site/apipatfielddefs.html

Example JSON response for the GET request, returning an array of patfielddef objects.

```json
[
{
"PatFieldDefNum": 7,
"FieldName": "Outstanding",
"FieldType": "Currency",
"PickList": "",
"IsHidden": "false"
},
{
"PatFieldDefNum": 8,
"FieldName": "Ortho Status",
"FieldType": "PickList",
"PickList": "",
"IsHidden": "false"
},
{
"PatFieldDefNum": 11,
"FieldName": "Accommodations",
"FieldType": "Text",
"PickList": "",
"IsHidden": "false"
}
]
```

--------------------------------

### TreatPlans GET Example Response

Source: https://www.opendental.com/site/apitreatplans.html

Example JSON response for a GET /treatplans request, showing an array of treatplan objects.

```json
[
{
"TreatPlanNum": 1786,
"PatNum": 1897,
"DateTP": "0001-01-01",
"Heading": "Active Treatment Plan",
"Note": "Please read this carefully:\nIf you have insurance, THIS IS AN ESTIMATE ONLY. Insurance might not pay what we expect.\nEven if you pay your estimate ahead of time, you will still be responsible for any portion that insurance does not pay.",
"SigIsTopaz": "false",
"ResponsParty": 0,
"DocNum": 0,
"TPStatus": "Active",
"SecUserNumEntry": 12,
"SecDateEntry": "2022-07-02",
"SecDateTEdit": "2022-07-02 09:39:54",
"UserNumPresenter": 0,
"TPType": "Insurance",
"DateTSigned": "0001-01-01 00:00:00",
"DateTPracticeSigned": "0001-01-01 00:00:00",
"SignatureText": "",
"SignaturePracticeText": "",
"isSigned": "false",
"isSignedPractice": "false"
},
{
"TreatPlanNum": 1787,
"PatNum": 1901,
"DateTP": "0001-01-01",
"Heading": "Active Treatment Plan",
"Note": "Please read this carefully:\nIf you have insurance, THIS IS AN ESTIMATE ONLY. Insurance might not pay what we expect.\nEven if you pay your estimate ahead of time, you will still be responsible for any portion that insurance does not pay.",
"SigIsTopaz": "false",
"ResponsParty": 0,
"DocNum": 0,
"TPStatus": "Active",
"SecUserNumEntry": 12,
"SecDateEntry": "2022-07-02",
"SecDateTEdit": "2022-07-02 10:32:51",
"UserNumPresenter": 0,
"TPType": "Insurance",
"DateTSigned": "0001-01-01 00:00:00",
"DateTPracticeSigned": "0001-01-01 00:00:00",
"SignatureText": "",
"SignaturePracticeText": "",
"isSigned": "false",
"isSignedPractice": "false"
},
{
"TreatPlanNum": 1788,
"PatNum": 1906,
"DateTP": "0001-01-01",
"Heading": "Saved Treatment Plan",
"Note": "Please read this carefully:\nIf you have insurance, THIS IS AN ESTIMATE ONLY. Insurance might not pay what we expect.\nEven if you pay your estimate ahead of time, you will still be responsible for any portion that insurance does not pay.",
"SigIsTopaz": "false",
"ResponsParty": 0,
"DocNum": 0,
"TPStatus": "Saved",
"SecUserNumEntry": 13,
"SecDateEntry": "2022-07-02",
"SecDateTEdit": "2022-07-02 11:39:54",
"UserNumPresenter": 0,
"TPType": "Insurance",
"DateTSigned": "2022-07-02 11:39:54",
"DateTPracticeSigned": "2022-07-02 11:39:54",
"SignatureText": "Brandon Booter",
"SignaturePracticeText": "Dr. Carl Moore",
"isSigned": "true",
"isSignedPractice": "true"
},
etc...
]
```

--------------------------------

### POST /appointments Example Request

Source: https://www.opendental.com/site/apiappointments.html

Example JSON request body for creating an appointment. Required fields: PatNum, Op, AptDateTime. Optional fields include colorOverride.

```json
{
  "PatNum": 21,
  "Op": 6,
  "AptDateTime": "2020-07-31 09:00:00",
  "colorOverride": "100,0,255"
}
```

--------------------------------

### GET /refattaches - Example response

Source: https://www.opendental.com/site/apirefattaches.html

Example JSON response for a GET /refattaches request, showing a list of refattach objects.

```json
[
{
"RefAttachNum": 1,
"ReferralNum": 3,
"referralName": "Steve N Stevens, DDS",
"PatNum": 25,
"ItemOrder": 0,
"RefDate": "2022-01-05",
"ReferralType": "RefFrom",
"RefToStatus": "None",
"Note": "",
"IsTransitionOfCare": "false",
"ProcNum": 0,
"DateProcComplete": "0001-01-01",
"ProvNum": 0,
"DateTStamp": "2022-01-05 10:13:12"
},
etc...
]
```

--------------------------------

### Example GET /appointments requests

Source: https://www.opendental.com/site/apiappointments.html

Four example request URLs demonstrating different query parameter combinations for the GET /appointments endpoint.

```http
GET /appointments?Offset=400
```

```http
GET /appointments?date=2020-07-30&Offset=200
```

```http
GET /appointments?dateStart=2020-07-30&dateEnd=2020-08-02&DateTStamp=2020-07-30 10:30:00&ClinicNum=3
```

```http
GET /appointments?PatNum=20
```
Tokens:
Raw