@rinse-dental/open-dental 3.4.2 → 4.0.2

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

@@ -0,0 +1,510 @@
+# API: Appointments
+
+**Source:** https://www.opendental.com/site/apiappointments.html
+**DB Schema Ref:** appointment
+**Extracted:** 2026-04-22
+**Base Path:** `/appointments`
+
+---
+
+## Overview
+Appointments represent scheduled, planned, unscheduled, or broken patient visits. They can be standard chair-time appointments, ASAP-priority slots, planned appointments (Chart module), WebSched online bookings, or patient post-it notes. The DB table also stores historical state via DateTStamp for synchronization.
+
+---
+
+## Endpoints
+
+### GET /appointments/{AptNum}
+
+**Version:** 21.1
+**Description:** Retrieves a single appointment by its primary key.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| AptNum | integer | Yes | FK to appointment.AptNum |
+
+**Response:** Single appointment object
+| Field | Type | Description |
+|-------|------|-------------|
+| AptNum | integer | Primary key |
+| PatNum | integer | FK to patient.PatNum |
+| AptStatus | string (enum) | Appointment status; see Field Reference |
+| AptDateTime | datetime (yyyy-MM-dd HH:mm:ss) | Appointment start time |
+| Op | integer | FK to operatory.OperatoryNum |
+| ProvNum | integer | FK to provider.ProvNum |
+| provAbbr | string | Provider abbreviation (display) |
+| ProvHyg | integer | FK to provider.ProvNum for hygienist; 0 if none |
+| Pattern | string | Time pattern in 5-min increments: X=doctor time, /=assistant time |
+| PatternSecondary | string | Secondary provider time pattern; same length as Pattern |
+| Confirmed | integer | FK to definition.DefNum (category=2; ApptConfirmed) |
+| confirmed | string | Confirmation status display label |
+| Note | string | Appointment notes |
+| NextAptNum | integer | FK to appointment.AptNum of the planned appointment this was derived from; 0 if none |
+| UnschedStatus | integer | FK to definition.DefNum (category=13; RecallUnschedStatus); 0 if none |
+| unschedStatus | string | Unscheduled status display label |
+| IsNewPatient | string | "true" or "false" |
+| IsHygiene | string | "true" or "false" |
+| ProcDescript | string | One-line summary of all procedures; auto-generated |
+| Assistant | integer | FK to employee.EmployeeNum; 0 if none |
+| ClinicNum | integer | FK to clinic.ClinicNum; 0 if no clinic |
+| DateTimeArrived | datetime | Patient check-in time; "0001-01-01 00:00:00" if not set |
+| DateTimeSeated | datetime | Patient seated time; "0001-01-01 00:00:00" if not set |
+| DateTimeDismissed | datetime | Patient dismissal time; "0001-01-01 00:00:00" if not set |
+| InsPlan1 | integer | FK to insplan.PlanNum for primary insurance at completion; 0 if none |
+| InsPlan2 | integer | FK to insplan.PlanNum for secondary insurance at completion; 0 if none |
+| DateTimeAskedToArrive | datetime | Requested arrival time; "0001-01-01 00:00:00" if same as AptDateTime |
+| colorOverride | string | RGB color override "R,G,B"; "0,0,0" means black; 0 stored in DB means no override |
+| AppointmentTypeNum | integer | FK to appointmenttype.AppointmentTypeNum; 0 if none |
+| SecUserNumEntry | integer | FK to userod.UserNum; user who created the record |
+| SecDateTEntry | datetime | Auto-generated entry timestamp |
+| Priority | string (enum) | "Normal" or "ASAP"; see Field Reference |
+| ItemOrderPlanned | integer | 1-indexed order among patient's planned appointments |
+| IsMirrored | string | "true" or "false"; controls secondary operatory mirror display |
+| TimeLocked | string | "true" or "false"; if true, pattern not auto-reset when procedures change |
+| DateTStamp | datetime | Auto-updated by MySQL on any row change; use for sync |
+| serverDateTime | datetime | Server time at moment of response; use as next DateTStamp sync cursor |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 404 | NotFound |
+
+---
+
+### GET /appointments
+
+**Version:** 21.1
+**Description:** Retrieves multiple appointments with optional filtering. Supports date range, status, provider, clinic, operatory, and timestamp-based synchronization.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| PatNum | integer | No | — | Filter by patient; added v21.4 |
+| AptStatus | string (enum) | No | — | Filter by status; added v22.4.28 |
+| Op | integer | No | — | Filter by operatory; added v23.2.27 |
+| date | string (yyyy-MM-dd) | No | — | Single day filter |
+| dateStart | string (yyyy-MM-dd) | No | — | Range start (inclusive) |
+| dateEnd | string (yyyy-MM-dd) | No | — | Range end (inclusive) |
+| ClinicNum | integer | No | — | Clinic filter; 0 for non-clinic appointments; omit for all clinics |
+| DateTStamp | string (yyyy-MM-dd HH:mm:ss) | No | — | Returns appointments modified after this timestamp |
+| AppointmentTypeNum | integer | No | — | Filter by appointment type; added v24.4.22 |
+| Offset | integer | No | 0 | Pagination offset |
+
+**Response:** Array of appointment objects (same fields as GET /appointments/{AptNum})
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### GET /appointments/ASAP
+
+**Version:** 21.1
+**Description:** Retrieves appointments with ASAP priority.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| ClinicNum | integer | Yes (if clinics enabled) | — | Clinic filter; use 0 for non-clinic appointments |
+| ProvNum | integer | No | — | Filter by provider |
+| Offset | integer | No | 0 | Pagination offset |
+
+**Response:** Array of appointment objects with `Priority: "ASAP"`
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+
+---
+
+### GET /appointments/Slots
+
+**Version:** 21.1
+**Description:** Retrieves available appointment time slots based on provider and operatory schedules. Returns full open slots, not suggested times.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| date | string (yyyy-MM-dd) | No | — | Single day; must be today or future |
+| dateStart | string (yyyy-MM-dd) | No | — | Range start (inclusive) |
+| dateEnd | string (yyyy-MM-dd) | No | — | Range end (inclusive); defaults to next 14 days if no dates given |
+| lengthMinutes | integer | No | — | Filters out slots shorter than this duration |
+| ProvNum | integer | No | — | Provider filter; defaults to practice default provider |
+| OpNum | integer | No | — | Operatory filter; added v22.1 |
+
+**Response:** Array of slot objects
+| Field | Type | Description |
+|-------|------|-------------|
+| DateTimeStart | datetime | Slot start time |
+| DateTimeEnd | datetime | Slot end time |
+| ProvNum | integer | Provider identifier |
+| OpNum | integer | Operatory identifier |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+
+---
+
+### GET /appointments/SlotsWebSched
+
+**Version:** 21.1
+**Description:** Retrieves WebSched-configured appointment slots. Requires WebSched eServices subscription.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| date | string (yyyy-MM-dd) | No | — | Single day |
+| dateStart | string (yyyy-MM-dd) | No | — | Range start (inclusive) |
+| dateEnd | string (yyyy-MM-dd) | No | — | Range end (inclusive); defaults to next 14 days if no dates given |
+| ClinicNum | integer | Yes (if clinics enabled) | — | Clinic identifier |
+| defNumApptType | integer | No | — | Definition number where category=42 (NewPat) or 51 (ExistingPat) |
+| isNewPatient | string | No | "false" | "true" or "false" |
+
+**Response:** Array of slot objects
+| Field | Type | Description |
+|-------|------|-------------|
+| DateTimeStart | datetime | Slot start time |
+| DateTimeEnd | datetime | Slot end time |
+| ProvNum | integer | Provider identifier |
+| OpNum | integer | Operatory identifier |
+
+---
+
+### GET /appointments/WebSched
+
+**Version:** 21.3
+**Description:** Retrieves appointments that originated from WebSched online booking.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| date | string (yyyy-MM-dd) | No | — | Single day |
+| dateStart | string (yyyy-MM-dd) | No | — | Range start (inclusive) |
+| dateEnd | string (yyyy-MM-dd) | No | — | Range end (inclusive) |
+| DateTStamp | string (yyyy-MM-dd HH:mm:ss) | No | — | Returns appointments modified after this timestamp |
+| ClinicNum | integer | No | — | Clinic filter |
+| Offset | integer | No | 0 | Pagination offset |
+
+**Response:** Array of appointment objects with additional field:
+| Field | Type | Description |
+|-------|------|-------------|
+| eServiceLogType | string (enum) | "Recall", "NewPat", "ExistingPat", "ASAP", or "None" |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+
+---
+
+### POST /appointments
+
+**Version:** 21.1
+**Description:** Creates a new scheduled appointment.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PatNum | integer | Yes | FK to patient.PatNum |
+| Op | integer | Yes | FK to operatory.OperatoryNum |
+| AptDateTime | string (yyyy-MM-dd HH:mm:ss) | Yes | Appointment start time; use GET Slots to find available times |
+| AptStatus | string (enum) | No | "Scheduled" (default), "Complete", "UnschedList", "PtNote", "PtNoteCompleted" |
+| Pattern | string | No | 5-min increment pattern; default "/XX/" (20 min); max 9 hours |
+| Confirmed | integer | No | FK to definition.DefNum (category=2); defaults to first in category |
+| Note | string | No | Appointment notes; default blank |
+| ProvNum | integer | No | Provider; defaults to patient primary provider or office default |
+| ProvHyg | integer | No | Hygiene provider; default 0 |
+| Assistant | integer | No | FK to employee.EmployeeNum; default 0; added v25.4.28 |
+| ClinicNum | integer | No | Defaults to operatory clinic or patient clinic |
+| IsHygiene | string | No | "true" or "false"; default "false" |
+| DateTimeArrived | string (HH:mm:ss) | No | Patient check-in time; added v25.2.10 |
+| DateTimeSeated | string (HH:mm:ss) | No | Patient seated time; added v25.2.10 |
+| DateTimeDismissed | string (HH:mm:ss) | No | Patient dismissal time; added v25.2.10 |
+| IsNewPatient | string | No | "true" or "false"; default "false"; sets patient.DateFirstVisit if true; added v21.3 |
+| Priority | string (enum) | No | "Normal" (default) or "ASAP"; added v22.1 |
+| AppointmentTypeNum | integer | No | FK to appointmenttype; default 0; applies pattern and color if not otherwise specified; added v22.1 |
+| colorOverride | string (R,G,B) | No | RGB color override; defaults to AppointmentType color if type specified; added v22.3.9 |
+| PatternSecondary | string | No | Secondary provider pattern; must match Pattern length; defaults to all "/"; added v23.3.17 |
+| SecUserNumEntry | integer | No | FK to userod.UserNum; default 0; added v25.1.27 |
+| IsMirrored | string | No | "true" or "false"; default based on ShowMirroredAppts preference; added v25.4.28 |
+
+**Response:** Appointment object (same fields as GET /appointments/{AptNum})
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created (header: "location": appointment URL) |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### POST /appointments/Planned
+
+**Version:** 22.2.31
+**Description:** Creates a planned appointment visible in the Chart Module Planned Appts tab. Does not appear on the schedule.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PatNum | integer | Yes | FK to patient.PatNum |
+| AppointmentTypeNum | integer | Yes* | Required if procNums not provided |
+| procNums | integer array | Yes* | Required if AppointmentTypeNum not provided; repeated values silently ignored |
+| Pattern | string | No | 5-min pattern; default "/XX/" (20 min); max 9 hours; derived from procedure length if not specified |
+| Confirmed | integer | No | FK to definition.DefNum (category=2); defaults to first in category |
+| Note | string | No | Appointment notes; default blank |
+| ProvNum | integer | No | Defaults to patient primary provider or office default |
+| ProvHyg | integer | No | Hygiene provider; default 0 |
+| ClinicNum | integer | No | Defaults to patient clinic |
+| IsHygiene | string | No | "true" or "false"; default "false" |
+| IsNewPatient | string | No | "true" or "false"; default "false" |
+| Priority | string (enum) | No | "Normal" (default) or "ASAP" |
+| PatternSecondary | string | No | Secondary pattern; must match Pattern length; added v23.3.17 |
+
+**Response:** Appointment object with `AptStatus: "Planned"`
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### POST /appointments/SchedulePlanned
+
+**Version:** 22.2
+**Description:** Schedules a new appointment from an existing planned appointment. Does not modify the original planned appointment.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| AptNum | integer | Yes | AptNum of the planned appointment |
+| AptDateTime | string (yyyy-MM-dd HH:mm:ss) | Yes | Scheduled start time; use GET Slots |
+| ProvNum | integer | Yes | Provider from the chosen timeslot |
+| Op | integer | Yes | Operatory from the chosen timeslot |
+| Confirmed | integer | No | FK to definition.DefNum (category=2) |
+| Note | string | No | Overwrites existing note |
+
+**Response:** Appointment object with `AptStatus: "Scheduled"` and `NextAptNum` linking to the planned appointment
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### POST /appointments/WebSched
+
+**Version:** 21.3
+**Description:** Creates a WebSched appointment from a slot returned by GET SlotsWebSched. Requires WebSched eServices subscription.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PatNum | integer | Yes | FK to patient.PatNum |
+| DateTimeStart | string (yyyy-MM-dd HH:mm:ss) | Yes | Timeslot start from GET SlotsWebSched |
+| DateTimeEnd | string (yyyy-MM-dd HH:mm:ss) | Yes | Timeslot end from GET SlotsWebSched |
+| ProvNum | integer | Yes | Provider from timeslot |
+| OpNum | integer | Yes | Operatory from timeslot |
+| defNumApptType | integer | Yes | Must match value used in GET SlotsWebSched |
+
+**Response:** Appointment object
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### PUT /appointments/{AptNum}
+
+**Version:** 21.1
+**Description:** Updates an existing appointment. All body fields are optional.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| AptNum | integer | Yes | Primary key of the appointment to update |
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| AptStatus | string (enum) | No | "Scheduled", "Complete", "UnschedList", "Broken", "Planned", "PtNote", "PtNoteCompleted" |
+| Pattern | string | No | 5-min pattern; max 9 hours |
+| Confirmed | integer | No | FK to definition.DefNum (category=2) |
+| Op | integer | No | Operatory identifier |
+| Note | string | No | Overwrites existing note entirely |
+| ProvNum | integer | No | Provider identifier |
+| ProvHyg | integer | No | Hygiene provider identifier |
+| AptDateTime | string (yyyy-MM-dd HH:mm:ss) | No | New start time |
+| Assistant | integer | No | FK to employee.EmployeeNum; added v25.4.28 |
+| ClinicNum | integer | No | Clinic identifier |
+| IsHygiene | string | No | "true" or "false" |
+| DateTimeArrived | string (HH:mm:ss) | No | Check-in time; added v25.2.10 |
+| DateTimeSeated | string (HH:mm:ss) | No | Seated time; added v25.2.10 |
+| DateTimeDismissed | string (HH:mm:ss) | No | Dismissal time; added v25.2.10 |
+| IsNewPatient | string | No | "true" or "false"; added v21.3 |
+| Priority | string (enum) | No | "Normal" or "ASAP"; added v22.1 |
+| AppointmentTypeNum | integer | No | FK to appointmenttype; use 0 for None; applies pattern/color if not specified; added v22.1 |
+| UnschedStatus | integer | No | FK to definition.DefNum (category=13); use 0 for None; added v22.2 |
+| colorOverride | string (R,G,B) | No | RGB color; use 0 to clear override; added v22.3.9 |
+| PatternSecondary | string | No | Secondary pattern; must match Pattern length; added v23.3.17 |
+| IsMirrored | string | No | "true" or "false"; added v25.4.28 |
+
+**Response:** Updated appointment object
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### PUT /appointments/{AptNum}/Break
+
+**Version:** 21.3
+**Description:** Breaks a scheduled appointment. Only applies to appointments with `AptStatus: "Scheduled"`.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| AptNum | integer | Yes | Primary key of the appointment to break |
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| sendToUnscheduledList | string | Yes | "true" to move to unscheduled list, "false" to not |
+| breakType | string (enum) | No | "Missed" (adds D9986 procedure), "Cancelled" (adds D9987 procedure), or omit for 24+ hour notice |
+
+**Response:** 200 OK (no content body)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### PUT /appointments/{AptNum}/Note
+
+**Version:** 21.1
+**Description:** Appends text to the existing appointment note (unlike PUT /appointments which overwrites).
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| AptNum | integer | Yes | Primary key of the appointment |
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| Note | string | Yes | Text to append; a carriage return is automatically prepended if a note already exists |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### PUT /appointments/{AptNum}/Confirm
+
+**Version:** 21.1
+**Description:** Updates the appointment confirmation status. Exactly one of `confirmVal` or `defNum` must be provided.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| AptNum | integer | Yes | Primary key of the appointment |
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| confirmVal | string (enum) | No* | "None", "Sent", "Confirmed", "Not Accepted", or "Failed"; exactly one of confirmVal/defNum required |
+| defNum | integer | No* | FK to definition.DefNum (category=2); added v21.2; exactly one of confirmVal/defNum required |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+## Field Reference
+
+### AptStatus (enum: ApptStatus)
+| Value | DB Int | Description |
+|-------|--------|-------------|
+| None | 0 | No appointment should ever have this status |
+| Scheduled | 1 | Shows as a regularly scheduled appointment |
+| Complete | 2 | Shows greyed out |
+| UnschedList | 3 | Only shows on unscheduled list |
+| ASAP | 4 | Deprecated in 17.4.1; use Priority field instead |
+| Broken | 5 | Shows with a big X on it |
+| Planned | 6 | Planned appointment; only shows in Chart module |
+| PtNote | 7 | Patient post-it note on the schedule; shows light yellow |
+| PtNoteCompleted | 8 | Patient post-it note completed |
+
+### Priority (enum: ApptPriority)
+| Value | DB Int | Description |
+|-------|--------|-------------|
+| Normal | 0 | Default priority |
+| ASAP | 1 | Used to identify items for the ASAP list |
+
+---
+
+## Implementation Notes
+- Use `serverDateTime` from the response as the next `DateTStamp` cursor value for incremental sync.
+- Empty/null datetime values are represented as "0001-01-01 00:00:00".
+- `Pattern` strings use X (doctor/booked time) and / (assistant/open time) only, in 5-minute increments.
+- `PatternSecondary` must be the same length as `Pattern`; defaults to all "/" characters.
+- `colorOverride` format is "R,G,B" where each component is 0–255; sending "0" clears the override.
+- `AppointmentTypeNum` of 0 means no appointment type; when set, applies the type's pattern and color unless those are explicitly provided.
+- PUT /appointments `Note` field overwrites; use PUT /appointments/{AptNum}/Note to append.
+- Break endpoint only works on `AptStatus: "Scheduled"` appointments.
+- `breakType` procedure codes (D9986/D9987) require office configuration to function.
+- For multi-operatory providers, GET Slots returns only times available across all operatories simultaneously.
+- `NextAptNum` in the DB is described as "PlannedAptNum" — it identifies the planned appointment from which a scheduled appointment was derived.
+- `InsPlan1`/`InsPlan2` are set at appointment completion time and cannot identify the subscriber, only the plan.
+
+---
+
+## Related Resources
+| Resource | Purpose |
+|----------|---------|
+| AppointmentTypes | AppointmentTypeNum reference |
+| ApptFields | Custom fields on appointments |
+| Patients | PatNum source |
+| Definitions (category=2) | Confirmation status values |
+| Definitions (category=13) | Unscheduled status values |
+| Operatories | Op/OpNum reference |
+| Providers | ProvNum/ProvHyg source |
+| ChartModules | Planned appointment retrieval |

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

@@ -0,0 +1,86 @@
+# API: AppointmentTypes
+
+**Source:** https://www.opendental.com/site/apiappointmenttypes.html
+**DB Schema Ref:** appointmenttype
+**Extracted:** 2026-04-22
+**Base Path:** `/appointmenttypes`
+
+---
+
+## Overview
+AppointmentTypes define named templates that control the visual color, time pattern, and associated procedure codes of appointments. When an appointment is assigned an AppointmentTypeNum, it inherits the type's color and pattern unless explicitly overridden.
+
+---
+
+## Endpoints
+
+### GET /appointmenttypes/{AppointmentTypeNum}
+
+**Version:** 25.4.35
+**Description:** Retrieves a single appointment type by its primary key.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| AppointmentTypeNum | integer | Yes | Primary key of the appointment type |
+
+**Response:** Single appointmenttype object (see field table below)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 404 | NotFound |
+
+---
+
+### GET /appointmenttypes
+
+**Version:** 22.4.10
+**Description:** Retrieves all appointment types.
+
+**Response:** Array of appointmenttype objects
+| Field | Type | Description |
+|-------|------|-------------|
+| AppointmentTypeNum | integer | Primary key |
+| AppointmentTypeName | string | Display name of the type |
+| appointmentTypeColor | string | RGB color value (e.g., "93,54,220"); stored as int in DB |
+| IsHidden | boolean | Whether the type is hidden from UI selection |
+| Pattern | string | Time pattern in 5-min increments (X=doctor, /=assistant); blank if pattern is derived dynamically from CodeStr procedures |
+| CodeStr | string | Comma-delimited list of procedure codes (e.g., "T1234,T4321") |
+| CodeStrRequired | string | Comma-delimited list of required procedure codes |
+| RequiredProcCodesNeeded | string (enum) | Requirement level for CodeStrRequired; see Field Reference |
+| BlockoutTypes | string | Comma-delimited list of definition.DefNums (category=25) for associated blockout types |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+
+---
+
+## Field Reference
+
+### RequiredProcCodesNeeded (enum: EnumRequiredProcCodesNeeded)
+| Value | DB Int | Description |
+|-------|--------|-------------|
+| None | 0 | No procedure codes from CodeStrRequired are needed to schedule appointments of this type |
+| AtLeastOne | 1 | At least one procedure code from CodeStrRequired is needed to schedule |
+| All | 2 | All procedure codes from CodeStrRequired are needed to schedule |
+
+---
+
+## Implementation Notes
+- `Pattern` is blank when the pattern should be dynamically calculated from the procedures in `CodeStr`.
+- `appointmentTypeColor` is stored as an integer (RGB packed) in the DB but returned as an "R,G,B" string by the API.
+- When assigning `AppointmentTypeNum` to an appointment via POST/PUT Appointments, the `ColorOverride` on the appointment should be updated to match the type's color.
+- `BlockoutTypes` references definition.DefNums where definition.Category=25.
+- `CodeStr` and `CodeStrRequired` use comma-delimited procedure code strings, not arrays.
+
+---
+
+## Related Resources
+| Resource | Purpose |
+|----------|---------|
+| Appointments | Consumes AppointmentTypeNum for color/pattern/procedure defaults |
+| Definitions (category=25) | BlockoutTypes reference |