@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20230208.2 → 1.20230403.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.
Files changed (58) hide show
  1. package/.openapi-generator/FILES +19 -0
  2. package/api/adv-group-api.ts +17 -17
  3. package/api/chat-gptapi.ts +154 -0
  4. package/api/events-api.ts +87 -0
  5. package/api/groups-api.ts +17 -17
  6. package/api/prem-rate-types-api.ts +668 -0
  7. package/api/premium-invoice-payments-api.ts +124 -0
  8. package/api/premium-invoices-api.ts +336 -5
  9. package/api/premium-rate-distribution-types-api.ts +155 -0
  10. package/api/state-interest-api.ts +668 -0
  11. package/api/subscriber-plan-policies-api.ts +43 -91
  12. package/api/user-api.ts +394 -0
  13. package/api.ts +4 -0
  14. package/models/chat-message.ts +30 -0
  15. package/models/claim-batch-detail.ts +152 -140
  16. package/models/claim-batch.ts +1697 -479
  17. package/models/claim-detail.ts +137 -125
  18. package/models/claim-pre-batch-detail.ts +101 -95
  19. package/models/claim-pre-batch.ts +1703 -425
  20. package/models/claim.ts +1562 -338
  21. package/models/company-data.ts +433 -403
  22. package/models/cost-contain-zelis-ex-code.ts +12 -6
  23. package/models/enrollment-disenroll-group.ts +84 -0
  24. package/models/enrollment-disenroll.ts +28 -34
  25. package/models/groups.ts +18 -18
  26. package/models/idcard-request.ts +3 -3
  27. package/models/index.ts +15 -0
  28. package/models/mem-enrollment-plan.ts +9 -9
  29. package/models/mem-enrollment-rider.ts +10 -10
  30. package/models/member-beneficiary.ts +3 -3
  31. package/models/member-language.ts +38 -2
  32. package/models/member-medicare-resp.ts +50 -26
  33. package/models/members.ts +1 -1
  34. package/models/network-procedure-cluster.ts +15 -9
  35. package/models/plan-benefit-cluster.ts +12 -12
  36. package/models/plan-benefit-rate.ts +5 -5
  37. package/models/plan-benefits.ts +58 -52
  38. package/models/plan-type.ts +21 -21
  39. package/models/plans.ts +41 -41
  40. package/models/prem-invoice-group-summary-vbaresponse.ts +45 -0
  41. package/models/prem-invoice-group-summary.ts +114 -0
  42. package/models/prem-invoice-payment-ext-list-vbaresponse.ts +45 -0
  43. package/models/prem-invoice-payment-ext.ts +102 -0
  44. package/models/prem-invoice-slim-list-vbaresponse.ts +45 -0
  45. package/models/prem-invoice-slim.ts +42 -0
  46. package/models/prem-rate-type-list-vbaresponse.ts +45 -0
  47. package/models/prem-rate-type-vbaresponse.ts +45 -0
  48. package/models/prem-rate-type.ts +72 -0
  49. package/models/prem-rate.ts +91 -85
  50. package/models/state-interest-list-vbaresponse.ts +45 -0
  51. package/models/state-interest-vbaresponse.ts +45 -0
  52. package/models/state-interest.ts +84 -0
  53. package/models/sub-enrollment-plan.ts +10 -10
  54. package/models/sub-enrollment-rider.ts +14 -14
  55. package/models/subscribers.ts +2 -2
  56. package/models/user-reset-password-request.ts +42 -0
  57. package/models/users.ts +8 -8
  58. package/package.json +1 -1
@@ -21,751 +21,763 @@
21
21
  */
22
22
  export interface ClaimDetail {
23
23
  /**
24
- *
24
+ * References the Claim.Claim_Number value on the parent record. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
25
25
  * @type {number}
26
26
  * @memberof ClaimDetail
27
27
  */
28
28
  'claim_Number': number;
29
29
  /**
30
- *
30
+ * In combination with Adjustment_Seq, creates a unique sequence for each service line on this claim.
31
31
  * @type {string}
32
32
  * @memberof ClaimDetail
33
33
  */
34
34
  'claim_Seq': string;
35
35
  /**
36
- *
36
+ * In combination with Claim_Seq, creates a unique sequence for each service line on this claim. Used to note adjustments, cascading, etc. when utlized.
37
37
  * @type {string}
38
38
  * @memberof ClaimDetail
39
39
  */
40
40
  'adjustment_Seq': string;
41
41
  /**
42
- *
42
+ * No longer in use.
43
43
  * @type {string}
44
44
  * @memberof ClaimDetail
45
45
  */
46
46
  'ansI_Code'?: string | null;
47
47
  /**
48
- *
48
+ * The APC code applied to this service if identified for calculation during adjudication.
49
49
  * @type {string}
50
50
  * @memberof ClaimDetail
51
51
  */
52
52
  'apC_Code'?: string | null;
53
53
  /**
54
- *
54
+ * For reference purposes, this hold the individual service line funding payor/account. If multiple payor/accounts are found on different service lines for the same claim, adjudication spits out an error.
55
55
  * @type {number}
56
56
  * @memberof ClaimDetail
57
57
  */
58
58
  'account_Key'?: number | null;
59
59
  /**
60
- *
60
+ * Notes if this line was adjusted as part of an individual claim adjustment process. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
61
61
  * @type {boolean}
62
62
  * @memberof ClaimDetail
63
63
  */
64
64
  'adjusted_Line': boolean;
65
65
  /**
66
- *
66
+ * No longer in use. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
67
67
  * @type {number}
68
68
  * @memberof ClaimDetail
69
69
  */
70
70
  'admin_Amt': number;
71
71
  /**
72
- *
72
+ * The Auth Number for services that require authorization. References Auth.Auth_Number.
73
73
  * @type {string}
74
74
  * @memberof ClaimDetail
75
75
  */
76
76
  'auth_Number'?: string | null;
77
77
  /**
78
- *
78
+ * If an Auth Penalty is applied during adjudication, that is housed here.
79
79
  * @type {number}
80
80
  * @memberof ClaimDetail
81
81
  */
82
82
  'auth_Penalty'?: number | null;
83
83
  /**
84
- *
84
+ * Notes that this service lines required authorization.
85
85
  * @type {string}
86
86
  * @memberof ClaimDetail
87
87
  */
88
88
  'auth_Required'?: string | null;
89
89
  /**
90
- *
90
+ * This is the benefit code assigned to this service line based on the Plan assigned on the Claim header. References BenefitCodes.Benefit_Code.
91
91
  * @type {string}
92
92
  * @memberof ClaimDetail
93
93
  */
94
94
  'benefit_Code'?: string | null;
95
95
  /**
96
- *
96
+ * Benefit Rate being applied to this detail line.
97
+ * @type {number}
98
+ * @memberof ClaimDetail
99
+ */
100
+ 'benefit_Rate_Applied'?: number | null;
101
+ /**
102
+ * The billed charges assigned by the provider for this service. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
97
103
  * @type {number}
98
104
  * @memberof ClaimDetail
99
105
  */
100
106
  'billed_Price': number;
101
107
  /**
102
- *
108
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
103
109
  * @type {string}
104
110
  * @memberof ClaimDetail
105
111
  */
106
112
  'brand_Indicator'?: string | null;
107
113
  /**
108
- *
114
+ * For dental claims, notes if this surface had services rendered. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
109
115
  * @type {boolean}
110
116
  * @memberof ClaimDetail
111
117
  */
112
118
  'buccal': boolean;
113
119
  /**
114
- *
120
+ * No longer in use.
115
121
  * @type {string}
116
122
  * @memberof ClaimDetail
117
123
  */
118
124
  'cliA_Number'?: string | null;
119
125
  /**
120
- *
126
+ * Holds the Other Insurance calculated amount that would affect the payable amount for this service (calculated from COB_Hold, COB_Mem_Resp, COB_Savings, and COB_Savings_Used). Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
121
127
  * @type {number}
122
128
  * @memberof ClaimDetail
123
129
  */
124
130
  'coB_Amt': number;
125
131
  /**
126
- *
132
+ * Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied.
127
133
  * @type {number}
128
134
  * @memberof ClaimDetail
129
135
  */
130
136
  'coB_Hold'?: number | null;
131
137
  /**
132
- *
138
+ * Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied.
133
139
  * @type {number}
134
140
  * @memberof ClaimDetail
135
141
  */
136
142
  'coB_Mem_Resp'?: number | null;
137
143
  /**
138
- *
144
+ * Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied.
139
145
  * @type {number}
140
146
  * @memberof ClaimDetail
141
147
  */
142
148
  'coB_Savings'?: number | null;
143
149
  /**
144
- *
150
+ * Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied.
145
151
  * @type {number}
146
152
  * @memberof ClaimDetail
147
153
  */
148
154
  'coB_Savings_Used'?: number | null;
149
155
  /**
150
- *
156
+ * Used for Flex Claims to indicate the calendar year this claim applies.
151
157
  * @type {string}
152
158
  * @memberof ClaimDetail
153
159
  */
154
160
  'calendar_Year'?: string | null;
155
161
  /**
156
- *
162
+ * Notes if this service line is captiated. If the Claim.Capitation_Claim value is flagged, it overrides this value and notes the entire claim and all service lines as capitated. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
157
163
  * @type {boolean}
158
164
  * @memberof ClaimDetail
159
165
  */
160
166
  'capitation_Claim': boolean;
161
167
  /**
162
- *
168
+ * No longer in use.
163
169
  * @type {number}
164
170
  * @memberof ClaimDetail
165
171
  */
166
172
  'check_ID'?: number | null;
167
173
  /**
168
- *
174
+ * The co-insurance amount applied by adjudication based on benefit definition. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
169
175
  * @type {number}
170
176
  * @memberof ClaimDetail
171
177
  */
172
178
  'co_Ins_Amt': number;
173
179
  /**
174
- *
180
+ * The co-pay amount applied by adjudication based on benefit definition. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
175
181
  * @type {number}
176
182
  * @memberof ClaimDetail
177
183
  */
178
184
  'co_Pay_Amt': number;
179
185
  /**
180
- *
186
+ * For currency calculations, this holds the destination currency.
181
187
  * @type {string}
182
188
  * @memberof ClaimDetail
183
189
  */
184
190
  'currency_ID'?: string | null;
185
191
  /**
186
- *
192
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
187
193
  * @type {number}
188
194
  * @memberof ClaimDetail
189
195
  */
190
196
  'days_Supply'?: number | null;
191
197
  /**
192
- *
198
+ * If the service is eligiblity for deductible credits, they would be stored here.
193
199
  * @type {number}
194
200
  * @memberof ClaimDetail
195
201
  */
196
202
  'ded_Credit_Amt'?: number | null;
197
203
  /**
198
- *
204
+ * The deductible amount applied by adjudication based on benefit definition. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
199
205
  * @type {number}
200
206
  * @memberof ClaimDetail
201
207
  */
202
208
  'deductible_Amt': number;
203
209
  /**
204
- *
210
+ * The diagnosis pointer for this service line indicating which Diagnostic Codes from the Claim are applicable to this service.
205
211
  * @type {string}
206
212
  * @memberof ClaimDetail
207
213
  */
208
214
  'diagnosis_Code'?: string | null;
209
215
  /**
210
- *
216
+ * The difference between Billed and Allowed is stored as the Discount Amount. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
211
217
  * @type {number}
212
218
  * @memberof ClaimDetail
213
219
  */
214
220
  'discount_Amt': number;
215
221
  /**
216
- *
222
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
217
223
  * @type {number}
218
224
  * @memberof ClaimDetail
219
225
  */
220
226
  'dispense_As_Written'?: number | null;
221
227
  /**
222
- *
228
+ * For dental claims, notes if this surface had services rendered. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
223
229
  * @type {boolean}
224
230
  * @memberof ClaimDetail
225
231
  */
226
232
  'distal': boolean;
227
233
  /**
228
- *
234
+ * For RX claims or medical claims that hold a drug code. References DrugCode.Drug_Code.
229
235
  * @type {string}
230
236
  * @memberof ClaimDetail
231
237
  */
232
238
  'drug_Code'?: string | null;
233
239
  /**
234
- *
240
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
235
241
  * @type {number}
236
242
  * @memberof ClaimDetail
237
243
  */
238
244
  'drug_Quantity'?: number | null;
239
245
  /**
240
- *
246
+ * Date when the record was first added to the system.
241
247
  * @type {string}
242
248
  * @memberof ClaimDetail
243
249
  */
244
250
  'entry_Date'?: string;
245
251
  /**
246
- *
252
+ * User that first added the record to the system.
247
253
  * @type {string}
248
254
  * @memberof ClaimDetail
249
255
  */
250
256
  'entry_User'?: string | null;
251
257
  /**
252
- *
258
+ * A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code.
253
259
  * @type {string}
254
260
  * @memberof ClaimDetail
255
261
  */
256
262
  'ex_Code'?: string | null;
257
263
  /**
258
- *
264
+ * A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code.
259
265
  * @type {string}
260
266
  * @memberof ClaimDetail
261
267
  */
262
268
  'ex_Code2'?: string | null;
263
269
  /**
264
- *
270
+ * A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code.
265
271
  * @type {string}
266
272
  * @memberof ClaimDetail
267
273
  */
268
274
  'ex_Code3'?: string | null;
269
275
  /**
270
- *
276
+ * The FICA tax amount for disability claims. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
271
277
  * @type {number}
272
278
  * @memberof ClaimDetail
273
279
  */
274
280
  'fica': number;
275
281
  /**
276
- *
282
+ * For dental claims, notes if this surface had services rendered. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
277
283
  * @type {boolean}
278
284
  * @memberof ClaimDetail
279
285
  */
280
286
  'facial': boolean;
281
287
  /**
282
- *
288
+ * Based on taxable amount and various configurations, this holds the Federal \"To Tax\" amount for disability claim.
283
289
  * @type {number}
284
290
  * @memberof ClaimDetail
285
291
  */
286
292
  'federal_Amount_To_Tax'?: number | null;
287
293
  /**
288
- *
294
+ * The calculated Federal tax amount based on the \"To Tax\" amount. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
289
295
  * @type {number}
290
296
  * @memberof ClaimDetail
291
297
  */
292
298
  'federal_Tax': number;
293
299
  /**
294
- *
300
+ * A flat federal tax amount applied in addition to the calculated tax amount.
295
301
  * @type {number}
296
302
  * @memberof ClaimDetail
297
303
  */
298
304
  'federal_Tax_Flat'?: number | null;
299
305
  /**
300
- *
306
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
301
307
  * @type {string}
302
308
  * @memberof ClaimDetail
303
309
  */
304
310
  'fill_Date'?: string | null;
305
311
  /**
306
- *
312
+ * Manually entered description of this flex claim.
307
313
  * @type {string}
308
314
  * @memberof ClaimDetail
309
315
  */
310
316
  'flex_Description'?: string | null;
311
317
  /**
312
- *
318
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
313
319
  * @type {string}
314
320
  * @memberof ClaimDetail
315
321
  */
316
322
  'formulary_Indicator'?: string | null;
317
323
  /**
318
- *
324
+ * For dental claims, notes if this surface had services rendered. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
319
325
  * @type {boolean}
320
326
  * @memberof ClaimDetail
321
327
  */
322
328
  'incisal': boolean;
323
329
  /**
324
- *
330
+ * If interest is calculated on a claim, it is stored here and applied to payable amount. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
325
331
  * @type {number}
326
332
  * @memberof ClaimDetail
327
333
  */
328
334
  'interest': number;
329
335
  /**
330
- *
336
+ * For dental claims, notes if this surface had services rendered. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
331
337
  * @type {boolean}
332
338
  * @memberof ClaimDetail
333
339
  */
334
340
  'labial': boolean;
335
341
  /**
336
- *
342
+ * The Life Benefit to be applied for Life claims processing.
337
343
  * @type {string}
338
344
  * @memberof ClaimDetail
339
345
  */
340
346
  'life_Benefit'?: string | null;
341
347
  /**
342
- *
348
+ * The Life Benefit calculated volume based on benefit definition.
343
349
  * @type {number}
344
350
  * @memberof ClaimDetail
345
351
  */
346
352
  'life_Benefit_Volume'?: number | null;
347
353
  /**
348
- *
354
+ * Number added manually to claims and from 837 files and sent outbound on 835 files.
349
355
  * @type {string}
350
356
  * @memberof ClaimDetail
351
357
  */
352
358
  'line_Control_Number'?: string | null;
353
359
  /**
354
- *
360
+ * For dental claims, notes if this surface had services rendered. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
355
361
  * @type {boolean}
356
362
  * @memberof ClaimDetail
357
363
  */
358
364
  'lingual': boolean;
359
365
  /**
360
- *
366
+ * If a locality tax is applicable it would be housed here.
361
367
  * @type {number}
362
368
  * @memberof ClaimDetail
363
369
  */
364
370
  'local_Tax'?: number | null;
365
371
  /**
366
- *
372
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
367
373
  * @type {string}
368
374
  * @memberof ClaimDetail
369
375
  */
370
376
  'mail_Order_Indicator'?: string | null;
371
377
  /**
372
- *
378
+ * Based on taxable amount and various configurations, this holds the Medicare \"To Tax\" amount for disability claim.
373
379
  * @type {number}
374
380
  * @memberof ClaimDetail
375
381
  */
376
382
  'medicare_Amount_To_Tax'?: number | null;
377
383
  /**
378
- *
384
+ * The calculated Medicare tax amount based on the \"To Tax\" amount.
379
385
  * @type {number}
380
386
  * @memberof ClaimDetail
381
387
  */
382
388
  'medicare_Tax'?: number | null;
383
389
  /**
384
- *
390
+ * For dental claims, notes if this surface had services rendered. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
385
391
  * @type {boolean}
386
392
  * @memberof ClaimDetail
387
393
  */
388
394
  'mesial': boolean;
389
395
  /**
390
- *
396
+ * The modifier applied to this service.
391
397
  * @type {string}
392
398
  * @memberof ClaimDetail
393
399
  */
394
400
  'modifier'?: string | null;
395
401
  /**
396
- *
402
+ * The modifier applied to this service.
397
403
  * @type {string}
398
404
  * @memberof ClaimDetail
399
405
  */
400
406
  'modifier_2'?: string | null;
401
407
  /**
402
- *
408
+ * The modifier applied to this service.
403
409
  * @type {string}
404
410
  * @memberof ClaimDetail
405
411
  */
406
412
  'modifier_3'?: string | null;
407
413
  /**
408
- *
414
+ * The modifier applied to this service.
409
415
  * @type {string}
410
416
  * @memberof ClaimDetail
411
417
  */
412
418
  'modifier_4'?: string | null;
413
419
  /**
414
- *
420
+ * For not covered services, or partially not covered services, this reflects that deduction. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
415
421
  * @type {number}
416
422
  * @memberof ClaimDetail
417
423
  */
418
424
  'not_Covered_Amt': number;
419
425
  /**
420
- *
426
+ * For dental claims, notes if this surface had services rendered. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
421
427
  * @type {boolean}
422
428
  * @memberof ClaimDetail
423
429
  */
424
430
  'occlusal': boolean;
425
431
  /**
426
- *
432
+ * For dental claims this holds the oral cavity designation sent on the 837D.
427
433
  * @type {string}
428
434
  * @memberof ClaimDetail
429
435
  */
430
436
  'oral_Cavity_Designation_Code_1'?: string | null;
431
437
  /**
432
- *
438
+ * For dental claims this holds the oral cavity designation sent on the 837D.
433
439
  * @type {string}
434
440
  * @memberof ClaimDetail
435
441
  */
436
442
  'oral_Cavity_Designation_Code_2'?: string | null;
437
443
  /**
438
- *
444
+ * For dental claims this holds the oral cavity designation sent on the 837D.
439
445
  * @type {string}
440
446
  * @memberof ClaimDetail
441
447
  */
442
448
  'oral_Cavity_Designation_Code_3'?: string | null;
443
449
  /**
444
- *
450
+ * For dental claims this holds the oral cavity designation sent on the 837D.
445
451
  * @type {string}
446
452
  * @memberof ClaimDetail
447
453
  */
448
454
  'oral_Cavity_Designation_Code_4'?: string | null;
449
455
  /**
450
- *
456
+ * For dental claims this holds the oral cavity designation sent on the 837D.
451
457
  * @type {string}
452
458
  * @memberof ClaimDetail
453
459
  */
454
460
  'oral_Cavity_Designation_Code_5'?: string | null;
455
461
  /**
456
- *
462
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
457
463
  * @type {number}
458
464
  * @memberof ClaimDetail
459
465
  */
460
466
  'other_Deduction_Amount'?: number | null;
461
467
  /**
462
- *
468
+ * Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
469
+ * @type {boolean}
470
+ * @memberof ClaimDetail
471
+ */
472
+ 'override_Benefit_Code': boolean;
473
+ /**
474
+ * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
463
475
  * @type {boolean}
464
476
  * @memberof ClaimDetail
465
477
  */
466
478
  'override_COB_Amt': boolean;
467
479
  /**
468
- *
480
+ * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
469
481
  * @type {boolean}
470
482
  * @memberof ClaimDetail
471
483
  */
472
484
  'override_Co_Ins_Amt': boolean;
473
485
  /**
474
- *
486
+ * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
475
487
  * @type {boolean}
476
488
  * @memberof ClaimDetail
477
489
  */
478
490
  'override_Co_Pay_Amt': boolean;
479
491
  /**
480
- *
492
+ * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
481
493
  * @type {boolean}
482
494
  * @memberof ClaimDetail
483
495
  */
484
496
  'override_Ded_Credit_Amt': boolean;
485
497
  /**
486
- *
498
+ * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
487
499
  * @type {boolean}
488
500
  * @memberof ClaimDetail
489
501
  */
490
502
  'override_Deductible_Amt': boolean;
491
503
  /**
492
- *
504
+ * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
493
505
  * @type {boolean}
494
506
  * @memberof ClaimDetail
495
507
  */
496
508
  'override_Federal_Tax': boolean;
497
509
  /**
498
- *
510
+ * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
499
511
  * @type {boolean}
500
512
  * @memberof ClaimDetail
501
513
  */
502
514
  'override_Local_Tax': boolean;
503
515
  /**
504
- *
516
+ * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
505
517
  * @type {boolean}
506
518
  * @memberof ClaimDetail
507
519
  */
508
520
  'override_Medicare_Tax': boolean;
509
521
  /**
510
- *
522
+ * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
511
523
  * @type {boolean}
512
524
  * @memberof ClaimDetail
513
525
  */
514
526
  'override_Not_Covered_Amt': boolean;
515
527
  /**
516
- *
528
+ * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
517
529
  * @type {boolean}
518
530
  * @memberof ClaimDetail
519
531
  */
520
532
  'override_Plan_Price': boolean;
521
533
  /**
522
- *
534
+ * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
523
535
  * @type {boolean}
524
536
  * @memberof ClaimDetail
525
537
  */
526
538
  'override_Social_Security': boolean;
527
539
  /**
528
- *
540
+ * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
529
541
  * @type {boolean}
530
542
  * @memberof ClaimDetail
531
543
  */
532
544
  'override_State_Tax': boolean;
533
545
  /**
534
- *
546
+ * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this amount. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
535
547
  * @type {boolean}
536
548
  * @memberof ClaimDetail
537
549
  */
538
550
  'override_With_Hold_Amt': boolean;
539
551
  /**
540
- *
552
+ * Information field used in custom processing and reporting.
541
553
  * @type {number}
542
554
  * @memberof ClaimDetail
543
555
  */
544
556
  'ppO_Price_Plan_Price_Diff'?: number | null;
545
557
  /**
546
- *
558
+ * The final paid amount for this service line based on allowed amount (Plan_Price) minus all applicable deductions. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
547
559
  * @type {number}
548
560
  * @memberof ClaimDetail
549
561
  */
550
562
  'paid_Amt': number;
551
563
  /**
552
- *
564
+ * The partial loss amount for disability claims. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
553
565
  * @type {number}
554
566
  * @memberof ClaimDetail
555
567
  */
556
568
  'partial_Loss': number;
557
569
  /**
558
- *
570
+ * For reference purposes, this hold the individual service line funding payor/account. If multiple payor/accounts are found on different service lines for the same claim, adjudication spits out an error.
559
571
  * @type {string}
560
572
  * @memberof ClaimDetail
561
573
  */
562
574
  'payor_ID'?: string | null;
563
575
  /**
564
- *
576
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
565
577
  * @type {string}
566
578
  * @memberof ClaimDetail
567
579
  */
568
580
  'pharmacy_Name'?: string | null;
569
581
  /**
570
- *
582
+ * The place of service for the services being rendered on this service line.
571
583
  * @type {string}
572
584
  * @memberof ClaimDetail
573
585
  */
574
586
  'place_Of_Service'?: string | null;
575
587
  /**
576
- *
588
+ * The allowed amount for this service based on fee schedule, pricing, repricing, etc. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
577
589
  * @type {number}
578
590
  * @memberof ClaimDetail
579
591
  */
580
592
  'plan_Price': number;
581
593
  /**
582
- *
594
+ * The premium deduction amount for disability claims. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
583
595
  * @type {number}
584
596
  * @memberof ClaimDetail
585
597
  */
586
598
  'premium_Deduction': number;
587
599
  /**
588
- *
600
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
589
601
  * @type {string}
590
602
  * @memberof ClaimDetail
591
603
  */
592
604
  'prescriber_ID'?: string | null;
593
605
  /**
594
- *
606
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
595
607
  * @type {string}
596
608
  * @memberof ClaimDetail
597
609
  */
598
610
  'prescription_Date'?: string | null;
599
611
  /**
600
- *
612
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
601
613
  * @type {string}
602
614
  * @memberof ClaimDetail
603
615
  */
604
616
  'prescription_Number'?: string | null;
605
617
  /**
606
- *
618
+ * For reprice claims (typically submitted via 837), this notes the reprice method used to reprice this service line.
607
619
  * @type {string}
608
620
  * @memberof ClaimDetail
609
621
  */
610
622
  'pricing_Method'?: string | null;
611
623
  /**
612
- *
624
+ * The rate associated with the reprice method (Pricing_Method).
613
625
  * @type {number}
614
626
  * @memberof ClaimDetail
615
627
  */
616
628
  'pricing_Rate'?: number | null;
617
629
  /**
618
- *
630
+ * For life claims, this holds the principal amount for reporting. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
619
631
  * @type {number}
620
632
  * @memberof ClaimDetail
621
633
  */
622
634
  'principal': number;
623
635
  /**
624
- *
636
+ * The service being rendered on this claim.
625
637
  * @type {string}
626
638
  * @memberof ClaimDetail
627
639
  */
628
640
  'procedure_Code'?: string | null;
629
641
  /**
630
- *
642
+ * The secondary service being rendered on this claim.
631
643
  * @type {string}
632
644
  * @memberof ClaimDetail
633
645
  */
634
646
  'procedure_Code2'?: string | null;
635
647
  /**
636
- *
648
+ * QPA (Qualified Payment Amount) values received in upcoming EDI transactions for the NSA (No Surprise Act) mandate.
637
649
  * @type {number}
638
650
  * @memberof ClaimDetail
639
651
  */
640
652
  'qualifying_Payment_Amount'?: number | null;
641
653
  /**
642
- *
654
+ * No longer in use.
643
655
  * @type {number}
644
656
  * @memberof ClaimDetail
645
657
  */
646
658
  'reason_Code'?: number | null;
647
659
  /**
648
- *
660
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
649
661
  * @type {number}
650
662
  * @memberof ClaimDetail
651
663
  */
652
664
  'refill_Indicator'?: number | null;
653
665
  /**
654
- *
666
+ * Holds the submitted reprice savings amount for services that include this amount in the pricing calculation.
655
667
  * @type {number}
656
668
  * @memberof ClaimDetail
657
669
  */
658
670
  'repriced_Savings_Amount'?: number | null;
659
671
  /**
660
- *
672
+ * For dental claims, notes if this surface had services rendered. Note: The database will apply a default value of `False` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
661
673
  * @type {boolean}
662
674
  * @memberof ClaimDetail
663
675
  */
664
676
  'root': boolean;
665
677
  /**
666
- *
678
+ * The start date of the services being rendered.
667
679
  * @type {string}
668
680
  * @memberof ClaimDetail
669
681
  */
670
682
  'service_Date'?: string | null;
671
683
  /**
672
- *
684
+ * The end date of the services being rendered.
673
685
  * @type {string}
674
686
  * @memberof ClaimDetail
675
687
  */
676
688
  'service_Thru'?: string | null;
677
689
  /**
678
- *
690
+ * Based on taxable amount and various configurations, this holds the Social Security \"To Tax\" amount for disability claim.
679
691
  * @type {number}
680
692
  * @memberof ClaimDetail
681
693
  */
682
694
  'socSec_Amount_To_Tax'?: number | null;
683
695
  /**
684
- *
696
+ * The calculated Social Security tax amount based on the \"To Tax\" amount. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
685
697
  * @type {number}
686
698
  * @memberof ClaimDetail
687
699
  */
688
700
  'social_Security': number;
689
701
  /**
690
- *
702
+ * Based on taxable amount and various configurations, this holds the State \"To Tax\" amount for disability claim.
691
703
  * @type {number}
692
704
  * @memberof ClaimDetail
693
705
  */
694
706
  'state_Amount_To_Tax'?: number | null;
695
707
  /**
696
- *
708
+ * The calculated State tax amount based on the \"To Tax\" amount. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
697
709
  * @type {number}
698
710
  * @memberof ClaimDetail
699
711
  */
700
712
  'state_Tax': number;
701
713
  /**
702
- *
714
+ * A flat state tax amount applied in addition to the calculated tax amount.
703
715
  * @type {number}
704
716
  * @memberof ClaimDetail
705
717
  */
706
718
  'state_Tax_Flat'?: number | null;
707
719
  /**
708
- *
720
+ * When state taxes are calculated, this indicates the state the tax amount was calculated against.
709
721
  * @type {string}
710
722
  * @memberof ClaimDetail
711
723
  */
712
724
  'state_Tax_State'?: string | null;
713
725
  /**
714
- *
726
+ * Holds the individaul status of this service line based on Ex Codes. A - Payable, D - Denied, E - Pended.
715
727
  * @type {string}
716
728
  * @memberof ClaimDetail
717
729
  */
718
730
  'status_Code'?: string | null;
719
731
  /**
720
- *
732
+ * The units applied to this service.
721
733
  * @type {number}
722
734
  * @memberof ClaimDetail
723
735
  */
724
736
  'svc_Count'?: number | null;
725
737
  /**
726
- *
738
+ * This holds the starting taxable amount based on pre-tax and pre-gross deductions applied to this service.
727
739
  * @type {number}
728
740
  * @memberof ClaimDetail
729
741
  */
730
742
  'taxable_Amount'?: number | null;
731
743
  /**
732
- *
744
+ * For dental claims, this identifies the tooth, quadrant or arch being worked for this service.
733
745
  * @type {number}
734
746
  * @memberof ClaimDetail
735
747
  */
736
748
  'tooth_Number'?: number | null;
737
749
  /**
738
- *
750
+ * No longer in use. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
739
751
  * @type {number}
740
752
  * @memberof ClaimDetail
741
753
  */
742
754
  'ucR_Price': number;
743
755
  /**
744
- *
756
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
745
757
  * @type {number}
746
758
  * @memberof ClaimDetail
747
759
  */
748
760
  'unit_Dose'?: number | null;
749
761
  /**
750
- *
762
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
751
763
  * @type {string}
752
764
  * @memberof ClaimDetail
753
765
  */
754
766
  'unit_Of_Measure'?: string | null;
755
767
  /**
756
- *
768
+ * Date when the record was last updated in the system.
757
769
  * @type {string}
758
770
  * @memberof ClaimDetail
759
771
  */
760
772
  'update_Date'?: string;
761
773
  /**
762
- *
774
+ * User that last updated the record in the system.
763
775
  * @type {string}
764
776
  * @memberof ClaimDetail
765
777
  */
766
778
  'update_User'?: string | null;
767
779
  /**
768
- *
780
+ * For plans that allow withhold, this amount is used to track that amount. Note: The database will apply a default value of `0` for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
769
781
  * @type {number}
770
782
  * @memberof ClaimDetail
771
783
  */