@rinse-dental/open-dental 3.4.2 → 4.0.2

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

@@ -0,0 +1,154 @@
+# API: DiscountPlans
+
+**Source:** https://www.opendental.com/site/apidiscountplans.html
+**Extracted:** 2026-04-22
+**Base Path:** `/discountplans`
+
+---
+
+## Overview
+Discount Plans are in-house membership or discount programs offered to patients in lieu of traditional insurance. Each plan references a fee schedule and an adjustment type definition, and may define frequency limits for common procedure categories and an annual maximum discount amount.
+
+---
+
+## Endpoints
+
+### GET /discountplans
+
+**Version:** 22.4.19
+**Description:** Gets a list of all Discount Plans.
+
+**Response:** array of DiscountPlan objects
+| Field | Type | Description |
+|-------|------|-------------|
+| DiscountPlanNum | integer | Primary key |
+| Description | string | Plan name/description |
+| FeeSchedNum | integer | FK to feesched table |
+| DefNum | integer | FK to definition table (Category=1, ItemValue="dp") |
+| adjustmentType | string | Always "Discount Plan" |
+| IsHidden | boolean | Visibility status |
+| PlanNote | string | Optional plan notes |
+| ExamFreqLimit | integer | Exam procedure allowance; -1 = no limit |
+| XrayFreqLimit | integer | X-Ray allowance; -1 = no limit |
+| ProphyFreqLimit | integer | Prophylaxis allowance; -1 = no limit |
+| FluorideFreqLimit | integer | Fluoride allowance; -1 = no limit |
+| PerioFreqLimit | integer | Periodontal allowance; -1 = no limit |
+| LimitedExamFreqLimit | integer | Limited Exam allowance; -1 = no limit |
+| PAFreqLimit | integer | Periapical X-Ray allowance; -1 = no limit |
+| AnnualMax | decimal | Annual maximum discount; -1 = no annual max |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request |
+| 404 | Not Found |
+
+---
+
+### GET /discountplans/{DiscountPlanNum}
+
+**Version:** 22.4.19
+**Description:** Gets a single Discount Plan by its primary key.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| DiscountPlanNum | integer | Yes | Plan identifier |
+
+**Response:** single DiscountPlan object (same fields as list GET)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request |
+| 404 | Not Found |
+
+---
+
+### POST /discountplans
+
+**Version:** 23.1.20
+**Description:** Creates a new Discount Plan.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| Description | string | Yes | Plan name/description |
+| FeeSchedNum | integer | Yes | FK to feesched table |
+| DefNum | integer | Yes | FK to definition table (Category=1, ItemValue="dp") |
+| IsHidden | boolean | No | Default: false |
+| PlanNote | string | No | Optional plan notes |
+| ExamFreqLimit | integer | No | Default: -1 (no limit) |
+| XrayFreqLimit | integer | No | Default: -1 (no limit) |
+| ProphyFreqLimit | integer | No | Default: -1 (no limit) |
+| FluorideFreqLimit | integer | No | Default: -1 (no limit) |
+| PerioFreqLimit | integer | No | Default: -1 (no limit) |
+| LimitedExamFreqLimit | integer | No | Default: -1 (no limit) |
+| PAFreqLimit | integer | No | Default: -1 (no limit) |
+| AnnualMax | decimal | No | Default: -1 (no annual max) |
+
+**Response:** created DiscountPlan object with all fields including generated DiscountPlanNum
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created |
+| 400 | Bad Request |
+| 404 | Not Found |
+
+---
+
+### PUT /discountplans/{DiscountPlanNum}
+
+**Version:** 23.1.20
+**Description:** Updates an existing Discount Plan. All body fields are optional.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| DiscountPlanNum | integer | Yes | Plan identifier |
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| Description | string | No | Overwrites existing description |
+| FeeSchedNum | integer | No | FK to feesched table |
+| DefNum | integer | No | FK to definition table (Category=1, ItemValue="dp") |
+| IsHidden | boolean | No | Visibility status |
+| PlanNote | string | No | Overwrites existing notes |
+| ExamFreqLimit | integer | No | -1 = no limit |
+| XrayFreqLimit | integer | No | -1 = no limit |
+| ProphyFreqLimit | integer | No | -1 = no limit |
+| FluorideFreqLimit | integer | No | -1 = no limit |
+| PerioFreqLimit | integer | No | -1 = no limit |
+| LimitedExamFreqLimit | integer | No | -1 = no limit |
+| PAFreqLimit | integer | No | -1 = no limit |
+| AnnualMax | decimal | No | -1 = no annual max |
+
+**Response:** updated DiscountPlan object
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request |
+| 404 | Not Found |
+
+---
+
+## Implementation Notes
+- All frequency limit fields (`*FreqLimit`) use -1 as a sentinel value meaning "no limitation." These display as blank in the Open Dental UI.
+- `AnnualMax` uses -1 as a sentinel value meaning "no annual maximum limitation."
+- `adjustmentType` is always the string "Discount Plan" in responses; it is not configurable.
+- `DefNum` must reference a Definition with Category=1 and ItemValue="dp" (the discount plan adjustment type).
+- Updating `Description` and/or `PlanNote` via PUT will overwrite the existing values entirely.
+
+---
+
+## Related Resources
+| Resource | Purpose |
+|----------|---------|
+| Definitions | Source of DefNum (Category=1, ItemValue="dp") |
+| FeeSchedules | Source of FeeSchedNum for discount pricing |

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

@@ -0,0 +1,125 @@
+# API: DiscountPlanSubs
+
+**Source:** https://www.opendental.com/site/apidiscountplansubs.html
+**Extracted:** 2026-04-22
+**Base Path:** `/discountplansubs`
+
+---
+
+## Overview
+
+DiscountPlanSubs manages a patient's enrollment (subscription) in a discount plan. Use this resource to enroll, retrieve, update, or remove a patient's discount plan subscription.
+
+---
+
+## Endpoints
+
+### GET /discountplansubs
+
+**Version:** 21.3
+**Description:** Retrieves a patient's discount plan subscription record.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| PatNum | integer | Yes | — | Patient identifier |
+
+**Response:** object
+| Field | Type | Description |
+|-------|------|-------------|
+| DiscountSubNum | integer | Subscription identifier (primary key) |
+| DiscountPlanNum | integer | Associated discount plan ID |
+| PatNum | integer | Patient number |
+| DateEffective | string (yyyy-MM-dd) | Plan start date |
+| DateTerm | string (yyyy-MM-dd) | Plan end date |
+| SubNote | string | Subscriber notes |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### POST /discountplansubs
+
+**Version:** 21.3
+**Description:** Enrolls a patient in an existing discount plan.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| DiscountPlanNum | integer | Yes | Discount plan to enroll the patient in |
+| PatNum | integer | Yes | Patient to enroll |
+| DateEffective | string (yyyy-MM-dd) | No | Plan start date; defaults to calendar year start |
+| DateTerm | string (yyyy-MM-dd) | No | Plan end date; defaults to no end date |
+| SubNote | string | No | Subscriber note |
+
+**Response:** 201 Created — created DiscountPlanSub object
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### PUT /discountplansubs/{DiscountSubNum}
+
+**Version:** 22.3.13
+**Description:** Modifies an existing subscription record.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| DiscountSubNum | integer | Yes | Subscription identifier |
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PatNum | integer | Yes | Patient identifier |
+| DateEffective | string (yyyy-MM-dd) | No | Updated plan start date |
+| DateTerm | string (yyyy-MM-dd) | No | Updated plan end date |
+| SubNote | string | No | Updated subscriber note; overwrites existing note |
+
+**Response:** object — updated DiscountPlanSub object
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### DELETE /discountplansubs/{DiscountSubNum}
+
+**Version:** 23.1.12
+**Description:** Removes a subscription record from the system.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| DiscountSubNum | integer | Yes | Subscription identifier |
+
+**Response:** 200 OK
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+## Implementation Notes
+
+- Updating `SubNote` via PUT will overwrite the existing subscriber note entirely (no append behavior).
+- `DateEffective` defaults to the start of the current calendar year if omitted on POST.
+- `DateTerm` defaults to no termination date (open-ended) if omitted on POST.

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

@@ -0,0 +1,88 @@
+# API: DiseaseDefs
+
+**Source:** https://www.opendental.com/site/apidiseasedefs.html
+**Extracted:** 2026-04-22
+**Base Path:** `/diseasedefs`
+
+---
+
+## Overview
+
+DiseaseDefs represent problem/disease definitions that can be assigned to patients. They serve as a reference catalog of conditions identified by name and clinical codes (ICD-9, ICD-10, SNOMED). Use this resource to retrieve or create disease definitions.
+
+---
+
+## Endpoints
+
+### GET /diseasedefs/{DiseaseDefNum}
+
+**Version:** 24.1.44
+**Description:** Retrieves a single DiseaseDef (Problem) by its identifier.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| DiseaseDefNum | integer | Yes | Disease definition identifier |
+
+**Response:** object
+| Field | Type | Description |
+|-------|------|-------------|
+| DiseaseDefNum | integer | Primary key |
+| DiseaseName | string | Name of the disease/problem |
+| IsHidden | boolean | Whether the definition is hidden from selection |
+| DateTStamp | datetime | Last modification timestamp |
+| ICD9Code | string | ICD-9 classification code |
+| ICD10Code | string | ICD-10 classification code |
+| SnomedCode | string | SNOMED code |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 404 | NotFound — with explanation |
+
+---
+
+### GET /diseasedefs
+
+**Version:** 21.3
+**Description:** Retrieves all DiseaseDefs available for patient assignment.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| Offset | integer | No | 0 | Pagination offset (e.g., 200) |
+
+**Response:** array of DiseaseDef objects (same fields as single GET)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+
+---
+
+### POST /diseasedefs
+
+**Version:** 21.3
+**Description:** Creates a new disease definition with a unique name.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| DiseaseName | string | Yes | The disease/problem name (must be unique) |
+
+**Response:** 201 Created — created DiseaseDef object
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created |
+| 400 | BadRequest — "DiseaseName is required" or "A DiseaseDef with that name already exists" |
+
+---
+
+## Implementation Notes
+
+- `DiseaseName` must be unique across all disease definitions; duplicate names are rejected with a 400 error.
+- `IsHidden` is returned on GET but cannot be set via POST (no update endpoint exists).

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

@@ -0,0 +1,168 @@
+# API: Diseases
+
+**Source:** https://www.opendental.com/site/apidiseases.html
+**Extracted:** 2026-04-22
+**Base Path:** `/diseases`
+
+---
+
+## Overview
+
+Diseases represents problem/disease records assigned to individual patients. Each record links a patient to a DiseaseDef (problem definition) and tracks status and date ranges. Use this resource to assign, query, update, or remove patient disease records.
+
+---
+
+## Endpoints
+
+### GET /diseases/{DiseaseNum}
+
+**Version:** 24.2.5
+**Description:** Retrieves a single disease record assigned to a patient.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| DiseaseNum | integer | Yes | Disease record identifier |
+
+**Response:** object
+| Field | Type | Description |
+|-------|------|-------------|
+| DiseaseNum | integer | Primary key |
+| PatNum | integer | Patient identifier |
+| DiseaseDefNum | integer | FK to DiseaseDef |
+| diseaseDefName | string | Name from the linked DiseaseDef |
+| PatNote | string | Patient-specific note |
+| ProbStatus | string | Status: "Active", "Resolved", or "Inactive" |
+| DateStart | string (ISO 8601) | Date the problem began |
+| DateStop | string (ISO 8601) | Date the problem ended |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 404 | NotFound |
+
+---
+
+### GET /diseases
+
+**Version:** 21.3
+**Description:** Retrieves all diseases assigned to a patient.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| PatNum | integer | No | — | Patient identifier to filter results |
+
+**Response:** array of disease objects (same fields as single GET)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### POST /diseases
+
+**Version:** 21.3
+**Description:** Assigns a disease definition to a patient, creating a new disease record.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PatNum | integer | Yes | Patient to assign the disease to |
+| diseaseDefName | string | Conditional | Disease definition name; required unless `DiseaseDefNum` is provided |
+| DiseaseDefNum | integer | Conditional | FK to DiseaseDef; required unless `diseaseDefName` is provided |
+| DateStart | string (yyyy-MM-dd) | No | Date the problem began |
+| DateStop | string (yyyy-MM-dd) | No | Date the problem ended |
+| ProbStatus | string | No | "Active", "Resolved", or "Inactive"; default: "Active" |
+| PatNote | string | No | Patient-specific note |
+
+**Response:** 201 Created — created disease object with assigned `DiseaseNum`
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### PUT /diseases/{DiseaseNum}
+
+**Version:** 22.1
+**Description:** Updates an existing disease record.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| DiseaseNum | integer | Yes | Disease record identifier |
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| DateStart | string (yyyy-MM-dd) | No | Updated start date |
+| DateStop | string (yyyy-MM-dd) | No | Updated stop date |
+| ProbStatus | string | No | "Active", "Resolved", or "Inactive" |
+| PatNote | string | No | Updated patient note |
+
+**Response:** object — updated disease record
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### DELETE /diseases/{DiseaseNum}
+
+**Version:** 22.1
+**Description:** Removes a disease record from a patient.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| DiseaseNum | integer | Yes | Disease record identifier |
+
+**Response:** 200 OK
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+## Field Reference
+
+### ProbStatus (enum)
+| Value | Description |
+|-------|-------------|
+| Active | Problem is currently active |
+| Resolved | Problem has been resolved |
+| Inactive | Problem is inactive |
+
+---
+
+## Implementation Notes
+
+- Either `DiseaseDefNum` or `diseaseDefName` must be provided on POST; both can be provided but at least one is required.
+- `ProbStatus` defaults to "Active" when not specified on POST.
+- Date fields use ISO 8601 format on GET responses and "yyyy-MM-dd" format on POST/PUT requests.
+
+---
+
+## Related Resources
+
+| Resource | Purpose |
+|----------|---------|
+| /diseasedefs | Retrieve or create disease definitions linked via DiseaseDefNum |