@rinse-dental/open-dental 3.4.2 → 4.0.2

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

@@ -0,0 +1,116 @@
+# API: FeeScheds
+
+**Source:** https://www.opendental.com/site/apifeescheds.html
+**DB Schema Ref:** feesched
+**Extracted:** 2026-04-22
+**Base Path:** `/feescheds`
+
+---
+
+## Overview
+
+FeeScheds manages fee schedule records used to group procedure fees by type. Fee schedules cannot have their type changed or be deleted after creation; they can only be hidden. Each schedule can be global (shared across clinics) or clinic-specific.
+
+---
+
+## Endpoints
+
+### GET /feescheds
+
+**Version:** 22.4.31
+**Description:** Retrieves a list of all fee schedules.
+
+**Response:** Array of objects
+
+| Field | Type | Description |
+|-------|------|-------------|
+| FeeSchedNum | integer | Primary key |
+| Description | string | Fee schedule name |
+| FeeSchedType | string | Schedule type: "Normal", "CoPay", "OutNetwork", "FixedBenefit", or "ManualBlueBook" |
+| ItemOrder | integer | Display order (ordered within same type) |
+| IsHidden | string | "true" or "false" |
+| IsGlobal | string | "true" or "false"; if true, ClinicNum and ProvNum must both be zero for all fees |
+| SecUserNumEntry | integer | FK to userod.UserNum — user who created the record |
+| SecDateEntry | string | Date of entry (yyyy-MM-dd) |
+| SecDateTEdit | string | Last modified timestamp (auto-updated by MySQL) |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+
+---
+
+### POST /feescheds
+
+**Version:** 23.3.7
+**Description:** Creates a new fee schedule.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| Description | string | Yes | Fee schedule name |
+| FeeSchedType | string | Yes | "Normal", "CoPay", "OutNetwork", "FixedBenefit", or "ManualBlueBook" — immutable after creation |
+| IsHidden | string | No | "true" or "false"; default "false" |
+| IsGlobal | string | No | "true" or "false"; default "true" |
+
+**Response:** Created fee schedule object with all fields
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+
+---
+
+### PUT /feescheds/{FeeSchedNum}
+
+**Version:** 23.3.7
+**Description:** Updates an existing fee schedule. FeeSchedType cannot be changed.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| FeeSchedNum | integer | Yes | Fee schedule identifier |
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| Description | string | No | Fee schedule name |
+| IsHidden | string | No | "true" or "false" |
+| IsGlobal | string | No | "true" or "false" |
+
+**Response:** Updated fee schedule object
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+## Field Reference
+
+### FeeSchedType (enum: FeeScheduleType)
+
+| Value | DB Int | Description |
+|-------|--------|-------------|
+| Normal | 0 | Standard fee schedule |
+| CoPay | 1 | Copay fee schedule |
+| OutNetwork | 2 | Out-of-network (formerly "Allowed") fees |
+| FixedBenefit | 3 | Fixed benefit amounts |
+| ManualBlueBook | 4 | Manual Blue Book fees |
+
+---
+
+## Implementation Notes
+
+- `FeeSchedType` is immutable after creation — cannot be changed via PUT.
+- Fee schedules cannot be deleted once created; use `IsHidden` to retire them.
+- `ItemOrder` is only meaningful among fee schedules of the same type.
+- When `IsGlobal` is "true", all associated fees must have `ClinicNum` = 0 and `ProvNum` = 0.
+- `SecDateTEdit` is automatically updated by MySQL and is not user-editable.

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

@@ -0,0 +1,121 @@
+# API: HistAppointments
+
+**Source:** https://www.opendental.com/site/apihistappointments.html
+**DB Schema Ref:** histappointment
+**Extracted:** 2026-04-22
+**Base Path:** `/histappointments`
+
+---
+
+## Overview
+
+HistAppointments provides read-only access to historical appointment records. A history record is created every time an appointment is created, changed, marked missed, cancelled, or deleted. Multiple history entries may exist for a single appointment number.
+
+---
+
+## Endpoints
+
+### GET /histappointments
+
+**Version:** 23.1.30
+**Description:** Retrieves a list of historical appointment records with optional filtering.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| HistApptAction | string | No | — | Filter by action: "Created", "Changed", "Missed", "Cancelled", or "Deleted" |
+| AptNum | integer | No | — | Filter by appointment number |
+| PatNum | integer | No | — | Filter by patient number |
+| AptStatus | string | No | — | Filter by status: "Scheduled", "Complete", "UnschedList", "Broken", or "Planned" |
+| ClinicNum | integer | No | — | Filter by clinic; omit for all clinics |
+| date | string | No | — | Single day filter in "yyyy-MM-dd" format |
+| dateStart | string | No | — | Range start in "yyyy-MM-dd" format (inclusive) |
+| dateEnd | string | No | — | Range end in "yyyy-MM-dd" format (inclusive) |
+
+**Response:** Array of objects
+
+| Field | Type | Description |
+|-------|------|-------------|
+| HistApptNum | integer | Primary key of the history record |
+| HistUserNum | integer | FK to userod.UserNum — user who made the change |
+| HistDateTStamp | datetime | Timestamp when history entry was created |
+| HistApptAction | string | Action type: "Created", "Changed", "Missed", "Cancelled", "Deleted" |
+| ApptSource | string | Source of the appointment action (eService type) |
+| AptNum | integer | FK to appointment — the appointment that was changed |
+| PatNum | integer | FK to patient.PatNum |
+| AptStatus | string | Appointment status at time of history entry |
+| ProvNum | integer | FK to provider.ProvNum |
+| provAbbr | string | Provider abbreviation (non-DB lowercase field) |
+| AptDateTime | datetime | Scheduled appointment date and time |
+| IsNewPatient | boolean | Whether the patient was a new patient |
+| ProcDescript | string | Procedure description |
+| ClinicNum | integer | FK to clinic |
+| Priority | string | Appointment priority: "Normal" or other values |
+| DateTimeArrived | datetime | Patient arrival time |
+| DateTimeSeated | datetime | Patient seated time |
+| DateTimeDismissed | datetime | Patient dismissal time |
+| InsPlan1 | integer | Primary insurance plan |
+| InsPlan2 | integer | Secondary insurance plan |
+| Pattern | string | Appointment time pattern |
+| Confirmed | integer | Confirmation status definition number |
+| TimeLocked | boolean | Whether appointment time is locked |
+| Op | integer | FK to operatory |
+| Note | string | Appointment note |
+| ProvHyg | integer | FK to hygienist provider |
+| NextAptNum | integer | FK to next appointment |
+| UnschedStatus | integer | Unscheduled status definition |
+| Assistant | integer | FK to assistant |
+| IsHygiene | boolean | Whether this is a hygiene appointment |
+| DateTimeAskedToArrive | datetime | Time patient was asked to arrive |
+| ProcsColored | string | Procedures colored data |
+| ColorOverride | integer | Color override value |
+| AppointmentTypeNum | integer | FK to appointment type |
+| SecUserNumEntry | integer | User who originally entered the appointment |
+| SecDateTEntry | datetime | Date/time the appointment was originally entered |
+| ItemOrderPlanned | integer | Planned item order |
+| IsMirrored | boolean | Whether appointment is mirrored |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest — invalid parameters |
+| 404 | NotFound |
+
+---
+
+## Field Reference
+
+### HistApptAction (enum: HistAppointmentAction)
+
+| Value | DB Int | Description |
+|-------|--------|-------------|
+| Created | 0 | Appointment was created |
+| Changed | 1 | Appointment was modified |
+| Missed | 2 | Patient missed the appointment |
+| Cancelled | 3 | Appointment was cancelled |
+| Deleted | 4 | Appointment was deleted |
+
+### ApptSource (enum: EServiceTypes)
+
+| Value | Description |
+|-------|-------------|
+| None | Not an eService user |
+| EConnector | eConnector service |
+| Broadcaster | Broadcaster service |
+| BroadcastMonitor | Broadcast monitor service |
+| ServiceMainHQ | Main HQ service |
+| OpenDentalService | Open Dental background service |
+| OpenDentalAPIService | Open Dental API Service |
+| SecureEmailService | Secure email service |
+| ODXam | WebServiceMainHQ / mobile app fallback |
+| EClipboard | eClipboard (WebServiceMainHQ) |
+
+---
+
+## Implementation Notes
+
+- This endpoint is read-only; no POST, PUT, or DELETE methods exist.
+- Multiple history records may share the same `AptNum` (one per edit event).
+- `HistDateTStamp` is when the history was recorded, not the appointment time.
+- Use `date` for single-day queries; use `dateStart` + `dateEnd` for ranges.

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

@@ -0,0 +1,128 @@
+# API: Implementation Guide
+
+**Source:** https://www.opendental.com/site/apiimplementation.html
+**Extracted:** 2026-04-22
+**Base Path:** `/api/v1`
+
+---
+
+## Overview
+
+This page documents the conventions, data types, pagination strategy, throttling rules, and HTTP behavior that apply uniformly across all Open Dental API endpoints. All SDK implementations must adhere to these rules.
+
+---
+
+## Base URL
+
+```
+https://api.opendental.com/api/v1
+```
+
+The API is versioned as v1. A v2 will only be introduced if breaking changes are required.
+
+---
+
+## URL & Naming Conventions
+
+- Resources use **lowercase plural** format: `/patients`, `/appointments`
+- Individual records are addressed by database primary key: `/patients/421`
+- Create/list operations omit the identifier: `/patients`
+- Field names use **PascalCase** (first letter capitalized): `PatNum`, `ClinicNum`
+- Non-database computed fields use **lowercase initial**: `clinicAbbr`, `confirmed`, `provAbbr`
+- Non-CRUD method examples: `/claimprocs/InsAdjust`, `/appointments/123/Confirm`
+
+---
+
+## Request Requirements
+
+**Required Header:**
+```
+Content-Type: application/json
+```
+
+**Body Size Limit:** PUT/POST JSON body maximum content length is **16.8 million characters**.
+
+---
+
+## Pagination
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| Limit | integer | 100 (local: 1000) | Maximum records to return per request |
+| Offset | integer | 0 | Number of records to skip |
+
+**Pagination strategy:** Perform an initial GET without offset/limit. If exactly 100 rows are returned, issue subsequent GETs with incremented offsets until fewer than 100 rows are returned.
+
+---
+
+## Date and DateTime Formatting
+
+**Date format** (version 22.2.26+):
+- Default: `yyyy-MM-dd`
+- Override per-request via query parameter `DateFormatString`
+- Example: `GET /procedurelogs?PatNum=52&DateFormatString=MM/dd/yyyy`
+
+**DateTime format** (version 22.2.14+):
+- Default: `yyyy-MM-dd HH:mm:ss`
+- Override per-request via query parameter `DateTimeFormatString`
+- Example: `GET /patients/Simple?DateTimeFormatString=dd/MM/yyyy HH:mm:ss zzz`
+
+---
+
+## Data Types
+
+| Type | DB Storage | API Representation |
+|------|-----------|-------------------|
+| Enumeration | Numeric integer | Text string, capitalized (e.g., "Male" not 0) |
+| Boolean | Numeric | String: "true" or "false" |
+| Date | String | `yyyy-MM-dd` (customizable) |
+| DateTime | String | `yyyy-MM-dd HH:mm:ss` (customizable) |
+| Foreign Key (write) | Numeric | Numeric (e.g., `ClinicNum=23`) |
+| Foreign Key (read) | Numeric | Lowercase string companion field (e.g., `clinicAbbr="Monroe"`) |
+| String (with carriage returns) | Text | Carriage returns (`\r\n`) output as spaces |
+
+---
+
+## URL Parameter Encoding
+
+Use percent encoding for all reserved characters in URL query parameters. Quotes are not used in URL parameters.
+
+- Space → `%20` (e.g., `De%20Angelo`)
+
+---
+
+## HTTP Status Codes
+
+| Code | Meaning |
+|------|---------|
+| 200 | OK — successful GET or PUT |
+| 201 | Created — successful POST |
+| 400 | BadRequest — eConnector issues, version mismatches, network issues, or malformed requests |
+| 401 | Unauthorized — invalid/disabled credentials or insufficient ApiPermission |
+| 404 | NotFound — non-existent API resource |
+| 410 | Gone — deprecated API resource |
+| 504 | Gateway Timeout — request exceeded 60-second processing limit |
+
+---
+
+## Throttling Rules
+
+| API Mode | Permission | Throttle Rate |
+|----------|-----------|---------------|
+| Standard API | `ApiReadAll` only | 1 request per 5 seconds (per customer key) |
+| Standard API | Any other permission (e.g., `ApiComm`) | 1 request per 1 second (per customer key) |
+| Local API | Any | No throttling |
+| API Service | Any | No throttling |
+
+Local API and API Service credentials are validated via HQ web call; valid for up to 6 hours offline.
+
+---
+
+## Implementation Notes
+
+- API behavior mirrors Open Dental UI operations but is not identical — there is less automation.
+- The API enforces database integrity; it is safe to use and prevents data corruption unlike direct DB queries.
+- Automatic security logging, archival, synchronization, and hashing are applied by the API.
+- The database version on the server must meet or exceed the version in which a method was added.
+- Excessive requests may result in temporary suspension or permanent termination at Open Dental's discretion.
+- Third-party implementers are solely responsible for securely retaining original signatures of digitally signed documents and must present them for verification on request.

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

@@ -0,0 +1,236 @@
+# API: InsPlans
+
+**Source:** https://www.opendental.com/site/apiinsplans.html
+**DB Schema Ref:** insplan
+**Extracted:** 2026-04-22
+**Base Path:** `/insplans`
+
+---
+
+## Overview
+
+InsPlans manages insurance plan records. An insurance plan defines the carrier, plan type, fee schedules, and billing rules. Multiple subscribers can share the same plan via the InsSub table. The PatPlan table determines coverage for individual patients.
+
+---
+
+## Endpoints
+
+### GET /insplans/{PlanNum}
+
+**Version:** 24.2.11
+**Description:** Retrieves a single insurance plan by its primary key.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PlanNum | integer | Yes | Insurance plan primary key |
+
+**Response:** Single object
+
+| Field | Type | Description |
+|-------|------|-------------|
+| PlanNum | integer | Primary key |
+| GroupName | string | Optional group name |
+| GroupNum | string | Optional group/plan number (Canada: Plan Number) |
+| PlanNote | string | Note for this plan; same for all subscribers |
+| FeeSched | integer | FK to feesched.FeeSchedNum |
+| PlanType | string | "" = Percentage, "p" = PPO Percentage, "f" = Flat Copay, "c" = Capitation |
+| ClaimFormNum | integer | FK to claimform.ClaimFormNum |
+| ClaimsUseUCR | string | "true" or "false" — bill standard provider fee on claims |
+| CopayFeeSched | integer | FK to feesched.FeeSchedNum (FeeSchedType=CoPay) |
+| EmployerNum | integer | FK to employer.EmployerNum |
+| CarrierNum | integer | FK to carrier.CarrierNum |
+| IsMedical | string | "true" or "false" — medical vs. dental insurance |
+| FilingCode | integer | FK to insfilingcode.InsFilingCodeNum |
+| ShowBaseUnits | string | "true" or "false" — show base units on claim form |
+| CodeSubstNone | string | "true" or "false" — disable procedure code downgrade substitution |
+| IsHidden | string | "true" or "false" |
+| MonthRenew | integer | 1–12 for renewal month; 0 = calendar year (renews 1st of month) |
+| FilingCodeSubtype | integer | FK to insfilingcodesubtype.InsFilingCodeSubtypeNum |
+| CobRule | string | "Basic", "Standard", "CarveOut", "SecondaryMedicaid" |
+| SecUserNumEntry | integer | FK to userod.UserNum — entry user |
+| SecDateEntry | string | Date of entry (yyyy-MM-dd) |
+| SecDateTEdit | string | Last modified timestamp (yyyy-MM-dd HH:mm:ss) |
+| BillingType | integer | FK to definition.DefNum (Category=4) |
+| ExclusionFeeRule | string | "PracticeDefault", "DoNothing", "UseUcrFee" |
+| ManualFeeSchedNum | integer | FK to feesched.FeeSchedNum (FeeSchedType=ManualBlueBook) |
+| IsBlueBookEnabled | string | "true" or "false" |
+| InsPlansZeroWriteOffsOnAnnualMaxOverride | string | "Default", "Yes", "No" |
+| InsPlansZeroWriteOffsOnFreqOrAgingOverride | string | "Default", "Yes", "No" |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 404 | NotFound |
+
+---
+
+### GET /insplans
+
+**Version:** 22.3.30
+**Description:** Retrieves a list of insurance plans with optional filtering.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| PlanType | string | No | — | Filter by plan type: "percentage", "p", "f", "c" (added 24.2.11) |
+| CarrierNum | integer | No | — | FK to carrier.CarrierNum (added 24.2.11) |
+
+**Response:** Array of objects with same fields as single GET
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+
+---
+
+### POST /insplans
+
+**Version:** 22.4.24
+**Description:** Creates a new insurance plan.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| CarrierNum | integer | Yes | FK to carrier.CarrierNum |
+| GroupName | string | No | Optional group name |
+| GroupNum | string | No | Optional group/plan number |
+| PlanNote | string | No | Plan note |
+| FeeSched | integer | No | FK to feesched.FeeSchedNum; default 0 |
+| PlanType | string | No | "" / "p" / "f" / "c"; default "" (Percentage) |
+| ClaimFormNum | integer | No | FK to claimform.ClaimFormNum; defaults to DefaultClaimForm preference (added 25.2.24) |
+| ClaimsUseUCR | string | No | "true"/"false"; defaults to "true" if InsDefaultShowUCRonClaims pref enabled and PlanType="" (added 25.1.20) |
+| CopayFeeSched | integer | No | FK to feesched.FeeSchedNum (CoPay type); default 0 (added 23.3.17) |
+| EmployerNum | integer | No | FK to employer.EmployerNum; default 0 |
+| IsMedical | string | No | "true"/"false"; default "false" (added 24.4.34) |
+| FilingCode | integer | No | FK to insfilingcode.InsFilingCodeNum; default 0 (added 25.1.20) |
+| ShowBaseUnits | string | No | "true"/"false"; default "false" (added 25.1.20) |
+| CodeSubstNone | string | No | "true"/"false"; default "false" (added 22.4.31) |
+| IsHidden | string | No | "true"/"false"; default "false" (added 22.4.31) |
+| MonthRenew | integer | No | 1–12 or 0 for calendar year; default 0 |
+| FilingCodeSubtype | integer | No | FK to insfilingcodesubtype.InsFilingCodeSubtypeNum; default 0 (added 25.1.20) |
+| CobRule | string | No | "Basic"/"Standard"/"CarveOut"/"SecondaryMedicaid"; defaults to InsDefaultCobRule preference (added 25.1.20) |
+| BillingType | integer | No | FK to definition.DefNum (Category=4); default 0 (added 25.1.20) |
+| ExclusionFeeRule | string | No | "PracticeDefault"/"DoNothing"/"UseUcrFee"; default "PracticeDefault" (added 25.1.20) |
+| ManualFeeSchedNum | integer | No | FK to feesched.FeeSchedNum (ManualBlueBook type); only if AllowedFeeSchedsAutomate="BlueBook" and IsBlueBookEnabled="true"; default 0 (added 25.2.24) |
+| IsBlueBookEnabled | string | No | "true"/"false"; cannot be true if PlanType is "p", "f", or "c"; defaults to true if AllowedFeeSchedsAutomate="BlueBook" |
+| InsPlansZeroWriteOffsOnAnnualMaxOverride | string | No | "Default"/"Yes"/"No"; default "Default" (added 25.1.20) |
+| InsPlansZeroWriteOffsOnFreqOrAgingOverride | string | No | "Default"/"Yes"/"No"; default "Default" (added 25.1.20) |
+
+**Response:** Created plan object with all fields populated, including generated `PlanNum` and security fields
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### PUT /insplans/{PlanNum}
+
+**Version:** 22.3.30
+**Description:** Updates an existing insurance plan. All body fields are optional.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PlanNum | integer | Yes | Insurance plan primary key |
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| GroupName | string | No | Group name |
+| GroupNum | string | No | Group/plan number |
+| PlanNote | string | No | Plan note |
+| FeeSched | integer | No | FK to feesched.FeeSchedNum |
+| PlanType | string | No | "" / "p" / "f" / "c" |
+| ClaimFormNum | integer | No | FK to claimform.ClaimFormNum (added 25.2.24) |
+| ClaimsUseUCR | string | No | "true"/"false" (added 25.1.20) |
+| CopayFeeSched | integer | No | FK to feesched.FeeSchedNum (CoPay type) (added 23.3.17) |
+| EmployerNum | integer | No | FK to employer.EmployerNum (added 22.4.24) |
+| CarrierNum | integer | No | FK to carrier.CarrierNum (added 22.4.24) |
+| IsMedical | string | No | "true"/"false" (added 24.4.34) |
+| FilingCode | integer | No | FK to insfilingcode.InsFilingCodeNum (added 25.1.20) |
+| ShowBaseUnits | string | No | "true"/"false" (added 25.1.20) |
+| CodeSubstNone | string | No | "true"/"false" (added 22.4.31) |
+| IsHidden | string | No | "true"/"false" (added 22.4.31) |
+| MonthRenew | integer | No | 1–12 or 0 for calendar year |
+| FilingCodeSubtype | integer | No | FK to insfilingcodesubtype (added 25.1.20) |
+| CobRule | string | No | "Basic"/"Standard"/"CarveOut"/"SecondaryMedicaid" (added 25.1.20) |
+| BillingType | integer | No | FK to definition.DefNum (Category=4) (added 25.1.20) |
+| ExclusionFeeRule | string | No | "PracticeDefault"/"DoNothing"/"UseUcrFee" (added 25.1.20) |
+| ManualFeeSchedNum | integer | No | FK to feesched.FeeSchedNum (ManualBlueBook); use 0 for "None"; only allowed if AllowedFeeSchedsAutomate="BlueBook" and IsBlueBookEnabled="true" (added 25.2.24) |
+| IsBlueBookEnabled | string | No | "true"/"false"; cannot be true if PlanType is "p", "f", or "c" (added 22.4.24) |
+| InsPlansZeroWriteOffsOnAnnualMaxOverride | string | No | "Default"/"Yes"/"No" (added 25.1.20) |
+| InsPlansZeroWriteOffsOnFreqOrAgingOverride | string | No | "Default"/"Yes"/"No" (added 25.1.20) |
+
+**Response:** Updated plan object with all fields
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+## Field Reference
+
+### PlanType
+
+| Value | Description |
+|-------|-------------|
+| "" | Percentage (default; stored as blank in DB) |
+| "p" | PPO Percentage |
+| "f" | Flat Copay |
+| "c" | Capitation |
+
+### CobRule (enum: EnumCobRule)
+
+| Value | DB Int | Description |
+|-------|--------|-------------|
+| Basic | 0 | Basic COB rule |
+| Standard | 1 | Standard COB rule |
+| CarveOut | 2 | Carve-out COB rule |
+| SecondaryMedicaid | 3 | Secondary pays after primary; patient portion becomes secondary writeoff. Use only when Medicaid is required to be secondary. |
+
+### ExclusionFeeRule
+
+| Value | Description |
+|-------|-------------|
+| PracticeDefault | Use the practice-level default setting |
+| DoNothing | No action on exclusion |
+| UseUcrFee | Use the UCR fee on exclusions |
+
+### InsPlansZeroWriteOffsOnAnnualMaxOverride / InsPlansZeroWriteOffsOnFreqOrAgingOverride
+
+| Value | Description |
+|-------|-------------|
+| Default | Use practice default setting |
+| Yes | Zero out write-offs |
+| No | Do not zero out write-offs |
+
+---
+
+## Implementation Notes
+
+- `IsBlueBookEnabled` cannot be set to "true" if `PlanType` is "p", "f", or "c" (only valid for Percentage plans).
+- `ManualFeeSchedNum` is only allowed when the practice preference `AllowedFeeSchedsAutomate` = "BlueBook" and `IsBlueBookEnabled` = "true".
+- `MonthRenew` = 0 means calendar year; the plan renews on the first of the month when set to 1–12.
+- `ClaimsUseUCR` defaults depend on the `InsDefaultShowUCRonClaims` preference and the `PlanType` setting.
+- `CobRule` defaults to the `InsDefaultCobRule` practice preference when not specified.
+- `ClaimFormNum` defaults to the `DefaultClaimForm` practice preference when not specified.
+
+## Related Resources
+
+| Resource | Purpose |
+|----------|---------|
+| /inssubs | Links an Insplan to a subscriber (patient) |
+| /feescheds | Manages fee schedules referenced by FeeSched, CopayFeeSched, ManualFeeSchedNum |
+| /insverifies | Insurance benefit and enrollment verification records |