@rinse-dental/open-dental 3.4.2 → 4.0.2

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

@@ -0,0 +1,140 @@
+# API: CodeGroups
+
+**Source:** https://www.opendental.com/site/apicodegroups.html
+**Extracted:** 2026-04-22
+**Base Path:** `/codegroups`
+
+---
+
+## Overview
+The CodeGroups API manages named groups of dental procedure codes used for frequency limitations, age limits, and other benefit rule configurations in insurance plans.
+
+---
+
+## Endpoints
+
+### GET /codegroups/{CodeGroupNum}
+
+**Version:** 25.3.10
+**Description:** Retrieves a single code group by its identifier.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| CodeGroupNum | integer | Yes | Code group identifier |
+
+**Response:** object
+| Field | Type | Description |
+|-------|------|-------------|
+| CodeGroupNum | integer | Unique identifier |
+| GroupName | string | Name of the code group |
+| ProcCodes | string | Comma-delimited list of procedure codes |
+| ItemOrder | integer | Display order |
+| CodeGroupFixed | string | Fixed group type (see Field Reference) |
+| IsHidden | string | "true" or "false" |
+| ShowInAgeLimit | string | "true" or "false"; whether group appears in age limit rules |
+| ShowInFrequency | string | "true" or "false"; whether group appears in frequency rules (v25.3.10+) |
+| ShowInOther | string | "true" or "false"; whether group appears in other rule types (v25.3.10+) |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 404 | NotFound |
+
+---
+
+### GET /codegroups
+
+**Version:** 23.2.62
+**Description:** Returns all code groups as an array.
+
+**Response:** array of objects (same fields as GET single)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+
+---
+
+### POST /codegroups
+
+**Version:** 24.1.29
+**Description:** Creates a new code group.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| GroupName | string | Yes | Name of the code group |
+| ProcCodes | string | No | Comma-delimited procedure codes |
+| CodeGroupFixed | string | No | Fixed group type; default "None" (see Field Reference) |
+| IsHidden | string | No | "true" or "false"; default "false" |
+| ShowInAgeLimit | string | No | "true" or "false"; default "false" |
+| ShowInFrequency | string | No | "true" or "false"; default "false" (v25.3.10+) |
+| ShowInOther | string | No | "true" or "false"; default "false" (v25.3.10+) |
+
+**Response:** object — created code group with all fields
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created |
+| 400 | BadRequest |
+
+---
+
+### PUT /codegroups/{CodeGroupNum}
+
+**Version:** 24.1.29
+**Description:** Updates an existing code group.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| CodeGroupNum | integer | Yes | Code group identifier |
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| GroupName | string | No | Name of the code group |
+| ProcCodes | string | No | Comma-delimited procedure codes |
+| CodeGroupFixed | string | No | Fixed group type (see Field Reference) |
+| IsHidden | string | No | "true" or "false" |
+| ShowInAgeLimit | string | No | "true" or "false" |
+| ShowInFrequency | string | No | "true" or "false" (v25.3.10+) |
+| ShowInOther | string | No | "true" or "false" (v25.3.10+) |
+
+**Response:** object — updated code group with all fields
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+## Field Reference
+
+### CodeGroupFixed (enum)
+| Value | Description |
+|-------|-------------|
+| None | Not a fixed/system group |
+| BW | Bitewing X-rays |
+| PanoFMX | Panoramic / Full-mouth X-rays |
+| Exam | Examination procedures |
+| Perio | Periodontal procedures |
+| Prophy | Prophylaxis |
+| SRP | Scaling and root planing |
+| FMDebride | Full-mouth debridement |
+| Fluoride | Fluoride treatments |
+| Sealant | Sealant procedures |
+
+---
+
+## Implementation Notes
+- `IsHidden` cannot be set to "true" if any of `ShowInAgeLimit`, `ShowInFrequency`, or `ShowInOther` are "true".
+- `ShowInFrequency` and `ShowInOther` fields were added in version 25.3.10; they are not available in earlier versions.
+- `ProcCodes` is a plain comma-delimited string, not a JSON array.

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

@@ -0,0 +1,161 @@
+# API: Commlogs
+
+**Source:** https://www.opendental.com/site/apicommlogs.html
+**Extracted:** 2026-04-22
+**Base Path:** `/commlogs`
+
+---
+
+## Overview
+Commlogs record patient communication history, including phone calls, emails, text messages, and in-person contacts. Each record captures the communication mode, direction (sent/received), timestamp, and a free-text note.
+
+---
+
+## Endpoints
+
+### GET /commlogs/{CommlogNum}
+
+**Version:** 25.1.13
+**Description:** Retrieves a single commlog record by its primary key.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| CommlogNum | integer | Yes | Commlog primary key |
+
+**Response:** object
+| Field | Type | Description |
+|-------|------|-------------|
+| CommlogNum | integer | Primary key |
+| PatNum | integer | FK to patient.PatNum |
+| CommDateTime | string | Communication timestamp (yyyy-MM-dd HH:mm:ss) |
+| CommType | integer | FK to definition.DefNum (Category=27) |
+| commType | string | Definition item name for CommType |
+| Note | string | Communication notes |
+| Mode_ | string | Communication method (enum; see Field Reference) |
+| SentOrReceived | string | Direction of communication (enum; see Field Reference) |
+| UserNum | integer | FK to userod; user who created the entry |
+| DateTStamp | string | Last modification timestamp |
+| CommSource | string | Origin of the communication entry |
+| ProgramNum | integer | FK to program (associated program) |
+| DateTEntry | string | Entry creation timestamp |
+| ReferralNum | integer | FK to referral |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 404 | Not Found |
+
+---
+
+### GET /commlogs
+
+**Version:** 21.1
+**Description:** Retrieves multiple commlog records with optional filtering.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| PatNum | integer | No | — | Optional after v25.1.13; FK to patient.PatNum |
+| DateTStamp | string | No | — | Added v25.1.13; returns commlogs modified on or after this datetime (yyyy-MM-dd HH:mm:ss) |
+
+**Response:** array of commlog objects (same fields as single GET)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request |
+| 404 | Not Found |
+
+---
+
+### POST /commlogs
+
+**Version:** 21.1
+**Description:** Creates a new commlog entry. Response includes the full commlog object as of v23.3.7+.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PatNum | integer | Yes | FK to patient.PatNum |
+| Note | string | Yes | Communication content |
+| CommDateTime | string | No | yyyy-MM-dd HH:mm:ss; defaults to current time |
+| CommType | integer | No | Definition.DefNum (Category=27); defaults to Miscellaneous |
+| commType | string | No | Definition item name (Category=27); overrides CommType if both provided |
+| Mode_ | string | No | Communication mode enum; defaults to "Phone" |
+| SentOrReceived | string | No | Direction enum; defaults to "Sent" |
+
+**Response:** created commlog object with all fields
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created |
+| 400 | Bad Request |
+| 404 | Not Found |
+
+---
+
+### PUT /commlogs/{CommlogNum}
+
+**Version:** 25.2.21
+**Description:** Updates an existing commlog. Overwrites the existing note and clears any existing signature.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| CommlogNum | integer | Yes | Commlog primary key |
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| Note | string | Yes | New note content; overwrites existing note and clears signature |
+
+**Response:** updated commlog object with all fields
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request |
+| 404 | Not Found |
+
+---
+
+## Field Reference
+
+### Mode_ (enum)
+| Value | Description |
+|-------|-------------|
+| None | No specific mode |
+| Email | Email communication |
+| Mail | Physical mail |
+| Phone | Phone call |
+| In Person | In-person contact |
+| Text | Text/SMS message |
+| Email and Text | Both email and text |
+| Phone and Text | Both phone and text |
+
+### SentOrReceived (enum)
+| Value | Description |
+|-------|-------------|
+| Neither | Direction not applicable |
+| Sent | Communication was sent to patient |
+| Received | Communication was received from patient |
+
+---
+
+## Implementation Notes
+- `commType` overrides `CommType` when both are provided in POST.
+- PUT overwrites the note and clears any existing signature on the commlog.
+- `CommType` references Definition Category=27; use the Definitions API to look up valid values.
+- Full response object returned on POST only as of v23.3.7+; earlier versions may return limited data.
+
+---
+
+## Related Resources
+| Resource | Purpose |
+|----------|---------|
+| Definitions | Source of CommType values (Category=27) |

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

@@ -0,0 +1,39 @@
+# API: Computers
+
+**Source:** https://www.opendental.com/site/apicomputers.html
+**Extracted:** 2026-04-22
+**Base Path:** `/computers`
+
+---
+
+## Overview
+The Computers API retrieves a list of computers registered in the Open Dental installation. The `LastHeartBeat` field indicates which computers are actively running the Open Dental client.
+
+---
+
+## Endpoints
+
+### GET /computers
+
+**Version:** 23.1.30
+**Description:** Retrieves a list of all computers registered in Open Dental.
+
+**Response:** array of objects
+| Field | Type | Description |
+|-------|------|-------------|
+| ComputerNum | integer | Unique computer identifier |
+| CompName | string | Computer name |
+| LastHeartBeat | string | Timestamp of last heartbeat; "0001-01-01 00:00:00" indicates an inactive computer |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request |
+
+---
+
+## Implementation Notes
+- `LastHeartBeat` of "0001-01-01 00:00:00" (DateTime.MinValue) indicates the computer is not actively running Open Dental.
+- Active computers display the current timestamp in `LastHeartBeat`.
+- This endpoint is read-only; no POST, PUT, or DELETE operations are available.

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

@@ -0,0 +1,139 @@
+# API: CovCats
+
+**Source:** https://www.opendental.com/site/apicovcats.html
+**Extracted:** 2026-04-22
+**Base Path:** `/covcats`
+
+---
+
+## Overview
+The CovCats API manages insurance coverage categories, which define how dental procedures are classified for benefit calculation purposes. Coverage categories link to coverage spans (procedure code ranges) and affect how insurance benefits are applied.
+
+---
+
+## Endpoints
+
+### GET /covcats/{CovCatNum}
+
+**Version:** 23.3.8
+**Description:** Retrieves a single coverage category by its identifier.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| CovCatNum | integer | Yes | Coverage category identifier |
+
+**Response:** object
+| Field | Type | Description |
+|-------|------|-------------|
+| CovCatNum | integer | Category identifier |
+| Description | string | Category description |
+| DefaultPercent | integer | Default coverage percentage; -1 means not set (range: -1 to 100) |
+| CovOrder | integer | Display/priority order |
+| IsHidden | string | "true" or "false" |
+| EbenefitCat | string | Electronic benefit category type (see Field Reference) |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 404 | NotFound |
+
+---
+
+### GET /covcats
+
+**Version:** 23.3.8
+**Description:** Retrieves all coverage categories as an array.
+
+**Response:** array of objects (same fields as GET single)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+
+---
+
+### POST /covcats
+
+**Version:** 24.1.24
+**Description:** Creates a new coverage category.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| Description | string | Yes | Category description |
+| DefaultPercent | integer | No | Coverage percentage -1 to 100; default -1 |
+| IsHidden | string | No | "true" or "false"; default "false" |
+| EbenefitCat | string | No | Electronic benefit category; default "None" |
+
+**Response:** object — created CovCat with assigned `CovCatNum` and `CovOrder`
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### PUT /covcats/{CovCatNum}
+
+**Version:** 24.1.24
+**Description:** Updates an existing coverage category. Changes affect all benefits tied to this category.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| CovCatNum | integer | Yes | Category to update |
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| Description | string | No | Category description |
+| DefaultPercent | integer | No | Coverage percentage -1 to 100 |
+| CovOrder | integer | No | Display/priority order |
+| IsHidden | string | No | "true" or "false" |
+| EbenefitCat | string | No | Electronic benefit category (see Field Reference) |
+
+**Response:** object — updated CovCat with all fields
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+## Field Reference
+
+### EbenefitCat (enum)
+| Value | Description |
+|-------|-------------|
+| None | No electronic benefit category |
+| General | General dental |
+| Diagnostic | Diagnostic services |
+| Periodontics | Periodontal services |
+| Restorative | Restorative services |
+| Endodontics | Endodontic services |
+| MaxillofacialProsth | Maxillofacial prosthetics |
+| Crowns | Crown services |
+| Accident | Accident-related |
+| Orthodontics | Orthodontic services |
+| Prosthodontics | Prosthodontic services |
+| OralSurgery | Oral surgery |
+| RoutinePreventive | Routine preventive care |
+| DiagnosticXRay | Diagnostic X-rays |
+| Adjunctive | Adjunctive general services |
+
+---
+
+## Implementation Notes
+- `DefaultPercent` of -1 is a sentinel value meaning "not set" / no default percentage applies.
+- Each `EbenefitCat` value (except "None") must be assigned to exactly one coverage category — no duplicates and no missing categories are allowed.
+- `CovOrder` determines priority: higher `CovOrder` overrides lower; lower `CovOrder` categories are more general.
+- Updates to a CovCat affect all insurance benefits associated with that category.

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

@@ -0,0 +1,140 @@
+# API: CovSpans
+
+**Source:** https://www.opendental.com/site/apicovspans.html
+**Extracted:** 2026-04-22
+**Base Path:** `/covspans`
+
+---
+
+## Overview
+The CovSpans API manages coverage spans, which define procedure code ranges associated with insurance coverage categories. Each span links a coverage category to a contiguous range of procedure codes (FromCode to ToCode).
+
+---
+
+## Endpoints
+
+### GET /covspans/{CovSpanNum}
+
+**Version:** 24.1.19
+**Description:** Retrieves a single coverage span by its identifier.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| CovSpanNum | integer | Yes | Coverage span identifier |
+
+**Response:** object
+| Field | Type | Description |
+|-------|------|-------------|
+| CovSpanNum | integer | Unique identifier |
+| CovCatNum | integer | FK to coverage category |
+| FromCode | string | Lower bound of the procedure code range (inclusive) |
+| ToCode | string | Upper bound of the procedure code range (inclusive) |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 404 | NotFound |
+
+---
+
+### GET /covspans
+
+**Version:** 24.1.19
+**Description:** Retrieves multiple coverage spans with optional filtering.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| CovCatNum | integer | No | — | Filter by coverage category FK |
+
+**Response:** array of objects (same fields as GET single)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 404 | NotFound |
+
+---
+
+### POST /covspans
+
+**Version:** 24.1.22
+**Description:** Creates a new coverage span.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| CovCatNum | integer | Yes | FK to coverage category |
+| FromCode | string | Yes | Lower range bound; must be alphabetically less than ToCode |
+| ToCode | string | Yes | Upper range bound; must be alphabetically greater than FromCode |
+
+**Response:** object — created CovSpan with all fields including auto-generated `CovSpanNum`
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### PUT /covspans/{CovSpanNum}
+
+**Version:** 24.1.22
+**Description:** Updates an existing coverage span's code range. `CovCatNum` cannot be changed.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| CovSpanNum | integer | Yes | Coverage span to update |
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| FromCode | string | No | Lower range bound (must be alphabetically less than ToCode) |
+| ToCode | string | No | Upper range bound (must be alphabetically greater than FromCode) |
+
+**Response:** object — updated CovSpan with all fields
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### DELETE /covspans/{CovSpanNum}
+
+**Version:** 24.1.22
+**Description:** Deletes a coverage span.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| CovSpanNum | integer | Yes | Coverage span to delete |
+
+**Response:** 200 OK (no body)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 404 | NotFound |
+
+---
+
+## Implementation Notes
+- `FromCode` must be alphabetically less than `ToCode`; the API enforces this bidirectional ordering constraint.
+- Code values do not need to be valid existing procedure codes — any string values meeting the ordering constraint are accepted.
+- `CovCatNum` cannot be modified after creation; to reassign a span to a different category, delete and recreate it.
+
+## Related Resources
+| Resource | Purpose |
+|----------|---------|
+| CovCats | Manage the coverage categories that CovSpans reference |

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

@@ -0,0 +1,90 @@
+# API: Definitions
+
+**Source:** https://www.opendental.com/site/apidefinitions.html
+**Extracted:** 2026-04-22
+**Base Path:** `/definitions`
+
+---
+
+## Overview
+Definitions are configurable lookup values used throughout Open Dental for categorized lists such as adjustment types, payment types, communication types, and many others. They are referenced by DefNum throughout the API. Each definition belongs to a Category and has a name, value, and hidden status.
+
+---
+
+## Endpoints
+
+### GET /definitions
+
+**Version:** 21.1
+**Description:** Retrieves a list of definitions, optionally filtered by category. Hidden definitions are excluded by default.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| Offset | integer | No | 0 | Pagination offset |
+| Category | integer | No | — | Filter by category number |
+| includeHidden | boolean | No | false | When true, includes hidden definitions |
+
+**Response:** array of objects
+| Field | Type | Description |
+|-------|------|-------------|
+| DefNum | integer | Definition identifier (primary key) |
+| ItemName | string | Name of the definition |
+| ItemValue | string | Value associated with the definition |
+| Category | integer | Numeric category identifier |
+| category | string | Category name (e.g., "AdjTypes", "PaymentTypes") |
+| isHidden | string | "true" or "false" |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+
+---
+
+### POST /definitions
+
+**Version:** 22.1
+**Description:** Creates a new definition. Attempting to set the Category via the request body will be silently ignored; use the `category` name field instead.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| ItemName | string | Yes | Name of the definition |
+| category | string | Yes | Category name; numeric Category field is silently ignored if provided |
+| ItemValue | string | No | Value for the definition; validated per category rules |
+| isHidden | string | No | "true" or "false"; defaults to "false" |
+
+**Response:** created definition object (same fields as GET)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created |
+| 400 | Bad Request (missing or invalid fields) |
+
+---
+
+## Implementation Notes
+- Attempting to set `Category` (integer) in the POST body is silently ignored; always use `category` (string name) instead.
+- `ItemValue` validation rules vary by category; consult the Open Dental Definitions documentation and current definitions list for valid values per category.
+- Commonly referenced categories in the API:
+  - Category 1: Billing types (used by DiscountPlans when ItemValue="dp")
+  - Category 27: Communication log types (CommType in Commlogs)
+  - Category 31: Claim tracking statuses (TrackingDefNum in ClaimTrackings)
+  - Category 32: Claim payment types (PayType in ClaimPayments)
+  - Category 36: Claim payment tracking (ClaimPaymentTracking in ClaimProcs)
+  - Category 40: Claim payment groups (PayGroup in ClaimPayments)
+  - Category 43: Claim tracking error types (TrackingErrorDefNum in ClaimTrackings)
+- `isHidden` is returned as a string ("true"/"false"), not a native boolean.
+
+---
+
+## Related Resources
+| Resource | Purpose |
+|----------|---------|
+| ClaimPayments | References PayType (Cat=32) and PayGroup (Cat=40) |
+| ClaimProcs | References ClaimPaymentTracking (Cat=36) |
+| ClaimTrackings | References TrackingDefNum (Cat=31) and TrackingErrorDefNum (Cat=43) |
+| Commlogs | References CommType (Cat=27) |
+| DiscountPlans | References DefNum with Category=1 and ItemValue="dp" |