@rinse-dental/open-dental 3.4.2 → 4.0.2

package/src/types/benefitTypes.ts

@@ -1,70 +0,0 @@
-/**
- * @see https://www.opendental.com/site/apibenefits.html
- */
-export interface Benefit {
-  BenefitNum?: number; // Primary Key
-  PlanNum?: number; // FK to InsPlan.PlanNum.
-  PatPlanNum?: number; // FK to PatPlan.PlanNum.
-  CovCatNum?: number; // FK to covcat.CovCatNum.
-  BenefitType?: "ActiveCoverage" | "CoInsurance" | "Deductible" | "CoPayment" | "Exclusions" | "Limitations" | "WaitingPeriod"; // Either "ActiveCoverage", "CoInsurance", "Deductible", "CoPayment", "Exclusions", "Limitations", or "WaitingPeriod".
-  Percent?: number; // Only allowed if BenefitType is "CoInsurance". Must be a value between 0 and 100. Default -1 (Indicating empty).
-  MonetaryAmt?: number; // Only used if BenefitType is "CoPayment", "Limitations", or "Deductible". Default -1.0 (Indicating empty).
-  TimePeriod?: "None" | "ServiceYear" | "CalendarYear" | "Lifetime" | "Years" | "NumberInLast12Months"; // Either "None", "ServiceYear", "CalendarYear", "Lifetime", "Years", or "NumberInLast12Months". Default "CalendarYear".
-  QuantityQualifier?: "None" | "NumberOfServices" | "AgeLimit" | "Visits" | "Years" | "Months"; // Either "None", "NumberOfServices", "AgeLimit", "Visits", "Years", or "Months". Default "None". Must be "Months" or "Years" if BenefitType is "WaitingPeriod".
-  Quantity?: number; // Must be a value between 0 and 100. Default 0. Must be a value greater than 0 if QuantityQualifier is "AgeLimit".
-  CodeNum?: number; // FK to procedurecode.CodeNum. Only allowed if CovCatNum is 0. Will be used over procCode if both are specified. Default 0.
-  procCode?: string; // FK to procedurecode.ProcCode. Only allowed if CovCatNum is 0. Default empty string.
-  CoverageLevel?: "None" | "Individual" | "Family"; // Either "None", "Individual", or "Family".
-  SecDateTEntry?: string; // String in "yyyy-MM-dd HH:mm:ss" format
-  SecDateTEdit?: string; // String in "yyyy-MM-dd HH:mm:ss" format
-  CodeGroupNum?: number; // (Added in version 23.2.62) FK to codegroup.CodeGroupNum. The group of procedure codes that apply to this Frequency Limitation benefit.
-}
-
-/**
- * Gets a list of PatPlans that meet a set of search criteria.
- * @see https://www.opendental.com/site/apibenefits.html
- */
-export interface GetBenefitsParams {
-  PlanNum?: number; // FK to InsPlan.PlanNum.
-  PatPlanNum?: number; // FK to PatPlan.PatPlanNum.
-  Offset?: number; // Pagination offset for results
-}
-
-/**
- * Parameters for creating a new insplan.
- * @see https://www.opendental.com/site/apibenefits.html
- */
-export interface CreateBenefitParams {
-  PlanNum?: number; // This or PatPlanNum is required. FK to InsPlan.PlanNum.
-  PatPlanNum?: number; // This or PlanNum is required. FK to PatPlan.PlanNum.
-  BenefitType: "ActiveCoverage" | "CoInsurance" | "Deductible" | "CoPayment" | "Exclusions" | "Limitations" | "WaitingPeriod"; // Required. Either "ActiveCoverage", "CoInsurance", "Deductible", "CoPayment", "Exclusions", "Limitations", or "WaitingPeriod".
-  CoverageLevel: "None" | "Individual" | "Family"; // Required. Either "None", "Individual", or "Family".
-  CovCatNum?: number; // Optional. FK to covcat.CovCatNum.
-  Percent?: number; // Optional. Only allowed if BenefitType is "CoInsurance". Must be a value between 0 and 100. Default -1 (Indicating empty).
-  MonetaryAmt?: number; // Optional. Only used if BenefitType is "CoPayment", "Limitations", or "Deductible". Default -1.0 (Indicating empty).
-  TimePeriod?: "None" | "ServiceYear" | "CalendarYear" | "Lifetime" | "Years" | "NumberInLast12Months"; // Optional. Either "None", "ServiceYear", "CalendarYear", "Lifetime", "Years", or "NumberInLast12Months". Default "CalendarYear".
-  QuantityQualifier?: "None" | "NumberOfServices" | "AgeLimit" | "Visits" | "Years" | "Months"; // Optional. Either "None", "NumberOfServices", "AgeLimit", "Visits", "Years", or "Months". Default "None". Must be "Months" or "Years" if BenefitType is "WaitingPeriod".
-  Quantity?: number; // Optional. Must be a value between 0 and 100. Default 0. Must be a value greater than 0 if QuantityQualifier is "AgeLimit".
-  CodeNum?: number; // Optional. FK to procedurecode.CodeNum. Only allowed if CovCatNum is 0. Will be used over procCode if both are specified. Default 0.
-  procCode?: string; // Optional. FK to procedurecode.ProcCode. Only allowed if CovCatNum is 0. Default empty string.
-  CodeGroupNum?: number; // Optional. (Added in version 23.2.62) FK to codegroup.CodeGroupNum. The group of procedure codes that apply to this Frequency Limitation benefit.
-}
-
-/**
- * Parameters to update an insplan.
- * @see https://www.opendental.com/site/apibenefits.html
- */
-export interface UpdateBenefitParams {
-  BenefitNum: number; // Required in URL. Primary Key. 
-  CovCatNum?: number; // Optional. FK to covcat.CovCatNum.
-  BenefitType?: "ActiveCoverage" | "CoInsurance" | "Deductible" | "CoPayment" | "Exclusions" | "Limitations" | "WaitingPeriod"; // Optional. Either "ActiveCoverage", "CoInsurance", "Deductible", "CoPayment", "Exclusions", "Limitations", or "WaitingPeriod".
-  Percent?: number; // Optional. Only allowed if BenefitType is "CoInsurance". Must be a value between 0 and 100. Default -1 (Indicating empty).
-  MonetaryAmt?: number; // Optional. Only used if BenefitType is "CoPayment", "Limitations", or "Deductible". Default -1.0 (Indicating empty).
-  TimePeriod?: "None" | "ServiceYear" | "CalendarYear" | "Lifetime" | "Years" | "NumberInLast12Months"; // Optional. Either "None", "ServiceYear", "CalendarYear", "Lifetime", "Years", or "NumberInLast12Months". Default "CalendarYear".
-  QuantityQualifier?: "None" | "NumberOfServices" | "AgeLimit" | "Visits" | "Years" | "Months"; // Optional. Either "None", "NumberOfServices", "AgeLimit", "Visits", "Years", or "Months". Default "None". Must be "Months" or "Years" if BenefitType is "WaitingPeriod".
-  Quantity?: number; // Optional. Must be a value between 0 and 100. Default 0. Must be a value greater than 0 if QuantityQualifier is "AgeLimit".
-  CodeNum?: number; // Optional. FK to procedurecode.CodeNum. Only allowed if CovCatNum is 0. Will be used over procCode if both are specified.
-  procCode?: string; // Optional. FK to procedurecode.ProcCode. Only allowed if CovCatNum is 0. Default empty string.
-  CoverageLevel?: "None" | "Individual" | "Family"; // Optional. Either "None", "Individual", or "Family".
-}
-  

package/src/types/chartModuleTypes.ts

@@ -1,65 +0,0 @@
-/**
- * Gets the Progress Notes for a patient, similarly to how it shows in the Chart Module. Use another API method or a query to get specific details about each object.
- * @see https://www.opendental.com/site/apichartmodules.html
- */
-export interface ProgNote {
-    ObjectType?: "Appointment" | "Commlog" | "Task" | "Email" | "LabCase" |  "Rx" | "Sheet"; // The type of object being displayed?: number; // Appointment, Commlog, Task, Email, LabCase, Rx, or Sheet.
-    PrimaryKey?: number; // Primary Key corresponding to the objectType. Example: AptNum=34.
-    Date?: string; // Human readable date. Example 05/15/2021
-    Time?: string; // Human readable time. Example 1:20p
-    DateTime?: string; // Example 2021-12-21 10:00:00
-    Th?: string; // ToothNum for a Procedure, otherwise blank.
-    Surf?: string; // Tooth surface for the Procedure, otherwise blank.
-    Dx?: string; // Description of the Diagnosis.
-    Description?: string; // Description of the of the returned object.
-    Note?: string; // Additional notes for the returned object.
-    Stat?: string; // Status of the Procedure, otherwise blank. Example TP.
-    Prov?: string; // Example Doc1.
-    ProvNum?: string; // Example: 3
-    Amount?: string; // ProcFee for Procedure, otherwise blank. Example 53.50
-    ProcCode?: string; // ProcCode for Procedure, otherwise blank. Example D0220
-    User?: string; // Name of the user who created the Commlog, Email, or Rx. Otherwise blank.
-    Signed?: string; // Will be "Signed" if there is a signature on the Procedure or Sheet. Otherwise blank.
-    Length?: string; // Length of the appointment in HH:mm format. Example 0:30.
-    Abbr?: string; // Abbreviation of the Procedure, otherwise blank.
-    Clinic?: string; // Clinic abbreviation. Example: Metro Office.
-    ClinicNum?: string; // Example: 4
-}
-
-/**
- * Gets Patient Info for a patient, similarly to how it shows in the Chart Module. Use another API method or a query to get specific details about returned elements.
- * @see https://www.opendental.com/site/apichartmodules.html
- */
-export interface PatientInfo {
-    Field?: string; // One of the following: Age, ABC0, Billing Type, Referred From, Date First Visit, Prov. (Pri, Sec), Pri Ins, Sec Ins, Payor Types, Premedicate, Problems, Med Urgent, Medical Summary, Service Notes, Medications, Allergies, Pat Restrictions
-    Content?: string; // The field's value
-}
-
-/**
- * Gets Planned Appointments for a patient, similarly to how it shows in the Chart Module's Planned Appointments tab.
- * @see https://www.opendental.com/site/apichartmodules.html
- */
-export interface PlannedAppointment {
-    AptNum?: number; // Unique identifier for the appointment
-    ProvNum?: number; // Provider number associated with the appointment
-    ItemOrder?: string; // Time pattern in 5-minute increments, e.g., "/XX/" for 20 minutes
-    minutes?: string; //The length of the appointment in minutes.
-    ProcDescript?: string; // Description of procedures linked to the appointment
-    Note?: string; //Appointment Note.
-    dateSched?: string; //DateTime of the linked scheduled appointment.
-    AptStatus?: AptStatus; // appointment.AptStatus.
-}
-
-/**
- * Appointment status options.
- * @see https://www.opendental.com/site/apichartmodules.html
- */
-export type AptStatus =
-| "Scheduled"
-| "Complete"
-| "UnschedList"
-| "ASAP"
-| "Broken"
-| "Planned"
-| "PtNote"
-| "PtNoteCompleted";

package/src/types/claimProcTypes.ts

@@ -1,99 +0,0 @@
-/**
- * Represents a ClaimProc in the Open Dental system.
- * @see https://www.opendental.com/site/apiclaimprocs.html
- */
-export interface ClaimProc {
-    ClaimProcNum?: number; // Primary Key.
-    ProcNum?: number; // FK to procedurelog.ProcNum.
-    ClaimNum?: number; // FK to claim.ClaimNum.
-    PatNum?: number; // FK to patient.PatNum.
-    ProvNum?: number; // ProvNum of a provider. Follows the ProcProvChangesClaimProcWithClaim preference. See Claimproc Provider for more information.,
-    FeeBilled?: number; // The amount billed to insurance.
-    InsPayEst?: number; // The estimated amount that insurance will pay.
-    DedApplied?: number; // Deductible applied to this procedure only. DedApplied will always match the DedEstOverride value when ClaimProc status is NotReceived or Preauth.
-    Status?: "NotReceived" | "Received" | "Preauth" | "Adjustment" | "Supplemental" | "CapClaim" | "Estimate" | "CapComplete" | "CapEstimate" | "InsHist"; // Either "NotReceived", "Received", "Preauth", "Adjustment", "Supplemental", "CapClaim", "Estimate", "CapComplete", "CapEstimate", or "InsHist".
-    InsPayAmt?: number; // Amount insurance actually paid. Cannot be updated once the procedure is attached to a check.
-    Remarks?: string; // The remarks that insurance sends in the EOB about procedures. Overwrites any existing Remarks.
-    ClaimPaymentNum?: number; // ClaimPaymentNum of a partial claimpayment. Attaches this ClaimProc, alongside any other able ClaimProcs on the same Claim, to the specified ClaimPayment. Can supply 0 to detach this ClaimProc, and all other ClaimProcs from the same claim that are on the same ClaimPayment. See Finalize Insurance Payment and Batch Insurance Payment for more information.
-    PlanNum?: number; // FK to insplan.plannum.
-    DateCP?: string; // 2021-02-16,
-    WriteOff?: number; // Amount not covered by insurance which is written off.
-    CodeSent?: string; // The procedure code that was sent to insurance. Usually it is the same as the actual procedure code, but may be different if using alternate codes (for example: Medicaid), medical codes, or custom codes with suffixes that get removed before being sent. See also Incorrect Procedures on Claim. Use ProcedureCodes GET to get a list of valid codes.
-    AllowedOverride?: number; //
-    Percentage?: number; // The percentage that insurance is expected to cover. 
-    PercentOverride?: number; // The percentage that insurance is expected to cover. A number between 0 and 100. Use -1 to indicate no override.
-    CopayAmt?: number; // Based on the insurance plan's copay fee schedule, and subtracted from the amount that insurance will pay.
-    NoBillIns?: true | false; // false,
-    PaidOtherIns?: number; // 0.0,
-    BaseEst?: number; // 88.0,
-    CopayOverride?: number; // Based on the insurance plan's copay fee schedule, and subtracted from the amount that insurance will pay. Use -1 to indicate no override.
-    ProcDate?: string; // String in "yyyy-MM-dd" format.
-    DateEntry?: string; // String in "yyyy-MM-dd" format.
-    DedEst?: number; //  The amount that the patient must pay each year before insurance kicks in, and always subtracted before Percentage is calculated.
-    DedEstOverride?: number; //  The amount that the patient must pay each year before insurance kicks in, and always subtracted before Percentage is calculated. Use -1 to indicate no override.
-    InsEstTotal?: number; // 88.0,
-    InsEstTotalOverride?: number; // The estimated amount that insurance will pay. If the claimproc is already attached to a claim, this will not affect the patient balance. Use -1 to indicate no override.
-    PaidOtherInsOverride?: number; // Adds up all amounts paid by insurance plans that are lower in order. Use -1 to indicate no override.
-    EstimateNote?: string; //
-    WriteOffEst?: number; // WriteOff amount usually only used for PPOs.
-    WriteOffEstOverride?: number; // WriteOff amount usually only used for PPOs. Use -1 to indicate no override.
-    ClinicNum?: number; // FK to clinics
-    InsSubNum?: number; // FK to inssub.inssubnum
-    PaymentRow?: number; // 
-    PayPlanNum?: number; // FK to pay plans
-    ClaimPaymentTracking?: number; // Used to document information about the payment of the procedure. Useful to track why payment was rejected. See also Definitions: Claim Payment Tracking. Definition.DefNum where definition.Category=36.
-    claimPaymentTracking?: string; // Used to document information about the payment of the procedure. Useful to track why payment was rejected. See also Definitions: Claim Payment Tracking. Definition.DefNum where definition.Category=36.
-    SecUserNumEntry?: number; // 
-    SecDateEntry?: string; // String in "yyyy-MM-dd" format.
-    SecDateTEdit?: string; // String in "yyyy-MM-dd HH:mm:ss" format.
-    DateSuppReceived?: string; // String in "yyyy-MM-dd" format.
-    DateInsFinalized?: string; // String in "yyyy-MM-dd" format.
-    IsTransfer?: "true" | "false"; // false,
-    ClaimAdjReasonCodes?: string; // 
-  }
-
-  /**
-   * Gets all ClaimProcs based on provided parameters. If no parameter is given, it will get all ClaimProcs ordered by ClaimProcNum.
-   * @see https://www.opendental.com/site/apiclaimprocs.html
-   */
-  export interface GetClaimProcsParams {
-    ProcNum?: number; // Optional. FK to procedurelog.ProcNum.
-    ClaimNum?: number; // Optional. FK to claim.ClaimNum.
-    PatNum?: number; // Optional. FK to patient.PatNum.
-    Status?: "NotReceived" | "Received" | "Preauth" | "Adjustment" | "Supplemental" | "CapClaim" | "Estimate" | "CapComplete" | "CapEstimate" | "InsHist"; // Either "NotReceived", "Received", "Preauth", "Adjustment", "Supplemental", "CapClaim", "Estimate", "CapComplete", "CapEstimate", or "InsHist".
-    ClaimPaymentNum?: number; // Optional. FK to claimpayment.ClaimPaymentNum.
-    Offset?: number; // Pagination offset for results
-  }
-
-/**
- * ClaimProcs are complex. They are used to link procedures to claims, insurance payments to procedures or claims, and insurance estimates to procedures without a claim. 
- * See Claim Procedures ( claimprocs ) and Claim for more details.
- * Updates a ClaimProc exactly as in Open Dental, performing the same calculations for necessary fields. 
- * All below fields are optional. However, which fields can be changed depends on the status of the ClaimProc and the Claim (if associated). 
- * Editing a received ClaimProc can delete all of the Income Transfers on the claim.
- * Cannot update a ClaimProc that has IsTransfer set to true, or a Status of "Adjustment", "InsHist", "CapClaim", "CapComplete", or "CapEstimate". To update a ClaimProc with a Status of Adjustment, use ClaimProcs PUT InsAdjust.
- * Updating a ClaimProc recalculates the claim totals of the Claim to which it's attached. BlueBook values are not updated. Override field values use -1 to represent none or blank.
- * @see https://www.opendental.com/site/apiclaimprocs.html
- */
-export interface updateClaimProcParams {
-    ClaimProcNum: number; // Primary Key. Required in the URL.
-    ProvNum?: number; // ProvNum of a provider. Follows the ProcProvChangesClaimProcWithClaim preference. See Claimproc Provider for more information.,
-    FeeBilled?: number; // The amount billed to insurance.
-    DedApplied?: number; // Deductible applied to this procedure only. DedApplied will always match the DedEstOverride value when ClaimProc status is NotReceived or Preauth.
-    Status?: "NotReceived" | "Received" | "Preauth" | "Adjustment" | "Supplemental" | "CapClaim" | "Estimate" | "CapComplete" | "CapEstimate" | "InsHist"; // Either "NotReceived", "Received", "Preauth", "Adjustment", "Supplemental", "CapClaim", "Estimate", "CapComplete", "CapEstimate", or "InsHist".
-    InsPayAmt?: number; // Amount insurance actually paid. Cannot be updated once the procedure is attached to a check.
-    Remarks?: string; // The remarks that insurance sends in the EOB about procedures. Overwrites any existing Remarks.
-    ClaimPaymentNum?: number; // ClaimPaymentNum of a partial claimpayment. Attaches this ClaimProc, alongside any other able ClaimProcs on the same Claim, to the specified ClaimPayment. Can supply 0 to detach this ClaimProc, and all other ClaimProcs from the same claim that are on the same ClaimPayment. See Finalize Insurance Payment and Batch Insurance Payment for more information.
-    WriteOff?: number; // Amount not covered by insurance which is written off.
-    CodeSent?: string; // The procedure code that was sent to insurance. Usually it is the same as the actual procedure code, but may be different if using alternate codes (for example: Medicaid), medical codes, or custom codes with suffixes that get removed before being sent. See also Incorrect Procedures on Claim. Use ProcedureCodes GET to get a list of valid codes.
-    PercentOverride?: number; // The percentage that insurance is expected to cover. A number between 0 and 100. Use -1 to indicate no override.
-    NoBillIns?: true | false; // false,
-    CopayOverride?: number; // Based on the insurance plan's copay fee schedule, and subtracted from the amount that insurance will pay. Use -1 to indicate no override.
-    DedEstOverride?: number; //  The amount that the patient must pay each year before insurance kicks in, and always subtracted before Percentage is calculated. Use -1 to indicate no override.
-    InsEstTotalOverride?: number; // The estimated amount that insurance will pay. If the claimproc is already attached to a claim, this will not affect the patient balance. Use -1 to indicate no override.
-    PaidOtherInsOverride?: number; // Adds up all amounts paid by insurance plans that are lower in order. Use -1 to indicate no override.
-    WriteOffEstOverride?: number; // WriteOff amount usually only used for PPOs. Use -1 to indicate no override.
-    ClaimPaymentTracking?: number; // Used to document information about the payment of the procedure. Useful to track why payment was rejected. See also Definitions: Claim Payment Tracking. Definition.DefNum where definition.Category=36.
-  }
-
-  

package/src/types/claimTypes.ts

@@ -1,227 +0,0 @@
-/**
- * Claim types for Open Dental REST API
- * Spec refs:
- *  - https://www.opendental.com/site/apiclaims.html
- *  - "Claim Database Schema" (columns and domain values)
- *
- * Notes:
- *  - Dates are strings from the API (yyyy-MM-dd or yyyy-MM-dd HH:mm:ss).
- *  - Some fields reference Definitions or DB enums; where Open Dental allows
- *    broader values, we model them as string unions with known values or `string`.
- */
-
-/** One-letter claim status sent by the API. */
-export type ClaimStatus =
-  | "U" // Unsent
-  | "H" // Hold until pri received
-  | "W" // Waiting in queue
-  | "S" // Sent
-  | "R" // Received
-  | "I"; // Hold for In Process (only available in GET multiple filter)
-
-/** Claim type per API (includes PreAuth and Other). */
-export type ClaimType = "P" | "S" | "PreAuth" | "Cap" | "Other";
-
-/** Medical type per API. */
-export type MedType = "Dental" | "Medical" | "Institutional";
-
-/** AccidentRelated per API. */
-export type AccidentRelated = "No" | "A" | "E" | "O" | "";
-
-/**
- * Place of service: API examples include "Office", "OtherLocation".
- * Database schema supports additional values, so keep this open-ended.
- */
-export type PlaceService = "Office" | "OtherLocation" | string;
-
-/** PatRelat per API. */
-export type PatientRelationship =
-  | "Self"
-  | "Spouse"
-  | "Child"
-  | "Employee"
-  | "HandicapDep"
-  | "SignifOther"
-  | "InjuredPlaintiff"
-  | "LifePartner"
-  | "Dependent";
-
-/**
- * Represents a Claim returned by the Open Dental API.
- * Mirrors the response payload of GET/POST/PUT endpoints.
- */
-export interface Claim {
-  ClaimNum: number;                 // PK
-  PatNum: number;                   // FK to patient.PatNum
-  DateService: string;              // "yyyy-MM-dd" | "0001-01-01"
-  DateSent: string;                 // "yyyy-MM-dd" | "0001-01-01"
-  ClaimStatus: Exclude<ClaimStatus, "I">; // "U" | "H" | "W" | "S" | "R"
-  DateReceived: string;             // "yyyy-MM-dd" | "0001-01-01"
-  PlanNum: number;                  // FK to insplan.PlanNum
-  ProvTreat: number;                // FK to provider.ProvNum
-  ClaimFee: number;                 // Total fee on claim
-  InsPayEst: number;                // Estimated insurance payment
-  InsPayAmt: number;                // Actual insurance payment
-  DedApplied: number;               // Deductible applied to claim
-  IsProsthesis: "N" | "I" | "R";    // No / Initial / Replacement
-  PriorDate: string;                // "yyyy-MM-dd" | "0001-01-01"
-  ReasonUnderPaid: string;          // Free text (patient statement note)
-  ClaimNote: string;                // Note to insurance (claim-level)
-  ClaimType: ClaimType;             // "P" | "S" | "PreAuth" | "Cap" | "Other"
-  ProvBill: number;                 // FK to provider.ProvNum (billing)
-  PlaceService: PlaceService;       // Usually "Office"
-  AccidentRelated: AccidentRelated; // "", "No", "A", "E", "O"
-  AccidentDate: string;             // "yyyy-MM-dd" | "0001-01-01"
-  AccidentST: string;               // 2-char state or ""
-  IsOrtho: "true" | "false";
-  OrthoRemainM: number;             // 0..36
-  OrthoDate: string;                // "yyyy-MM-dd" | "0001-01-01"
-  PatRelat: PatientRelationship;    // Relationship for primary plan
-  PlanNum2: number;                 // FK to insplan.PlanNum (other coverage)
-  PatRelat2: PatientRelationship;   // Relationship for other coverage
-  WriteOff: number;
-  ClaimForm: string;                // FK to claimform.ClaimFormNum as string
-  InsSubNum: number;                // FK to inssub.InsSubNum (primary/selected)
-  InsSubNum2: number;               // FK to inssub.InsSubNum (other coverage)
-  PriorAuthorizationNumber: string; // Rare; medical claims
-  MedType: MedType;                 // "Dental" | "Medical" | "Institutional"
-  CustomTracking: number;           // DefNum (Definitions: Claim Custom Tracking)
-  customTracking: string;           // Human-readable name for CustomTracking
-  CorrectionType: string;         // Open Dental supports more; keep open
-  ClaimIdentifier: string;          // Semi-unique per DB (e.g., "PatNum/ClaimNum")
-  OrigRefNum: string;               // Original reference number if corrected
-  OrthoTotalM: number;              // 0..36
-  ShareOfCost: number;              // For specific payor scenarios
-  SecDateTEdit: string;             // "yyyy-MM-dd HH:mm:ss"
-}
-
-/** GET /claims (multiple) query params. */
-export interface GetClaimsParams {
-  /** Optional after 23.3.11 */
-  PatNum?: number;
-  /**
-   * Added 23.3.11
-   * "U"=Unsent, "H"=Hold until pri received, "W"=Waiting in queue,
-   * "S"=Sent, "R"=Received, "I"=Hold for In Process
-   */
-  ClaimStatus?: ClaimStatus;
-  /** Added 25.3.41 */
-  ClaimType?: ClaimType;
-  /** Added 25.3.41 */
-  PlanNum?: number;
-  /** Added 25.3.41 - Other coverage plan */
-  PlanNum2?: number;
-  /** Added 25.3.41 - X12 CLM01 semi-unique identifier */
-  ClaimIdentifier?: string;
-  /**
-   * Added 23.3.11 - returns claims on/after this edit timestamp
-   * Format: "yyyy-MM-dd HH:mm:ss"
-   */
-  SecDateTEdit?: string;
-  /** Optional offset (if your client/SDK supports pagination). */
-  Offset?: number;
-}
-
-/** GET /claims/{ClaimNum} - path parameter only. */
-export interface GetClaimByIdParams {
-  ClaimNum: number;
-}
-
-/**
- * POST /claims body.
- * - Required: PatNum, procNums[], ClaimType
- * - If ClaimType is "PreAuth" or "Other", InsSubNum and PatRelat are required.
- * - For "P"/"S", plan is implied by patient’s primary/secondary coverage.
- */
-export interface CreateClaimParamsBase {
-  PatNum: number;
-  procNums: number[];
-  DateService?: string; // "yyyy-MM-dd" (ignored for "PreAuth")
-  DateSent?: string;    // "yyyy-MM-dd" (default to today)
-  ClaimForm?: number;   // FK to claimform.ClaimFormNum
-  ProvTreat?: number;   // FK to provider.ProvNum
-  ProvBill?: number;    // FK to provider.ProvNum
-}
-
-/** Primary claim. */
-export interface CreatePrimaryClaimParams extends CreateClaimParamsBase {
-  ClaimType: "P";
-}
-
-/** Secondary claim. */
-export interface CreateSecondaryClaimParams extends CreateClaimParamsBase {
-  ClaimType: "S";
-}
-
-/** Preauthorization claim. */
-export interface CreatePreAuthClaimParams extends CreateClaimParamsBase {
-  ClaimType: "PreAuth";
-  InsSubNum: number;             // required
-  PatRelat: PatientRelationship; // required
-  InsSubNum2?: number;
-  PatRelat2?: PatientRelationship;
-}
-
-/** Other claim (added 25.3.41). */
-export interface CreateOtherClaimParams extends CreateClaimParamsBase {
-  ClaimType: "Other";
-  InsSubNum: number;             // required
-  PatRelat: PatientRelationship; // required
-  InsSubNum2?: number;
-  PatRelat2?: PatientRelationship;
-}
-
-/** Union for POST body. */
-export type CreateClaimParams =
-  | CreatePrimaryClaimParams
-  | CreateSecondaryClaimParams
-  | CreatePreAuthClaimParams
-  | CreateOtherClaimParams;
-
-/**
- * PUT /claims/{ClaimNum}
- * All fields optional; send only what you intend to change.
- * API recalculates as Open Dental does; some fields constrained by claim state.
- */
-export interface UpdateClaimParams {
-  ClaimNum: number;                // in URL
-  ClaimStatus?: Exclude<ClaimStatus, "I">; // "U" | "H" | "W" | "S" | "R"
-  DateSent?: string;               // "yyyy-MM-dd" (added 25.3.41)
-  DateReceived?: string;           // "yyyy-MM-dd"
-  ProvTreat?: number;
-  IsProsthesis?: "N" | "I" | "R";
-  PriorDate?: string;              // "yyyy-MM-dd"
-  ClaimNote?: string;              // overwrites existing
-  ReasonUnderPaid?: string;        // overwrites existing
-  ProvBill?: number;
-  PlaceService?: PlaceService;
-  AccidentRelated?: AccidentRelated;
-  AccidentDate?: string;           // "yyyy-MM-dd"
-  AccidentST?: string;             // 2 chars
-  IsOrtho?: "true" | "false";
-  OrthoRemainM?: number;           // 1..36
-  OrthoDate?: string;              // "yyyy-MM-dd"
-  PatRelat?: PatientRelationship;  // added 24.4.35
-  PatRelat2?: PatientRelationship; // added 24.4.35
-  ClaimForm?: number | 0;          // 0 to clear
-  InsSubNum2?: number;             // added 24.4.35
-  PriorAuthorizationNumber?: string;
-  MedType?: MedType;               // added 25.3.41
-  OrthoTotalM?: number;            // 1..36
-}
-
-/** Minimal helper to detect "zero" dates in responses. */
-export const isZeroDate = (d?: string | null): boolean =>
-  !d || d === "0001-01-01";
-
-/** Narrow helper for timestamps that can be zeroed by the API. */
-export const isZeroDateTime = (d?: string | null): boolean =>
-  !d || d.startsWith("0001-01-01");
-
-/** Example runtime guard for ClaimStatus values. */
-export const isClaimStatus = (s: string): s is ClaimStatus =>
-  ["U", "H", "W", "S", "R", "I"].includes(s);
-
-/** Example runtime guard for ClaimType values. */
-export const isClaimType = (t: string): t is ClaimType =>
-  ["P", "S", "PreAuth", "Cap", "Other"].includes(t);

package/src/types/commlogTypes.ts

@@ -1,28 +0,0 @@
-/**
- * Represents a communication log in the Open Dental system.
- * @see https://www.opendental.com/site/apicommlogs.html
- */
-export interface CommLog {
-    CommLogNum?: number; // Unique identifier for the communication log
-    PatNum?: number; // Unique identifier for the patient
-    CommDateTime?: string; // Date and time of the communication in "yyyy-MM-dd HH:mm:ss" format
-    Mode_?: "None" | "Email" | "Mail" | "Phone" | "In Person" | "Text" | "Email and Text" | "Phone and Text"; // Mode of communication
-    Note?: string; // Detailed note about the communication
-    CommType?: number; // Type of communication: definition.DefNum where definition.Category=25
-    commType?: string; // Optional: Human-readable description of the communication type
-    SentOrReceived?: "Sent" | "Received" | "Neither"; // Optional: Direction of communication
-  }
-  
-/**
- * Parameters for creating a new communication log.
- * @see https://www.opendental.com/site/apicommlogs.html
- */
-export interface CreateCommLogParams {
-    PatNum: number; // Required: Unique identifier for the patient
-    CommDateTime: string; // Required: Date and time of the communication in "yyyy-MM-dd HH:mm:ss" format
-    Mode_: "None" | "Email" | "Mail" | "Phone" | "In Person" | "Text" | "Email and Text" | "Phone and Text"; // Required: Mode of communication
-    Note: string; // Required: Detailed note about the communication
-    CommType?: number; // Optional: Type of communication: definition.DefNum where definition.Category=25
-    commType?: string; // Optional: Human-readable description of the communication type
-    SentOrReceived?: "Sent" | "Received" | "Neither"; // Optional: Direction of communication
-}

package/src/types/definitionTypes.ts

@@ -1,24 +0,0 @@
-/**
- * Represents a definition in the Open Dental system.
- * Used in multiple definition-related endpoints.
- * @see https://www.opendental.com/site/apidefinitions.html
- */
-export interface Definition {
-    DefNum?: number; //PK
-    ItemName?: string; //
-    ItemValue?: string; //
-    Category?: number; //
-    category?: string; //
-    isHidden?: 'true' | 'false'; //
-  }
-
-  /**
-   * Parameters for GET Definitions.
-   * @see https://www.opendental.com/site/apidefinitions.html
-   */
-  export interface GetDefinitionsParams {
-    Category?: number; //definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
-    includeHidden?: 'true' | 'false'; //optional parameter that defaults to false.
-    Offset?: number; // Pagination offset for results
-  }
-  

package/src/types/discountPlanSubTypes.ts

@@ -1,45 +0,0 @@
-/**
- * Represents a subscription to a discount plan in the Open Dental system.
- * @see https://www.opendental.com/site/apidiscountplansubs.html
- */
-export interface DiscountPlanSub {
-    DiscountSubNum?: number; //PK
-    DiscountPlanNum?: number; //FK to discount plan
-    PatNum?: number; //FK to patient
-    DateEffective?: string; //String in "yyyy-MM-dd" format. 
-    DateTerm?: string; //String in "yyyy-MM-dd" format. 
-    SubNote?: string; //
-  }
-
-  /**
-   * Parameters for GET discount plan subs.
-   * @see https://www.opendental.com/site/apidiscountplansubs.html
-   */
-  export interface GetDiscountPlanSubsParams {
-    PatNum?: number; // FK to patient.PatNum.
-  }
-
-  /**
-   * Parameters for creating a discount plan sub.
-   * @see https://www.opendental.com/site/apidiscountplansubs.html
-   */
-  export interface CreateDiscountPlanSubParams {
-    PatNum: number; //FK to patient
-    DiscountPlanNum: number; //FK to discount plan
-    DateEffective?: string; //Optional. String in "yyyy-MM-dd" format. The date when the plan will start impacting procedure fees. Default "0001-01-01" to indicate the beginning of the current calendar year.
-    DateTerm?: string; //Optional. String in "yyyy-MM-dd" format. The date when the plan will no longer impact procedure fees. Default "0001-01-01" to indicate no end date.
-    SubNote?: string; //Optional. Subscriber note.
-  }
-  
-  /**
-   * Parameters for updating a discount plan sub.
-   * @see https://www.opendental.com/site/apidiscountplansubs.html
-   */
-  export interface UpdateDiscountPlanSubParams {
-    DiscountSubNum: number; //PK  
-    PatNum: string; //FK to patient
-    DateEffective?: string; //Optional. String in "yyyy-MM-dd" format. The date when the plan will start impacting procedure fees. Default "0001-01-01" to indicate the beginning of the current calendar year.
-    DateTerm?: string; //Optional. String in "yyyy-MM-dd" format. The date when the plan will no longer impact procedure fees. Default "0001-01-01" to indicate no end date.
-    SubNote?: string; //Optional. Subscriber note.
-  }
-  

package/src/types/diseaseTypes.ts

@@ -1,50 +0,0 @@
-/**
- * Represents a Disease (Problem) that is assigned to a patient in the Open Dental system.
- * @see https://www.opendental.com/site/apidiseases.html
- */
-export interface Disease {
-    DiseaseNum?: number; //PK
-    PatNum?: number; // FK to patient
-    DiseaseDefNum?: number; // FK to DiseaseDef
-    diseaseDefName?: string; //
-    PatNote?: string; // 
-    ProbStatus?: 'Active' | 'Resolved' | 'Inactive'; // Either "Active", "Resolved" or "Inactive". Default "Active".
-    DateStart?: string; //String in "yyyy-MM-dd" format. 
-    DateStop?: string; //String in "yyyy-MM-dd" format.
-  }
-
-  /**
-   * Parameters for GET diseases attached to one or more patients.
-   * @see https://www.opendental.com/site/apidiseases.html
-   */
-  export interface GetDiseasesParams {
-    PatNum?: number; // FK to patient.PatNum. Optional (Optional after version 24.2.5).
-    Offset?: number; // Optional pagination.
-  }
-
-  /**
-   * Parameters for attaching a diseaseDef (Problem) to a patient.
-   * @see https://www.opendental.com/site/apidiseases.html
-   */
-  export interface AddDiseaseParams {
-    PatNum: number; // Required. FK to patient
-    DiseaseDefNum?: number; // Rarely used. Just use diseaseDefName instead, which handles insertion of DiseaseDef automatically.
-    diseaseDefName?: string; // Required unless you choose to use DiseaseDefNum.
-    PatNote?: string; // Optional
-    ProbStatus?: 'Active' | 'Resolved' | 'Inactive'; // Optional. Either "Active", "Resolved" or "Inactive". Default "Active".
-    DateStart?: string; // Optional. String in "yyyy-MM-dd" format. Default "0001-01-01".
-    DateStop?: string; // Optional. String in "yyyy-MM-dd" format. Default "0001-01-01".
-  }
-  
-  /**
-   * Parameters for updating a diseaseDef (Problem) attached to a patient.
-   * @see https://www.opendental.com/site/apidiseases.html
-   */
-  export interface UpdateDiseaseParams {
-    DiseaseNum: number; // Required.
-    PatNote?: string; // Optional. Will overwrite existing note.
-    ProbStatus?: 'Active' | 'Resolved' | 'Inactive'; // Optional. Either "Active", "Resolved" or "Inactive".
-    DateStart?: string; // Optional. String in "yyyy-MM-dd" format. 
-    DateStop?: string; // Optional. String in "yyyy-MM-dd" format.
-  }
-