@rinse-dental/open-dental 3.4.2 → 4.0.2

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

@@ -0,0 +1,133 @@
+# API: Adjustments
+
+**Source:** https://www.opendental.com/site/apiadjustments.html
+**DB Schema Ref:** adjustment
+**Extracted:** 2026-04-22
+**Base Path:** `/adjustments`
+
+---
+
+## Overview
+Adjustments represent credit or debit entries in a patient's account. They can be simple patient-level adjustments or attached to a specific procedure to represent a discount. The adjustment type is controlled via definition records with category=1.
+
+---
+
+## Endpoints
+
+### GET /adjustments
+
+**Version:** 22.2.21
+**Description:** Retrieves all adjustments for a specified patient, with optional filtering by type or procedure.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| PatNum | integer | Yes | — | Patient identifier |
+| AdjType | integer | No | — | Definition number where category=1; added v22.2.33 |
+| ProcNum | integer | No | — | FK to procedurelog.ProcNum; added v22.4.28 |
+
+**Response:** Array of adjustment objects
+| Field | Type | Description |
+|-------|------|-------------|
+| AdjNum | integer | Primary key (FK: adjustment.AdjNum) |
+| AdjDate | string (yyyy-MM-dd) | Date the adjustment shows in the patient account |
+| AdjAmt | decimal | Adjustment amount; can be positive or negative |
+| PatNum | integer | FK to patient.PatNum |
+| AdjType | integer | FK to definition.DefNum (category=1) |
+| adjType | string | Human-readable adjustment type label |
+| ProvNum | integer | FK to provider.ProvNum |
+| AdjNote | string | Note for this adjustment |
+| ProcDate | string (yyyy-MM-dd) | Procedure date (not date of entry) |
+| ProcNum | integer | FK to procedurelog.ProcNum; 0 if not attached to a procedure |
+| DateEntry | string (yyyy-MM-dd) | Actual date of entry; auto-generated, not user-editable |
+| ClinicNum | integer | FK to clinic.ClinicNum |
+| SecUserNumEntry | integer | FK to userod.UserNum; user who created the record |
+| SecDateTEdit | string (yyyy-MM-dd HH:mm:ss) | Auto-updated by MySQL on any row change |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### POST /adjustments
+
+**Version:** 22.2.22
+**Description:** Creates a new adjustment for a patient.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PatNum | integer | Yes | FK to patient.PatNum |
+| AdjType | integer | Yes | FK to definition.DefNum (category=1); ItemValue must be "+" or "-" |
+| AdjAmt | decimal | Yes | Amount; must be positive if AdjType ItemValue is "+", negative if "-" |
+| AdjDate | string (yyyy-MM-dd) | Yes | Cannot be a future date |
+| ProvNum | integer | No | Defaults to patient's primary provider |
+| ProcNum | integer | No | FK to procedurelog.ProcNum; defaults to 0 |
+| ClinicNum | integer | No | Defaults to patient's clinic |
+| ProcDate | string (yyyy-MM-dd) | No | Defaults to procedure date if ProcNum given, else today |
+| AdjNote | string | No | Descriptive note |
+
+**Response:** Adjustment object (same fields as GET response)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### PUT /adjustments/{AdjNum}
+
+**Version:** 22.2.23
+**Description:** Updates an existing adjustment. All body fields are optional.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| AdjNum | integer | Yes | Primary key of the adjustment to update |
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| AdjDate | string (yyyy-MM-dd) | No | Cannot be a future date |
+| AdjAmt | decimal | No | Must align with AdjType sign convention |
+| AdjType | integer | No | FK to definition.DefNum; cannot change from a discount plan type |
+| ProvNum | integer | No | Must be a non-hidden provider |
+| AdjNote | string | No | Overwrites the existing note entirely |
+| ProcNum | integer | No | Attaches to a procedure; updates ProcDate accordingly |
+| ClinicNum | integer | No | Can be 0 |
+
+**Response:** Updated adjustment object
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+## Implementation Notes
+- `AdjType` must reference a definition where category=1 and ItemValue is either "+" or "-".
+- `AdjAmt` sign must match the AdjType ItemValue: positive for "+", negative for "-".
+- `AdjDate` cannot be a future date on either POST or PUT.
+- Discount plan adjustment types cannot be changed to another AdjType via PUT.
+- `ProcNum` of 0 means the adjustment is not attached to any procedure.
+- `StatementNum` (FK to statement) is present in the DB but not exposed via the API.
+- `TaxTransID` is deprecated in the DB schema.
+
+---
+
+## Related Resources
+| Resource | Purpose |
+|----------|---------|
+| Definitions (category=1) | Provides valid AdjType values |
+| Patients | PatNum source |
+| Procedures | ProcNum attachment |

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

@@ -0,0 +1,132 @@
+# API: Allergies
+
+**Source:** https://www.opendental.com/site/apiallergies.html
+**Extracted:** 2026-04-22
+**Base Path:** `/allergies`
+
+---
+
+## Overview
+Allergies represent allergy records associated with a specific patient. Each allergy links a patient to an allergy definition (AllergyDef) and may include reaction details and status. The allergy definition can be specified by ID or resolved by description.
+
+---
+
+## Endpoints
+
+### GET /allergies
+
+**Version:** 21.1
+**Description:** Retrieves all allergy records for a specified patient.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| PatNum | integer | Yes | — | Patient identifier |
+
+**Response:** Array of allergy objects
+| Field | Type | Description |
+|-------|------|-------------|
+| AllergyNum | integer | Primary key |
+| AllergyDefNum | integer | FK to allergydef.AllergyDefNum |
+| PatNum | integer | FK to patient.PatNum |
+| defDescription | string | Allergy name from the definition |
+| defSnomedType | string | SNOMED code type from the definition |
+| Reaction | string | Description of the adverse reaction |
+| StatusIsActive | string | "true" or "false" |
+| DateAdverseReaction | string (yyyy-MM-dd) | Date of adverse reaction; "0001-01-01" if not set |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### POST /allergies
+
+**Version:** 21.3
+**Description:** Associates an allergy definition with a patient, creating a new allergy record.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PatNum | integer | Yes | FK to patient.PatNum |
+| AllergyDefNum | integer | No* | FK to allergydef.AllergyDefNum; required if defDescription not provided |
+| defDescription | string | No* | Allergy name; required if AllergyDefNum not provided; used to look up or create the definition |
+| Reaction | string | No | Adverse reaction description |
+| StatusIsActive | string | No | "true" or "false"; defaults to "true" |
+| DateAdverseReaction | string (yyyy-MM-dd) | No | Defaults to "0001-01-01" |
+
+**Response:** Created allergy object
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### PUT /allergies/{AllergyNum}
+
+**Version:** 22.1
+**Description:** Modifies an existing patient allergy record.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| AllergyNum | integer | Yes | Primary key of the allergy to update |
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| Reaction | string | No | Adverse reaction description |
+| DateAdverseReaction | string (yyyy-MM-dd) | No | Date of adverse reaction |
+| StatusIsActive | string | No | "true" or "false" |
+
+**Response:** Updated allergy object
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### DELETE /allergies/{AllergyNum}
+
+**Version:** 22.1
+**Description:** Removes an allergy record from a patient.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| AllergyNum | integer | Yes | Primary key of the allergy to delete |
+
+**Response:** 200 OK (no content body)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 404 | NotFound |
+
+---
+
+## Implementation Notes
+- On POST, either `AllergyDefNum` or `defDescription` must be provided.
+- `DateAdverseReaction` sentinel value is "0001-01-01" when not set.
+- `StatusIsActive` is a string ("true"/"false"), not a boolean.
+
+---
+
+## Related Resources
+| Resource | Purpose |
+|----------|---------|
+| AllergyDefs | Provides AllergyDefNum values and allergy definitions |
+| Patients | PatNum source |

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

@@ -0,0 +1,74 @@
+# API: AllergyDefs
+
+**Source:** https://www.opendental.com/site/apiallergydefs.html
+**Extracted:** 2026-04-22
+**Base Path:** `/allergydefs`
+
+---
+
+## Overview
+AllergyDefs are allergy definitions — the master list of named allergies that can be assigned to patients. Each definition has a unique description and optional SNOMED and medication references. This resource is rarely used directly; the Allergies API handles most use cases.
+
+---
+
+## Endpoints
+
+### GET /allergydefs
+
+**Version:** 21.3
+**Description:** Retrieves a list of all allergy definitions.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| Offset | integer | No | 0 | Pagination offset |
+
+**Response:** Array of allergydef objects
+| Field | Type | Description |
+|-------|------|-------------|
+| AllergyDefNum | integer | Primary key |
+| Description | string | Allergy name/description; must be unique |
+| IsHidden | boolean | Whether the definition is hidden |
+| DateTStamp | datetime | Last modified timestamp |
+| SnomedType | string | SNOMED code type |
+| MedicationNum | integer | FK to medication.MedicationNum; 0 if not associated |
+| UniiCode | string | UNII identifier |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+
+---
+
+### POST /allergydefs
+
+**Version:** 21.3
+**Description:** Creates a new allergy definition with a unique description.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| Description | string | Yes | Allergy name; must be unique |
+
+**Response:** Created allergydef object
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created |
+| 400 | BadRequest — "Description is required" or "An AllergyDef with that name already exists" |
+
+---
+
+## Implementation Notes
+- This resource is rarely used directly. The Allergies POST endpoint can create definitions implicitly via `defDescription`.
+- `Description` must be unique across all allergy definitions; duplicate names are rejected with 400.
+- Pagination via `Offset` is supported on GET.
+
+---
+
+## Related Resources
+| Resource | Purpose |
+|----------|---------|
+| Allergies | Associates allergy definitions with patients |