@rinse-dental/open-dental 3.4.2 → 4.0.2

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

@@ -0,0 +1,166 @@
+# API: PatFields
+
+**Source:** https://www.opendental.com/site/apipatfields.html
+**DB Schema Ref:** patfield, patfielddef
+**Extracted:** 2026-04-22
+**Base Path:** `/patfields`
+
+---
+
+## Overview
+
+PatFields are custom patient fields accessible across Open Dental modules (Family, Account, Chart). Each row represents a single field value for one patient, keyed by field name defined in PatFieldDef. The API supports full CRUD operations on these records.
+
+---
+
+## Endpoints
+
+### GET /patfields/{PatFieldNum}
+
+**Version:** 22.4
+**Description:** Retrieves a single patient field record by its primary key.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PatFieldNum | integer | Yes | Primary key of the patfield record |
+
+**Response:** object
+| Field | Type | Description |
+|-------|------|-------------|
+| PatFieldNum | integer | Primary key |
+| PatNum | integer | FK to patient.PatNum |
+| FieldName | string | FK to patfielddef.FieldName (case-sensitive) |
+| FieldValue | string | Field data value |
+| SecDateEntry | string | Creation date, format: yyyy-MM-dd |
+| SecDateTEdit | string | Last edit timestamp, format: yyyy-MM-dd HH:mm:ss |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 404 | NotFound |
+
+---
+
+### GET /patfields
+
+**Version:** 21.1
+**Description:** Retrieves multiple patient field records with optional filtering.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| PatNum | integer | No (optional after v22.4.5) | — | Patient identifier |
+| FieldName | string | No (optional after v22.4.5) | — | Case-sensitive FK to patfielddef.FieldName |
+| SecDateTEdit | string | No (added v22.4.5) | — | Filter by last edit date/time, format: yyyy-MM-dd HH:mm:ss |
+
+**Response:** array of objects (same fields as single GET)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+
+---
+
+### POST /patfields
+
+**Version:** 22.4
+**Description:** Creates a new patient field. Cannot create fields for hidden PatFieldDefs.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PatNum | integer | Yes | FK to patient.PatNum |
+| FieldName | string | Yes | Case-sensitive FK to patfielddef.FieldName |
+| FieldValue | string | Yes | Data value per PatFieldDef.FieldType specification |
+
+**Response:** object — created PatField with assigned PatFieldNum and timestamps
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### PUT /patfields
+
+**Version:** 21.1
+**Description:** Updates an existing patient field identified by PatNum + FieldName.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PatNum | integer | Yes | FK to patient.PatNum |
+| FieldName | string | Yes | Case-sensitive FK to patfielddef.FieldName |
+| FieldValue | string | Yes | Updated data value per PatFieldDef.FieldType |
+
+**Response:** object — updated PatField with refreshed SecDateTEdit
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### DELETE /patfields/{PatFieldNum}
+
+**Version:** 22.4
+**Description:** Removes a patient field record. Cannot delete PatFields where the PatFieldDef type is CareCreditStatus.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PatFieldNum | integer | Yes | Primary key of the patfield record |
+
+**Response:** 200 No Content
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+## Field Reference
+
+### FieldType (enum: PatFieldType) — from patfielddef table
+| Value | DB Int | Description |
+|-------|--------|-------------|
+| Text | 0 | Free-form string value |
+| PickList | 1 | References patfieldpickitem.Name |
+| Date | 2 | Stored as entered/localized string (e.g. 2/4/2011); not normalized |
+| Checkbox | 3 | Value "1" if checked; row deleted if unchecked |
+| Currency | 4 | Numbers only, culture-neutral |
+| InCaseOfEmergency | 5 | DEPRECATED (used 16.3.1, deprecated by 16.3.4) |
+| CareCreditStatus | 6 | CareCredit pre-approval status string (e.g. "Pre-Approved") |
+| CareCreditPreApprovalAmt | 7 | CareCredit pre-approval amount |
+| CareCreditAvailableCredit | 8 | CareCredit remaining available credit |
+
+---
+
+## Implementation Notes
+
+- FieldName values are case-sensitive across all operations
+- Date FieldValues are stored as entered/localized; queries filtering by date are unreliable
+- Checkbox fields: value "1" means checked; if unchecked, the row is deleted from the database
+- Cannot create PatField for a PatFieldDef that has IsHidden=1 and no existing value for that patient
+- Cannot delete PatFields with PatFieldDef type CareCreditStatus (DB int 6)
+- SecDateTEdit is auto-managed by MySQL; not user-editable
+
+---
+
+## Related Resources
+| Resource | Purpose |
+|----------|---------|
+| patfielddef | Defines available field names and types |
+| patfieldpickitem | Provides pick list items for PickList-type fields |

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

@@ -0,0 +1,102 @@
+# API: PatientNotes
+
+**Source:** https://www.opendental.com/site/apipatientnotes.html
+**DB Schema Ref:** patientnote
+**Extracted:** 2026-04-22
+**Base Path:** `/patientnotes`
+
+---
+
+## Overview
+
+PatientNotes stores extended text information for a patient, essentially additional columns to the patient table held separately due to their potential size. Each patient has at most one PatientNotes record. Fields include medical history, family financial notes, service notes, treatment notes, and emergency contact information.
+
+---
+
+## Endpoints
+
+### GET /patientnotes/{PatNum}
+
+**Version:** 21.2
+**Description:** Retrieves a single patient note record by patient number.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PatNum | integer | Yes | FK to patient.PatNum; also the primary key of patientnote |
+
+**Response:** object
+| Field | Type | Description |
+|-------|------|-------------|
+| PatNum | integer | FK to patient.PatNum (also primary key) |
+| FamFinancial | string | Family financial notes; stored with guarantor only |
+| Medical | string | Medical summary/history |
+| Service | string | Service notes; visible in Medical Info window and Pt Info section of Chart module |
+| MedicalComp | string | Complete current medical history |
+| Treatment | string | Treatment/odontogram notes shown below graphical tooth chart in Chart module |
+| ICEName | string | In-case-of-emergency contact name |
+| ICEPhone | string | In-case-of-emergency contact phone |
+| SecDateTEntry | datetime | Entry timestamp (yyyy-MM-dd HH:mm:ss) |
+| SecDateTEdit | datetime | Last edit timestamp (yyyy-MM-dd HH:mm:ss) |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 404 | NotFound |
+
+---
+
+### GET /patientnotes
+
+**Version:** 25.2.14
+**Description:** Retrieves a list of all patient note records.
+
+**Response:** array of objects (same fields as single GET)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+
+---
+
+### PUT /patientnotes/{PatNum}
+
+**Version:** 21.2
+**Description:** Updates an existing patient note. Any fields provided replace existing values. Fields not provided are left unchanged.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PatNum | integer | Yes | FK to patient.PatNum |
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| FamFinancial | string | No | Family financial note (v25.2.14+) |
+| Medical | string | No | Medical history/summary (v25.2.14+) |
+| Service | string | No | Service note (v21.4+) |
+| MedicalComp | string | No | Complete medical history (v25.2.14+) |
+| Treatment | string | No | Treatment/odontogram notes (v25.2.14+) |
+| ICEName | string | No | Emergency contact name |
+| ICEPhone | string | No | Emergency contact phone |
+
+**Response:** object — updated PatientNote record
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+## Implementation Notes
+
+- PatientNotes is a one-to-one extension of the patient table; a new patient may not have a row here until needed
+- FamFinancial is stored only once per family with the guarantor's record
+- To append text rather than replace, retrieve the existing note first, concatenate, then PUT the combined value
+- OrthoMonthsTreatOverride in the DB defaults to -1 (sentinel meaning: use practice default from pref OrthoDefaultMonthsTreat); not exposed by API
+- SecDateTEdit is auto-managed by MySQL

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

@@ -0,0 +1,51 @@
+# API: PatientRaces
+
+**Source:** https://www.opendental.com/site/apipatientraces.html
+**Extracted:** 2026-04-22
+**Base Path:** `/patientraces`
+
+---
+
+## Overview
+
+PatientRaces stores CDC Race and Ethnicity data for patients. The dental office must have Public Health enabled to record this information. Returns both race and ethnicity records keyed by CDC-standard codes.
+
+---
+
+## Endpoints
+
+### GET /patientraces
+
+**Version:** 22.3.12
+**Description:** Retrieves all race and ethnicity information for a specific patient.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| PatNum | integer | Yes | — | FK to patient.PatNum |
+
+**Response:** array of objects
+| Field | Type | Description |
+|-------|------|-------------|
+| PatientRaceNum | integer | Primary key of the patientrace table |
+| PatNum | integer | FK to patient.PatNum |
+| CdcrecCode | string | CDC Race and Ethnicity unique identifier code |
+| descripition | string | Race or ethnicity description corresponding to the CdcrecCode (note: "descripition" is the documented field name) |
+| isEthnicity | boolean | True for ethnicity; false for race |
+| heirarchicalCode | string | Alphanumeric code the CDC uses to organize CdcrecCodes |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest (e.g. patient is deleted) |
+| 401 | NotFound (patient not found) |
+
+---
+
+## Implementation Notes
+
+- The dental office must have Public Health enabled to record race and ethnicity information
+- Response is an array; a patient may have multiple records (one per race/ethnicity entry)
+- `isEthnicity` distinguishes race records (false) from ethnicity records (true)
+- Note the documented field name `descripition` contains a typo — use exactly as documented when parsing responses

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

@@ -0,0 +1,346 @@
+# API: Patients
+
+**Source:** https://www.opendental.com/site/apipatients.html
+**Extracted:** 2026-04-22
+**Base Path:** `/patients`
+
+---
+
+## Overview
+
+The Patients API provides retrieval, creation, and updating of patient records. Patients cannot be deleted via the API — deletion is only possible from within the Open Dental application. The resource exposes three GET variants: single patient, simplified list search, and full search.
+
+---
+
+## Endpoints
+
+### GET /patients/{PatNum}
+
+**Version:** 21.1
+**Description:** Retrieves a single patient record by patient number.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PatNum | integer | Yes | Patient identifier |
+
+**Response:** object
+| Field | Type | Description |
+|-------|------|-------------|
+| PatNum | integer | Patient ID |
+| LName | string | Last name |
+| FName | string | First name |
+| MiddleI | string | Middle initial or name |
+| Preferred | string | Preferred name |
+| PatStatus | string | Patient status (enum) |
+| Gender | string | Gender (enum) |
+| Position | string | Marital status (enum) |
+| Birthdate | string | Format: yyyy-MM-dd |
+| SSN | string | Social Security Number |
+| Address | string | Street address |
+| Address2 | string | Second address line |
+| City | string | City |
+| State | string | State/Province |
+| Zip | string | Postal code |
+| HmPhone | string | Home phone |
+| WkPhone | string | Work phone |
+| WirelessPhone | string | Wireless phone |
+| Guarantor | integer | Guarantor's PatNum |
+| Email | string | Email address |
+| EstBalance | decimal | Individual estimated balance |
+| PriProv | integer | Primary provider ProvNum |
+| priProvAbbr | string | Primary provider abbreviation |
+| SecProv | integer | Secondary provider ProvNum |
+| secProvAbbr | string | Secondary provider abbreviation |
+| FeeSched | integer | Fee schedule number |
+| BillingType | string | Billing type definition ItemName |
+| ImageFolder | string | Image folder name |
+| FamFinUrgNote | string | Family financial urgent note |
+| MedUrgNote | string | Medical urgent note |
+| ApptModNote | string | Appointment module note |
+| ChartNumber | string | Chart number (max 15 chars) |
+| MedicaidID | string | Medicaid ID |
+| Bal_0_30 | decimal | Balance 0–30 days (guarantor only; 0 for non-guarantors) |
+| Bal_31_60 | decimal | Balance 31–60 days (guarantor only; 0 for non-guarantors) |
+| Bal_61_90 | decimal | Balance 61–90 days (guarantor only; 0 for non-guarantors) |
+| BalOver90 | decimal | Balance over 90 days (guarantor only; 0 for non-guarantors) |
+| InsEst | decimal | Insurance estimate (guarantor only; 0 for non-guarantors) |
+| BalTotal | decimal | Family total balance (guarantor only; 0 for non-guarantors) |
+| dateTimeLastAging | string | Last aging datetime (guarantor only) |
+| EmployerNum | integer | Employer number |
+| DateFirstVisit | string | First visit date (yyyy-MM-dd) |
+| ClinicNum | integer | Clinic number |
+| clinicAbbr | string | Clinic abbreviation |
+| Premed | boolean | Premedication required |
+| Ward | string | Hospital ward |
+| PreferConfirmMethod | string | Confirmation method preference (enum) |
+| PreferContactMethod | string | Contact method preference (enum) |
+| PreferRecallMethod | string | Recall method preference (enum) |
+| Language | string | ISO 639-2 language code |
+| AdmitDate | string | Hospital admit date (yyyy-MM-dd) |
+| SiteNum | integer | Site number |
+| siteDesc | string | Site description |
+| DateTStamp | string | Timestamp (yyyy-MM-dd HH:mm:ss) |
+| SuperFamily | integer | SuperFamily head PatNum |
+| TxtMsgOk | string | Text message permission (enum) |
+| SecUserNumEntry | integer | Security user entry number |
+| SecDateEntry | string | Security date entry |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### GET /patients/Simple
+
+**Version:** 21.2
+**Description:** Retrieves a simplified, searchable list of patients. Supports more filter parameters than the standard GET list.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| LName | string | No | — | Last name, partial match, case-insensitive |
+| FName | string | No | — | First name, partial match, case-insensitive |
+| Birthdate | string | No | — | Format: yyyy-MM-dd |
+| ClinicNum | integer | No | — | Single clinic number |
+| PatStatus | string | No | — | Enum: Patient, NonPatient, Inactive, Archived, Deceased, Prospective |
+| DateTStamp | string | No | — | Format: yyyy-MM-dd HH:mm:ss |
+| PriProv | integer | No | — | Primary provider ProvNum (v21.3+) |
+| Gender | string | No | — | Enum: Male, Female, Unknown, Other (v22.3.6+) |
+| Position | string | No | — | Enum: Single, Married, Child, Widowed, Divorced (v22.3.6+) |
+| Guarantor | integer | No | — | Account responsible person PatNum (v22.4.19+) |
+| SuperFamily | integer | No | — | SuperFamily head PatNum (v22.4.38+) |
+| EmployerNum | integer | No | — | Employer FK (v24.3.30+) |
+| FeeSched | integer | No | — | Fee schedule FK (v25.2.19+) |
+| HmPhone | string | No | — | Home phone number (v25.4.29+) |
+| WkPhone | string | No | — | Work phone number (v25.4.29+) |
+| WirelessPhone | string | No | — | Wireless phone number (v25.4.29+) |
+| Offset | integer | No | — | Pagination offset |
+
+**Response:** array of objects (same full fields as single GET)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+
+---
+
+### GET /patients
+
+**Version:** 21.1
+**Description:** Retrieves multiple patient records using general search criteria.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| LName | string | No | — | Last name, partial match, case-insensitive |
+| FName | string | No | — | First name, partial match, case-insensitive |
+| Phone | string | No | — | Any phone number |
+| Address | string | No | — | Street address |
+| hideInactive | boolean | No | — | Exclude inactive patients |
+| City | string | No | — | City |
+| State | string | No | — | State/Province |
+| SSN | string | No | — | Social Security Number |
+| ChartNumber | string | No | — | Chart number |
+| guarOnly | boolean | No | — | Guarantors only |
+| showArchived | boolean | No | — | Include archived patients |
+| Birthdate | string | No | — | Format: yyyy-MM-dd |
+| SiteNum | integer | No | — | Site number |
+| SubscriberId | string | No | — | Subscriber ID |
+| Email | string | No | — | Email address |
+| Country | string | No | — | Country |
+| clinicNums | string | No | — | Comma-separated clinic numbers |
+| clinicAbbr | string | No | — | Clinic abbreviation |
+| invoiceNumber | string | No | — | Invoice number |
+| Offset | integer | No | — | Pagination offset |
+
+**Response:** array of objects (subset of full patient record)
+| Field | Type |
+|-------|------|
+| PatNum | integer |
+| LName | string |
+| FName | string |
+| MiddleI | string |
+| Preferred | string |
+| PatStatus | string |
+| Birthdate | string |
+| SSN | string |
+| Address | string |
+| Address2 | string |
+| City | string |
+| State | string |
+| Zip | integer |
+| HmPhone | string |
+| WkPhone | string |
+| WirelessPhone | string |
+| Email | string |
+| priProvAbbr | string |
+| secProvAbbr | string |
+| BillingType | string |
+| ChartNumber | string |
+| ClinicNum | integer |
+| clinicAbbr | string |
+| siteDesc | string |
+| TxtMsgOk | string |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+
+---
+
+### POST /patients
+
+**Version:** 21.1
+**Description:** Creates a new patient record.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| LName | string | Yes | Last name |
+| FName | string | Yes | First name |
+| MiddleI | string | No | Middle initial or name |
+| Preferred | string | No | Preferred name |
+| PatStatus | string | No | Enum; default: Patient |
+| Gender | string | No | Enum; default: Unknown |
+| Position | string | No | Enum; default: Single |
+| Birthdate | string | No | Format: yyyy-MM-dd |
+| SSN | string | No | 9 digits (USA) or any format |
+| Address | string | No | Street address |
+| Address2 | string | No | Second address line |
+| City | string | No | City |
+| State | string | No | Two capitals (USA) or province (Canada) |
+| Zip | string | No | 12345, 12345-1234, 123456789 (US) or A0A 0A0 (Canada, v23.2.5+) |
+| HmPhone | string | No | Home phone with punctuation |
+| WkPhone | string | No | Work phone with punctuation |
+| WirelessPhone | string | No | Wireless phone with punctuation |
+| Guarantor | integer | No | Head of household PatNum; default: patient's own PatNum; mutually exclusive with SuperFamily |
+| Email | string | No | Email address |
+| PriProv | integer | No | Primary provider ProvNum |
+| SecProv | integer | No | Secondary provider ProvNum |
+| FeeSched | integer | No | Fee schedule FK; default: 0 (v25.2.19+) |
+| BillingType | string | No | Definition ItemName (Category=4) |
+| FamFinUrgNote | string | No | Family financial urgent note; guarantor only; default: empty (v23.2.5+) |
+| MedUrgNote | string | No | Medical urgent note; default: empty (v25.4.29+) |
+| ApptModNote | string | No | Appointment module note; default: empty (v25.4.29+) |
+| ChartNumber | string | No | Max 15 characters |
+| MedicaidID | string | No | Medicaid ID (v24.4.13+) |
+| EmployerNum | integer | No | Employer FK; default: 0 (v24.3.30+) |
+| DateFirstVisit | string | No | Format: yyyy-MM-dd (v22.4.42+) |
+| ClinicNum | integer | No | 0 if not attached to clinic |
+| Premed | boolean | No | Premedication required; default: false (v25.2.30+) |
+| Ward | string | No | Hospital ward; requires hospitals feature (v24.1.12+) |
+| PreferConfirmMethod | string | No | Enum; default: None |
+| PreferContactMethod | string | No | Enum; default: None |
+| PreferRecallMethod | string | No | Enum; default: None (v22.2+) |
+| Language | string | No | ISO 639-2 code; default: blank (None) |
+| AdmitDate | string | No | Format: yyyy-MM-dd; requires hospitals feature (v24.1.12+) |
+| SuperFamily | integer | No | SuperFamily head PatNum; default: 0; mutually exclusive with Guarantor (v22.4.38+) |
+| TxtMsgOk | string | No | Enum; default: Unknown |
+
+**Response:** object — full patient record (same fields as GET single)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### PUT /patients/{PatNum}
+
+**Version:** 21.2
+**Description:** Updates an existing patient record. All body parameters are optional; only provided fields are updated.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PatNum | integer | Yes | Patient identifier |
+
+**Body Parameters:** Same as POST (all optional), with the following additional restrictions:
+- Guarantor cannot be changed to a different family member unless the patient being updated is the current guarantor
+- Guarantor and SuperFamily are mutually exclusive per request
+- Setting SuperFamily to 0 removes the patient from the current SuperFamily, or disbands the entire SuperFamily if the patient is the head
+
+**Response:** object — updated patient record (same fields as GET single)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+## Field Reference
+
+### PatStatus (enum)
+| Value | Description |
+|-------|-------------|
+| Patient | Active patient |
+| NonPatient | Non-patient contact |
+| Inactive | Inactive patient |
+| Archived | Archived patient |
+| Deceased | Deceased patient |
+| Prospective | Prospective patient |
+
+### Gender (enum)
+| Value | Description |
+|-------|-------------|
+| Male | Male |
+| Female | Female |
+| Unknown | Unknown (default) |
+| Other | Other (v22.3.6+) |
+
+### Position (enum — marital status)
+| Value | Description |
+|-------|-------------|
+| Single | Single (default) |
+| Married | Married |
+| Child | Child |
+| Widowed | Widowed |
+| Divorced | Divorced |
+
+### PreferConfirmMethod / PreferContactMethod / PreferRecallMethod (enum)
+| Value | Description |
+|-------|-------------|
+| None | None (default) |
+| DoNotCall | Do not call |
+| HmPhone | Home phone |
+| WkPhone | Work phone |
+| WirelessPh | Wireless phone |
+| Email | Email |
+| SeeNotes | See notes |
+| Mail | Mail |
+| TextMessage | Text message |
+
+### TxtMsgOk (enum)
+| Value | Description |
+|-------|-------------|
+| Unknown | Unknown (default) |
+| Yes | Text messaging allowed |
+| No | Text messaging not allowed |
+
+---
+
+## Implementation Notes
+
+- Patients cannot be deleted via the API; deletion is only possible from within Open Dental
+- Deleted patients and their associated resources cannot be modified via API
+- Balance fields (Bal_0_30, Bal_31_60, Bal_61_90, BalOver90, InsEst, BalTotal) return 0 for non-guarantors; EstBalance is individual
+- Language uses ISO 639-2 format (e.g., "spa"=Spanish, "eng"=English); empty string means "None"
+- Duplicate prevention on POST compares LName, FName, Birthdate, Email, and phone numbers
+- Guarantor and SuperFamily are mutually exclusive in a single request
+- SuperFamily creation does not honor contact/recall preferences
+- Phone numbers accept any punctuation format