@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20230208.2 → 1.20230225.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.
@@ -21,79 +21,79 @@
21
21
  */
22
22
  export interface ClaimBatchDetail {
23
23
  /**
24
- *
24
+ * References the ClaimBatch.Batch_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 ClaimBatchDetail
27
27
  */
28
28
  'batch_Number': number;
29
29
  /**
30
- *
30
+ * References the ClaimBatch.Batch_Claim 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.
31
31
  * @type {number}
32
32
  * @memberof ClaimBatchDetail
33
33
  */
34
34
  'batch_Claim': number;
35
35
  /**
36
- *
36
+ * In combination with Adjustment_Seq, creates a unique sequence for each service line on this claim.
37
37
  * @type {string}
38
38
  * @memberof ClaimBatchDetail
39
39
  */
40
40
  'claim_Seq': string;
41
41
  /**
42
- *
42
+ * In combination with Claim_Seq, creates a unique sequence for each service line on this claim. Used to note adjustments, cascading, etc. when utlized.
43
43
  * @type {string}
44
44
  * @memberof ClaimBatchDetail
45
45
  */
46
46
  'adjustment_Seq': string;
47
47
  /**
48
- *
48
+ * No longer in use.
49
49
  * @type {string}
50
50
  * @memberof ClaimBatchDetail
51
51
  */
52
52
  'ansI_Code'?: string | null;
53
53
  /**
54
- *
54
+ * The APC code applied to this service if identified for calculation during adjudication.
55
55
  * @type {string}
56
56
  * @memberof ClaimBatchDetail
57
57
  */
58
58
  'apC_Code'?: string | null;
59
59
  /**
60
- *
60
+ * 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.
61
61
  * @type {number}
62
62
  * @memberof ClaimBatchDetail
63
63
  */
64
64
  'account_Key'?: number | null;
65
65
  /**
66
- *
66
+ * References the Adjustment_Seq value on the original claim that this claim is adjusting.
67
67
  * @type {string}
68
68
  * @memberof ClaimBatchDetail
69
69
  */
70
70
  'adjusted_From_Adjustment_Line'?: string | null;
71
71
  /**
72
- *
72
+ * References the Claim_Seq value on the original claim that this claim is adjusting.
73
73
  * @type {string}
74
74
  * @memberof ClaimBatchDetail
75
75
  */
76
76
  'adjusted_From_Line'?: string | null;
77
77
  /**
78
- *
78
+ * The Auth Number for services that require authorization. References Auth.Auth_Number.
79
79
  * @type {string}
80
80
  * @memberof ClaimBatchDetail
81
81
  */
82
82
  'auth_Number'?: string | null;
83
83
  /**
84
- *
84
+ * If an Auth Penalty is applied during adjudication, that is housed here.
85
85
  * @type {number}
86
86
  * @memberof ClaimBatchDetail
87
87
  */
88
88
  'auth_Penalty'?: number | null;
89
89
  /**
90
- *
90
+ * Notes that this service lines required authorization.
91
91
  * @type {string}
92
92
  * @memberof ClaimBatchDetail
93
93
  */
94
94
  'auth_Required'?: string | null;
95
95
  /**
96
- *
96
+ * This is the benefit code assigned to this service line based on the Plan assigned on the Claim header. References BenefitCodes.Benefit_Code.
97
97
  * @type {string}
98
98
  * @memberof ClaimBatchDetail
99
99
  */
@@ -103,759 +103,765 @@ export interface ClaimBatchDetail {
103
103
  * @type {number}
104
104
  * @memberof ClaimBatchDetail
105
105
  */
106
+ 'benefit_Rate_Applied'?: number | null;
107
+ /**
108
+ * 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.
109
+ * @type {number}
110
+ * @memberof ClaimBatchDetail
111
+ */
106
112
  'billed_Price': number;
107
113
  /**
108
- *
114
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
109
115
  * @type {string}
110
116
  * @memberof ClaimBatchDetail
111
117
  */
112
118
  'brand_Indicator'?: string | null;
113
119
  /**
114
- *
120
+ * 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.
115
121
  * @type {boolean}
116
122
  * @memberof ClaimBatchDetail
117
123
  */
118
124
  'buccal': boolean;
119
125
  /**
120
- *
126
+ * No longer in use.
121
127
  * @type {string}
122
128
  * @memberof ClaimBatchDetail
123
129
  */
124
130
  'cliA_Number'?: string | null;
125
131
  /**
126
- *
132
+ * 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.
127
133
  * @type {number}
128
134
  * @memberof ClaimBatchDetail
129
135
  */
130
136
  'coB_Amt': number;
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 ClaimBatchDetail
135
141
  */
136
142
  'coB_Hold'?: 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 ClaimBatchDetail
141
147
  */
142
148
  'coB_Mem_Resp'?: 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 ClaimBatchDetail
147
153
  */
148
154
  'coB_Savings'?: number | null;
149
155
  /**
150
- *
156
+ * Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied.
151
157
  * @type {number}
152
158
  * @memberof ClaimBatchDetail
153
159
  */
154
160
  'coB_Savings_Used'?: number | null;
155
161
  /**
156
- *
162
+ * Used for Flex Claims to indicate the calendar year this claim applies.
157
163
  * @type {string}
158
164
  * @memberof ClaimBatchDetail
159
165
  */
160
166
  'calendar_Year'?: string | null;
161
167
  /**
162
- *
168
+ * 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.
163
169
  * @type {boolean}
164
170
  * @memberof ClaimBatchDetail
165
171
  */
166
172
  'capitation_Claim': boolean;
167
173
  /**
168
- *
174
+ * No longer in use.
169
175
  * @type {number}
170
176
  * @memberof ClaimBatchDetail
171
177
  */
172
178
  'check_ID'?: number | null;
173
179
  /**
174
- *
180
+ * 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.
175
181
  * @type {number}
176
182
  * @memberof ClaimBatchDetail
177
183
  */
178
184
  'co_Ins_Amt': number;
179
185
  /**
180
- *
186
+ * 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.
181
187
  * @type {number}
182
188
  * @memberof ClaimBatchDetail
183
189
  */
184
190
  'co_Pay_Amt': number;
185
191
  /**
186
- *
192
+ * For currency calculations, this holds the destination currency.
187
193
  * @type {string}
188
194
  * @memberof ClaimBatchDetail
189
195
  */
190
196
  'currency_ID'?: string | null;
191
197
  /**
192
- *
198
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
193
199
  * @type {number}
194
200
  * @memberof ClaimBatchDetail
195
201
  */
196
202
  'days_Supply'?: number | null;
197
203
  /**
198
- *
204
+ * If the service is eligiblity for deductible credits, they would be stored here.
199
205
  * @type {number}
200
206
  * @memberof ClaimBatchDetail
201
207
  */
202
208
  'ded_Credit_Amt'?: number | null;
203
209
  /**
204
- *
210
+ * 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.
205
211
  * @type {number}
206
212
  * @memberof ClaimBatchDetail
207
213
  */
208
214
  'deductible_Amt': number;
209
215
  /**
210
- *
216
+ * The diagnosis pointer for this service line indicating which Diagnostic Codes from the Claim are applicable to this service.
211
217
  * @type {string}
212
218
  * @memberof ClaimBatchDetail
213
219
  */
214
220
  'diagnosis_Code'?: string | null;
215
221
  /**
216
- *
222
+ * 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.
217
223
  * @type {number}
218
224
  * @memberof ClaimBatchDetail
219
225
  */
220
226
  'discount_Amt': number;
221
227
  /**
222
- *
228
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
223
229
  * @type {number}
224
230
  * @memberof ClaimBatchDetail
225
231
  */
226
232
  'dispense_As_Written'?: number | null;
227
233
  /**
228
- *
234
+ * 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.
229
235
  * @type {boolean}
230
236
  * @memberof ClaimBatchDetail
231
237
  */
232
238
  'distal': boolean;
233
239
  /**
234
- *
240
+ * For RX claims or medical claims that hold a drug code. References DrugCode.Drug_Code.
235
241
  * @type {string}
236
242
  * @memberof ClaimBatchDetail
237
243
  */
238
244
  'drug_Code'?: string | null;
239
245
  /**
240
- *
246
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
241
247
  * @type {number}
242
248
  * @memberof ClaimBatchDetail
243
249
  */
244
250
  'drug_Quantity'?: number | null;
245
251
  /**
246
- *
252
+ * Date when the record was first added to the system.
247
253
  * @type {string}
248
254
  * @memberof ClaimBatchDetail
249
255
  */
250
256
  'entry_Date'?: string;
251
257
  /**
252
- *
258
+ * User that first added the record to the system.
253
259
  * @type {string}
254
260
  * @memberof ClaimBatchDetail
255
261
  */
256
262
  'entry_User'?: string | null;
257
263
  /**
258
- *
264
+ * During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.
259
265
  * @type {string}
260
266
  * @memberof ClaimBatchDetail
261
267
  */
262
268
  'error_Auth'?: string | null;
263
269
  /**
264
- *
270
+ * During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.
265
271
  * @type {string}
266
272
  * @memberof ClaimBatchDetail
267
273
  */
268
274
  'error_Benefit'?: string | null;
269
275
  /**
270
- *
276
+ * During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.
271
277
  * @type {string}
272
278
  * @memberof ClaimBatchDetail
273
279
  */
274
280
  'error_Count'?: string | null;
275
281
  /**
276
- *
282
+ * During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.
277
283
  * @type {string}
278
284
  * @memberof ClaimBatchDetail
279
285
  */
280
286
  'error_Covered'?: string | null;
281
287
  /**
282
- *
288
+ * During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.
283
289
  * @type {string}
284
290
  * @memberof ClaimBatchDetail
285
291
  */
286
292
  'error_Dates'?: string | null;
287
293
  /**
288
- *
294
+ * During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.
289
295
  * @type {string}
290
296
  * @memberof ClaimBatchDetail
291
297
  */
292
298
  'error_Diagnosis'?: string | null;
293
299
  /**
294
- *
300
+ * During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.
295
301
  * @type {string}
296
302
  * @memberof ClaimBatchDetail
297
303
  */
298
304
  'error_ExCode'?: string | null;
299
305
  /**
300
- *
306
+ * During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.
301
307
  * @type {string}
302
308
  * @memberof ClaimBatchDetail
303
309
  */
304
310
  'error_Modifier'?: string | null;
305
311
  /**
306
- *
312
+ * During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.
307
313
  * @type {string}
308
314
  * @memberof ClaimBatchDetail
309
315
  */
310
316
  'error_Place'?: string | null;
311
317
  /**
312
- *
318
+ * During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.
313
319
  * @type {string}
314
320
  * @memberof ClaimBatchDetail
315
321
  */
316
322
  'error_Price'?: string | null;
317
323
  /**
318
- *
324
+ * During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.
319
325
  * @type {string}
320
326
  * @memberof ClaimBatchDetail
321
327
  */
322
328
  'error_Procedure'?: string | null;
323
329
  /**
324
- *
330
+ * A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code.
325
331
  * @type {string}
326
332
  * @memberof ClaimBatchDetail
327
333
  */
328
334
  'ex_Code'?: string | null;
329
335
  /**
330
- *
336
+ * A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code.
331
337
  * @type {string}
332
338
  * @memberof ClaimBatchDetail
333
339
  */
334
340
  'ex_Code2'?: string | null;
335
341
  /**
336
- *
342
+ * A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code.
337
343
  * @type {string}
338
344
  * @memberof ClaimBatchDetail
339
345
  */
340
346
  'ex_Code3'?: string | null;
341
347
  /**
342
- *
348
+ * 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.
343
349
  * @type {number}
344
350
  * @memberof ClaimBatchDetail
345
351
  */
346
352
  'fica': number;
347
353
  /**
348
- *
354
+ * 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.
349
355
  * @type {boolean}
350
356
  * @memberof ClaimBatchDetail
351
357
  */
352
358
  'facial': boolean;
353
359
  /**
354
- *
360
+ * Based on taxable amount and various configurations, this holds the Federal \"To Tax\" amount for disability claim.
355
361
  * @type {number}
356
362
  * @memberof ClaimBatchDetail
357
363
  */
358
364
  'federal_Amount_To_Tax'?: number | null;
359
365
  /**
360
- *
366
+ * 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.
361
367
  * @type {number}
362
368
  * @memberof ClaimBatchDetail
363
369
  */
364
370
  'federal_Tax': number;
365
371
  /**
366
- *
372
+ * A flat federal tax amount applied in addition to the calculated tax amount.
367
373
  * @type {number}
368
374
  * @memberof ClaimBatchDetail
369
375
  */
370
376
  'federal_Tax_Flat'?: number | null;
371
377
  /**
372
- *
378
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
373
379
  * @type {string}
374
380
  * @memberof ClaimBatchDetail
375
381
  */
376
382
  'fill_Date'?: string | null;
377
383
  /**
378
- *
384
+ * Manually entered description of this flex claim.
379
385
  * @type {string}
380
386
  * @memberof ClaimBatchDetail
381
387
  */
382
388
  'flex_Description'?: string | null;
383
389
  /**
384
- *
390
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
385
391
  * @type {string}
386
392
  * @memberof ClaimBatchDetail
387
393
  */
388
394
  'formulary_Indicator'?: string | null;
389
395
  /**
390
- *
396
+ * 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.
391
397
  * @type {boolean}
392
398
  * @memberof ClaimBatchDetail
393
399
  */
394
400
  'incisal': boolean;
395
401
  /**
396
- *
402
+ * 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.
397
403
  * @type {number}
398
404
  * @memberof ClaimBatchDetail
399
405
  */
400
406
  'interest': number;
401
407
  /**
402
- *
408
+ * 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.
403
409
  * @type {boolean}
404
410
  * @memberof ClaimBatchDetail
405
411
  */
406
412
  'labial': boolean;
407
413
  /**
408
- *
414
+ * The Life Benefit to be applied for Life claims processing.
409
415
  * @type {string}
410
416
  * @memberof ClaimBatchDetail
411
417
  */
412
418
  'life_Benefit'?: string | null;
413
419
  /**
414
- *
420
+ * The Life Benefit calculated volume based on benefit definition.
415
421
  * @type {number}
416
422
  * @memberof ClaimBatchDetail
417
423
  */
418
424
  'life_Benefit_Volume'?: number | null;
419
425
  /**
420
- *
426
+ * Number added manually to claims and from 837 files and sent outbound on 835 files.
421
427
  * @type {string}
422
428
  * @memberof ClaimBatchDetail
423
429
  */
424
430
  'line_Control_Number'?: string | null;
425
431
  /**
426
- *
432
+ * 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.
427
433
  * @type {boolean}
428
434
  * @memberof ClaimBatchDetail
429
435
  */
430
436
  'lingual': boolean;
431
437
  /**
432
- *
438
+ * If a locality tax is applicable it would be housed here.
433
439
  * @type {number}
434
440
  * @memberof ClaimBatchDetail
435
441
  */
436
442
  'local_Tax'?: number | null;
437
443
  /**
438
- *
444
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
439
445
  * @type {string}
440
446
  * @memberof ClaimBatchDetail
441
447
  */
442
448
  'mail_Order_Indicator'?: string | null;
443
449
  /**
444
- *
450
+ * Based on taxable amount and various configurations, this holds the Medicare \"To Tax\" amount for disability claim.
445
451
  * @type {number}
446
452
  * @memberof ClaimBatchDetail
447
453
  */
448
454
  'medicare_Amount_To_Tax'?: number | null;
449
455
  /**
450
- *
456
+ * The calculated Medicare tax amount based on the \"To Tax\" amount.
451
457
  * @type {number}
452
458
  * @memberof ClaimBatchDetail
453
459
  */
454
460
  'medicare_Tax'?: number | null;
455
461
  /**
456
- *
462
+ * 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.
457
463
  * @type {boolean}
458
464
  * @memberof ClaimBatchDetail
459
465
  */
460
466
  'mesial': boolean;
461
467
  /**
462
- *
468
+ * This is for anesthesia, each Unit of anesthesia is equal to a specific amount of Minutes.
463
469
  * @type {number}
464
470
  * @memberof ClaimBatchDetail
465
471
  */
466
472
  'minutes_Per_Unit'?: number | null;
467
473
  /**
468
- *
474
+ * The modifier applied to this service.
469
475
  * @type {string}
470
476
  * @memberof ClaimBatchDetail
471
477
  */
472
478
  'modifier'?: string | null;
473
479
  /**
474
- *
480
+ * The modifier applied to this service.
475
481
  * @type {string}
476
482
  * @memberof ClaimBatchDetail
477
483
  */
478
484
  'modifier_2'?: string | null;
479
485
  /**
480
- *
486
+ * The modifier applied to this service.
481
487
  * @type {string}
482
488
  * @memberof ClaimBatchDetail
483
489
  */
484
490
  'modifier_3'?: string | null;
485
491
  /**
486
- *
492
+ * The modifier applied to this service.
487
493
  * @type {string}
488
494
  * @memberof ClaimBatchDetail
489
495
  */
490
496
  'modifier_4'?: string | null;
491
497
  /**
492
- *
498
+ * The number of the units from this detail line that comes from the Modifier. This determines pricing for the line.
493
499
  * @type {number}
494
500
  * @memberof ClaimBatchDetail
495
501
  */
496
502
  'modifier_Units'?: number | null;
497
503
  /**
498
- *
504
+ * 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.
499
505
  * @type {number}
500
506
  * @memberof ClaimBatchDetail
501
507
  */
502
508
  'not_Covered_Amt': number;
503
509
  /**
504
- *
510
+ * 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.
505
511
  * @type {boolean}
506
512
  * @memberof ClaimBatchDetail
507
513
  */
508
514
  'occlusal': boolean;
509
515
  /**
510
- *
516
+ * For dental claims this holds the oral cavity designation sent on the 837D.
511
517
  * @type {string}
512
518
  * @memberof ClaimBatchDetail
513
519
  */
514
520
  'oral_Cavity_Designation_Code_1'?: string | null;
515
521
  /**
516
- *
522
+ * For dental claims this holds the oral cavity designation sent on the 837D.
517
523
  * @type {string}
518
524
  * @memberof ClaimBatchDetail
519
525
  */
520
526
  'oral_Cavity_Designation_Code_2'?: string | null;
521
527
  /**
522
- *
528
+ * For dental claims this holds the oral cavity designation sent on the 837D.
523
529
  * @type {string}
524
530
  * @memberof ClaimBatchDetail
525
531
  */
526
532
  'oral_Cavity_Designation_Code_3'?: string | null;
527
533
  /**
528
- *
534
+ * For dental claims this holds the oral cavity designation sent on the 837D.
529
535
  * @type {string}
530
536
  * @memberof ClaimBatchDetail
531
537
  */
532
538
  'oral_Cavity_Designation_Code_4'?: string | null;
533
539
  /**
534
- *
540
+ * For dental claims this holds the oral cavity designation sent on the 837D.
535
541
  * @type {string}
536
542
  * @memberof ClaimBatchDetail
537
543
  */
538
544
  'oral_Cavity_Designation_Code_5'?: string | null;
539
545
  /**
540
- *
546
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
541
547
  * @type {number}
542
548
  * @memberof ClaimBatchDetail
543
549
  */
544
550
  'other_Deduction_Amount'?: number | null;
545
551
  /**
546
- *
552
+ * 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.
547
553
  * @type {boolean}
548
554
  * @memberof ClaimBatchDetail
549
555
  */
550
556
  'override_COB_Amt': boolean;
551
557
  /**
552
- *
558
+ * 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.
553
559
  * @type {boolean}
554
560
  * @memberof ClaimBatchDetail
555
561
  */
556
562
  'override_Co_Ins_Amt': boolean;
557
563
  /**
558
- *
564
+ * 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.
559
565
  * @type {boolean}
560
566
  * @memberof ClaimBatchDetail
561
567
  */
562
568
  'override_Co_Pay_Amt': boolean;
563
569
  /**
564
- *
570
+ * 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.
565
571
  * @type {boolean}
566
572
  * @memberof ClaimBatchDetail
567
573
  */
568
574
  'override_Ded_Credit_Amt': boolean;
569
575
  /**
570
- *
576
+ * 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.
571
577
  * @type {boolean}
572
578
  * @memberof ClaimBatchDetail
573
579
  */
574
580
  'override_Deductible_Amt': boolean;
575
581
  /**
576
- *
582
+ * 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.
577
583
  * @type {boolean}
578
584
  * @memberof ClaimBatchDetail
579
585
  */
580
586
  'override_Federal_Tax': boolean;
581
587
  /**
582
- *
588
+ * 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.
583
589
  * @type {boolean}
584
590
  * @memberof ClaimBatchDetail
585
591
  */
586
592
  'override_Local_Tax': boolean;
587
593
  /**
588
- *
594
+ * 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.
589
595
  * @type {boolean}
590
596
  * @memberof ClaimBatchDetail
591
597
  */
592
598
  'override_Medicare_Tax': boolean;
593
599
  /**
594
- *
600
+ * 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.
595
601
  * @type {boolean}
596
602
  * @memberof ClaimBatchDetail
597
603
  */
598
604
  'override_Not_Covered_Amt': boolean;
599
605
  /**
600
- *
606
+ * 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.
601
607
  * @type {boolean}
602
608
  * @memberof ClaimBatchDetail
603
609
  */
604
610
  'override_Plan_Price': boolean;
605
611
  /**
606
- *
612
+ * 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.
607
613
  * @type {boolean}
608
614
  * @memberof ClaimBatchDetail
609
615
  */
610
616
  'override_Social_Security': boolean;
611
617
  /**
612
- *
618
+ * 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.
613
619
  * @type {boolean}
614
620
  * @memberof ClaimBatchDetail
615
621
  */
616
622
  'override_State_Tax': boolean;
617
623
  /**
618
- *
624
+ * 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.
619
625
  * @type {boolean}
620
626
  * @memberof ClaimBatchDetail
621
627
  */
622
628
  'override_With_Hold_Amt': boolean;
623
629
  /**
624
- *
630
+ * Information field used in custom processing and reporting.
625
631
  * @type {number}
626
632
  * @memberof ClaimBatchDetail
627
633
  */
628
634
  'ppO_Price_Plan_Price_Diff'?: number | null;
629
635
  /**
630
- *
636
+ * 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.
631
637
  * @type {number}
632
638
  * @memberof ClaimBatchDetail
633
639
  */
634
640
  'paid_Amt': number;
635
641
  /**
636
- *
642
+ * 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.
637
643
  * @type {number}
638
644
  * @memberof ClaimBatchDetail
639
645
  */
640
646
  'partial_Loss': number;
641
647
  /**
642
- *
648
+ * 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.
643
649
  * @type {string}
644
650
  * @memberof ClaimBatchDetail
645
651
  */
646
652
  'payor_ID'?: string | null;
647
653
  /**
648
- *
654
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
649
655
  * @type {string}
650
656
  * @memberof ClaimBatchDetail
651
657
  */
652
658
  'pharmacy_Name'?: string | null;
653
659
  /**
654
- *
660
+ * The place of service for the services being rendered on this service line.
655
661
  * @type {string}
656
662
  * @memberof ClaimBatchDetail
657
663
  */
658
664
  'place_Of_Service'?: string | null;
659
665
  /**
660
- *
666
+ * 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.
661
667
  * @type {number}
662
668
  * @memberof ClaimBatchDetail
663
669
  */
664
670
  'plan_Price': number;
665
671
  /**
666
- *
672
+ * 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.
667
673
  * @type {number}
668
674
  * @memberof ClaimBatchDetail
669
675
  */
670
676
  'premium_Deduction': number;
671
677
  /**
672
- *
678
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
673
679
  * @type {string}
674
680
  * @memberof ClaimBatchDetail
675
681
  */
676
682
  'prescriber_ID'?: string | null;
677
683
  /**
678
- *
684
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
679
685
  * @type {string}
680
686
  * @memberof ClaimBatchDetail
681
687
  */
682
688
  'prescription_Date'?: string | null;
683
689
  /**
684
- *
690
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
685
691
  * @type {string}
686
692
  * @memberof ClaimBatchDetail
687
693
  */
688
694
  'prescription_Number'?: string | null;
689
695
  /**
690
- *
696
+ * For reprice claims (typically submitted via 837), this notes the reprice method used to reprice this service line.
691
697
  * @type {string}
692
698
  * @memberof ClaimBatchDetail
693
699
  */
694
700
  'pricing_Method'?: string | null;
695
701
  /**
696
- *
702
+ * The rate associated with the reprice method (Pricing_Method).
697
703
  * @type {number}
698
704
  * @memberof ClaimBatchDetail
699
705
  */
700
706
  'pricing_Rate'?: number | null;
701
707
  /**
702
- *
708
+ * 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.
703
709
  * @type {number}
704
710
  * @memberof ClaimBatchDetail
705
711
  */
706
712
  'principal': number;
707
713
  /**
708
- *
714
+ * The service being rendered on this claim.
709
715
  * @type {string}
710
716
  * @memberof ClaimBatchDetail
711
717
  */
712
718
  'procedure_Code'?: string | null;
713
719
  /**
714
- *
720
+ * The secondary service being rendered on this claim.
715
721
  * @type {string}
716
722
  * @memberof ClaimBatchDetail
717
723
  */
718
724
  'procedure_Code2'?: string | null;
719
725
  /**
720
- *
726
+ * The number of th eunits from this detail line that comes from the Prtocedure Code. This determines pricing for the line.
721
727
  * @type {number}
722
728
  * @memberof ClaimBatchDetail
723
729
  */
724
730
  'procedure_Code_Units'?: number | null;
725
731
  /**
726
- *
732
+ * QPA (Qualified Payment Amount) values received in upcoming EDI transactions for the NSA (No Surprise Act) mandate.
727
733
  * @type {number}
728
734
  * @memberof ClaimBatchDetail
729
735
  */
730
736
  'qualifying_Payment_Amount'?: number | null;
731
737
  /**
732
- *
738
+ * No longer in use.
733
739
  * @type {number}
734
740
  * @memberof ClaimBatchDetail
735
741
  */
736
742
  'reason_Code'?: number | null;
737
743
  /**
738
- *
744
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
739
745
  * @type {number}
740
746
  * @memberof ClaimBatchDetail
741
747
  */
742
748
  'refill_Indicator'?: number | null;
743
749
  /**
744
- *
750
+ * Holds the submitted reprice savings amount for services that include this amount in the pricing calculation.
745
751
  * @type {number}
746
752
  * @memberof ClaimBatchDetail
747
753
  */
748
754
  'repriced_Savings_Amount'?: number | null;
749
755
  /**
750
- *
756
+ * 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.
751
757
  * @type {boolean}
752
758
  * @memberof ClaimBatchDetail
753
759
  */
754
760
  'root': boolean;
755
761
  /**
756
- *
762
+ * The start date of the services being rendered.
757
763
  * @type {string}
758
764
  * @memberof ClaimBatchDetail
759
765
  */
760
766
  'service_Date'?: string | null;
761
767
  /**
762
- *
768
+ * The end date of the services being rendered.
763
769
  * @type {string}
764
770
  * @memberof ClaimBatchDetail
765
771
  */
766
772
  'service_Thru'?: string | null;
767
773
  /**
768
- *
774
+ * Based on taxable amount and various configurations, this holds the Social Security \"To Tax\" amount for disability claim.
769
775
  * @type {number}
770
776
  * @memberof ClaimBatchDetail
771
777
  */
772
778
  'socSec_Amount_To_Tax'?: number | null;
773
779
  /**
774
- *
780
+ * 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.
775
781
  * @type {number}
776
782
  * @memberof ClaimBatchDetail
777
783
  */
778
784
  'social_Security': number;
779
785
  /**
780
- *
786
+ * Based on taxable amount and various configurations, this holds the State \"To Tax\" amount for disability claim.
781
787
  * @type {number}
782
788
  * @memberof ClaimBatchDetail
783
789
  */
784
790
  'state_Amount_To_Tax'?: number | null;
785
791
  /**
786
- *
792
+ * 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.
787
793
  * @type {number}
788
794
  * @memberof ClaimBatchDetail
789
795
  */
790
796
  'state_Tax': number;
791
797
  /**
792
- *
798
+ * A flat state tax amount applied in addition to the calculated tax amount.
793
799
  * @type {number}
794
800
  * @memberof ClaimBatchDetail
795
801
  */
796
802
  'state_Tax_Flat'?: number | null;
797
803
  /**
798
- *
804
+ * When state taxes are calculated, this indicates the state the tax amount was calculated against.
799
805
  * @type {string}
800
806
  * @memberof ClaimBatchDetail
801
807
  */
802
808
  'state_Tax_State'?: string | null;
803
809
  /**
804
- *
810
+ * Holds the individaul status of this service line based on Ex Codes. A - Payable, D - Denied, E - Pended.
805
811
  * @type {string}
806
812
  * @memberof ClaimBatchDetail
807
813
  */
808
814
  'status_Code'?: string | null;
809
815
  /**
810
- *
816
+ * The units applied to this service.
811
817
  * @type {number}
812
818
  * @memberof ClaimBatchDetail
813
819
  */
814
820
  'svc_Count'?: number | null;
815
821
  /**
816
- *
822
+ * This holds the starting taxable amount based on pre-tax and pre-gross deductions applied to this service.
817
823
  * @type {number}
818
824
  * @memberof ClaimBatchDetail
819
825
  */
820
826
  'taxable_Amount'?: number | null;
821
827
  /**
822
- *
828
+ * For dental claims, this identifies the tooth, quadrant or arch being worked for this service.
823
829
  * @type {number}
824
830
  * @memberof ClaimBatchDetail
825
831
  */
826
832
  'tooth_Number'?: number | null;
827
833
  /**
828
- *
834
+ * 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.
829
835
  * @type {number}
830
836
  * @memberof ClaimBatchDetail
831
837
  */
832
838
  'ucR_Price': number;
833
839
  /**
834
- *
840
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
835
841
  * @type {number}
836
842
  * @memberof ClaimBatchDetail
837
843
  */
838
844
  'unit_Dose'?: number | null;
839
845
  /**
840
- *
846
+ * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
841
847
  * @type {string}
842
848
  * @memberof ClaimBatchDetail
843
849
  */
844
850
  'unit_Of_Measure'?: string | null;
845
851
  /**
846
- *
852
+ * Date when the record was last updated in the system.
847
853
  * @type {string}
848
854
  * @memberof ClaimBatchDetail
849
855
  */
850
856
  'update_Date'?: string;
851
857
  /**
852
- *
858
+ * User that last updated the record in the system.
853
859
  * @type {string}
854
860
  * @memberof ClaimBatchDetail
855
861
  */
856
862
  'update_User'?: string | null;
857
863
  /**
858
- *
864
+ * 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.
859
865
  * @type {number}
860
866
  * @memberof ClaimBatchDetail
861
867
  */