@rinse-dental/open-dental 1.0.2 → 1.0.4

package/src/api/insSubs.ts

@@ -0,0 +1,155 @@
+import HttpClient from "../utils/httpClient";
+import {
+  InsSub,
+  GetInsSubsParams,
+  CreateInsSubParams,
+  UpdateInsSubParams,
+} from "../types/insSubTypes";
+
+export default class InsSubs {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+   * Fetch a single inssub by its ID.
+   * @param {number} InsSubNum - The unique identifier for the inssub.
+   * @returns {Promise<InsSub>} - The inssub object.
+   * @throws {Error} - If `InsSubNum` is not provided.
+   */
+  public async getInsSub(InsSubNum: number): Promise<InsSub> {
+    if (!InsSubNum) {
+      throw new Error("InsSubNum is required.");
+    }
+    return this.httpClient.get<InsSub>(`/inssubs/${InsSubNum}`);
+  }
+
+  /**
+    * Fetch multiple inssubs with optional filtering and pagination.
+    * @param {Object} params - The parameters for filtering and pagination.
+    * @param {number} [params.PlanNum] - The PlanNum of the InsPlan.
+    * @param {number} [params.Subscriber] - The PatNum of the patient who is subscribed to this plan.
+    * @param {string} [params.SecDateTEdit] - The last date the InsPlan was edited. Returns all InsSubs on or after this date.
+    * @param {number} [params.Offset] - Pagination offset for results.
+    * @returns {Promise<InsSub[]>} - A list of inssubs.
+    */
+  public async getInsSubs({
+    PlanNum,
+    Subscriber,
+    SecDateTEdit,
+    Offset,
+  }: GetInsSubsParams = {}): Promise<InsSub[]> {
+    const params = {
+      PlanNum,
+      Subscriber,
+      SecDateTEdit,
+      Offset,
+    };
+  
+    return this.httpClient.get<InsSub[]>("/inssubs", params);
+  }
+
+  /**
+   * Create a new inssub.
+   * @param {Object} data - The details of InsSub to create.
+   * @param {number} data.PlanNum - Required. The PlanNum of the InsPlan.
+   * @param {number} data.Subscriber - Required. The PatNum of the patient who is subscribed to this plan.
+   * @param {string} data.SubscriberID - Required. Number assigned by insurance company.
+   * @param {string} [data.DateEffective] - Optional. The date this InsPlan became effective.
+   * @param {string} [data.DateTerm] - Optional. Not usually used. The date this InsPlan was terminated.
+   * @param {string} [data.BenefitNotes] - Optional. BenefitNotes are specifically designed to store automated notes. For example, when automatically requesting benefits through Trojan. Benefits are stored here in text form for later reference. Not at plan level because might be specific to subscriber. If blank, it may display a benefitNote for another subscriber to the plan.
+   * @param {"true" | "false"} [data.ReleaseInfo] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+   * @param {"true" | "false"} [data.AssignBen] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+   * @param {string} [data.SubscNote] - Optional. Use to store any other info that affects coverage.
+  * @returns {Promise<InsSub>} - The created inssub.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async createInsSub({
+    PlanNum,
+    Subscriber,
+    SubscriberID,
+    DateEffective,
+    DateTerm,
+    BenefitNotes,
+    ReleaseInfo,
+    AssignBen,
+    SubscNote,
+  } : CreateInsSubParams): Promise<InsSub> {
+    if (!PlanNum || !Subscriber || !SubscriberID) {
+      throw new Error("Invalid data: PlanNum, Subscriber, and SubscriberID are required.");
+    }
+
+    return this.httpClient.post<InsSub>("/inssubs", {
+      PlanNum,
+      Subscriber,
+      SubscriberID,
+      DateEffective,
+      DateTerm,
+      BenefitNotes,
+      ReleaseInfo,
+      AssignBen,
+      SubscNote,
+    });
+  }
+
+  /**
+   * Update an inssub.
+   * @param {Object} data - The details of InsSub to update.
+   * @param {number} data.InsSubNum - Required in the URL. The PK of the InsSub.
+   * @param {number} [data.PlanNum] - Optional. The PlanNum of the InsPlan.
+   * @param {number} [data.Subscriber] - Optional. The PatNum of the patient who is subscribed to this plan.
+   * @param {string} [data.SubscriberID] - Optional. Number assigned by insurance company.
+   * @param {string} [data.DateEffective] - Optional. The date this InsPlan became effective.
+   * @param {string} [data.DateTerm] - Optional. Not usually used. The date this InsPlan was terminated.
+   * @param {string} [data.BenefitNotes] - Optional. BenefitNotes are specifically designed to store automated notes. For example, when automatically requesting benefits through Trojan. Benefits are stored here in text form for later reference. Not at plan level because might be specific to subscriber. If blank, it may display a benefitNote for another subscriber to the plan.
+   * @param {"true" | "false"} [data.ReleaseInfo] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+   * @param {"true" | "false"} [data.AssignBen] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+   * @param {string} [data.SubscNote] - Optional. Use to store any other info that affects coverage.
+  * @returns {Promise<InsSub>} - The updated inssub.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async updateInsSub({
+    InsSubNum,
+    PlanNum,
+    Subscriber,
+    SubscriberID,
+    DateEffective,
+    DateTerm,
+    BenefitNotes,
+    ReleaseInfo,
+    AssignBen,
+    SubscNote,
+  } : UpdateInsSubParams): Promise<InsSub> {
+    if (!InsSubNum || typeof InsSubNum !== "number") {
+      throw new Error("Invalid data: A Valid InsSubNum is required.");
+    }
+
+    return this.httpClient.put<InsSub>(`/inssubs/${InsSubNum}`, {
+      PlanNum,
+      Subscriber,
+      SubscriberID,
+      DateEffective,
+      DateTerm,
+      BenefitNotes,
+      ReleaseInfo,
+      AssignBen,
+      SubscNote,
+    });
+  }
+
+  /**
+   * Delete an inssub entry. Will fail if any PatPlans exist. You can obtain the InsSubNum from FamilyModules GET Insurance.
+   * @param {number} InsSubNum - Required: The unique identifier of the inssub to delete.
+   * @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
+   * @throws {Error} - If `InsSubNum` is not valid or the API returns an error.
+   */
+  public async deleteInsSub(InsSubNum: number): Promise<void> {
+    if (!InsSubNum || typeof InsSubNum !== "number") {
+      throw new Error("Invalid parameter: InsSubNum must be a valid number.");
+    }
+
+    return this.httpClient.delete<void>(`/inssubs/${InsSubNum}`);
+  }
+}

package/src/api/patFields.ts

@@ -104,7 +104,7 @@ export default class PatFields {
      */
     public async deletePatField(PatFieldNum: number): Promise<{ status: number }> {
         if (!PatFieldNum || typeof PatFieldNum !== "number") {
-            throw new Error("Invalid parameter: PatNum must be a valid number.");
+            throw new Error("Invalid parameter: PatFieldNum must be a valid number.");
         }
 
         return await this.httpClient.delete<{ status: number }>(`/patfields/${PatFieldNum}`);

package/src/api/patPlans.ts

@@ -0,0 +1,113 @@
+import HttpClient from "../utils/httpClient";
+import {
+  PatPlan,
+  GetPatPlansParams,
+  CreatePatPlanParams,
+  UpdatePatPlanParams,
+} from "../types/patPlanTypes";
+
+export default class PatPlans {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+    * Fetch multiple patplans with optional filtering and pagination.
+    * @param {Object} params - The parameters for filtering and pagination.
+    * @param {number} [params.PatNum] - FK to patient.PatNum.
+    * @param {number} [params.InsSubNum] - FK to inssub.InsSubNum
+    * @param {number} [params.Offset] - Pagination offset for results.
+    * @returns {Promise<PatPlan[]>} - A list of patplans.
+    */
+  public async getPatPlans({
+    PatNum,
+    InsSubNum,
+    Offset,
+  }: GetPatPlansParams = {}): Promise<PatPlan[]> {
+    const params = {
+      PatNum,
+      InsSubNum,
+      Offset,
+    };
+  
+    return this.httpClient.get<PatPlan[]>("/patplans", params);
+  }
+
+  /**
+   * This adds a PatPlan row to the database.
+   * @param {Object} data - The details of the patplan to create.
+   * @param {number} data.PatNum - Required. FK of patient
+   * @param {number} data.InsSubNum - Required. This requires that a valid InsSub is already in place. You can obtain the InsSubNum from FamilyModules GET Insurance, or you can obtain it from an InsSubs POST. If this plan is already linked to this InsSub, then response will be BadRequest.
+   * @param {string} [data.Ordinal] - Optional with a default of 1. This is a single digit numeric field (example: 1, 2, 3...). It represents the primary insurance, secondary insurance, etc. 0 is not used. If Ordinal is set to1, and there is already primary insurance, the other insurance will get bumped to Ordinal 2.
+   * @param {"Self" | "Spouse" | "Child" | "Employee" | "HandicapDep" | "SignifOther" | "InjuredPlantiff" | "LifePartner" | "Dependent"} [data.Relationship] - Optional. Default is Self. Values can be "Self", "Spouse", "Child", "Employee", "HandicapDep", "SignifOther", "InjuredPlantiff", "LifePartner" or "Dependent".
+   * @param {string} [data.PatID] - Optional. A patient ID which will override the subscriber ID on eclaims. Also used for Canada.
+  * @returns {Promise<PatPlan>} - The created patplan.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async createPatPlan({
+    PatNum,
+    InsSubNum,
+    Ordinal,
+    Relationship,
+    PatID,
+  } : CreatePatPlanParams): Promise<PatPlan> {
+    if (!PatNum || !InsSubNum) {
+      throw new Error("Invalid data: PatNum and InsSubNum are required.");
+    }
+
+    return this.httpClient.post<PatPlan>("/patplans", {
+      PatNum,
+      InsSubNum,
+      Ordinal,
+      Relationship,
+      PatID,
+    });
+  }
+
+  /**
+   * Update a PatPlan.
+   * @param {Object} data - The details of PatPlan to update.
+   * @param {number} data.PatPlanNum - Required. PK
+   * @param {number} [data.InsSubNum] - Optional. This corresponds to the Change button in the Subscriber Information section of the Insurance Plan window.
+   * @param {string} [data.Ordinal] - Optional. This is a single digit numeric field (example: 1, 2, 3...). It represents the primary insurance, secondary insurance, etc. 0 is not used. If Ordinal is set to1, and there is already primary insurance, the other insurance will get bumped to Ordinal 2.
+   * @param {"Self" | "Spouse" | "Child" | "Employee" | "HandicapDep" | "SignifOther" | "InjuredPlantiff" | "LifePartner" | "Dependent"} [data.Relationship] - Optional. Default is Self. Values can be "Self", "Spouse", "Child", "Employee", "HandicapDep", "SignifOther", "InjuredPlantiff", "LifePartner" or "Dependent".
+   * @param {string} [data.PatID] - Optional. A patient ID which will override the subscriber ID on eclaims. Also used for Canada.
+  * @returns {Promise<PatPlan>} - The updated patplan.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async updatePatPlan({
+    PatPlanNum,
+    InsSubNum,
+    Ordinal,
+    Relationship,
+    PatID,
+  } : UpdatePatPlanParams): Promise<PatPlan> {
+    if (!PatPlanNum || typeof PatPlanNum !== "number") {
+      throw new Error("Invalid data: A Valid PatPlanNum is required.");
+    }
+
+    return this.httpClient.put<PatPlan>(`/patplans/${PatPlanNum}`, {
+      InsSubNum,
+      Ordinal,
+      Relationship,
+      PatID,
+    });
+  }
+
+  /**
+   * Delete an PatPlan entry. 
+   * This is called "Drop" in the Open Dental UI. This removes a PatPlan row from the database, indicating no coverage, but does not affect the InsPlan itself.
+   * @param {number} PatPlanNum - Required: The unique identifier of the inssub to delete.
+   * @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
+   * @throws {Error} - If `PatPlanNum` is not valid or the API returns an error.
+   */
+  public async deletePatPlan(PatPlanNum: number): Promise<void> {
+    if (!PatPlanNum || typeof PatPlanNum !== "number") {
+      throw new Error("Invalid parameter: PatPlanNum must be a valid number.");
+    }
+
+    return this.httpClient.delete<void>(`/patplans/${PatPlanNum}`);
+  }
+}

package/src/api/procedureLog.ts

@@ -1,6 +1,7 @@
 import HttpClient from "../utils/httpClient";
 import {
   ProcedureLog,
+  GetProcedureLogParams,
   createProcedureLogParams,
   updateProcedureLogParams,
   InsuranceHistory,
@@ -29,16 +30,47 @@ export default class ProcedureLogs {
     return this.httpClient.get<ProcedureLog>(`/procedurelogs/${ProcNum}`);
   }
 
+  /**
+    * Fetch multiple procedurelogs with optional filtering and pagination.
+    * @param {Object} params - Filtering and pagination parameters.
+    * @param {number} [params.PatNum] - Get procedurelogs by PatNum
+    * @param {number} [params.AptNum] - Get procedurelogs by AptNum
+    * @param {number} [params.PlannedAptNum] - Get procedurelogs by PlannedAptNum
+    * @param {number} [params.ClinicNum] - Get procedurelogs by ClinicNum
+    * @param {string} [params.DateTStamp] - Get procedurelogs altered after the specified date and time
+    * @param {string} [params.Offset] - Pagination
+    * @returns {Promise<ProcedureLog[]>} - A list of procedurelogs.
+    * @throws {Error} - If the API returns an error.
+    */
+    public async getProcedureLogs({
+      PatNum,
+      AptNum,
+      PlannedAptNum,
+      ClinicNum,
+      DateTStamp,
+      Offset,
+    }: GetProcedureLogParams = {}): Promise<ProcedureLog[]> {
+
+      return await this.httpClient.get<ProcedureLog[]>("/procedurelogs", {
+        PatNum,
+        AptNum,
+        PlannedAptNum,
+        ClinicNum,
+        DateTStamp,
+        Offset,
+      });
+    }
+
   /**
    * Create a new procedure log entry.
-   * @param {Object} params - The details of the procedure log to create.
-   * @param {number} params.PatNum - Required: Patient number.
-   * @param {string} params.ProcDate - Required: Procedure date in "yyyy-MM-dd" format.
-   * @param {'TP' | 'C' | 'EO'} params.ProcStatus - Required: Procedure status.
-   * @param {string} params.procCode - Required: Procedure code (D code).
-   * @param {number} [params.AptNum] - Optional: Associated appointment number.
-   * @param {number} [params.ProcFee] - Optional: Fee for the procedure.
-   * @param {Surf} [Surf] - Optional: Tooth surface or treatment area. Options include:
+   * @param {Object} data - The details of the procedure log to create.
+   * @param {number} data.PatNum - Required: Patient number.
+   * @param {string} data.ProcDate - Required: Procedure date in "yyyy-MM-dd" format.
+   * @param {'TP' | 'C' | 'EO'} data.ProcStatus - Required: Procedure status.
+   * @param {string} data.procCode - Required: Procedure code (D code).
+   * @param {number} [data.AptNum] - Optional: Associated appointment number.
+   * @param {number} [data.ProcFee] - Optional: Fee for the procedure.
+   * @param {Surf} [data.Surf] - Optional: Tooth surface or treatment area. Options include:
     * - "B/F" (Buccal/Facial)
     * - "V" (Vestibular)
     * - "M" (Mesial)
@@ -57,13 +89,13 @@ export default class ProcedureLogs {
     * - "6" (Sextant 6)
     * - "U" (Upper Arch)
     * - "L" (Lower Arch)
-   * @param {string} [params.ToothNum] - Optional: Tooth number.
-   * @param {string} [params.ToothRange] - Optional: Tooth range.
-   * @param {number} [params.Priority] - Optional: Priority code.
-   * @param {number} [params.ProvNum] - Optional: Provider number.
-   * @param {string} [params.Dx] - Optional: Diagnosis code.
-   * @param {number} [params.PlannedAptNum] - Optional: Planned appointment number.
-   * @param {number} [params.ClinicNum] - Optional: Clinic number.
+   * @param {string} [data.ToothNum] - Optional: Tooth number.
+   * @param {string} [data.ToothRange] - Optional: Tooth range.
+   * @param {number} [data.Priority] - Optional: Priority code.
+   * @param {number} [data.ProvNum] - Optional: Provider number.
+   * @param {string} [data.Dx] - Optional: Diagnosis code.
+   * @param {number} [data.PlannedAptNum] - Optional: Planned appointment number.
+   * @param {number} [data.ClinicNum] - Optional: Clinic number.
    * @returns {Promise<ProcedureLog>} - The created procedure log.
    * @throws {Error} - If required fields are missing or the API returns an error.
    */
@@ -72,7 +104,19 @@ export default class ProcedureLogs {
     ProcDate,
     ProcStatus,
     procCode,
-    ...optionalData
+    AptNum,
+    ProcFee,
+    Surf,
+    ToothNum,
+    ToothRange,
+    Priority,
+    priority,
+    ProvNum,
+    Dx,
+    dxName,
+    PlannedAptNum,
+    ClinicNum,
+    //...optionalData
   }: createProcedureLogParams): Promise<ProcedureLog> {
     if (!PatNum || !ProcDate || !ProcStatus || !procCode) {
       throw new Error("Invalid data: PatNum, ProcDate, ProcStatus, and procCode are required.");
@@ -83,21 +127,32 @@ export default class ProcedureLogs {
       ProcDate,
       ProcStatus,
       procCode,
-      ...optionalData,
+      AptNum,
+      ProcFee,
+      Surf,
+      ToothNum,
+      ToothRange,
+      Priority,
+      priority,
+      ProvNum,
+      Dx,
+      dxName,
+      PlannedAptNum,
+      ClinicNum,
     });
   }
 
   /**
    * Update an existing procedure log entry.
-   * @param {number} ProcNum - Required: The unique identifier of the procedure log to update.
-   * @param {Object} params - The updated details of the procedure log.
-   * @param {string} [params.ProcDate] - Optional: Updated procedure date in "yyyy-MM-dd" format.
-   * @param {number} [params.AptNum] - Optional: Updated associated appointment number.
-   * @param {number} [params.ProcFee] - Optional: Updated fee for the procedure.
-   * @param {number} [params.Priority] - Optional: Updated priority code.
-   * @param {'TP' | 'C' | 'EO'} [params.ProcStatus] - Optional: Updated procedure status.
-   * @param {string} [params.procCode] - Optional: Updated procedure code (D code).
-   * @param {Surf} [Surf] - Optional: Tooth surface or treatment area. Options include:
+   * @param {Object} data - The updated details of the procedure log.
+   * @param {number} data.ProcNum - Required: The unique identifier of the procedure log to update.
+   * @param {string} [data.ProcDate] - Optional: Updated procedure date in "yyyy-MM-dd" format.
+   * @param {number} [data.AptNum] - Optional: Updated associated appointment number.
+   * @param {number} [data.ProcFee] - Optional: Updated fee for the procedure.
+   * @param {number} [data.Priority] - Optional: Updated priority code.
+   * @param {'TP' | 'C' | 'EO'} [data.ProcStatus] - Optional: Updated procedure status.
+   * @param {string} [data.procCode] - Optional: Updated procedure code (D code).
+   * @param {Surf} [data.Surf] - Optional: Tooth surface or treatment area. Options include:
     * - "B/F" (Buccal/Facial)
     * - "V" (Vestibular)
     * - "M" (Mesial)
@@ -116,18 +171,18 @@ export default class ProcedureLogs {
     * - "6" (Sextant 6)
     * - "U" (Upper Arch)
     * - "L" (Lower Arch)
-   * @param {string} [params.ToothNum] - Optional: Updated tooth number.
-   * @param {string} [params.ToothRange] - Optional: Updated tooth range.
-   * @param {number} [params.ProvNum] - Optional: Updated provider number.
-   * @param {string} [params.Dx] - Optional: Updated diagnosis code.
-   * @param {number} [params.PlannedAptNum] - Optional: Updated planned appointment number.
-   * @param {number} [params.ClinicNum] - Optional: Updated clinic number.
+   * @param {string} [data.ToothNum] - Optional: Updated tooth number.
+   * @param {string} [data.ToothRange] - Optional: Updated tooth range.
+   * @param {number} [data.ProvNum] - Optional: Updated provider number.
+   * @param {string} [data.Dx] - Optional: Updated diagnosis code.
+   * @param {number} [data.PlannedAptNum] - Optional: Updated planned appointment number.
+   * @param {number} [data.ClinicNum] - Optional: Updated clinic number.
    * @returns {Promise<ProcedureLog>} - The updated procedure log.
    * @throws {Error} - If required fields are missing or the API returns an error.
    */
   public async updateProcedureLog(
-    ProcNum: number,
     {
+      ProcNum,
       ProcDate,
       AptNum,
       ProcFee,
@@ -180,8 +235,9 @@ export default class ProcedureLogs {
 
   /**
    * Fetch insurance history for a patient.
-   * @param {number} PatNum - Required: The patient number.
-   * @param {number} InsSubNum - Required: The insurance subscription number.
+   * @param {Object} params - the params to filter
+   * @param {number} params.PatNum - Required: The patient number.
+   * @param {number} params.InsSubNum - Required: The insurance subscription number.
    * @returns {Promise<InsuranceHistory[]>} - The insurance history details.
    * @throws {Error} - If required fields are missing or the API returns an error.
    */
@@ -201,10 +257,11 @@ export default class ProcedureLogs {
 
   /**
    * Add an insurance history entry.
-   * @param {number} PatNum - Required: The patient number.
-   * @param {number} InsSubNum - Required: The insurance subscription number.
-   * @param {"InsHistBWCodes" | "InsHistPanoCodes" | "InsHistExamCodes" | "InsHistProphyCodes" | "InsHistPerioURCodes" | "InsHistPerioULCodes" | "InsHistPerioLRCodes" | "InsHistPerioLLCodes" | "InsHistPerioMaintCodes" | "InsHistDebridementCodes"} insHistPrefName - Required: The insurance history category name.
-   * @param {string} ProcDate - Required: Procedure date in "yyyy-MM-dd" format.
+   * @param {Object} data - the insurance history object to create.
+   * @param {number} data.PatNum - Required: The patient number.
+   * @param {number} data.InsSubNum - Required: The insurance subscription number.
+   * @param {"InsHistBWCodes" | "InsHistPanoCodes" | "InsHistExamCodes" | "InsHistProphyCodes" | "InsHistPerioURCodes" | "InsHistPerioULCodes" | "InsHistPerioLRCodes" | "InsHistPerioLLCodes" | "InsHistPerioMaintCodes" | "InsHistDebridementCodes"} data.insHistPrefName - Required: The insurance history category name.
+   * @param {string} data.ProcDate - Required: Procedure date in "yyyy-MM-dd" format.
    * @returns {Promise<InsuranceHistory>} - The created insurance history entry.
    * @throws {Error} - If required fields are missing or the API returns an error.
    */

package/src/openDental.ts

@@ -13,6 +13,8 @@ import Operatories from "./api/operatories";
 import Payments from "./api/payments";
 import Definitions from "./api/definitions";
 import DiscountPlanSubs from "./api/discountPlanSubs";
+import FamilyModules from "./api/familyModules";
+import InsSubs from "./api/insSubs";
 
 class OpenDental {
   private static httpClient: HttpClient;
@@ -161,6 +163,7 @@ class OpenDental {
     }
     return new Definitions(this.httpClient);
   }
+
   /**
    * Create a new instance of the DiscountPlanSubs API.
    */
@@ -170,6 +173,26 @@ class OpenDental {
     }
     return new DiscountPlanSubs(this.httpClient);
   }
+
+  /**
+   * Create a new instance of the FamilyModules API.
+   */
+  public static FamilyModules() {
+    if (!this.httpClient) {
+      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+    }
+    return new FamilyModules(this.httpClient);
+  }
+
+  /**
+   * Create a new instance of the InsSub API.
+   */
+  public static InsSubs() {
+    if (!this.httpClient) {
+      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+    }
+    return new InsSubs(this.httpClient);
+  }
 }
 
 export { OpenDental };

package/src/types/familyModuleTypes.ts

@@ -0,0 +1,33 @@
+/**
+ * Represents the insurance information for a patient similar to how it shows in the Family Module in Open Dental.
+ * @see https://www.opendental.com/site/apifamilymodules.html
+ */
+export interface Insurance {
+    PatNum?: number; //PK to patient
+    InsSubNum?: number; //inssub.InsSubNum. Primary key to insurance subscriber.
+    Subscriber?: number; //inssub.Subscriber. The PatNum of the subscriber.
+    subscriber?: string; //First and last name of Subscriber from patient table.
+    SubscriberID?: string; //inssub.SubscriberID. Number assigned by insurance company, may be Medicaid ID.
+    SubscNote?: string; //inssub.SubscNote. Stores any other information that affects coverage.
+    PatPlanNum?: number; //patplan.PatPlanNum. Primary key to patient plan.
+    Ordinal?: number; //patplan.Ordinal. Numerical representation of the patient's insurance order. 1, 2, 3, etc.
+    ordinal?: string; //Description of Ordinal. Primary, Secondary, Medical, or Other insurance.
+    IsPending?: 'true' | 'false'; //patplan.IsPending. Informational only. true or false. Identifies insurance information that is incomplete or unverified.
+    Relationship?: string; //patplan.Relationship to subscriber. Self, Spouse, Child, Employee, HandicapDep, SignifOther, InjuredPlaintiff, LifePartner, or Dependant.
+    PatID?: string; //patplan.PatID. Optional patient ID which overrides Subscriber ID on eclaims.
+    CarrierNum?: number; //carrier.CarrierNum. Primary key to the carrier.
+    CarrierName?: string; //carrier.CarrierName. Full name of carrier.
+    PlanNum?: number; //insplan.PlanNum. Primary key to the insurance plan.
+    GroupName?: string; //insplan.GroupName. Each plan has a group name, typically similar to employer.
+    GroupNum?: string; //insplan.GroupNum. Issued by the carrier.
+    PlanNote?: string; //insplan.PlanNote. Notes specific to the subscriber and associated family members.
+    FeeSched?: number; //insplan.FeeSched, foreign key to feesched.FeeSchedNum.
+    feeSchedule?: string; //feesched.Description of the fee schedule.
+    PlanType?: string; //insplan.PlanType. ""=percentage, "p"=ppo percentage, "f"=flat copay, "c"=capitation.
+    planType?: string; //Description of PlanType. Category Percentage, PPO Fixed Benefit, PPO Percentage, Medicaid or Flat Co-pay, or Capitation.
+    CopayFeeSched?: number; //insplan.CopayFeeSched, foreign key to feesched.FeeSchedNum.
+    EmployerNum?: number; //insplan.EmployerNum, foreign key to employer.EmployerNum.
+    employer?: string; //employer.EmpName. Description of EmployerNum.
+    IsMedical?: 'true' | 'false'; // insplan.IsMedical. True if this is medical insurance rather than dental insurance.
+  }
+  

package/src/types/insSubTypes.ts

@@ -0,0 +1,65 @@
+/**
+ * Represents an InsSub in the Open Dental system. Links an InsPlan to a Subscriber (patient.PatNum). Also, see PatPlans to indicate coverage.
+ * @see https://www.opendental.com/site/apiinssubs.html
+ */
+export interface InsSub {
+    InsSubNum?: number; //PK
+    PlanNum?: number; //FK to insplan.plannnum
+    Subscriber?: number; //FK to patient.guarantor
+    DateEffective?: string; //String in "yyyy-MM-dd" format. 
+    DateTerm?: string; //String in "yyyy-MM-dd" format. 
+    SubscriberID?: string; //
+    BenefitNotes?: string; //
+    ReleaseInfo?: "true" | "false"; //
+    AssignBen?: "true" | "false"; //
+    SubscNote?: string; //
+    SecDateTEdit?: string; //String in "yyyy-MM-dd HH:mm:ss" format
+  }
+
+  /**
+   * Gets all InsSubs based on provided parameters. If no parameter is given, it will get all InsSubs ordered by InsSubNum.
+   * @see https://www.opendental.com/site/apiinssubs.html
+   */
+  export interface GetInsSubsParams {
+    PlanNum?: number; // Optional. The PlanNum of the InsPlan.
+    Subscriber?: number; // Optional. The PatNum of the patient who is subscribed to this plan.
+    SecDateTEdit?: string; // Optional. The last date the InsPlan was edited. Returns all InsSubs on or after this date.
+    Offset?: number; // Pagination offset for results
+  }
+
+  /**
+   * Parameters for creating an InsSub. This does not create a new insurance plan or change benefits.
+   * @see https://www.opendental.com/site/apiinssubs.html
+   */
+  export interface CreateInsSubParams {
+    PlanNum: number; // Required. The PlanNum of the InsPlan.
+    Subscriber: number; // Required. The PatNum of the patient who is subscribed to this plan.
+    SubscriberID: string; // Required. Number assigned by insurance company.
+    DateEffective?: string; // Optional. The date this InsPlan became effective.
+    DateTerm?: string; // Optional. Not usually used. The date this InsPlan was terminated.
+    BenefitNotes?: string; //Optional. Optional. BenefitNotes are specifically designed to store automated notes. For example, when automatically requesting benefits through Trojan. Benefits are stored here in text form for later reference. Not at plan level because might be specific to subscriber. If blank, it may display a benefitNote for another subscriber to the plan.
+    ReleaseInfo?: "true" | "false"; // Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+    AssignBen?: "true" | "false"; // Optional. Either "true" or "false". Default is according to global preference within Open Dental. This authorizes the assignment of benefits based on if there is a signature on file.
+    SubscNote?: string; // Optional. Use to store any other info that affects coverage.
+  }
+  
+  /**
+   * Parameters for updating an InsSub. This can be used to assign a different PlanNum or Subscriber to this InsSub. 
+   * None of these changes affect the InsSubNum, so all the PatPlans (coverage) for family members will continue to point to this InsSub and will be untouched. 
+   * You can obtain the InsSubNum from FamilyModules GET Insurance. 
+   * SecDateTEdit is updated automatically and cannot be set by developers.
+   * @see https://www.opendental.com/site/apiinssubs.html
+   */
+  export interface UpdateInsSubParams {
+    InsSubNum: number; // Required. PK of the record to update
+    PlanNum?: number; // Optional. The PlanNum of the InsPlan.
+    Subscriber?: number; // Optional. The PatNum of the patient who is subscribed to this plan.
+    SubscriberID: string; // Required. Number assigned by insurance company.
+    DateEffective?: string; // Optional. The date this InsPlan became effective.
+    DateTerm?: string; // Optional. Not usually used. The date this InsPlan was terminated.
+    BenefitNotes?: string; //Optional. Optional. BenefitNotes are specifically designed to store automated notes. For example, when automatically requesting benefits through Trojan. Benefits are stored here in text form for later reference. Not at plan level because might be specific to subscriber. If blank, it may display a benefitNote for another subscriber to the plan.
+    ReleaseInfo?: "true" | "false"; // Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+    AssignBen?: "true" | "false"; // Optional. Either "true" or "false". Default is according to global preference within Open Dental. This authorizes the assignment of benefits based on if there is a signature on file.
+    SubscNote?: string; // Optional. Use to store any other info that affects coverage.
+  }
+