@rinse-dental/open-dental 2.1.4 → 2.2.0

package/src/types/procedurelogTypes.ts

@@ -16,21 +16,35 @@ export interface ProcedureLog {
   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; 
+  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
+  PlaceService?: "Office" | "PatientsHome" | "InpatHospital" | "OutpatHospital" | "SkilledNursFac" | "CustodialCareFacility" | "OtherLocation" | "MobileUnit" | "School" | "MilitaryTreatFac" | "FederalHealthCenter" | "PublicHealthClinic" | "RuralHealthClinic" | "EmergencyRoomHospital" | "AmbulatorySurgicalCenter" | "TelehealthOutsideHome" | "TelehealthInHome" | "OutreachSiteOrStreet"; // (Added in version 25.2.21) 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.
+  Prosthesis?: "" | "I" | "R"; // (Added in version 25.2.21) Either "No" (shows as ""), Initial "I", or Replacement "R". Cannot be set if procedurecode.IsProsth is false. Default is "No".
+  DateOriginalProsth?: string // Date in yyyy-MM-dd format
+  ClaimNote?: string; // 
+  DateEntryC?: 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
+  BaseUnits?: number; // 
+  DateTP?: string; // Date in yyyy-MM-dd format
+  SiteNum?: number; // 
+  HideGraphics?: 'true' | 'false'; //
+  CanadianTypeCodes?: string; // 
+  ProcTime?: string; // Time taken for the procedure
+  ProcTimeEnd?: string; // 
   DateTStamp?: string; // Timestamp of the last update in "yyyy-MM-dd HH:mm:ss" format
-  IsDateProsthEst?: 'true' | 'false' ; // 
+  Prognosis?: number; // 
+  IsLocked?: 'true' | 'false'; // 
+  BillingNote?: string; // 
+  Discount?: number; // 
+  IsDateProsthEst?: 'true' | 'false'; // 
+  SecDateEntry?: string; // 
   serverDateTime?: string;
 }
 
@@ -41,54 +55,91 @@ export interface ProcedureLog {
 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.
+  ProcStatus?: 'TP' | 'C' | 'EC' | 'EO' | 'R' | 'D' | 'Cn' | 'TPi'; // (Added in version 25.2.21) 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).
+  PlannedAptNum?: number; // (Added in version 24.4.5) FK to appointment.AptNum where appointment.AptStatus=Planned.
+  ClinicNum?: number; // (Added in version 23.3.13) FK to clinic.ClinicNum.
+  CodeNum?: number; // (Added in version 25.2.21) FK to procedurecode.CodeNum.
+  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.
+ * 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; // Unique patient identifier
-    ProcDate: string; // Procedure date in "yyyy-MM-dd" format
-    ProcStatus: 'TP' | 'C' | 'EO'; // Procedure status?: Treatment Planned (TP), Complete (C), etc.
-    procCode: string; // D code
-    AptNum?: number; // Associated appointment number
-    ProcFee?: number; // Fee for the procedure
-    Surf?: Surf; // Tooth surface
-    ToothNum?: string; // Tooth number
-    ToothRange?: string; // Tooth range
-    Priority?: number; //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.
-    priority?: string; // Priority description
-    ProvNum?: number; 
+    ProcDate: string; // Required. String in "yyyy-MM-dd" format.
+    ProcStatus: 'TP' | 'C' | 'EO' | 'EC' | 'R' | 'Cn'; // Required. Either TreatmentPlanned (TP), Complete (C), or ExisitingOtherProvider (EO). (Added in version 25.1.14) Existing Current Provider (EC), Referred Out (R), or Condition (Cn).
+    CodeNum?: number; // (Added in version 25.2.21) This or procCode is Required. FK to procedurecode.CodeNum.
+    procCode?: string; // This or CodeNum is Required. This should be a valid D code, example: D0120. CodeNum is set automatically.
+    AptNum?: number; // Optional. FK to appointment.PatNum.
+    ProcFee?: number; // Optional. If none is given this will default to the procedurecodes default, with consideration of the patient's insurance.
+    Priority?: number; // 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.
+    priority?: string; // Optional. String version of Priority. If priority is used, then Priority will be set automatically.
+    ProvNum?: number; // 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.
     Dx?: string; // 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.
-    dxName?: string; // Diagnosis name
-    PlannedAptNum?: number; // Planned appointment number
-    ClinicNum?: number; // Clinic number
+    dxName?: string; // Optional. String version of Dx. If dxName is used, then Dx will be set automatically.
+    PlannedAptNum?: number; // Optional. Only set if this procedure is on a planned appointment, otherwise it will be 0.
+    PlaceService?: "Office" | "PatientsHome" | "InpatHospital" | "OutpatHospital" | "SkilledNursFac" | "CustodialCareFacility" | "OtherLocation" | "MobileUnit" | "School" | "MilitaryTreatFac" | "FederalHealthCenter" | "PublicHealthClinic" | "RuralHealthClinic" | "EmergencyRoomHospital" | "AmbulatorySurgicalCenter" | "TelehealthOutsideHome" | "TelehealthInHome" | "OutreachSiteOrStreet"; // (Added in version 25.2.21) 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.
+    Prosthesis?: "" | "I" | "R"; // (Added in version 25.2.21) Optional. Either "No" (shows as ""), Initial "I", or Replacement "R". Cannot be set if procedurecode.IsProsth is false. Default is "No".
+    DateOriginalProsth?: string; // (Added in version 25.2.21) Optional. String in "yyyy-MM-dd" format. Cannot be set if procedurecode.IsProsth is false. Default is "0001-01-01"
+    ClaimNote?: string; // (Added in version 25.2.21) Optional. Note that goes out on e-claims. Default empty string.
+    ClinicNum?: number; // Optional. Defaults to the patient's clinic.
+    DateTP?: string; // (Added in version 25.2.21) Optional. The date the procedure was originally treatment planned. String in "yyyy-MM-dd" format. Defaults to the date the procedure was created.
+    SiteNum?: number; // (Added in version 25.2.21) Optional. FK to site.SiteNum. Public Health feature must be enabled. Default 0.
+    ProcTime?: string; // (Added in version 25.2.21) Optional. Time of day the procedure started. String in "HH:mm:ss" format. Default "00:00:00".
+    ProcTimeEnd?: string; // (Added in version 25.2.21) Optional. Time of day the procedure ended. Medical Insurance feature must be enabled. String in "HH:mm:ss" format. Default "00:00:00".
+    Prognosis?: number; // (Added in version 25.2.21) Optional. FK to definition.DefNum where definition.Category=30. Default 0.
+    ToothNum?: string; // Required by procCodes with a Surf or Tooth treatment area.
+    Surf?: 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).
+    ToothRange?: string; // 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.
+    BillingNote?: string; // (Added in version 25.2.21) Optional. Note that shows in the Account Module. Default empty string.
+    Discount?: number; // (Added in version 25.2.21) Optional. The dollar amount of the discount. Default 0.0.
+    IsDateProsthEst?: "true" | "false"; // (Added in version 25.2.21) Optional. Either "true" or "false". Default "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; // Associated appointment number
-    ProcDate?: string; // Procedure date in "yyyy-MM-dd" format
-    ProcFee?: number; // Fee for the procedure
-    Priority?: number; //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.
-    ProcStatus?: 'TP' | 'C' | 'EO'; // Procedure status?: Treatment Planned (TP), Complete (C), etc.
-    ProvNum?: number; 
+    ProcNum: number; // Required in URL.
+
+    AptNum?: number; // Optional. FK to appointment.PatNum.
+    ProcDate: string; // Optional. String in "yyyy-MM-dd" format.
+    ProcFee?: number; // Optional. If none is given this will default to the procedurecodes default, with consideration of the patient's insurance.
+    Priority?: number; // 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.
+    ProcStatus: 'TP' | 'C' | 'EO' | 'EC' | 'R' | 'Cn'; // Required. Either TreatmentPlanned (TP), Complete (C), or ExisitingOtherProvider (EO). (Added in version 25.1.14) Existing Current Provider (EC), Referred Out (R), or Condition (Cn).
+    ProvNum?: number; // 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.
     Dx?: string; // 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.
-    PlannedAptNum?: number; // Planned appointment number
-    ClinicNum?: number; // Clinic number
-    procCode?: string; // D code
-    ToothNum?: string; // Tooth number
-    Surf?: Surf; // Tooth surface
-    ToothRange?: string; // Tooth rang
+    PlannedAptNum?: number; // Optional. Only set if this procedure is on a planned appointment, otherwise it will be 0.
+    PlaceService?: "Office" | "PatientsHome" | "InpatHospital" | "OutpatHospital" | "SkilledNursFac" | "CustodialCareFacility" | "OtherLocation" | "MobileUnit" | "School" | "MilitaryTreatFac" | "FederalHealthCenter" | "PublicHealthClinic" | "RuralHealthClinic" | "EmergencyRoomHospital" | "AmbulatorySurgicalCenter" | "TelehealthOutsideHome" | "TelehealthInHome" | "OutreachSiteOrStreet"; // (Added in version 25.2.21) 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.
+    Prosthesis?: "" | "I" | "R"; // (Added in version 25.2.21) Optional. Either "No" (shows as ""), Initial "I", or Replacement "R". Cannot be set if procedurecode.IsProsth is false. Default is "No".
+    DateOriginalProsth?: string; // (Added in version 25.2.21) Optional. String in "yyyy-MM-dd" format. Cannot be set if procedurecode.IsProsth is false. Default is "0001-01-01"
+    ClaimNote?: string; // (Added in version 25.2.21) Optional. Note that goes out on e-claims. Default empty string.
+    ClinicNum?: number; // Optional. Defaults to the patient's clinic.
+    CodeNum?: number; // (Added in version 25.2.21) This or procCode is Required. FK to procedurecode.CodeNum.
+    procCode?: string; // This or CodeNum is Required. This should be a valid D code, example: D0120. CodeNum is set automatically.   
+    DateTP?: string; // (Added in version 25.2.21) Optional. The date the procedure was originally treatment planned. String in "yyyy-MM-dd" format. Defaults to the date the procedure was created.
+    SiteNum?: number; // (Added in version 25.2.21) Optional. FK to site.SiteNum. Public Health feature must be enabled. Default 0.
+    ProcTime?: string; // (Added in version 25.2.21) Optional. Time of day the procedure started. String in "HH:mm:ss" format. Default "00:00:00".
+    ProcTimeEnd?: string; // (Added in version 25.2.21) Optional. Time of day the procedure ended. Medical Insurance feature must be enabled. String in "HH:mm:ss" format. Default "00:00:00".
+    Prognosis?: number; // (Added in version 25.2.21) Optional. FK to definition.DefNum where definition.Category=30. Default 0.
+    ToothNum?: string; // Required by procCodes with a Surf or Tooth treatment area.
+    Surf?: 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).
+    ToothRange?: string; // 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.
+    BillingNote?: string; // (Added in version 25.2.21) Optional. Note that shows in the Account Module. Default empty string.
+    Discount?: number; // (Added in version 25.2.21) Optional. The dollar amount of the discount. Default 0.0.
+    IsDateProsthEst?: "true" | "false"; // (Added in version 25.2.21) Optional. Either "true" or "false". Default "false".
   }
 
 /**
@@ -123,7 +174,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" |