@rinse-dental/open-dental 2.1.3 → 2.2.0

package/src/api/procTPs.ts

@@ -0,0 +1,112 @@
+import HttpClient from "../utils/httpClient";
+import {
+  ProcTP,
+  GetProcTPsParams,
+  updateProcTPParams,
+} from "../types/procTPTypes";
+
+export default class procTPs {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+/**
+ * Get a list of ProcTPs by the TreatPlanNum. Before calling this method, use TreatPlans GET to find the TreatPlanNum of an existing TreatPlan.
+ * @param {Object} params - The parameters for filtering and pagination.
+ * @param {number} params.TreatPlanNum - Required. FK to TreatPlan.TreatPlanNum.
+ * @param {number} [params.Offset] - Optional. Pagination offset for results.
+ * @returns {Promise<ProcTP[]>} - A list of procTPs.
+ */
+public async getProcTPs({
+    TreatPlanNum,
+    Offset,
+  }: GetProcTPsParams = {}): Promise<ProcTP[]> {
+    const params = {
+      TreatPlanNum,
+      Offset,
+    };
+  
+    return this.httpClient.get<ProcTP[]>("/proctps", params);
+  }
+
+/**
+ * Update an existing procedure log entry.
+* @param {Object} data - The updated details of the ProcTP.
+* @param {number} data.ProcTPNum - Required: The unique identifier of the procTP to update.
+* @param {number} [data.Priority] - Optional: definition.DefNum where definition.Category=20.
+* @param {string} [data.ToothNumTP] - Optional: Updated tooth number.
+* @param {Surf} [data.Surf] - Optional: Tooth surface or treatment area. Options include:
+  * - "B/F" (Buccal/Facial)
+  * - "V" (Vestibular)
+  * - "M" (Mesial)
+  * - "O/I" (Occlusal/Incisal)
+  * - "D" (Distal)
+  * - "L" (Lingual)
+  * - "UL" (Upper Left Quadrant)
+  * - "UR" (Upper Right Quadrant)
+  * - "LR" (Lower Right Quadrant)
+  * - "LL" (Lower Left Quadrant)
+  * - "1" (Sextant 1)
+  * - "2" (Sextant 2)
+  * - "3" (Sextant 3)
+  * - "4" (Sextant 4)
+  * - "5" (Sextant 5)
+  * - "6" (Sextant 6)
+  * - "U" (Upper Arch)
+  * - "L" (Lower Arch)
+* @param {string} [data.ProcCode] - Optional: Updated procedure code (D code).
+* @param {string} [data.Descript] - Optional: Description of procedure.
+* @param {number} [data.FeeAmt] - Optional: The fee charged to the patient.
+* @param {number} [data.PriInsAmt] - Optional: The amount primary insurance is expected to pay.
+* @param {number} [data.SecInsAmt] - Optional: The amount secondary insurance is expected to pay.
+* @param {number} [data.PatAmt] - Optional: The amount the patient is expected to pay.
+* @param {number} [data.Discount] - Optional:  The amount of discount. Used for PPOs and procedure level discounts.
+* @param {string} [data.Prognosis] - Optional: Text for prognosis definition.
+* @param {string} [data.Dx] - Optional: Updated diagnosis code.
+* @param {string} [data.ProcAbbr] - Optional: The procedure code abbreviation.
+* @param {number} [data.FeeAllowed] - Optional: Description of procedure.
+* @returns {Promise<ProcTP>} - The updated ProcTP.
+* @throws {Error} - If required fields are missing or the API returns an error.
+*/
+public async updateProcTP(
+  {
+    ProcTPNum,
+    Priority,
+    ToothNumTP,
+    Surf,
+    ProcCode,
+    Descript,
+    FeeAmt,
+    PriInsAmt,
+    SecInsAmt,
+    PatAmt,
+    Discount,
+    Prognosis,
+    Dx,
+    ProcAbbr,
+  }: updateProcTPParams
+  ): Promise<ProcTP> {
+    if (!ProcTPNum || typeof ProcTPNum !== "number") {
+      throw new Error("Invalid parameter: ProcTPNum must be a valid number.");
+    }
+
+    return this.httpClient.put<ProcTP>(`/proctps/${ProcTPNum}`, {
+      Priority,
+      ToothNumTP,
+      Surf,
+      ProcCode,
+      Descript,
+      FeeAmt,
+      PriInsAmt,
+      SecInsAmt,
+      PatAmt,
+      Discount,
+      Prognosis,
+      Dx,
+      ProcAbbr,
+    });
+  }
+
+}

package/src/api/procedureLog.ts

@@ -35,9 +35,11 @@ export default class ProcedureLogs {
     * @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 {'TP' | 'C' | 'EC' | 'EO' | 'R' | 'D' | 'Cn' | 'TPi'} [params.ProcStatus] - // Either "TP" (Treatment Plan), "C" (Complete), "EC" (Existing Current Provider), "EO" (Existing Other Provider), "R" (Referred Out), "D" (Deleted), "Cn" (Condition), or "TPi" (Treatment Plan inactive).
+    * @param {number} [params.PlannedAptNum] - FK to appointment.AptNum where appointment.AptStatus=Planned.
+    * @param {number} [params.ClinicNum] - FK to clinic.ClinicNum.
+    * @param {number} [params.CodeNum] - FK to procedurecode.CodeNum.
+    * @param {string} [params.DateTStamp] - Gets procedurelogs created on or after the specified date and time. String in "yyyy-MM-dd HH:mm:ss" format.
     * @param {string} [params.Offset] - Pagination
     * @returns {Promise<ProcedureLog[]>} - A list of procedurelogs.
     * @throws {Error} - If the API returns an error.
@@ -45,8 +47,10 @@ export default class ProcedureLogs {
     public async getProcedureLogs({
       PatNum,
       AptNum,
+      ProcStatus,
       PlannedAptNum,
       ClinicNum,
+      CodeNum,
       DateTStamp,
       Offset,
     }: GetProcedureLogParams = {}): Promise<ProcedureLog[]> {
@@ -54,8 +58,10 @@ export default class ProcedureLogs {
       return await this.httpClient.get<ProcedureLog[]>("/procedurelogs", {
         PatNum,
         AptNum,
+        ProcStatus,
         PlannedAptNum,
         ClinicNum,
+        CodeNum,
         DateTStamp,
         Offset,
       });
@@ -66,11 +72,28 @@ export default class ProcedureLogs {
    * @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:
+   * @param {'TP' | 'C' | 'EO' | 'EC' | 'R' | 'Cn'} data.ProcStatus - Required: Either "TP" (Treatment Plan), "C" (Complete), "EC" (Existing Current Provider), "EO" (Existing Other Provider), "R" (Referred Out), "D" (Deleted), or "Cn" (Condition).
+   * @param {number} [data.CodeNum] - This or procCode is Required. FK to procedurecode.CodeNum.
+   * @param {string} [data.procCode] - This or CodeNum is Required. This should be a valid D code, example: D0120. CodeNum is set automatically.
+   * @param {number} [data.AptNum] - Optional. FK to appointment.PatNum.
+   * @param {number} [data.ProcFee] - Optional. If none is given this will default to the procedurecodes default, with consideration of the patient's insurance.
+   * @param {number} [data.Priority] - Optional. Definition.DefNum where definition.Category=20. Default is the first definition in that Category. If Priority is used, then priority will be set automatically.
+   * @param {number} [data.priority] - Optional. String version of Priority. If priority is used, then Priority will be set automatically.
+   * @param {number} [data.ProvNum] - Optional. Defaults to the PriProv of the appointment if given, otherwise it will check the patient's default provider. Failing either of the previous options, it will be set to the dental office's default provider. If ProvNum is used, then provAbbr will be set automatically.
+   * @param {number} [data.Dx] - Optional. Definition.DefNum where definition.Category=16. Default is the first definition in that Category. If Dx is used, then dxName will be set automatically.
+   * @param {string} [data.dxName] - Optional. String version of Dx. If dxName is used, then Dx will be set automatically.
+   * @param {number} [data.PlannedAptNum] - Optional. Only set if this procedure is on a planned appointment, otherwise it will be 0.
+   * @param {"Office" | "PatientsHome" | "InpatHospital" | "OutpatHospital" | "SkilledNursFac" | "CustodialCareFacility" | "OtherLocation" | "MobileUnit" | "School" | "MilitaryTreatFac" | "FederalHealthCenter" | "PublicHealthClinic" | "RuralHealthClinic" | "EmergencyRoomHospital" | "AmbulatorySurgicalCenter" | "TelehealthOutsideHome" | "TelehealthInHome" | "OutreachSiteOrStreet"} [data.PlaceService] - // Optional. Either "Office", "PatientsHome", "InpatHospital", "OutpatHospital", "SkilledNursFac", "CustodialCareFacility", "OtherLocation", "MobileUnit", "School", "MilitaryTreatFac", "FederalHealthCenter", "PublicHealthClinic", "RuralHealthClinic", "EmergencyRoomHospital", "AmbulatorySurgicalCenter", "TelehealthOutsideHome", "TelehealthInHome", or "OutreachSiteOrStreet". Public Health feature must be enabled. Defaults to DefaultProcedurePlaceService preference or clinic.DefaultPlaceService.
+   * @param {"" | "I" | "R"} [data.Prosthesis] - Optional. Either "No" (shows as ""), Initial "I", or Replacement "R". Cannot be set if procedurecode.IsProsth is false. Default is "No".
+   * @param {string} [data.DateOriginalProsth] - Optional. String in "yyyy-MM-dd" format. Cannot be set if procedurecode.IsProsth is false. Default is "0001-01-01"
+   * @param {string} [data.ClaimNote] - Optional. Note that goes out on e-claims. Default empty string.
+   * @param {number} [data.ClinicNum] - Optional. Defaults to the patient's clinic.
+   * @param {string} [data.DateTP] - Optional. The date the procedure was originally treatment planned. String in "yyyy-MM-dd" format.
+   * @param {string} [data.SiteNum] - Optional. FK to site.SiteNum. Public Health feature must be enabled.
+   * @param {string} [data.ProcTime] - Optional. Time of day the procedure started. String in "HH:mm:ss" format.
+   * @param {string} [data.ProcTimeEnd] - Optional. Time of day the procedure ended. Medical Insurance feature must be enabled. String in "HH:mm:ss" format.
+   * @param {string} [data.Prognosis] - Optional. FK to definition.DefNum where definition.Category=30.
+   * @param {Surf} [data.Surf] - Required for the treatment areas of some procCodes. Can be tooth Surfaces (B/F,V,M,O/I,D,L), mouth Quadrants (UL,UR,LR,LL), Sextants (1,2,3,4,5,6), or Arches (U or L).
     * - "B/F" (Buccal/Facial)
     * - "V" (Vestibular)
     * - "M" (Mesial)
@@ -89,13 +112,11 @@ export default class ProcedureLogs {
     * - "6" (Sextant 6)
     * - "U" (Upper Arch)
     * - "L" (Lower Arch)
-   * @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.
+   * @param {string} [data.ToothNum] - Required by procCodes with a Surf or Tooth treatment area.
+   * @param {string} [data.ToothRange] - Required by procCodes with a ToothRange treatment area, or for Quadrants and Arches when AreaAlsoToothRange is true. A string of numbers separated by commas and/or hyphen separated ranges.
+   * @param {string} [data.BillingNote] - Optional. Note that shows in the Account Module. Default empty string.
+   * @param {number} [data.Discount] - Optional. The dollar amount of the discount. Default 0.0.
+   * @param {"true" | "false"} [data.IsDateProsthEst] - Optional. Either "true" or "false". Default "false".
    * @returns {Promise<ProcedureLog>} - The created procedure log.
    * @throws {Error} - If required fields are missing or the API returns an error.
    */
@@ -103,56 +124,96 @@ export default class ProcedureLogs {
     PatNum,
     ProcDate,
     ProcStatus,
+    CodeNum,
     procCode,
     AptNum,
     ProcFee,
-    Surf,
-    ToothNum,
-    ToothRange,
     Priority,
     priority,
     ProvNum,
     Dx,
     dxName,
     PlannedAptNum,
+    PlaceService,
+    Prosthesis,
+    DateOriginalProsth,
+    ClaimNote,
     ClinicNum,
-    //...optionalData
+    DateTP,
+    SiteNum,
+    ProcTime,
+    ProcTimeEnd,
+    Prognosis,
+    ToothNum,
+    Surf,
+    ToothRange,
+    BillingNote,
+    Discount,
+    IsDateProsthEst,
   }: createProcedureLogParams): Promise<ProcedureLog> {
-    if (!PatNum || !ProcDate || !ProcStatus || !procCode) {
-      throw new Error("Invalid data: PatNum, ProcDate, ProcStatus, and procCode are required.");
+    if (!PatNum || !ProcDate || !ProcStatus || (!procCode && !CodeNum)) {
+      throw new Error("Invalid data: PatNum, ProcDate, ProcStatus, and either procCode or CodeNum are required.");
     }
 
     return this.httpClient.post<ProcedureLog>("/procedurelogs", {
       PatNum,
       ProcDate,
       ProcStatus,
+      CodeNum,
       procCode,
       AptNum,
       ProcFee,
-      Surf,
-      ToothNum,
-      ToothRange,
       Priority,
       priority,
       ProvNum,
       Dx,
       dxName,
       PlannedAptNum,
+      PlaceService,
+      Prosthesis,
+      DateOriginalProsth,
+      ClaimNote,
       ClinicNum,
+      DateTP,
+      SiteNum,
+      ProcTime,
+      ProcTimeEnd,
+      Prognosis,
+      ToothNum,
+      Surf,
+      ToothRange,
+      BillingNote,
+      Discount,
+      IsDateProsthEst,
     });
   }
 
   /**
-   * Update an existing procedure log entry.
+   * Updates an existing procedure. When changing procCode, the treatment area of the current and passed in procedure codes must match. Attempting to pass in empty strings for ToothNum, Surf, and ToothRange will be silently ignored. The CodeNum, procCode, Discount, ToothNum, Surf, and ToothRange fields cannot be updated on procedures with a ProcStatus of C. If the procedurelog is associated with certain appointments, claims, or orthocases, then some fields cannot be updated. Procedure code default notes will not be used.
+   * ProcedureLogs associated with adjustments, appointments, payments, payplancharges, or paysplits are updated exactly as in Open Dental.
    * @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:
+   * @param {string} data.ProcDate - Required: Procedure date in "yyyy-MM-dd" format.
+   * @param {'TP' | 'C' | 'EO' | 'EC' | 'R' | 'Cn'} data.ProcStatus - Required: Either "TP" (Treatment Plan), "C" (Complete), "EC" (Existing Current Provider), "EO" (Existing Other Provider), "R" (Referred Out), "D" (Deleted), or "Cn" (Condition).
+   * @param {number} [data.CodeNum] - This or procCode is Required. FK to procedurecode.CodeNum.
+   * @param {string} [data.procCode] - This or CodeNum is Required. This should be a valid D code, example: D0120. CodeNum is set automatically.
+   * @param {number} [data.AptNum] - Optional. FK to appointment.PatNum.
+   * @param {number} [data.ProcFee] - Optional. If none is given this will default to the procedurecodes default, with consideration of the patient's insurance.
+   * @param {number} [data.Priority] - Optional. Definition.DefNum where definition.Category=20. Default is the first definition in that Category. If Priority is used, then priority will be set automatically.
+   * @param {number} [data.ProvNum] - Optional. Defaults to the PriProv of the appointment if given, otherwise it will check the patient's default provider. Failing either of the previous options, it will be set to the dental office's default provider. If ProvNum is used, then provAbbr will be set automatically.
+   * @param {number} [data.Dx] - Optional. Definition.DefNum where definition.Category=16. Default is the first definition in that Category. If Dx is used, then dxName will be set automatically.
+   * @param {number} [data.PlannedAptNum] - Optional. Only set if this procedure is on a planned appointment, otherwise it will be 0.
+   * @param {"Office" | "PatientsHome" | "InpatHospital" | "OutpatHospital" | "SkilledNursFac" | "CustodialCareFacility" | "OtherLocation" | "MobileUnit" | "School" | "MilitaryTreatFac" | "FederalHealthCenter" | "PublicHealthClinic" | "RuralHealthClinic" | "EmergencyRoomHospital" | "AmbulatorySurgicalCenter" | "TelehealthOutsideHome" | "TelehealthInHome" | "OutreachSiteOrStreet"} [data.PlaceService] - // Optional. Either "Office", "PatientsHome", "InpatHospital", "OutpatHospital", "SkilledNursFac", "CustodialCareFacility", "OtherLocation", "MobileUnit", "School", "MilitaryTreatFac", "FederalHealthCenter", "PublicHealthClinic", "RuralHealthClinic", "EmergencyRoomHospital", "AmbulatorySurgicalCenter", "TelehealthOutsideHome", "TelehealthInHome", or "OutreachSiteOrStreet". Public Health feature must be enabled. Defaults to DefaultProcedurePlaceService preference or clinic.DefaultPlaceService.
+   * @param {"" | "I" | "R"} [data.Prosthesis] - Optional. Either "No" (shows as ""), Initial "I", or Replacement "R". Cannot be set if procedurecode.IsProsth is false. Default is "No".
+   * @param {string} [data.DateOriginalProsth] - Optional. String in "yyyy-MM-dd" format. Cannot be set if procedurecode.IsProsth is false. Default is "0001-01-01"
+   * @param {string} [data.ClaimNote] - Optional. Note that goes out on e-claims. Default empty string.
+   * @param {number} [data.ClinicNum] - Optional. Defaults to the patient's clinic.
+   * @param {string} [data.DateTP] - Optional. The date the procedure was originally treatment planned. String in "yyyy-MM-dd" format.
+   * @param {string} [data.SiteNum] - Optional. FK to site.SiteNum. Public Health feature must be enabled.
+   * @param {string} [data.ProcTime] - Optional. Time of day the procedure started. String in "HH:mm:ss" format.
+   * @param {string} [data.ProcTimeEnd] - Optional. Time of day the procedure ended. Medical Insurance feature must be enabled. String in "HH:mm:ss" format.
+   * @param {string} [data.Prognosis] - Optional. FK to definition.DefNum where definition.Category=30.
+   * @param {Surf} [data.Surf] - Required for the treatment areas of some procCodes. Can be tooth Surfaces (B/F,V,M,O/I,D,L), mouth Quadrants (UL,UR,LR,LL), Sextants (1,2,3,4,5,6), or Arches (U or L).
     * - "B/F" (Buccal/Facial)
     * - "V" (Vestibular)
     * - "M" (Mesial)
@@ -171,12 +232,11 @@ export default class ProcedureLogs {
     * - "6" (Sextant 6)
     * - "U" (Upper Arch)
     * - "L" (Lower Arch)
-   * @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.
+   * @param {string} [data.ToothNum] - Required by procCodes with a Surf or Tooth treatment area.
+   * @param {string} [data.ToothRange] - Required by procCodes with a ToothRange treatment area, or for Quadrants and Arches when AreaAlsoToothRange is true. A string of numbers separated by commas and/or hyphen separated ranges.
+   * @param {string} [data.BillingNote] - Optional. Note that shows in the Account Module. Default empty string.
+   * @param {number} [data.Discount] - Optional. The dollar amount of the discount. Default 0.0.
+   * @param {"true" | "false"} [data.IsDateProsthEst] - Optional. Either "true" or "false". Default "false".
    * @returns {Promise<ProcedureLog>} - The updated procedure log.
    * @throws {Error} - If required fields are missing or the API returns an error.
    */
@@ -184,18 +244,31 @@ export default class ProcedureLogs {
     {
       ProcNum,
       ProcDate,
+      ProcStatus,
+      CodeNum,
+      procCode,
       AptNum,
       ProcFee,
       Priority,
-      ProcStatus,
-      procCode,
-      Surf,
-      ToothNum,
-      ToothRange,
       ProvNum,
       Dx,
       PlannedAptNum,
+      PlaceService,
+      Prosthesis,
+      DateOriginalProsth,
+      ClaimNote,
       ClinicNum,
+      DateTP,
+      SiteNum,
+      ProcTime,
+      ProcTimeEnd,
+      Prognosis,
+      ToothNum,
+      Surf,
+      ToothRange,
+      BillingNote,
+      Discount,
+      IsDateProsthEst,
     }: updateProcedureLogParams
   ): Promise<ProcedureLog> {
     if (!ProcNum || typeof ProcNum !== "number") {
@@ -203,19 +276,33 @@ export default class ProcedureLogs {
     }
 
     return this.httpClient.put<ProcedureLog>(`/procedurelogs/${ProcNum}`, {
+      ProcNum,
       ProcDate,
+      ProcStatus,
+      CodeNum,
+      procCode,
       AptNum,
       ProcFee,
       Priority,
-      ProcStatus,
-      procCode,
-      Surf,
-      ToothNum,
-      ToothRange,
       ProvNum,
       Dx,
       PlannedAptNum,
+      PlaceService,
+      Prosthesis,
+      DateOriginalProsth,
+      ClaimNote,
       ClinicNum,
+      DateTP,
+      SiteNum,
+      ProcTime,
+      ProcTimeEnd,
+      Prognosis,
+      ToothNum,
+      Surf,
+      ToothRange,
+      BillingNote,
+      Discount,
+      IsDateProsthEst,
     });
   }
 

package/src/types/chartModuleTypes.ts

@@ -1,7 +1,43 @@
 /**
- * Represents an appointment in the Open Dental system.
- * Used in multiple appointment-related endpoints.
- * @see https://www.opendental.com/site/apiappointments.html
+ * 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
@@ -11,12 +47,12 @@ export interface PlannedAppointment {
     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.
+    AptStatus?: AptStatus; // appointment.AptStatus.
 }
 
 /**
  * Appointment status options.
- * @see https://www.opendental.com/site/apiappointments.html
+ * @see https://www.opendental.com/site/apichartmodules.html
  */
 export type AptStatus =
 | "Scheduled"

package/src/types/procTPTypes.ts

@@ -0,0 +1,79 @@
+//NEED TO COMPLETE FOR PUT/POST/DELETE GROUP NOTES AND INSURANCE HISTORY
+
+/**
+ * ProcTPs are copies of procedures that are attached to Saved treatment plans. 
+ * The ProcNumOrig points to the actual procedurelog row. 
+ * For Active and Inactive treatment plans, use TreatPlanAttaches. 
+ * See Treatment Plans for more information.
+ * @see https://www.opendental.com/site/apiproctps.html
+ */
+export interface ProcTP {
+  ProcTPNum?: number, 
+  TreatPlanNum?: number;
+  PatNum?: number; // Unique patient identifier
+  ProcNumOrig?: number; // Unique procedure identifier
+  ItemOrder?: number; 
+  Priority?: number; // Priority code
+  priority?: string; // Priority description
+  ToothNumTP?: string; // Tooth number
+  Surf?: Surf; // Tooth surface
+  ProcCode?: string; // D code
+  Descript?: string; // Procedure code description
+  FeeAmt?: number; // Fee for the procedure
+  PriInsAmt?: number; // PriInsAmt for the procedure
+  SecInsAmt?: number; // SecInsAmt for the procedure
+  PatAmt?: number; // PatAmt for the procedure
+  Discount?: number; // Discount for the procedure
+  Prognosis?: string; // Type of prosthesis
+  Dx?: string; // Diagnosis code
+  ProcAbbr?: string;
+  SecUserNumEntry?: number;
+  SecDateEntry?: string;
+  FeeAllowed?: number; // Fee allowed for the procedure
+  TaxAmt?: number; // TaxAmt for the procedure
+  ProvNum?: number;
+  DateTP?: string; 
+  ClinicNum?: number; // Clinic number
+  CatPercUCR?: number;
+}
+
+/**
+   * Parameters for GET Multiple ProcTPs.
+   * @see https://www.opendental.com/site/apiproctps.html
+   */
+export interface GetProcTPsParams {
+  TreatPlanNum?: number; //FK to treatplan.TreatPlanNum.
+  Offset?: number; // Pagination offset for results
+}
+
+/**
+ * Updates a ProcTp. Only ProcTPs associated with an unsigned treatment plan can be updated.
+ * @see https://www.opendental.com/site/apiproctps.html
+ */
+export interface updateProcTPParams {
+    ProcTPNum: number, //Required in the URL.
+    Priority?: number; // definition.DefNum where definition.Category=20.
+    ToothNumTP?: string; // The tooth number.
+    Surf?: Surf; // Tooth surfaces or area.
+    ProcCode?: string; // Not a foreign key. Simply display text.
+    Descript?: string; // Description of procedure.
+    FeeAmt?: number; // The fee charged to the patient.
+    PriInsAmt?: number; // The amount primary insurance is expected to pay.
+    SecInsAmt?: number; // The amount secondary insurance is expected to pay.
+    PatAmt?: number; // The amount the patient is expected to pay.
+    Discount?: number; // The amount of discount. Used for PPOs and procedure level discounts.
+    Prognosis?: string; // Text for prognosis definition.
+    Dx?: string; // Text for diagnosis definition.
+    ProcAbbr?: string; // The procedure code abbreviation.
+    FeeAllowed?: number; // The amount primary insurance allows.
+  }
+
+/**
+ * Surf: Required for the treatment areas of some procCodes. Can be tooth Surfaces (B/F,V,M,O/I,D,L), mouth Quadrants (UL,UR,LR,LL), Sextants (1,2,3,4,5,6), or Arches (U or L).
+ * @see https://www.opendental.com/site/apiproctps.html
+ */
+  export type Surf = 
+  "B/F" | "V" | "M" | "O/I" | "D" | "L" | 
+  "UL" | "UR" | "LR" | "LL" | 
+  "1" | "2" | "3" | "4" | "5" | "6" | 
+  "U" | "L";