@rinse-dental/open-dental 2.1.4 → 2.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -22,19 +22,23 @@ class ProcedureLogs {
22
22
  * @param {Object} params - Filtering and pagination parameters.
23
23
  * @param {number} [params.PatNum] - Get procedurelogs by PatNum
24
24
  * @param {number} [params.AptNum] - Get procedurelogs by AptNum
25
- * @param {number} [params.PlannedAptNum] - Get procedurelogs by PlannedAptNum
26
- * @param {number} [params.ClinicNum] - Get procedurelogs by ClinicNum
27
- * @param {string} [params.DateTStamp] - Get procedurelogs altered after the specified date and time
25
+ * @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).
26
+ * @param {number} [params.PlannedAptNum] - FK to appointment.AptNum where appointment.AptStatus=Planned.
27
+ * @param {number} [params.ClinicNum] - FK to clinic.ClinicNum.
28
+ * @param {number} [params.CodeNum] - FK to procedurecode.CodeNum.
29
+ * @param {string} [params.DateTStamp] - Gets procedurelogs created on or after the specified date and time. String in "yyyy-MM-dd HH:mm:ss" format.
28
30
  * @param {string} [params.Offset] - Pagination
29
31
  * @returns {Promise<ProcedureLog[]>} - A list of procedurelogs.
30
32
  * @throws {Error} - If the API returns an error.
31
33
  */
32
- async getProcedureLogs({ PatNum, AptNum, PlannedAptNum, ClinicNum, DateTStamp, Offset, } = {}) {
34
+ async getProcedureLogs({ PatNum, AptNum, ProcStatus, PlannedAptNum, ClinicNum, CodeNum, DateTStamp, Offset, } = {}) {
33
35
  return await this.httpClient.get("/procedurelogs", {
34
36
  PatNum,
35
37
  AptNum,
38
+ ProcStatus,
36
39
  PlannedAptNum,
37
40
  ClinicNum,
41
+ CodeNum,
38
42
  DateTStamp,
39
43
  Offset,
40
44
  });
@@ -44,11 +48,28 @@ class ProcedureLogs {
44
48
  * @param {Object} data - The details of the procedure log to create.
45
49
  * @param {number} data.PatNum - Required: Patient number.
46
50
  * @param {string} data.ProcDate - Required: Procedure date in "yyyy-MM-dd" format.
47
- * @param {'TP' | 'C' | 'EO'} data.ProcStatus - Required: Procedure status.
48
- * @param {string} data.procCode - Required: Procedure code (D code).
49
- * @param {number} [data.AptNum] - Optional: Associated appointment number.
50
- * @param {number} [data.ProcFee] - Optional: Fee for the procedure.
51
- * @param {Surf} [data.Surf] - Optional: Tooth surface or treatment area. Options include:
51
+ * @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).
52
+ * @param {number} [data.CodeNum] - This or procCode is Required. FK to procedurecode.CodeNum.
53
+ * @param {string} [data.procCode] - This or CodeNum is Required. This should be a valid D code, example: D0120. CodeNum is set automatically.
54
+ * @param {number} [data.AptNum] - Optional. FK to appointment.PatNum.
55
+ * @param {number} [data.ProcFee] - Optional. If none is given this will default to the procedurecodes default, with consideration of the patient's insurance.
56
+ * @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.
57
+ * @param {number} [data.priority] - Optional. String version of Priority. If priority is used, then Priority will be set automatically.
58
+ * @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.
59
+ * @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.
60
+ * @param {string} [data.dxName] - Optional. String version of Dx. If dxName is used, then Dx will be set automatically.
61
+ * @param {number} [data.PlannedAptNum] - Optional. Only set if this procedure is on a planned appointment, otherwise it will be 0.
62
+ * @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.
63
+ * @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".
64
+ * @param {string} [data.DateOriginalProsth] - Optional. String in "yyyy-MM-dd" format. Cannot be set if procedurecode.IsProsth is false. Default is "0001-01-01"
65
+ * @param {string} [data.ClaimNote] - Optional. Note that goes out on e-claims. Default empty string.
66
+ * @param {number} [data.ClinicNum] - Optional. Defaults to the patient's clinic.
67
+ * @param {string} [data.DateTP] - Optional. The date the procedure was originally treatment planned. String in "yyyy-MM-dd" format.
68
+ * @param {string} [data.SiteNum] - Optional. FK to site.SiteNum. Public Health feature must be enabled.
69
+ * @param {string} [data.ProcTime] - Optional. Time of day the procedure started. String in "HH:mm:ss" format.
70
+ * @param {string} [data.ProcTimeEnd] - Optional. Time of day the procedure ended. Medical Insurance feature must be enabled. String in "HH:mm:ss" format.
71
+ * @param {string} [data.Prognosis] - Optional. FK to definition.DefNum where definition.Category=30.
72
+ * @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).
52
73
  * - "B/F" (Buccal/Facial)
53
74
  * - "V" (Vestibular)
54
75
  * - "M" (Mesial)
@@ -67,52 +88,76 @@ class ProcedureLogs {
67
88
  * - "6" (Sextant 6)
68
89
  * - "U" (Upper Arch)
69
90
  * - "L" (Lower Arch)
70
- * @param {string} [data.ToothNum] - Optional: Tooth number.
71
- * @param {string} [data.ToothRange] - Optional: Tooth range.
72
- * @param {number} [data.Priority] - Optional: Priority code.
73
- * @param {number} [data.ProvNum] - Optional: Provider number.
74
- * @param {string} [data.Dx] - Optional: Diagnosis code.
75
- * @param {number} [data.PlannedAptNum] - Optional: Planned appointment number.
76
- * @param {number} [data.ClinicNum] - Optional: Clinic number.
91
+ * @param {string} [data.ToothNum] - Required by procCodes with a Surf or Tooth treatment area.
92
+ * @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.
93
+ * @param {string} [data.BillingNote] - Optional. Note that shows in the Account Module. Default empty string.
94
+ * @param {number} [data.Discount] - Optional. The dollar amount of the discount. Default 0.0.
95
+ * @param {"true" | "false"} [data.IsDateProsthEst] - Optional. Either "true" or "false". Default "false".
77
96
  * @returns {Promise<ProcedureLog>} - The created procedure log.
78
97
  * @throws {Error} - If required fields are missing or the API returns an error.
79
98
  */
80
- async createProcedureLog({ PatNum, ProcDate, ProcStatus, procCode, AptNum, ProcFee, Surf, ToothNum, ToothRange, Priority, priority, ProvNum, Dx, dxName, PlannedAptNum, ClinicNum,
81
- //...optionalData
82
- }) {
83
- if (!PatNum || !ProcDate || !ProcStatus || !procCode) {
84
- throw new Error("Invalid data: PatNum, ProcDate, ProcStatus, and procCode are required.");
99
+ async createProcedureLog({ PatNum, ProcDate, ProcStatus, CodeNum, procCode, AptNum, ProcFee, Priority, priority, ProvNum, Dx, dxName, PlannedAptNum, PlaceService, Prosthesis, DateOriginalProsth, ClaimNote, ClinicNum, DateTP, SiteNum, ProcTime, ProcTimeEnd, Prognosis, ToothNum, Surf, ToothRange, BillingNote, Discount, IsDateProsthEst, }) {
100
+ if (!PatNum || !ProcDate || !ProcStatus || (!procCode && !CodeNum)) {
101
+ throw new Error("Invalid data: PatNum, ProcDate, ProcStatus, and either procCode or CodeNum are required.");
85
102
  }
86
103
  return this.httpClient.post("/procedurelogs", {
87
104
  PatNum,
88
105
  ProcDate,
89
106
  ProcStatus,
107
+ CodeNum,
90
108
  procCode,
91
109
  AptNum,
92
110
  ProcFee,
93
- Surf,
94
- ToothNum,
95
- ToothRange,
96
111
  Priority,
97
112
  priority,
98
113
  ProvNum,
99
114
  Dx,
100
115
  dxName,
101
116
  PlannedAptNum,
117
+ PlaceService,
118
+ Prosthesis,
119
+ DateOriginalProsth,
120
+ ClaimNote,
102
121
  ClinicNum,
122
+ DateTP,
123
+ SiteNum,
124
+ ProcTime,
125
+ ProcTimeEnd,
126
+ Prognosis,
127
+ ToothNum,
128
+ Surf,
129
+ ToothRange,
130
+ BillingNote,
131
+ Discount,
132
+ IsDateProsthEst,
103
133
  });
104
134
  }
105
135
  /**
106
- * Update an existing procedure log entry.
136
+ * 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.
137
+ * ProcedureLogs associated with adjustments, appointments, payments, payplancharges, or paysplits are updated exactly as in Open Dental.
107
138
  * @param {Object} data - The updated details of the procedure log.
108
139
  * @param {number} data.ProcNum - Required: The unique identifier of the procedure log to update.
109
- * @param {string} [data.ProcDate] - Optional: Updated procedure date in "yyyy-MM-dd" format.
110
- * @param {number} [data.AptNum] - Optional: Updated associated appointment number.
111
- * @param {number} [data.ProcFee] - Optional: Updated fee for the procedure.
112
- * @param {number} [data.Priority] - Optional: Updated priority code.
113
- * @param {'TP' | 'C' | 'EO'} [data.ProcStatus] - Optional: Updated procedure status.
114
- * @param {string} [data.procCode] - Optional: Updated procedure code (D code).
115
- * @param {Surf} [data.Surf] - Optional: Tooth surface or treatment area. Options include:
140
+ * @param {string} data.ProcDate - Required: Procedure date in "yyyy-MM-dd" format.
141
+ * @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).
142
+ * @param {number} [data.CodeNum] - This or procCode is Required. FK to procedurecode.CodeNum.
143
+ * @param {string} [data.procCode] - This or CodeNum is Required. This should be a valid D code, example: D0120. CodeNum is set automatically.
144
+ * @param {number} [data.AptNum] - Optional. FK to appointment.PatNum.
145
+ * @param {number} [data.ProcFee] - Optional. If none is given this will default to the procedurecodes default, with consideration of the patient's insurance.
146
+ * @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.
147
+ * @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.
148
+ * @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.
149
+ * @param {number} [data.PlannedAptNum] - Optional. Only set if this procedure is on a planned appointment, otherwise it will be 0.
150
+ * @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.
151
+ * @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".
152
+ * @param {string} [data.DateOriginalProsth] - Optional. String in "yyyy-MM-dd" format. Cannot be set if procedurecode.IsProsth is false. Default is "0001-01-01"
153
+ * @param {string} [data.ClaimNote] - Optional. Note that goes out on e-claims. Default empty string.
154
+ * @param {number} [data.ClinicNum] - Optional. Defaults to the patient's clinic.
155
+ * @param {string} [data.DateTP] - Optional. The date the procedure was originally treatment planned. String in "yyyy-MM-dd" format.
156
+ * @param {string} [data.SiteNum] - Optional. FK to site.SiteNum. Public Health feature must be enabled.
157
+ * @param {string} [data.ProcTime] - Optional. Time of day the procedure started. String in "HH:mm:ss" format.
158
+ * @param {string} [data.ProcTimeEnd] - Optional. Time of day the procedure ended. Medical Insurance feature must be enabled. String in "HH:mm:ss" format.
159
+ * @param {string} [data.Prognosis] - Optional. FK to definition.DefNum where definition.Category=30.
160
+ * @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).
116
161
  * - "B/F" (Buccal/Facial)
117
162
  * - "V" (Vestibular)
118
163
  * - "M" (Mesial)
@@ -131,33 +176,46 @@ class ProcedureLogs {
131
176
  * - "6" (Sextant 6)
132
177
  * - "U" (Upper Arch)
133
178
  * - "L" (Lower Arch)
134
- * @param {string} [data.ToothNum] - Optional: Updated tooth number.
135
- * @param {string} [data.ToothRange] - Optional: Updated tooth range.
136
- * @param {number} [data.ProvNum] - Optional: Updated provider number.
137
- * @param {string} [data.Dx] - Optional: Updated diagnosis code.
138
- * @param {number} [data.PlannedAptNum] - Optional: Updated planned appointment number.
139
- * @param {number} [data.ClinicNum] - Optional: Updated clinic number.
179
+ * @param {string} [data.ToothNum] - Required by procCodes with a Surf or Tooth treatment area.
180
+ * @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.
181
+ * @param {string} [data.BillingNote] - Optional. Note that shows in the Account Module. Default empty string.
182
+ * @param {number} [data.Discount] - Optional. The dollar amount of the discount. Default 0.0.
183
+ * @param {"true" | "false"} [data.IsDateProsthEst] - Optional. Either "true" or "false". Default "false".
140
184
  * @returns {Promise<ProcedureLog>} - The updated procedure log.
141
185
  * @throws {Error} - If required fields are missing or the API returns an error.
142
186
  */
143
- async updateProcedureLog({ ProcNum, ProcDate, AptNum, ProcFee, Priority, ProcStatus, procCode, Surf, ToothNum, ToothRange, ProvNum, Dx, PlannedAptNum, ClinicNum, }) {
187
+ async updateProcedureLog({ ProcNum, ProcDate, ProcStatus, CodeNum, procCode, AptNum, ProcFee, Priority, ProvNum, Dx, PlannedAptNum, PlaceService, Prosthesis, DateOriginalProsth, ClaimNote, ClinicNum, DateTP, SiteNum, ProcTime, ProcTimeEnd, Prognosis, ToothNum, Surf, ToothRange, BillingNote, Discount, IsDateProsthEst, }) {
144
188
  if (!ProcNum || typeof ProcNum !== "number") {
145
189
  throw new Error("Invalid parameter: ProcNum must be a valid number.");
146
190
  }
147
191
  return this.httpClient.put(`/procedurelogs/${ProcNum}`, {
192
+ ProcNum,
148
193
  ProcDate,
194
+ ProcStatus,
195
+ CodeNum,
196
+ procCode,
149
197
  AptNum,
150
198
  ProcFee,
151
199
  Priority,
152
- ProcStatus,
153
- procCode,
154
- Surf,
155
- ToothNum,
156
- ToothRange,
157
200
  ProvNum,
158
201
  Dx,
159
202
  PlannedAptNum,
203
+ PlaceService,
204
+ Prosthesis,
205
+ DateOriginalProsth,
206
+ ClaimNote,
160
207
  ClinicNum,
208
+ DateTP,
209
+ SiteNum,
210
+ ProcTime,
211
+ ProcTimeEnd,
212
+ Prognosis,
213
+ ToothNum,
214
+ Surf,
215
+ ToothRange,
216
+ BillingNote,
217
+ Discount,
218
+ IsDateProsthEst,
161
219
  });
162
220
  }
163
221
  /**
@@ -30,6 +30,7 @@ import Fees from "./api/fees";
30
30
  import Diseases from "./api/diseases";
31
31
  import Allergies from "./api/allergies";
32
32
  import MedicationPats from "./api/medicationPats";
33
+ import ProcTPs from "./api/procTPs";
33
34
  declare class OpenDental {
34
35
  private static httpClient;
35
36
  /**
@@ -164,6 +165,10 @@ declare class OpenDental {
164
165
  * Create a new instance of the MedicationPats API.
165
166
  */
166
167
  static MedicationPats(): MedicationPats;
168
+ /**
169
+ * Create a new instance of the ProcTPs API.
170
+ */
171
+ static ProcTPs(): ProcTPs;
167
172
  }
168
173
  export { OpenDental };
169
174
  //# sourceMappingURL=openDental.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"openDental.d.ts","sourceRoot":"","sources":["../src/openDental.ts"],"names":[],"mappings":"AACA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,qBAAqB,MAAM,yBAAyB,CAAC;AAC5D,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,gBAAgB,MAAM,wBAAwB,CAAC;AACtD,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAC1C,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,IAAI,MAAM,YAAY,CAAC;AAC9B,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAElD,cAAM,UAAU;IACd,OAAO,CAAC,MAAM,CAAC,UAAU,CAAa;IAEtC;;OAEG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAWlE;;OAEG;WACa,YAAY;IAQ5B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,YAAY;IAO1B;;SAEK;WACS,SAAS;IAOvB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,qBAAqB;IAOnC;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,gBAAgB;IAO9B;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,UAAU;IAOxB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,IAAI;IAOlB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,cAAc;CAO7B;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}
1
+ {"version":3,"file":"openDental.d.ts","sourceRoot":"","sources":["../src/openDental.ts"],"names":[],"mappings":"AACA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,qBAAqB,MAAM,yBAAyB,CAAC;AAC5D,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,gBAAgB,MAAM,wBAAwB,CAAC;AACtD,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAC1C,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,IAAI,MAAM,YAAY,CAAC;AAC9B,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,OAAO,MAAM,eAAe,CAAC;AAEpC,cAAM,UAAU;IACd,OAAO,CAAC,MAAM,CAAC,UAAU,CAAa;IAEtC;;OAEG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAWlE;;OAEG;WACa,YAAY;IAQ5B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,YAAY;IAO1B;;SAEK;WACS,SAAS;IAOvB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,qBAAqB;IAOnC;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,gBAAgB;IAO9B;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,UAAU;IAOxB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,IAAI;IAOlB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,OAAO;CAOtB;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}
@@ -37,6 +37,7 @@ const fees_1 = __importDefault(require("./api/fees"));
37
37
  const diseases_1 = __importDefault(require("./api/diseases"));
38
38
  const allergies_1 = __importDefault(require("./api/allergies"));
39
39
  const medicationPats_1 = __importDefault(require("./api/medicationPats"));
40
+ const procTPs_1 = __importDefault(require("./api/procTPs"));
40
41
  class OpenDental {
41
42
  static httpClient;
42
43
  /**
@@ -338,5 +339,14 @@ class OpenDental {
338
339
  }
339
340
  return new medicationPats_1.default(this.httpClient);
340
341
  }
342
+ /**
343
+ * Create a new instance of the ProcTPs API.
344
+ */
345
+ static ProcTPs() {
346
+ if (!this.httpClient) {
347
+ throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
348
+ }
349
+ return new procTPs_1.default(this.httpClient);
350
+ }
341
351
  }
342
352
  exports.OpenDental = OpenDental;
@@ -1,7 +1,41 @@
1
1
  /**
2
- * Represents an appointment in the Open Dental system.
3
- * Used in multiple appointment-related endpoints.
4
- * @see https://www.opendental.com/site/apiappointments.html
2
+ * 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.
3
+ * @see https://www.opendental.com/site/apichartmodules.html
4
+ */
5
+ export interface ProgNote {
6
+ ObjectType?: "Appointment" | "Commlog" | "Task" | "Email" | "LabCase" | "Rx" | "Sheet";
7
+ PrimaryKey?: number;
8
+ Date?: string;
9
+ Time?: string;
10
+ DateTime?: string;
11
+ Th?: string;
12
+ Surf?: string;
13
+ Dx?: string;
14
+ Description?: string;
15
+ Note?: string;
16
+ Stat?: string;
17
+ Prov?: string;
18
+ ProvNum?: string;
19
+ Amount?: string;
20
+ ProcCode?: string;
21
+ User?: string;
22
+ Signed?: string;
23
+ Length?: string;
24
+ Abbr?: string;
25
+ Clinic?: string;
26
+ ClinicNum?: string;
27
+ }
28
+ /**
29
+ * 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.
30
+ * @see https://www.opendental.com/site/apichartmodules.html
31
+ */
32
+ export interface PatientInfo {
33
+ Field?: string;
34
+ Content?: string;
35
+ }
36
+ /**
37
+ * Gets Planned Appointments for a patient, similarly to how it shows in the Chart Module's Planned Appointments tab.
38
+ * @see https://www.opendental.com/site/apichartmodules.html
5
39
  */
6
40
  export interface PlannedAppointment {
7
41
  AptNum?: number;
@@ -15,7 +49,7 @@ export interface PlannedAppointment {
15
49
  }
16
50
  /**
17
51
  * Appointment status options.
18
- * @see https://www.opendental.com/site/apiappointments.html
52
+ * @see https://www.opendental.com/site/apichartmodules.html
19
53
  */
20
54
  export type AptStatus = "Scheduled" | "Complete" | "UnschedList" | "ASAP" | "Broken" | "Planned" | "PtNote" | "PtNoteCompleted";
21
55
  //# sourceMappingURL=chartModuleTypes.d.ts.map
@@ -1 +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"}
1
+ {"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"}
@@ -0,0 +1,71 @@
1
+ /**
2
+ * ProcTPs are copies of procedures that are attached to Saved treatment plans.
3
+ * The ProcNumOrig points to the actual procedurelog row.
4
+ * For Active and Inactive treatment plans, use TreatPlanAttaches.
5
+ * See Treatment Plans for more information.
6
+ * @see https://www.opendental.com/site/apiproctps.html
7
+ */
8
+ export interface ProcTP {
9
+ ProcTPNum?: number;
10
+ TreatPlanNum?: number;
11
+ PatNum?: number;
12
+ ProcNumOrig?: number;
13
+ ItemOrder?: number;
14
+ Priority?: number;
15
+ priority?: string;
16
+ ToothNumTP?: string;
17
+ Surf?: Surf;
18
+ ProcCode?: string;
19
+ Descript?: string;
20
+ FeeAmt?: number;
21
+ PriInsAmt?: number;
22
+ SecInsAmt?: number;
23
+ PatAmt?: number;
24
+ Discount?: number;
25
+ Prognosis?: string;
26
+ Dx?: string;
27
+ ProcAbbr?: string;
28
+ SecUserNumEntry?: number;
29
+ SecDateEntry?: string;
30
+ FeeAllowed?: number;
31
+ TaxAmt?: number;
32
+ ProvNum?: number;
33
+ DateTP?: string;
34
+ ClinicNum?: number;
35
+ CatPercUCR?: number;
36
+ }
37
+ /**
38
+ * Parameters for GET Multiple ProcTPs.
39
+ * @see https://www.opendental.com/site/apiproctps.html
40
+ */
41
+ export interface GetProcTPsParams {
42
+ TreatPlanNum?: number;
43
+ Offset?: number;
44
+ }
45
+ /**
46
+ * Updates a ProcTp. Only ProcTPs associated with an unsigned treatment plan can be updated.
47
+ * @see https://www.opendental.com/site/apiproctps.html
48
+ */
49
+ export interface updateProcTPParams {
50
+ ProcTPNum: number;
51
+ Priority?: number;
52
+ ToothNumTP?: string;
53
+ Surf?: Surf;
54
+ ProcCode?: string;
55
+ Descript?: string;
56
+ FeeAmt?: number;
57
+ PriInsAmt?: number;
58
+ SecInsAmt?: number;
59
+ PatAmt?: number;
60
+ Discount?: number;
61
+ Prognosis?: string;
62
+ Dx?: string;
63
+ ProcAbbr?: string;
64
+ FeeAllowed?: number;
65
+ }
66
+ /**
67
+ * 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).
68
+ * @see https://www.opendental.com/site/apiproctps.html
69
+ */
70
+ export type Surf = "B/F" | "V" | "M" | "O/I" | "D" | "L" | "UL" | "UR" | "LR" | "LL" | "1" | "2" | "3" | "4" | "5" | "6" | "U" | "L";
71
+ //# sourceMappingURL=procTPTypes.d.ts.map
@@ -0,0 +1 @@
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"}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ //NEED TO COMPLETE FOR PUT/POST/DELETE GROUP NOTES AND INSURANCE HISTORY
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -19,16 +19,30 @@ export interface ProcedureLog {
19
19
  Dx?: string;
20
20
  dxName?: string;
21
21
  PlannedAptNum?: number;
22
- Prosthesis?: string;
22
+ PlaceService?: "Office" | "PatientsHome" | "InpatHospital" | "OutpatHospital" | "SkilledNursFac" | "CustodialCareFacility" | "OtherLocation" | "MobileUnit" | "School" | "MilitaryTreatFac" | "FederalHealthCenter" | "PublicHealthClinic" | "RuralHealthClinic" | "EmergencyRoomHospital" | "AmbulatorySurgicalCenter" | "TelehealthOutsideHome" | "TelehealthInHome" | "OutreachSiteOrStreet";
23
+ Prosthesis?: "" | "I" | "R";
23
24
  DateOriginalProsth?: string;
25
+ ClaimNote?: string;
26
+ DateEntryC?: string;
24
27
  ClinicNum?: number;
25
28
  CodeNum?: number;
26
29
  procCode?: string;
27
30
  descript?: string;
28
- ProcTime?: string;
29
31
  UnitQty?: number;
32
+ BaseUnits?: number;
33
+ DateTP?: string;
34
+ SiteNum?: number;
35
+ HideGraphics?: 'true' | 'false';
36
+ CanadianTypeCodes?: string;
37
+ ProcTime?: string;
38
+ ProcTimeEnd?: string;
30
39
  DateTStamp?: string;
40
+ Prognosis?: number;
41
+ IsLocked?: 'true' | 'false';
42
+ BillingNote?: string;
43
+ Discount?: number;
31
44
  IsDateProsthEst?: 'true' | 'false';
45
+ SecDateEntry?: string;
32
46
  serverDateTime?: string;
33
47
  }
34
48
  /**
@@ -38,52 +52,88 @@ export interface ProcedureLog {
38
52
  export interface GetProcedureLogParams {
39
53
  PatNum?: number;
40
54
  AptNum?: number;
55
+ ProcStatus?: 'TP' | 'C' | 'EC' | 'EO' | 'R' | 'D' | 'Cn' | 'TPi';
41
56
  PlannedAptNum?: number;
42
57
  ClinicNum?: number;
58
+ CodeNum?: number;
43
59
  DateTStamp?: string;
44
60
  Offset?: number;
45
61
  }
46
62
  /**
47
- * Create procedure log parameters.
63
+ * Creates a new procedure for a given patient. Attempts to set them will be silently ignored.
64
+ * Furthermore, the following pairs of fields may only have one of the two passed in at once: Priority and priority, Dx and dxName.
65
+ * Not all procedure codes support Surfs, ToothNums, and ToothRanges. Procedure code default notes will not be used.
48
66
  * @see https://www.opendental.com/site/apiprocedurelogs.html
49
67
  */
50
68
  export interface createProcedureLogParams {
51
69
  PatNum: number;
52
70
  ProcDate: string;
53
- ProcStatus: 'TP' | 'C' | 'EO';
54
- procCode: string;
71
+ ProcStatus: 'TP' | 'C' | 'EO' | 'EC' | 'R' | 'Cn';
72
+ CodeNum?: number;
73
+ procCode?: string;
55
74
  AptNum?: number;
56
75
  ProcFee?: number;
57
- Surf?: Surf;
58
- ToothNum?: string;
59
- ToothRange?: string;
60
76
  Priority?: number;
61
77
  priority?: string;
62
78
  ProvNum?: number;
63
79
  Dx?: string;
64
80
  dxName?: string;
65
81
  PlannedAptNum?: number;
82
+ PlaceService?: "Office" | "PatientsHome" | "InpatHospital" | "OutpatHospital" | "SkilledNursFac" | "CustodialCareFacility" | "OtherLocation" | "MobileUnit" | "School" | "MilitaryTreatFac" | "FederalHealthCenter" | "PublicHealthClinic" | "RuralHealthClinic" | "EmergencyRoomHospital" | "AmbulatorySurgicalCenter" | "TelehealthOutsideHome" | "TelehealthInHome" | "OutreachSiteOrStreet";
83
+ Prosthesis?: "" | "I" | "R";
84
+ DateOriginalProsth?: string;
85
+ ClaimNote?: string;
66
86
  ClinicNum?: number;
87
+ DateTP?: string;
88
+ SiteNum?: number;
89
+ ProcTime?: string;
90
+ ProcTimeEnd?: string;
91
+ Prognosis?: number;
92
+ ToothNum?: string;
93
+ Surf?: Surf;
94
+ ToothRange?: string;
95
+ BillingNote?: string;
96
+ Discount?: number;
97
+ IsDateProsthEst?: "true" | "false";
67
98
  }
68
99
  /**
69
- * Update procedure log parameters.
100
+ * Updates an existing procedure. When changing procCode, the treatment area of the current and passed in procedure codes must match.
101
+ * Attempting to pass in empty strings for ToothNum, Surf, and ToothRange will be silently ignored.
102
+ * The CodeNum, procCode, Discount, ToothNum, Surf, and ToothRange fields cannot be updated on procedures with a ProcStatus of C.
103
+ * If the procedurelog is associated with certain appointments, claims, or orthocases, then some fields cannot be updated.
104
+ * Procedure code default notes will not be used.
105
+ *
106
+ * ProcedureLogs associated with adjustments, appointments, payments, payplancharges, or paysplits are updated exactly as in Open Dental.
70
107
  * @see https://www.opendental.com/site/apiprocedurelogs.html
71
108
  */
72
109
  export interface updateProcedureLogParams {
73
110
  ProcNum: number;
74
111
  AptNum?: number;
75
- ProcDate?: string;
112
+ ProcDate: string;
76
113
  ProcFee?: number;
77
114
  Priority?: number;
78
- ProcStatus?: 'TP' | 'C' | 'EO';
115
+ ProcStatus: 'TP' | 'C' | 'EO' | 'EC' | 'R' | 'Cn';
79
116
  ProvNum?: number;
80
117
  Dx?: string;
81
118
  PlannedAptNum?: number;
119
+ PlaceService?: "Office" | "PatientsHome" | "InpatHospital" | "OutpatHospital" | "SkilledNursFac" | "CustodialCareFacility" | "OtherLocation" | "MobileUnit" | "School" | "MilitaryTreatFac" | "FederalHealthCenter" | "PublicHealthClinic" | "RuralHealthClinic" | "EmergencyRoomHospital" | "AmbulatorySurgicalCenter" | "TelehealthOutsideHome" | "TelehealthInHome" | "OutreachSiteOrStreet";
120
+ Prosthesis?: "" | "I" | "R";
121
+ DateOriginalProsth?: string;
122
+ ClaimNote?: string;
82
123
  ClinicNum?: number;
124
+ CodeNum?: number;
83
125
  procCode?: string;
126
+ DateTP?: string;
127
+ SiteNum?: number;
128
+ ProcTime?: string;
129
+ ProcTimeEnd?: string;
130
+ Prognosis?: number;
84
131
  ToothNum?: string;
85
132
  Surf?: Surf;
86
133
  ToothRange?: string;
134
+ BillingNote?: string;
135
+ Discount?: number;
136
+ IsDateProsthEst?: "true" | "false";
87
137
  }
88
138
  /**
89
139
  * Insurance History object in Open Dental.
@@ -114,7 +164,7 @@ export interface postInsuranceHistoryParams {
114
164
  }
115
165
  /**
116
166
  * 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).
117
- * @see https://www.opendental.com/site/apiappointments.html
167
+ * @see https://www.opendental.com/site/apiprocedurelogs.html
118
168
  */
119
169
  export type Surf = "B/F" | "V" | "M" | "O/I" | "D" | "L" | "UL" | "UR" | "LR" | "LL" | "1" | "2" | "3" | "4" | "5" | "6" | "U" | "L";
120
170
  //# sourceMappingURL=procedurelogTypes.d.ts.map
@@ -1 +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"}
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,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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rinse-dental/open-dental",
3
- "version": "2.1.4",
3
+ "version": "2.2.1",
4
4
  "description": "A TypeScript library for easily accessing Open Dental APIs.",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",