@rinse-dental/open-dental 2.1.4 → 2.2.0

package/dist/types/chartModuleTypes.d.ts

@@ -1,7 +1,41 @@
 /**
- * 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";
+    PrimaryKey?: number;
+    Date?: string;
+    Time?: string;
+    DateTime?: string;
+    Th?: string;
+    Surf?: string;
+    Dx?: string;
+    Description?: string;
+    Note?: string;
+    Stat?: string;
+    Prov?: string;
+    ProvNum?: string;
+    Amount?: string;
+    ProcCode?: string;
+    User?: string;
+    Signed?: string;
+    Length?: string;
+    Abbr?: string;
+    Clinic?: string;
+    ClinicNum?: string;
+}
+/**
+ * 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;
+    Content?: string;
+}
+/**
+ * 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;
@@ -15,7 +49,7 @@ export interface PlannedAppointment {
 }
 /**
  * Appointment status options.
- * @see https://www.opendental.com/site/apiappointments.html
+ * @see https://www.opendental.com/site/apichartmodules.html
  */
 export type AptStatus = "Scheduled" | "Complete" | "UnschedList" | "ASAP" | "Broken" | "Planned" | "PtNote" | "PtNoteCompleted";
 //# sourceMappingURL=chartModuleTypes.d.ts.map

package/dist/types/chartModuleTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"chartModuleTypes.d.ts","sourceRoot":"","sources":["../../src/types/chartModuleTypes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,SAAS,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,MAAM,SAAS,GACnB,WAAW,GACX,UAAU,GACV,aAAa,GACb,MAAM,GACN,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,iBAAiB,CAAC"}
+{"version":3,"file":"chartModuleTypes.d.ts","sourceRoot":"","sources":["../../src/types/chartModuleTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACrB,UAAU,CAAC,EAAE,aAAa,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,GAAI,IAAI,GAAG,OAAO,CAAC;IACxF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,SAAS,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,MAAM,SAAS,GACnB,WAAW,GACX,UAAU,GACV,aAAa,GACb,MAAM,GACN,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,iBAAiB,CAAC"}

package/dist/types/procTPTypes.d.ts

@@ -0,0 +1,71 @@
+/**
+ * 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;
+    ProcNumOrig?: number;
+    ItemOrder?: number;
+    Priority?: number;
+    priority?: string;
+    ToothNumTP?: string;
+    Surf?: Surf;
+    ProcCode?: string;
+    Descript?: string;
+    FeeAmt?: number;
+    PriInsAmt?: number;
+    SecInsAmt?: number;
+    PatAmt?: number;
+    Discount?: number;
+    Prognosis?: string;
+    Dx?: string;
+    ProcAbbr?: string;
+    SecUserNumEntry?: number;
+    SecDateEntry?: string;
+    FeeAllowed?: number;
+    TaxAmt?: number;
+    ProvNum?: number;
+    DateTP?: string;
+    ClinicNum?: number;
+    CatPercUCR?: number;
+}
+/**
+   * Parameters for GET Multiple ProcTPs.
+   * @see https://www.opendental.com/site/apiproctps.html
+   */
+export interface GetProcTPsParams {
+    TreatPlanNum?: number;
+    Offset?: number;
+}
+/**
+ * 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;
+    Priority?: number;
+    ToothNumTP?: string;
+    Surf?: Surf;
+    ProcCode?: string;
+    Descript?: string;
+    FeeAmt?: number;
+    PriInsAmt?: number;
+    SecInsAmt?: number;
+    PatAmt?: number;
+    Discount?: number;
+    Prognosis?: string;
+    Dx?: string;
+    ProcAbbr?: string;
+    FeeAllowed?: number;
+}
+/**
+ * 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";
+//# sourceMappingURL=procTPTypes.d.ts.map

package/dist/types/procTPTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"procTPTypes.d.ts","sourceRoot":"","sources":["../../src/types/procTPTypes.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,WAAW,MAAM;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;KAGK;AACL,MAAM,WAAW,gBAAgB;IAC/B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAEH;;;GAGG;AACD,MAAM,MAAM,IAAI,GAChB,KAAK,GAAG,GAAG,GAAG,GAAG,GAAG,KAAK,GAAG,GAAG,GAAG,GAAG,GACrC,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GACzB,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GACjC,GAAG,GAAG,GAAG,CAAC"}

package/dist/types/procTPTypes.js

@@ -0,0 +1,3 @@
+"use strict";
+//NEED TO COMPLETE FOR PUT/POST/DELETE GROUP NOTES AND INSURANCE HISTORY
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/procedurelogTypes.d.ts

@@ -19,16 +19,30 @@ export interface ProcedureLog {
     Dx?: string;
     dxName?: string;
     PlannedAptNum?: number;
-    Prosthesis?: string;
+    PlaceService?: "Office" | "PatientsHome" | "InpatHospital" | "OutpatHospital" | "SkilledNursFac" | "CustodialCareFacility" | "OtherLocation" | "MobileUnit" | "School" | "MilitaryTreatFac" | "FederalHealthCenter" | "PublicHealthClinic" | "RuralHealthClinic" | "EmergencyRoomHospital" | "AmbulatorySurgicalCenter" | "TelehealthOutsideHome" | "TelehealthInHome" | "OutreachSiteOrStreet";
+    Prosthesis?: "" | "I" | "R";
     DateOriginalProsth?: string;
+    ClaimNote?: string;
+    DateEntryC?: string;
     ClinicNum?: number;
     CodeNum?: number;
     procCode?: string;
     descript?: string;
-    ProcTime?: string;
     UnitQty?: number;
+    BaseUnits?: number;
+    DateTP?: string;
+    SiteNum?: number;
+    HideGraphics?: 'true' | 'false';
+    CanadianTypeCodes?: string;
+    ProcTime?: string;
+    ProcTimeEnd?: string;
     DateTStamp?: string;
+    Prognosis?: number;
+    IsLocked?: 'true' | 'false';
+    BillingNote?: string;
+    Discount?: number;
     IsDateProsthEst?: 'true' | 'false';
+    SecDateEntry?: string;
     serverDateTime?: string;
 }
 /**
@@ -38,52 +52,88 @@ export interface ProcedureLog {
 export interface GetProcedureLogParams {
     PatNum?: number;
     AptNum?: number;
+    ProcStatus?: 'TP' | 'C' | 'EC' | 'EO' | 'R' | 'D' | 'Cn' | 'TPi';
     PlannedAptNum?: number;
     ClinicNum?: number;
+    CodeNum?: number;
     DateTStamp?: string;
     Offset?: number;
 }
 /**
- * Create procedure log parameters.
+ * Creates a new procedure for a given patient. Attempts to set them will be silently ignored.
+ * Furthermore, the following pairs of fields may only have one of the two passed in at once: Priority and priority, Dx and dxName.
+ * Not all procedure codes support Surfs, ToothNums, and ToothRanges. Procedure code default notes will not be used.
  * @see https://www.opendental.com/site/apiprocedurelogs.html
  */
 export interface createProcedureLogParams {
     PatNum: number;
     ProcDate: string;
-    ProcStatus: 'TP' | 'C' | 'EO';
-    procCode: string;
+    ProcStatus: 'TP' | 'C' | 'EO' | 'EC' | 'R' | 'Cn';
+    CodeNum?: number;
+    procCode?: string;
     AptNum?: number;
     ProcFee?: number;
-    Surf?: Surf;
-    ToothNum?: string;
-    ToothRange?: string;
     Priority?: number;
     priority?: string;
     ProvNum?: number;
     Dx?: string;
     dxName?: string;
     PlannedAptNum?: number;
+    PlaceService?: "Office" | "PatientsHome" | "InpatHospital" | "OutpatHospital" | "SkilledNursFac" | "CustodialCareFacility" | "OtherLocation" | "MobileUnit" | "School" | "MilitaryTreatFac" | "FederalHealthCenter" | "PublicHealthClinic" | "RuralHealthClinic" | "EmergencyRoomHospital" | "AmbulatorySurgicalCenter" | "TelehealthOutsideHome" | "TelehealthInHome" | "OutreachSiteOrStreet";
+    Prosthesis?: "" | "I" | "R";
+    DateOriginalProsth?: string;
+    ClaimNote?: string;
     ClinicNum?: number;
+    DateTP?: string;
+    SiteNum?: number;
+    ProcTime?: string;
+    ProcTimeEnd?: string;
+    Prognosis?: number;
+    ToothNum?: string;
+    Surf?: Surf;
+    ToothRange?: string;
+    BillingNote?: string;
+    Discount?: number;
+    IsDateProsthEst?: "true" | "false";
 }
 /**
- * Update procedure log parameters.
+ * 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.
  * @see https://www.opendental.com/site/apiprocedurelogs.html
  */
 export interface updateProcedureLogParams {
     ProcNum: number;
     AptNum?: number;
-    ProcDate?: string;
+    ProcDate: string;
     ProcFee?: number;
     Priority?: number;
-    ProcStatus?: 'TP' | 'C' | 'EO';
+    ProcStatus: 'TP' | 'C' | 'EO' | 'EC' | 'R' | 'Cn';
     ProvNum?: number;
     Dx?: string;
     PlannedAptNum?: number;
+    PlaceService?: "Office" | "PatientsHome" | "InpatHospital" | "OutpatHospital" | "SkilledNursFac" | "CustodialCareFacility" | "OtherLocation" | "MobileUnit" | "School" | "MilitaryTreatFac" | "FederalHealthCenter" | "PublicHealthClinic" | "RuralHealthClinic" | "EmergencyRoomHospital" | "AmbulatorySurgicalCenter" | "TelehealthOutsideHome" | "TelehealthInHome" | "OutreachSiteOrStreet";
+    Prosthesis?: "" | "I" | "R";
+    DateOriginalProsth?: string;
+    ClaimNote?: string;
     ClinicNum?: number;
+    CodeNum?: number;
     procCode?: string;
+    DateTP?: string;
+    SiteNum?: number;
+    ProcTime?: string;
+    ProcTimeEnd?: string;
+    Prognosis?: number;
     ToothNum?: string;
     Surf?: Surf;
     ToothRange?: string;
+    BillingNote?: string;
+    Discount?: number;
+    IsDateProsthEst?: "true" | "false";
 }
 /**
  * Insurance History object in Open Dental.
@@ -114,7 +164,7 @@ export interface postInsuranceHistoryParams {
 }
 /**
  * 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/apiappointments.html
+ * @see https://www.opendental.com/site/apiprocedurelogs.html
  */
 export type Surf = "B/F" | "V" | "M" | "O/I" | "D" | "L" | "UL" | "UR" | "LR" | "LL" | "1" | "2" | "3" | "4" | "5" | "6" | "U" | "L";
 //# sourceMappingURL=procedurelogTypes.d.ts.map

package/dist/types/procedurelogTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"procedurelogTypes.d.ts","sourceRoot":"","sources":["../../src/types/procedurelogTypes.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IACjD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAE;IACpC,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;KAGK;AACL,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAEH;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAEH;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAEH;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAEH;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,gBAAgB,GAAG,kBAAkB,GAAG,kBAAkB,GAAG,oBAAoB,GAAG,qBAAqB,GAAG,qBAAqB,GAAG,qBAAqB,GAAG,qBAAqB,GAAG,wBAAwB,GAAG,yBAAyB,CAAC;IAC1P,QAAQ,EAAE,MAAM,CAAC;CAClB;AAEH;;;GAGG;AACD,MAAM,MAAM,IAAI,GAChB,KAAK,GAAG,GAAG,GAAG,GAAG,GAAG,KAAK,GAAG,GAAG,GAAG,GAAG,GACrC,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GACzB,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GACjC,GAAG,GAAG,GAAG,CAAC"}
+{"version":3,"file":"procedurelogTypes.d.ts","sourceRoot":"","sources":["../../src/types/procedurelogTypes.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IACjD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,QAAQ,GAAG,cAAc,GAAG,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,uBAAuB,GAAG,eAAe,GAAG,YAAY,GAAG,QAAQ,GAAG,kBAAkB,GAAG,qBAAqB,GAAG,oBAAoB,GAAG,mBAAmB,GAAG,uBAAuB,GAAG,0BAA0B,GAAG,uBAAuB,GAAG,kBAAkB,GAAG,sBAAsB,CAAC;IAChY,UAAU,CAAC,EAAE,EAAE,GAAG,GAAG,GAAG,GAAG,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAChC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACnC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;KAGK;AACL,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,KAAK,CAAC;IACjE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC;IAClD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,QAAQ,GAAG,cAAc,GAAG,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,uBAAuB,GAAG,eAAe,GAAG,YAAY,GAAG,QAAQ,GAAG,kBAAkB,GAAG,qBAAqB,GAAG,oBAAoB,GAAG,mBAAmB,GAAG,uBAAuB,GAAG,0BAA0B,GAAG,uBAAuB,GAAG,kBAAkB,GAAG,sBAAsB,CAAC;IAChY,UAAU,CAAC,EAAE,EAAE,GAAG,GAAG,GAAG,GAAG,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACpC;AAEH;;;;;;;;;GASG;AACH,MAAM,WAAW,wBAAwB;IACrC,OAAO,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC;IAClD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,QAAQ,GAAG,cAAc,GAAG,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,uBAAuB,GAAG,eAAe,GAAG,YAAY,GAAG,QAAQ,GAAG,kBAAkB,GAAG,qBAAqB,GAAG,oBAAoB,GAAG,mBAAmB,GAAG,uBAAuB,GAAG,0BAA0B,GAAG,uBAAuB,GAAG,kBAAkB,GAAG,sBAAsB,CAAC;IAChY,UAAU,CAAC,EAAE,EAAE,GAAG,GAAG,GAAG,GAAG,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACpC;AAEH;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAEH;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAEH;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,gBAAgB,GAAG,kBAAkB,GAAG,kBAAkB,GAAG,oBAAoB,GAAG,qBAAqB,GAAG,qBAAqB,GAAG,qBAAqB,GAAG,qBAAqB,GAAG,wBAAwB,GAAG,yBAAyB,CAAC;IAC1P,QAAQ,EAAE,MAAM,CAAC;CAClB;AAEH;;;GAGG;AACD,MAAM,MAAM,IAAI,GAChB,KAAK,GAAG,GAAG,GAAG,GAAG,GAAG,KAAK,GAAG,GAAG,GAAG,GAAG,GACrC,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GACzB,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GACjC,GAAG,GAAG,GAAG,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rinse-dental/open-dental",
-    "version": "2.1.4",
+    "version": "2.2.0",
     "description": "A TypeScript library for easily accessing Open Dental APIs.",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

package/src/api/chartModules.ts

@@ -1,5 +1,7 @@
 import HttpClient from "../utils/httpClient";
 import {
+  ProgNote,
+  PatientInfo,
   PlannedAppointment,
 } from "../types/chartModuleTypes"
 
@@ -10,6 +12,32 @@ export default class ChartModules {
     this.httpClient = httpClient;
   }
 
+  /**
+   * 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.
+   * @param {number} PatNum - The unique identifier for the patient.
+   * @returns {Promise<ProgNote>} - The ProgNote object.
+   * @throws {Error} - If `PatNum` is not provided.
+   */
+  public async getProgNotes(PatNum: number): Promise<ProgNote> {
+    if (!PatNum || typeof PatNum !== "number") {
+      throw new Error("PatNum must be an integer.");
+    }
+    return this.httpClient.get<ProgNote>(`/chartmodules/${PatNum}/ProgNotes`);
+  }
+
+  /**
+   * 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.
+   * @param {number} PatNum - The unique identifier for the patient.
+   * @returns {Promise<PatientInfo>} - The PatientInfo object.
+   * @throws {Error} - If `PatNum` is not provided.
+   */
+  public async PatientInfo(PatNum: number): Promise<PatientInfo> {
+    if (!PatNum || typeof PatNum !== "number") {
+      throw new Error("PatNum must be an integer.");
+    }
+    return this.httpClient.get<PatientInfo>(`/chartmodules/${PatNum}/PatientInfo`);
+  }
+
   /**
    * Gets Planned Appointments for a patient, similarly to how it shows in the Chart Module's Planned Appointments tab.
    * @param {number} PatNum - The unique identifier for the patient.
@@ -17,8 +45,8 @@ export default class ChartModules {
    * @throws {Error} - If `PatNum` is not provided.
    */
   public async getPlannedAppts(PatNum: number): Promise<PlannedAppointment> {
-    if (!PatNum) {
-      throw new Error("PatNum is required.");
+    if (!PatNum || typeof PatNum !== "number") {
+      throw new Error("PatNum must be an integer.");
     }
     return this.httpClient.get<PlannedAppointment>(`/chartmodules/${PatNum}/PlannedAppts`);
   }

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,
+    });
+  }
+
+}