@rinse-dental/open-dental 1.3.0 → 1.4.0

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.
@@ -0,0 +1,19 @@
1
+ import HttpClient from "../utils/httpClient";
2
+ import { ClaimProc, GetClaimProcsParams } from "../types/claimProcTypes";
3
+ export default class ClaimProcs {
4
+ private httpClient;
5
+ constructor(httpClient: HttpClient);
6
+ /**
7
+ * Fetch multiple ClaimProcs with optional filtering and pagination.
8
+ * @param {Object} params - The parameters for filtering and pagination.
9
+ * @param {number} [params.ProcNum] - FK to procedurelog.ProcNum.
10
+ * @param {number} [params.ClaimNum] - FK to claim.ClaimNum.
11
+ * @param {number} [params.PatNum] - FK to patient.PatNum.
12
+ * @param {"NotReceived" | "Received" | "Preauth" | "Adjustment" | "Supplemental" | "CapClaim" | "Estimate" | "CapComplete" | "CapEstimate" | "InsHist"} [params.Status] - Either "NotReceived", "Received", "Preauth", "Adjustment", "Supplemental", "CapClaim", "Estimate",
13
+ * @param {number} [params.ClaimPaymentNum] - FK to claimpayment.ClaimPaymentNum.
14
+ * @param {number} [params.Offset] - Pagination offset for results.
15
+ * @returns {Promise<ClaimProc[]>} - A list of ClaimProcs.
16
+ */
17
+ getClaimProcs({ ProcNum, ClaimNum, PatNum, Status, ClaimPaymentNum, Offset, }?: GetClaimProcsParams): Promise<ClaimProc[]>;
18
+ }
19
+ //# sourceMappingURL=claimProcs.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"claimProcs.d.ts","sourceRoot":"","sources":["../../src/api/claimProcs.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,SAAS,EACT,mBAAmB,EACpB,MAAM,yBAAyB,CAAC;AAEjC,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;QAUI;IACS,aAAa,CAAC,EACzB,OAAO,EACP,QAAQ,EACR,MAAM,EACN,MAAM,EACN,eAAe,EACf,MAAM,GACP,GAAE,mBAAwB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;CAYnD"}
@@ -0,0 +1,31 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ class ClaimProcs {
4
+ httpClient;
5
+ constructor(httpClient) {
6
+ this.httpClient = httpClient;
7
+ }
8
+ /**
9
+ * Fetch multiple ClaimProcs with optional filtering and pagination.
10
+ * @param {Object} params - The parameters for filtering and pagination.
11
+ * @param {number} [params.ProcNum] - FK to procedurelog.ProcNum.
12
+ * @param {number} [params.ClaimNum] - FK to claim.ClaimNum.
13
+ * @param {number} [params.PatNum] - FK to patient.PatNum.
14
+ * @param {"NotReceived" | "Received" | "Preauth" | "Adjustment" | "Supplemental" | "CapClaim" | "Estimate" | "CapComplete" | "CapEstimate" | "InsHist"} [params.Status] - Either "NotReceived", "Received", "Preauth", "Adjustment", "Supplemental", "CapClaim", "Estimate",
15
+ * @param {number} [params.ClaimPaymentNum] - FK to claimpayment.ClaimPaymentNum.
16
+ * @param {number} [params.Offset] - Pagination offset for results.
17
+ * @returns {Promise<ClaimProc[]>} - A list of ClaimProcs.
18
+ */
19
+ async getClaimProcs({ ProcNum, ClaimNum, PatNum, Status, ClaimPaymentNum, Offset, } = {}) {
20
+ const params = {
21
+ ProcNum,
22
+ ClaimNum,
23
+ PatNum,
24
+ Status,
25
+ ClaimPaymentNum,
26
+ Offset,
27
+ };
28
+ return this.httpClient.get("/claimprocs", params);
29
+ }
30
+ }
31
+ exports.default = ClaimProcs;
@@ -20,6 +20,7 @@ import Referrals from "./api/referrals";
20
20
  import RefAttaches from "./api/refAttaches";
21
21
  import InsPlans from "./api/insPlans";
22
22
  import Benefits from "./api/benefits";
23
+ import ClaimProcs from "./api/claimProcs";
23
24
  declare class OpenDental {
24
25
  private static httpClient;
25
26
  /**
@@ -103,17 +104,21 @@ declare class OpenDental {
103
104
  */
104
105
  static Referrals(): Referrals;
105
106
  /**
106
- * Create a new instance of the LabCases API.
107
+ * Create a new instance of the RefAttaches API.
107
108
  */
108
109
  static RefAttaches(): RefAttaches;
109
110
  /**
110
- * Create a new instance of the LabCases API.
111
+ * Create a new instance of the InsPlans API.
111
112
  */
112
113
  static InsPlans(): InsPlans;
113
114
  /**
114
- * Create a new instance of the LabCases API.
115
+ * Create a new instance of the Benefits API.
115
116
  */
116
117
  static Benefits(): Benefits;
118
+ /**
119
+ * Create a new instance of the ClaimProcs API.
120
+ */
121
+ static ClaimProcs(): ClaimProcs;
117
122
  }
118
123
  export { OpenDental };
119
124
  //# 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,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,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;AAEtC,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;WACa,SAAS;IAOzB;;OAEG;WACa,SAAS;IAOzB;;OAEG;WACa,WAAW;IAO3B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,WAAW;IAOzB;;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;CAMvB;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,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,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;AAE1C,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;WACa,SAAS;IAOzB;;OAEG;WACa,SAAS;IAOzB;;OAEG;WACa,WAAW;IAO3B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,WAAW;IAOzB;;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;CAMzB;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}
@@ -27,6 +27,7 @@ const referrals_1 = __importDefault(require("./api/referrals"));
27
27
  const refAttaches_1 = __importDefault(require("./api/refAttaches"));
28
28
  const insPlans_1 = __importDefault(require("./api/insPlans"));
29
29
  const benefits_1 = __importDefault(require("./api/benefits"));
30
+ const claimProcs_1 = __importDefault(require("./api/claimProcs"));
30
31
  class OpenDental {
31
32
  static httpClient;
32
33
  /**
@@ -212,7 +213,7 @@ class OpenDental {
212
213
  return new referrals_1.default(this.httpClient);
213
214
  }
214
215
  /**
215
- * Create a new instance of the LabCases API.
216
+ * Create a new instance of the RefAttaches API.
216
217
  */
217
218
  static RefAttaches() {
218
219
  if (!this.httpClient) {
@@ -221,7 +222,7 @@ class OpenDental {
221
222
  return new refAttaches_1.default(this.httpClient);
222
223
  }
223
224
  /**
224
- * Create a new instance of the LabCases API.
225
+ * Create a new instance of the InsPlans API.
225
226
  */
226
227
  static InsPlans() {
227
228
  if (!this.httpClient) {
@@ -230,7 +231,7 @@ class OpenDental {
230
231
  return new insPlans_1.default(this.httpClient);
231
232
  }
232
233
  /**
233
- * Create a new instance of the LabCases API.
234
+ * Create a new instance of the Benefits API.
234
235
  */
235
236
  static Benefits() {
236
237
  if (!this.httpClient) {
@@ -238,5 +239,14 @@ class OpenDental {
238
239
  }
239
240
  return new benefits_1.default(this.httpClient);
240
241
  }
242
+ /**
243
+ * Create a new instance of the ClaimProcs API.
244
+ */
245
+ static ClaimProcs() {
246
+ if (!this.httpClient) {
247
+ throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
248
+ }
249
+ return new claimProcs_1.default(this.httpClient);
250
+ }
241
251
  }
242
252
  exports.OpenDental = OpenDental;
@@ -0,0 +1,66 @@
1
+ /**
2
+ * Represents a ClaimProc in the Open Dental system.
3
+ * @see https://www.opendental.com/site/apiclaimprocs.html
4
+ */
5
+ export interface ClaimProc {
6
+ ClaimProcNum?: number;
7
+ ProcNum?: number;
8
+ ClaimNum?: number;
9
+ PatNum?: number;
10
+ ProvNum?: number;
11
+ FeeBilled?: number;
12
+ InsPayEst?: number;
13
+ DedApplied?: number;
14
+ Status?: "NotReceived" | "Received" | "Preauth" | "Adjustment" | "Supplemental" | "CapClaim" | "Estimate" | "CapComplete" | "CapEstimate" | "InsHist";
15
+ InsPayAmt?: number;
16
+ Remarks?: string;
17
+ ClaimPaymentNum?: number;
18
+ PlanNum?: number;
19
+ DateCP?: string;
20
+ WriteOff?: number;
21
+ CodeSent?: string;
22
+ AllowedOverride?: number;
23
+ Percentage?: number;
24
+ PercentOverride?: number;
25
+ CopayAmt?: number;
26
+ NoBillIns?: true | false;
27
+ PaidOtherIns?: number;
28
+ BaseEst?: number;
29
+ CopayOverride?: number;
30
+ ProcDate?: string;
31
+ DateEntry?: string;
32
+ DedEst?: number;
33
+ DedEstOverride?: number;
34
+ InsEstTotal?: number;
35
+ InsEstTotalOverride?: number;
36
+ PaidOtherInsOverride?: number;
37
+ EstimateNote?: string;
38
+ WriteOffEst?: number;
39
+ WriteOffEstOverride?: number;
40
+ ClinicNum?: number;
41
+ InsSubNum?: number;
42
+ PaymentRow?: number;
43
+ PayPlanNum?: number;
44
+ ClaimPaymentTracking?: number;
45
+ claimPaymentTracking?: string;
46
+ SecUserNumEntry?: number;
47
+ SecDateEntry?: string;
48
+ SecDateTEdit?: string;
49
+ DateSuppReceived?: string;
50
+ DateInsFinalized?: string;
51
+ IsTransfer?: "true" | "false";
52
+ ClaimAdjReasonCodes?: string;
53
+ }
54
+ /**
55
+ * Gets all ClaimProcs based on provided parameters. If no parameter is given, it will get all ClaimProcs ordered by ClaimProcNum.
56
+ * @see https://www.opendental.com/site/apiclaimprocs.html
57
+ */
58
+ export interface GetClaimProcsParams {
59
+ ProcNum?: number;
60
+ ClaimNum?: number;
61
+ PatNum?: number;
62
+ Status?: "NotReceived" | "Received" | "Preauth" | "Adjustment" | "Supplemental" | "CapClaim" | "Estimate" | "CapComplete" | "CapEstimate" | "InsHist";
63
+ ClaimPaymentNum?: number;
64
+ Offset?: number;
65
+ }
66
+ //# sourceMappingURL=claimProcTypes.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"claimProcTypes.d.ts","sourceRoot":"","sources":["../../src/types/claimProcTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,SAAS;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,aAAa,GAAG,UAAU,GAAG,SAAS,GAAG,YAAY,GAAG,cAAc,GAAG,UAAU,GAAG,UAAU,GAAG,aAAa,GAAG,aAAa,GAAG,SAAS,CAAC;IACtJ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,IAAI,GAAG,KAAK,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9B,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,aAAa,GAAG,UAAU,GAAG,SAAS,GAAG,YAAY,GAAG,cAAc,GAAG,UAAU,GAAG,UAAU,GAAG,aAAa,GAAG,aAAa,GAAG,SAAS,CAAC;IACtJ,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rinse-dental/open-dental",
3
- "version": "1.3.0",
3
+ "version": "1.4.0",
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",
@@ -0,0 +1,44 @@
1
+ import HttpClient from "../utils/httpClient";
2
+ import {
3
+ ClaimProc,
4
+ GetClaimProcsParams,
5
+ } from "../types/claimProcTypes";
6
+
7
+ export default class ClaimProcs {
8
+ private httpClient: HttpClient;
9
+
10
+ constructor(httpClient: HttpClient) {
11
+ this.httpClient = httpClient;
12
+ }
13
+
14
+ /**
15
+ * Fetch multiple ClaimProcs with optional filtering and pagination.
16
+ * @param {Object} params - The parameters for filtering and pagination.
17
+ * @param {number} [params.ProcNum] - FK to procedurelog.ProcNum.
18
+ * @param {number} [params.ClaimNum] - FK to claim.ClaimNum.
19
+ * @param {number} [params.PatNum] - FK to patient.PatNum.
20
+ * @param {"NotReceived" | "Received" | "Preauth" | "Adjustment" | "Supplemental" | "CapClaim" | "Estimate" | "CapComplete" | "CapEstimate" | "InsHist"} [params.Status] - Either "NotReceived", "Received", "Preauth", "Adjustment", "Supplemental", "CapClaim", "Estimate",
21
+ * @param {number} [params.ClaimPaymentNum] - FK to claimpayment.ClaimPaymentNum.
22
+ * @param {number} [params.Offset] - Pagination offset for results.
23
+ * @returns {Promise<ClaimProc[]>} - A list of ClaimProcs.
24
+ */
25
+ public async getClaimProcs({
26
+ ProcNum,
27
+ ClaimNum,
28
+ PatNum,
29
+ Status,
30
+ ClaimPaymentNum,
31
+ Offset,
32
+ }: GetClaimProcsParams = {}): Promise<ClaimProc[]> {
33
+ const params = {
34
+ ProcNum,
35
+ ClaimNum,
36
+ PatNum,
37
+ Status,
38
+ ClaimPaymentNum,
39
+ Offset,
40
+ };
41
+
42
+ return this.httpClient.get<ClaimProc[]>("/claimprocs", params);
43
+ }
44
+ }
package/src/openDental.ts CHANGED
@@ -21,6 +21,7 @@ import Referrals from "./api/referrals";
21
21
  import RefAttaches from "./api/refAttaches";
22
22
  import InsPlans from "./api/insPlans";
23
23
  import Benefits from "./api/benefits";
24
+ import ClaimProcs from "./api/claimProcs";
24
25
 
25
26
  class OpenDental {
26
27
  private static httpClient: HttpClient;
@@ -231,7 +232,7 @@ class OpenDental {
231
232
  }
232
233
 
233
234
  /**
234
- * Create a new instance of the LabCases API.
235
+ * Create a new instance of the RefAttaches API.
235
236
  */
236
237
  public static RefAttaches() {
237
238
  if (!this.httpClient) {
@@ -241,7 +242,7 @@ class OpenDental {
241
242
  }
242
243
 
243
244
  /**
244
- * Create a new instance of the LabCases API.
245
+ * Create a new instance of the InsPlans API.
245
246
  */
246
247
  public static InsPlans() {
247
248
  if (!this.httpClient) {
@@ -251,7 +252,7 @@ class OpenDental {
251
252
  }
252
253
 
253
254
  /**
254
- * Create a new instance of the LabCases API.
255
+ * Create a new instance of the Benefits API.
255
256
  */
256
257
  public static Benefits() {
257
258
  if (!this.httpClient) {
@@ -259,6 +260,16 @@ class OpenDental {
259
260
  }
260
261
  return new Benefits(this.httpClient);
261
262
  }
263
+
264
+ /**
265
+ * Create a new instance of the ClaimProcs API.
266
+ */
267
+ public static ClaimProcs() {
268
+ if (!this.httpClient) {
269
+ throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
270
+ }
271
+ return new ClaimProcs(this.httpClient);
272
+ }
262
273
  }
263
274
 
264
275
  export { OpenDental };
@@ -0,0 +1,68 @@
1
+ /**
2
+ * Represents a ClaimProc in the Open Dental system.
3
+ * @see https://www.opendental.com/site/apiclaimprocs.html
4
+ */
5
+ export interface ClaimProc {
6
+ ClaimProcNum?: number; // Primary Key.
7
+ ProcNum?: number; // FK to procedurelog.ProcNum.
8
+ ClaimNum?: number; // FK to claim.ClaimNum.
9
+ PatNum?: number; // FK to patient.PatNum.
10
+ ProvNum?: number; // ProvNum of a provider. Follows the ProcProvChangesClaimProcWithClaim preference. See Claimproc Provider for more information.,
11
+ FeeBilled?: number; // The amount billed to insurance.
12
+ InsPayEst?: number; // The estimated amount that insurance will pay.
13
+ DedApplied?: number; // Deductible applied to this procedure only. DedApplied will always match the DedEstOverride value when ClaimProc status is NotReceived or Preauth.
14
+ Status?: "NotReceived" | "Received" | "Preauth" | "Adjustment" | "Supplemental" | "CapClaim" | "Estimate" | "CapComplete" | "CapEstimate" | "InsHist"; // Either "NotReceived", "Received", "Preauth", "Adjustment", "Supplemental", "CapClaim", "Estimate", "CapComplete", "CapEstimate", or "InsHist".
15
+ InsPayAmt?: number; // Amount insurance actually paid. Cannot be updated once the procedure is attached to a check.
16
+ Remarks?: string; // The remarks that insurance sends in the EOB about procedures. Overwrites any existing Remarks.
17
+ ClaimPaymentNum?: number; // ClaimPaymentNum of a partial claimpayment. Attaches this ClaimProc, alongside any other able ClaimProcs on the same Claim, to the specified ClaimPayment. Can supply 0 to detach this ClaimProc, and all other ClaimProcs from the same claim that are on the same ClaimPayment. See Finalize Insurance Payment and Batch Insurance Payment for more information.
18
+ PlanNum?: number; // FK to insplan.plannum.
19
+ DateCP?: string; // 2021-02-16,
20
+ WriteOff?: number; // Amount not covered by insurance which is written off.
21
+ CodeSent?: string; // The procedure code that was sent to insurance. Usually it is the same as the actual procedure code, but may be different if using alternate codes (for example: Medicaid), medical codes, or custom codes with suffixes that get removed before being sent. See also Incorrect Procedures on Claim. Use ProcedureCodes GET to get a list of valid codes.
22
+ AllowedOverride?: number; //
23
+ Percentage?: number; // The percentage that insurance is expected to cover.
24
+ PercentOverride?: number; // The percentage that insurance is expected to cover. A number between 0 and 100. Use -1 to indicate no override.
25
+ CopayAmt?: number; // Based on the insurance plan's copay fee schedule, and subtracted from the amount that insurance will pay.
26
+ NoBillIns?: true | false; // false,
27
+ PaidOtherIns?: number; // 0.0,
28
+ BaseEst?: number; // 88.0,
29
+ CopayOverride?: number; // Based on the insurance plan's copay fee schedule, and subtracted from the amount that insurance will pay. Use -1 to indicate no override.
30
+ ProcDate?: string; // String in "yyyy-MM-dd" format.
31
+ DateEntry?: string; // String in "yyyy-MM-dd" format.
32
+ DedEst?: number; // The amount that the patient must pay each year before insurance kicks in, and always subtracted before Percentage is calculated.
33
+ DedEstOverride?: number; // The amount that the patient must pay each year before insurance kicks in, and always subtracted before Percentage is calculated. Use -1 to indicate no override.
34
+ InsEstTotal?: number; // 88.0,
35
+ InsEstTotalOverride?: number; // The estimated amount that insurance will pay. If the claimproc is already attached to a claim, this will not affect the patient balance. Use -1 to indicate no override.
36
+ PaidOtherInsOverride?: number; // Adds up all amounts paid by insurance plans that are lower in order. Use -1 to indicate no override.
37
+ EstimateNote?: string; //
38
+ WriteOffEst?: number; // WriteOff amount usually only used for PPOs.
39
+ WriteOffEstOverride?: number; // WriteOff amount usually only used for PPOs. Use -1 to indicate no override.
40
+ ClinicNum?: number; // FK to clinics
41
+ InsSubNum?: number; // FK to inssub.inssubnum
42
+ PaymentRow?: number; //
43
+ PayPlanNum?: number; // FK to pay plans
44
+ ClaimPaymentTracking?: number; // Used to document information about the payment of the procedure. Useful to track why payment was rejected. See also Definitions: Claim Payment Tracking. Definition.DefNum where definition.Category=36.
45
+ claimPaymentTracking?: string; // Used to document information about the payment of the procedure. Useful to track why payment was rejected. See also Definitions: Claim Payment Tracking. Definition.DefNum where definition.Category=36.
46
+ SecUserNumEntry?: number; //
47
+ SecDateEntry?: string; // String in "yyyy-MM-dd" format.
48
+ SecDateTEdit?: string; // String in "yyyy-MM-dd HH:mm:ss" format.
49
+ DateSuppReceived?: string; // String in "yyyy-MM-dd" format.
50
+ DateInsFinalized?: string; // String in "yyyy-MM-dd" format.
51
+ IsTransfer?: "true" | "false"; // false,
52
+ ClaimAdjReasonCodes?: string; //
53
+ }
54
+
55
+ /**
56
+ * Gets all ClaimProcs based on provided parameters. If no parameter is given, it will get all ClaimProcs ordered by ClaimProcNum.
57
+ * @see https://www.opendental.com/site/apiclaimprocs.html
58
+ */
59
+ export interface GetClaimProcsParams {
60
+ ProcNum?: number; // Optional. FK to procedurelog.ProcNum.
61
+ ClaimNum?: number; // Optional. FK to claim.ClaimNum.
62
+ PatNum?: number; // Optional. FK to patient.PatNum.
63
+ Status?: "NotReceived" | "Received" | "Preauth" | "Adjustment" | "Supplemental" | "CapClaim" | "Estimate" | "CapComplete" | "CapEstimate" | "InsHist"; // Either "NotReceived", "Received", "Preauth", "Adjustment", "Supplemental", "CapClaim", "Estimate", "CapComplete", "CapEstimate", or "InsHist".
64
+ ClaimPaymentNum?: number; // Optional. FK to claimpayment.ClaimPaymentNum.
65
+ Offset?: number; // Pagination offset for results
66
+ }
67
+
68
+
@@ -13,7 +13,7 @@ export interface InsSub {
13
13
  ReleaseInfo?: "true" | "false"; //
14
14
  AssignBen?: "true" | "false"; //
15
15
  SubscNote?: string; //
16
- SecDateTEdit?: string; //String in "yyyy-MM-dd HH:mm:ss" format
16
+ SecDateTEdit?: string; // String in "yyyy-MM-dd HH:mm:ss" format
17
17
  }
18
18
 
19
19
  /**