@rinse-dental/open-dental 1.0.3 → 1.0.5

package/src/types/patPlanTypes.ts

@@ -0,0 +1,55 @@
+/**
+ * A PatPlan row in the database indicates coverage aka eligibility. 
+ * If there is no patplan row, then the patient does not have coverage. 
+ * So eligibility can be set by adding or removing PatPlan rows.
+ * @see https://www.opendental.com/site/apipatplans.html
+ */
+export interface PatPlan {
+    PatPlanNum?: number; // PK
+    PatNum?: number; // FK to patient
+    Ordinal?: number; // 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.
+    IsPending?: "true" | "false"; //String in "yyyy-MM-dd" format. 
+    Relationship?: "Self" | "Spouse" | "Child" | "Employee" | "HandicapDep" | "SignifOther" | "InjuredPlantiff" | "LifePartner" | "Dependent"; //Default is Self. Values can be "Self", "Spouse", "Child", "Employee", "HandicapDep", "SignifOther", "InjuredPlantiff", "LifePartner" or "Dependent".
+    PatID?: string; // A patient ID which will override the subscriber ID on eclaims. Also used for Canada.
+    InsSubNum?: number; // 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.
+    OrthoAutoFeeBilledOverride?: string; //
+    OrthoAutoNextClaimDate?: string; //
+    SecDateTEntry?: string; // String in "yyyy-MM-dd HH:mm:ss" format
+    SecDateTEdit?: string; // String in "yyyy-MM-dd HH:mm:ss" format
+  }
+
+  /**
+   * Gets a list of PatPlans that meet a set of search criteria.
+   * @see https://www.opendental.com/site/apipatplans.html
+   */
+  export interface GetPatPlansParams {
+    PatNum?: number; // Optional. FK to patient.PatNum.
+    InsSubNum?: number; // Optional. FK to inssub.InsSubNum
+    Offset?: number; // Pagination offset for results
+  }
+
+  /**
+   * Parameters for creating an PatPlan. This adds a PatPlan row to the database.
+   * @see https://www.opendental.com/site/apipatplans.html
+   */
+  export interface CreatePatPlanParams {
+    PatNum: number; // Required. FK to patient
+    InsSubNum: number; // 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.
+    Ordinal?: number; // Optional. 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.
+    Relationship?: "Self" | "Spouse" | "Child" | "Employee" | "HandicapDep" | "SignifOther" | "InjuredPlantiff" | "LifePartner" | "Dependent"; // Optional. Default is Self. Values can be "Self", "Spouse", "Child", "Employee", "HandicapDep", "SignifOther", "InjuredPlantiff", "LifePartner" or "Dependent".
+    PatID?: string; // Optional. A patient ID which will override the subscriber ID on eclaims. Also used for Canada.
+  }
+  
+  /**
+   * Parameters for updating an PatPlan. 
+   * This updates an existing PatPlan row in the database. PatNum cannot be updated. Instead, drop the PatPlan and then recreate it.
+   * @see https://www.opendental.com/site/apipatplans.html
+   */
+  export interface UpdatePatPlanParams {
+    PatPlanNum: number; //Required. PK
+    InsSubNum?: number; // 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.
+    Ordinal?: number; // Optional. 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.
+    Relationship?: "Self" | "Spouse" | "Child" | "Employee" | "HandicapDep" | "SignifOther" | "InjuredPlantiff" | "LifePartner" | "Dependent"; // Optional. Default is Self. Values can be "Self", "Spouse", "Child", "Employee", "HandicapDep", "SignifOther", "InjuredPlantiff", "LifePartner" or "Dependent".
+    PatID?: string; // Optional. A patient ID which will override the subscriber ID on eclaims. Also used for Canada.
+  }
+  

package/src/types/procedurelogTypes.ts

@@ -5,34 +5,47 @@
  * @see https://www.opendental.com/site/apiprocedurelogs.html
  */
 export interface ProcedureLog {
-    ProcNum?: number; // Unique procedure identifier
-    PatNum?: number; // Unique patient identifier
-    AptNum?: number; // Associated appointment number
-    ProcDate?: string; // Procedure date in "yyyy-MM-dd" format
-    ProcFee?: number; // Fee for the procedure
-    Surf?: Surf; // Tooth surface
-    ToothNum?: string; // Tooth number
-    ToothRange?: string; // Tooth range
-    Priority?: number; // Priority code
-    priority?: string; // Priority description
-    ProcStatus?: 'TP' | 'C' | 'EO' | 'R' | 'D' | 'E'; // Procedure status?: Treatment Planned (TP), Complete (C), etc.
-    ProvNum?: number; 
-    provAbbr?: string; 
-    Dx?: string; // Diagnosis code
-    dxName?: string; // Diagnosis name
-    PlannedAptNum?: number; // Planned appointment number
-    Prosthesis?: string; // Type of prosthesis
-    DateOriginalProsth?: string //Date in yyyy-MM-dd format
-    ClinicNum?: number; // Clinic number
-    CodeNum?: number; // Procedure code number
-    procCode?: string; // D code
-    descript?: string; // Procedure code description
-    ProcTime?: string; // Time taken for the procedure
-    UnitQty?: number; // Quantity of units
-    DateTStamp?: string; // Timestamp of the last update in "yyyy-MM-dd HH:mm:ss" format
-    IsDateProsthEst?: 'true' | 'false' ; // 
-    serverDateTime?: string;
-  }
+  ProcNum?: number; // Unique procedure identifier
+  PatNum?: number; // Unique patient identifier
+  AptNum?: number; // Associated appointment number
+  ProcDate?: string; // Procedure date in "yyyy-MM-dd" format
+  ProcFee?: number; // Fee for the procedure
+  Surf?: Surf; // Tooth surface
+  ToothNum?: string; // Tooth number
+  ToothRange?: string; // Tooth range
+  Priority?: number; // Priority code
+  priority?: string; // Priority description
+  ProcStatus?: 'TP' | 'C' | 'EO' | 'R' | 'D' | 'E'; // Procedure status?: Treatment Planned (TP), Complete (C), etc.
+  ProvNum?: number; 
+  provAbbr?: string; 
+  Dx?: string; // Diagnosis code
+  dxName?: string; // Diagnosis name
+  PlannedAptNum?: number; // Planned appointment number
+  Prosthesis?: string; // Type of prosthesis
+  DateOriginalProsth?: string //Date in yyyy-MM-dd format
+  ClinicNum?: number; // Clinic number
+  CodeNum?: number; // Procedure code number
+  procCode?: string; // D code
+  descript?: string; // Procedure code description
+  ProcTime?: string; // Time taken for the procedure
+  UnitQty?: number; // Quantity of units
+  DateTStamp?: string; // Timestamp of the last update in "yyyy-MM-dd HH:mm:ss" format
+  IsDateProsthEst?: 'true' | 'false' ; // 
+  serverDateTime?: string;
+}
+
+/**
+   * Parameters for GET Multiple ProcedureLogs.
+   * @see https://www.opendental.com/site/apiprocedurelogs.html
+   */
+export interface GetProcedureLogParams {
+  PatNum?: number; //FK to patient.PatNum.
+  AptNum?: number; //FK to appointment.aptnum, returns procedures that are attached to an appointment.
+  PlannedAptNum?: number; //FK to appointment.aptnum, returns procedures that are attached to a plannedapt
+  ClinicNum?: number; //FK to clinic.
+  DateTStamp?: string; //Gets procedurelogs created on or after the specified date and time. String in "yyyy-MM-dd HH:mm:ss" format.
+  Offset?: number; // Pagination offset for results
+}
 
 /**
  * Create procedure log parameters.