@rinse-dental/open-dental 3.4.2 → 4.0.2

package/docs/Open Dental 2026-04-22/apireports.md

@@ -0,0 +1,85 @@
+# API: Reports
+
+**Source:** https://www.opendental.com/site/apireports.html
+**Extracted:** 2026-04-22
+**Base Path:** `/reports`
+
+---
+
+## Overview
+
+The Reports API provides access to pre-built financial reports, including aging balances and finance charge history. Results are scoped per office and support date range, provider, and clinic filtering.
+
+---
+
+## Endpoints
+
+### GET /reports/Aging
+
+**Version:** 21.4
+**Description:** Retrieves aging balances for guarantors as of a specified date. Returns one row per guarantor family.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| DateAsOf | string (yyyy-MM-dd) | No | Today's date | Returns aging balances as of this date |
+| ClinicNum | integer | No | — | Filter to a specific clinic's account entries (v22.2+) |
+| Offset | integer | No | 0 | Pagination offset |
+
+**Response:** array of objects
+| Field | Type | Description |
+|-------|------|-------------|
+| PatNum | integer | PatNum of the guarantor |
+| patName | string | Guarantor's first and last name |
+| Bal_0_30 | decimal | Balance 0–30 days past due |
+| Bal_31_60 | decimal | Balance 31–60 days past due |
+| Bal_61_90 | decimal | Balance 61–90 days past due |
+| BalOver90 | decimal | Balance greater than 90 days past due |
+| BalTotal | decimal | Total amount owed by the family before insurance |
+| InsWoEst | decimal | Insurance write-off estimate |
+| InsPayEst | decimal | Estimated insurance payment |
+| PatientPortion | decimal | Calculated as: BalTotal - InsPayEst - InsWoEst |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request |
+
+---
+
+### GET /reports/FinanceCharges
+
+**Version:** 22.2.32
+**Description:** Retrieves finance charge adjustments within a date range, with optional provider and billing type filters.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| DateFrom | string (yyyy-MM-dd) | No | Today's date | Start of date range |
+| DateTo | string (yyyy-MM-dd) | No | Today's date | End of date range |
+| ProvNums | integer array | No | All providers | Filter by provider numbers |
+| BillingTypes | integer array | No | All billing types | Array of definition.DefNum values (Category=4) |
+
+**Response:** array of objects
+| Field | Type | Description |
+|-------|------|-------------|
+| PatNum | integer | Patient identifier |
+| PatName | string | Patient's first and last name |
+| Preferred | string | Patient's preferred name |
+| AdjAmt | decimal | Amount of the finance charge adjustment |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request |
+
+---
+
+## Implementation Notes
+
+- `PatientPortion` in the Aging response is a derived value: `BalTotal - InsPayEst - InsWoEst`.
+- `BillingTypes` parameter for FinanceCharges references definition.DefNum values where Category=4.
+- Both endpoints support pagination via the `Offset` parameter (FinanceCharges inherits standard pagination).
+- `DateFrom` and `DateTo` for FinanceCharges both default to today if omitted, resulting in a single-day report.

package/docs/Open Dental 2026-04-22/apirxpats.md

@@ -0,0 +1,113 @@
+# API: RxPats
+
+**Source:** https://www.opendental.com/site/apirxpats.html
+**DB Schema Ref:** rxpat
+**Extracted:** 2026-04-22
+**Base Path:** `/rxpats`
+
+---
+
+## Overview
+
+RxPats represents patient prescriptions. Each record is a single prescription for one patient, copied from a prescription definition at creation time rather than linked to it. Records include drug, dosing, dispensing, refill, and send-status information, as well as optional links to a pharmacy, clinic, and associated procedure.
+
+---
+
+## Endpoints
+
+### GET /rxpats/{RxNum}
+
+**Version:** 24.2.35
+**Description:** Retrieves a single prescription record by primary key.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| RxNum | integer | Yes | Primary key of the prescription |
+
+**Response:** object
+| Field | Type | Description |
+|-------|------|-------------|
+| RxNum | bigint | Primary key |
+| PatNum | bigint | FK to patient.PatNum |
+| RxDate | date | Date of the prescription |
+| Drug | varchar(255) | Drug name and dosage (e.g., "PenVK 500 mg capsules") |
+| Sig | varchar(255) | Directions for the pharmacist (e.g., "Take 2 tablets twice a day") |
+| Disp | varchar(255) | Amount to dispense (e.g., "12 (twelve)") |
+| Refills | varchar(30) | Number of refills (e.g., "3" or "1 per month") |
+| ProvNum | bigint | FK to provider.ProvNum |
+| Notes | varchar(255) | Staff-only notes; does not appear on printed Rx |
+| PharmacyNum | bigint | FK to pharmacy.PharmacyNum |
+| IsControlled | boolean (tinyint) | True if a controlled substance; affects print formatting |
+| DateTStamp | datetime (timestamp) | Last modified; not user-editable |
+| SendStatus | string | Enum: RxSendStatus (see Field Reference) |
+| IsErxOld | boolean (tinyint) | True for historic prescriptions prior to v15.4 |
+| ErxPharmacyInfo | varchar(255) | eRx pharmacy info string for visual verification |
+| IsProcRequired | boolean (tinyint) | True if a procedure must be attached before printing |
+| ProcNum | bigint | FK to procedure; required when IsProcRequired is true |
+| DaysOfSupply | double | Days the prescription is intended to last; used when IsProcRequired is true |
+| PatientInstruction | text | Directions intended for the patient |
+| ClinicNum | bigint | FK to clinic.ClinicNum |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 404 | NotFound |
+
+---
+
+### GET /rxpats
+
+**Version:** 24.2.35
+**Description:** Retrieves multiple prescription records, optionally filtered by patient.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| PatNum | integer | No | — | FK to patient.PatNum; filters results to a single patient |
+
+**Response:** array of objects (same fields as single GET)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+## Field Reference
+
+### SendStatus (enum: RxSendStatus)
+
+| Value | DB Int | Description |
+|-------|--------|-------------|
+| Unsent | 0 | Not yet sent |
+| InElectQueue | 1 | Electronic queue (proof-of-concept only; not used in production) |
+| SentElect | 2 | Sent electronically |
+| Printed | 3 | Printed |
+| Faxed | 4 | Faxed |
+| CalledIn | 5 | Called in |
+| GaveScript | 6 | Script given to patient |
+| Pending | 7 | Pending |
+
+---
+
+## Implementation Notes
+
+- `Notes` is for internal staff use only and does not appear on the printed prescription.
+- `IsControlled = true` changes the printed format of the prescription.
+- `IsProcRequired` (usually true when `IsControlled` is true) requires `ProcNum` to be set before the Rx can be printed.
+- `IsErxOld = true` marks prescriptions that existed before v15.4; used to keep historical reports accurate.
+- `DateTStamp` is automatically maintained by MySQL and is not user-editable.
+- DB columns `RxCui` and `DosageCode` are deprecated and not relevant for API use.
+
+---
+
+## Related Resources
+
+| Resource | Purpose |
+|----------|---------|
+| Pharmacies | Pharmacy record referenced by PharmacyNum |

package/docs/Open Dental 2026-04-22/apischeduleops.md

@@ -0,0 +1,58 @@
+# API: ScheduleOps
+
+**Source:** https://www.opendental.com/site/apischeduleops.html
+**DB Schema Ref:** scheduleop
+**Extracted:** 2026-04-22
+**Base Path:** `/scheduleops`
+
+---
+
+## Overview
+
+ScheduleOps link schedule blocks to operatories. A single schedule block can be linked to one or more operatories via separate ScheduleOp records. Provider schedule blocks typically have no associated ScheduleOp rows.
+
+---
+
+## Endpoints
+
+### GET /scheduleops
+
+**Version:** 23.2.27
+**Description:** Retrieves a list of schedule-to-operatory link records. Supports optional filtering by schedule or operatory.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| ScheduleNum | integer | No | — | FK to schedule.ScheduleNum; filters to links for a specific schedule block |
+| OperatoryNum | integer | No | — | FK to operatory.OperatoryNum; filters to links for a specific operatory |
+
+**Response:** array of objects
+| Field | Type | Description |
+|-------|------|-------------|
+| ScheduleOpNum | bigint | Primary key |
+| ScheduleNum | bigint | FK to schedule.ScheduleNum |
+| OperatoryNum | bigint | FK to operatory.OperatoryNum |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+## Implementation Notes
+
+- A schedule block can be linked to multiple operatories (one ScheduleOp row per operatory).
+- Provider-type schedule blocks often have no ScheduleOp entries.
+- Query with no parameters returns all ScheduleOp records.
+
+---
+
+## Related Resources
+
+| Resource | Purpose |
+|----------|---------|
+| Schedules | Parent schedule block (ScheduleNum FK target) |
+| Operatories | Operatory linked to the schedule block (OperatoryNum FK target) |

package/docs/Open Dental 2026-04-22/apischedules.md

@@ -0,0 +1,106 @@
+# API: Schedules
+
+**Source:** https://www.opendental.com/site/apischedules.html
+**Extracted:** 2026-04-22
+**Base Path:** `/schedules`
+
+---
+
+## Overview
+
+Schedules represent time blocks assigned to providers, employees, the practice, or blockouts within the appointment module. The API supports retrieval of individual schedule entries and filtered lists.
+
+---
+
+## Endpoints
+
+### GET /schedules/{ScheduleNum}
+
+**Version:** 22.1
+**Description:** Retrieves a single schedule entry by its identifier.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| ScheduleNum | string | Yes | Schedule identifier |
+
+**Response:** object
+| Field | Type | Description |
+|-------|------|-------------|
+| ScheduleNum | string | Schedule identifier |
+| SchedDate | string (YYYY-MM-DD) | Date of the schedule block |
+| StartTime | string (HH:MM:SS) | Start time of the block |
+| StopTime | string (HH:MM:SS) | End time of the block |
+| SchedType | string | "Practice", "Provider", "Blockout", "Employee", or "WebSchedASAP" |
+| ProvNum | string | Provider number; 0 unless SchedType is "Provider" |
+| BlockoutType | string | Definition.DefNum (Category=25); "0" unless SchedType is "Blockout" |
+| blockoutType | string | Blockout description; empty unless SchedType is "Blockout" |
+| Note | string | Additional notes |
+| operatories | string | Operatory identifiers associated with this block |
+| EmployeeNum | string | Employee number; 0 unless SchedType is "Employee" |
+| DateTStamp | string (YYYY-MM-DD HH:MM:SS) | Last updated timestamp |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 404 | Not Found — "Schedule not found" |
+
+---
+
+### GET /schedules
+
+**Version:** 22.1
+**Description:** Retrieves all schedule entries matching specified criteria, sorted by StartTime.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| date | string (YYYY-MM-DD) | No | Today | Single date filter; mutually exclusive with dateStart/dateEnd |
+| dateStart | string (YYYY-MM-DD) | No | — | Date range start (inclusive) |
+| dateEnd | string (YYYY-MM-DD) | No | — | Date range end (inclusive) |
+| SchedType | string | No | — | "Practice", "Provider", "Blockout", "Employee", or "WebSchedASAP" |
+| BlockoutDefNum | string | No | — | Definition.DefNum where Category=25; filters blockout type |
+| ProvNum | string | No | — | Provider identifier |
+| EmployeeNum | string | No | — | Employee identifier |
+
+**Response:** array of objects (same fields as single GET)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request (with explanation) |
+| 404 | Not Found (with explanation) |
+
+---
+
+## Field Reference
+
+### SchedType (enum)
+| Value | Description |
+|-------|-------------|
+| Practice | Practice-wide schedule block |
+| Provider | Provider-specific schedule block |
+| Blockout | Blockout block (see BlockoutType/blockoutType) |
+| Employee | Employee-specific schedule block |
+| WebSchedASAP | Web scheduling ASAP slot |
+
+---
+
+## Implementation Notes
+
+- Results from GET /schedules are sorted by `StartTime`.
+- Certain fields are always "0" depending on SchedType: `ProvNum` is 0 unless SchedType is "Provider"; `EmployeeNum` is 0 unless SchedType is "Employee"; `BlockoutType` is "0" unless SchedType is "Blockout".
+- `BlockoutDefNum` query parameter references definition.DefNum where Category=25.
+- `date` defaults to today when no date parameters are specified.
+
+---
+
+## Related Resources
+| Resource | Purpose |
+|----------|---------|
+| Appointments | Schedule-linked appointment data |
+| Definitions | BlockoutType values (Category=25) |
+| Providers | ProvNum references |
+| Employees | EmployeeNum references |

package/docs/Open Dental 2026-04-22/apisecurity.md

@@ -0,0 +1,53 @@
+# API: Security (SecurityPerms)
+
+**Source:** https://www.opendental.com/site/apisecurity.html
+**Extracted:** 2026-04-22
+**Base Path:** `/securityperms`
+
+---
+
+## Overview
+
+The SecurityPerms endpoint returns all API permissions granted to the dental office associated with the authenticated API key. It is used to inspect which API capabilities are enabled for a given integration.
+
+---
+
+## Endpoints
+
+### GET /securityperms
+
+**Version:** 22.2
+**Description:** Retrieves all API permissions for the dental office associated with the API key in the request header. No query parameters accepted.
+
+**Response:** array of objects
+| Field | Type | Description |
+|-------|------|-------------|
+| Permission | string | Name of the API permission |
+| HasPermission | string | "true" or "false" — whether the permission is granted |
+
+**Example Permission Names:**
+- `ApiReadAll`
+- `ApiAllOthers`
+- `ApiComm`
+- `ApiDocuments`
+- `ApiQueries`
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+
+---
+
+## Implementation Notes
+
+- Authentication is via API Key provided in the request header; no additional parameters are needed.
+- `HasPermission` is returned as a string ("true"/"false"), not a boolean.
+- For the full list of available permission names and their meanings, refer to the API Permissions documentation.
+
+---
+
+## Related Resources
+| Resource | Purpose |
+|----------|---------|
+| SecurityLogs | Audit trail of API actions performed |

package/docs/Open Dental 2026-04-22/apisecuritylogs.md

@@ -0,0 +1,59 @@
+# API: SecurityLogs
+
+**Source:** https://www.opendental.com/site/apisecuritylogs.html
+**Extracted:** 2026-04-22
+**Base Path:** `/securitylogs`
+
+---
+
+## Overview
+
+SecurityLogs provides access to the audit trail of actions performed via the API. All returned records are scoped to the authenticated API developer, allowing developers to review their own API activity.
+
+---
+
+## Endpoints
+
+### GET /securitylogs
+
+**Version:** 23.1.33
+**Description:** Retrieves all security log entries for the API developer making the request, optionally filtered by permission type.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| PermType | string | No | — | Filter by permission type; see Audit Trail Permissions documentation for valid values |
+
+**Response:** array of objects
+| Field | Type | Description |
+|-------|------|-------------|
+| SecurityLogNum | integer | Primary key / unique identifier |
+| PermType | string | Permission type associated with the logged action |
+| UserNum | integer | User number; 0 for API-originated operations |
+| LogDateTime | string (timestamp) | Datetime of the logged action |
+| LogText | string | Descriptive text of the action performed |
+| PatNum | integer | Patient number affected by the action; 0 if not patient-specific |
+| CompName | string | Company/computer name |
+| LogSource | string | Origin of the action (e.g., "API") |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request (with explanation) |
+
+---
+
+## Implementation Notes
+
+- All returned logs are scoped to the authenticated API developer — developers can only see their own API logs.
+- `UserNum` is 0 for API-generated operations (no human user context).
+- `LogSource` will be "API" for actions performed via the API.
+- Valid `PermType` filter values are documented in the Audit Trail Permissions section of the Open Dental documentation.
+
+---
+
+## Related Resources
+| Resource | Purpose |
+|----------|---------|
+| SecurityPerms | Inspect which API permissions are enabled for the office |

package/docs/Open Dental 2026-04-22/apisheetdefs.md

@@ -0,0 +1,118 @@
+# API: SheetDefs
+
+**Source:** https://www.opendental.com/site/apisheetdefs.html
+**DB Schema Ref:** sheetdef
+**Extracted:** 2026-04-22
+**Base Path:** `/sheetdefs`
+
+---
+
+## Overview
+
+SheetDefs are template definitions for sheets (forms). They define the layout, type, and default properties for forms such as consent forms, patient letters, medical histories, and exam sheets. SheetDefs are used as blueprints when creating Sheet instances for patients.
+
+---
+
+## Endpoints
+
+### GET /sheetdefs/{SheetDefNum}
+
+**Version:** 25.1.20
+**Description:** Retrieves a single SheetDef template by its identifier.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| SheetDefNum | integer | Yes | SheetDef primary key |
+
+**Response:** object
+| Field | Type | Description |
+|-------|------|-------------|
+| SheetDefNum | integer | Primary key |
+| Description | string | Name/description of the sheet definition |
+| SheetType | string | Sheet type classification (see SheetTypeEnum) |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 404 | Not Found |
+
+---
+
+### GET /sheetdefs
+
+**Version:** 23.2.5.0
+**Description:** Retrieves a list of SheetDef templates with optional type filtering.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| SheetType | string | No | — | Filter by SheetTypeEnum value (v25.1.20+) |
+
+**Response:** array of objects
+| Field | Type | Description |
+|-------|------|-------------|
+| SheetDefNum | integer | Primary key |
+| Description | string | Name/description of the sheet definition |
+| SheetType | string | Sheet type classification |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request (with explanation) |
+
+---
+
+## Field Reference
+
+### SheetType (enum: SheetTypeEnum)
+| Value | DB Int | Description |
+|-------|--------|-------------|
+| LabelPatient | 0 | Patient label; requires PatNum parameter; not saved to DB |
+| LabelCarrier | 1 | Carrier label; requires CarrierNum parameter; not saved to DB |
+| LabelReferral | 2 | Referral label; requires ReferralNum parameter; not saved to DB |
+| ReferralSlip | 3 | Referral slip; requires PatNum and ReferralNum parameters |
+| LabelAppointment | 4 | Appointment label; requires AptNum parameter; not saved to DB |
+| Rx | 5 | Prescription; requires RxNum parameter |
+| Consent | 6 | Consent form; requires PatNum parameter |
+| PatientLetter | 7 | Patient letter; requires PatNum parameter |
+| ReferralLetter | 8 | Referral letter; requires PatNum and ReferralNum parameters |
+| PatientForm | 9 | Patient form; requires PatNum parameter |
+| RoutingSlip | 10 | Routing slip; requires AptNum parameter; not saved to DB |
+| MedicalHistory | 11 | Medical history form; requires PatNum parameter |
+| LabSlip | 12 | Lab slip; requires PatNum and LabCaseNum parameters |
+| ExamSheet | 13 | Exam sheet; requires PatNum parameter |
+| DepositSlip | 14 | Deposit slip; requires DepositNum parameter |
+| Statement | 15 | Statement; requires PatNum parameter |
+| MedLabResults | 16 | Medical lab results; requires PatNum, MedLab, and MedLabResult parameters |
+| TreatmentPlan | 17 | Treatment plan; requires PatNum and TreatmentPlan parameters |
+| Screening | 18 | Screening; requires ScreenNum (PatNum optional) |
+| PaymentPlan | 19 | Payment plan sheet |
+| RxMulti | 20 | Multiple prescriptions; requires ListRxSheet and ListRxNums parameters |
+| ERA | 21 | Electronic remittance advice |
+| ERAGridHeader | 22 | ERA grid header |
+| RxInstruction | 23 | Prescription instructions |
+| PatientDashboard | 24 | Deprecated — patient dashboard layout |
+| PatientDashboardWidget | 25 | Patient dashboard widget definition |
+| ChartModule | 26 | Chart module sheet |
+| None | 27 | Not designed to be saved to DB; used as a UI "none/all" default |
+| Check | 28 | Check printing |
+
+---
+
+## Implementation Notes
+
+- SheetDefs are templates; Sheet instances (saved per-patient forms) are created via the Sheets API using a SheetDefNum.
+- POST /sheets (Sheets API) supports creating sheets only for these SheetTypes: "Consent", "PatientLetter", "PatientForm", "MedicalHistory", and "ExamSheet".
+- SheetDefs with types that are "not saved to db" (LabelPatient, LabelCarrier, LabelReferral, LabelAppointment, RoutingSlip, None) are generated at runtime and will not appear as persistent Sheet records.
+- The `SheetType` filter on GET /sheetdefs was added in v25.1.20.
+
+---
+
+## Related Resources
+| Resource | Purpose |
+|----------|---------|
+| Sheets | Create sheet instances from a SheetDef for a patient |
+| SheetFields | Individual field values within a sheet instance |