Claims

Create Claim

Creates a new Claim

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
claim_Number
required
integer <int32>

Unique identifier assigned each time a claim is processed from batch. This value can change if a claim is returned to batch and reprocessed. 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.

abF_Exported
required
boolean

Used by VBA Backroom IT Services to track export status of a claim using ABF. This has since been moved to ClaimExport tables and is no longer in use. 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.

abF_Exported_Date
string or null <date-time>

Used by VBA Backroom IT Services to track export status of a claim using ABF. This has since been moved to ClaimExport tables and is no longer in use.

aeoB_Claim
required
boolean

A flag indicating a claim is an Advanced EOB and not a claim for payment. Part of the No Surprise Act. 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.

accident_Date
string or null <date-time>

The date of accident.

account_Key
integer or null <int32>

For claim funding, indicates the payor/account this claim would be paid from.

adjustment_Claim
required
boolean

Indicates that this claim was part of an 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.

admin_Amt
number or null <double>

No longer in use.

admission_Date
string or null <date-time>

For institutional Claims, holds the Admission Date.

admission_Diagnostic_Code
string or null <= 8 characters

The admission diagnosis code if applicable for this claim.

admission_Hour
string or null <= 8 characters

For institutional Claims, holds the Admission Hour.

admission_Source
string or null <= 8 characters

For institutional Claims, holds the Admission Source.

admit_Date
string or null <date-time>

Used to identify the date the member was admitted to the Hospital if hospitalized as part of this disability.

advance_Pay
required
boolean

Indicates if this claim, for disability, can be processed and paid in advance of that service dates. 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.

advice_To_Pay
required
boolean

Notes this claim is advice to pay and will not go through funding. 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.

all_Docs_Rec_Date
string or null <date-time>

Information field used in custom processing and reporting.

ambulance_DropOff_Address
string or null <= 90 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_DropOff_Address2
string or null <= 90 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_DropOff_City
string or null <= 32 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_DropOff_Location
string or null <= 64 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_DropOff_Org_Name
string or null <= 512 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_DropOff_State
string or null <= 10 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_DropOff_Zip
string or null <= 32 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_PickUp_Address
string or null <= 90 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_PickUp_Address2
string or null <= 90 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_PickUp_City
string or null <= 32 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_PickUp_Location
string or null <= 64 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_PickUp_State
string or null <= 10 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_PickUp_Zip
string or null <= 32 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

appliance_Placed_Date
string or null <date-time>

The date the orthodontic appliance was placed.

assumed_Care_Date
string or null <date-time>

Information field used in custom processing and reporting.

attended_Physician_Date
string or null <date-time>

This identifies the date the member first visited the Physician. This field, in combination with Disabled by Physician Date and Last Day Worked, create the Disability Date for the Member.

auto_Flex
required
boolean

Notes if this Flex claim was auto-generated by the adjducation engine based on member responsibility configuration at the Group. 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.

batch_Claim
integer or null <int32>

This value, in combination with Batch_Number, creates a unique identifier for each claim that is maintained in both batch and processed.

batch_Number
integer or null <int32>

This value, in combination with Batch_Claim, creates a unique identifier for each claim that is maintained in both batch and processed.

beneficiary_ID
string or null <= 20 characters

Notes the beneficiary for Life & Disability claims. References the MemberBeneficiary.Beneficiary_ID.

cliA_Number
string or null <= 32 characters

No longer in use.

calculate_Interest
required
boolean

Notes if interest was calculated for this claim as part of adjudication. 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.

capitation_Claim
required
boolean

Indicates if this claim is 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.

ceridian_Exported
required
boolean

Used in custom integration with ceridian tax services. 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.

ceridian_Exported_Date
string or null <date-time>

Used in custom integration with ceridian tax services.

check_Batch
integer or null <int32>

This is the primary indicator if a claim is "Paid". When this value is NULL, the claim has been processed but not paid. When paid, this value will hold what Check Batch the claim was paid under. References CheckBatch.Check_Batch.

check_ID
integer or null <int32>

Holds the Check ID this claim was paid under. References Checks.Check_ID.

check_Number
string or null <= 20 characters

No longer in use.

claim_837_COB
string or null <= 1 characters

For 837 transactions, indicates COB has been submitted.

claim_Exported
required
boolean

Used by VBA Backroom IT Services to track export status of a claim. This has since been moved to ClaimExport tables and is no longer in use. 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.

claim_Exported_Date
string or null <date-time>

Used by VBA Backroom IT Services to track export status of a claim. This has since been moved to ClaimExport tables and is no longer in use.

claim_Funded_Status
string or null <= 32 characters

Indicates the Claim Funded Status for this claim, indicating if the claim is ready for funding, suspended, a candidate for payment, part of a funding request or funded.

claim_ID
string or null <= 32 characters

An identifier assigned by external vendors and used for integrations. Primarily comes from the REF*D9 value in the 837.

claim_Priority
string or null <= 1 characters

For 837 transactions, indicates the submitted claim priority.

claim_Status
string or null <= 8 characters

The status of the claim. Valid values reside in the ClaimStatus table.

claim_Type
string or null <= 20 characters

Notes the claim type for this claim. References ClaimType.Claim_Type.

closure_Effective_Date
string or null <date-time>

This is an information only field that allows the tracking of the Closure Effective Date.

condition_Code1
string or null <= 8 characters

The Condition Code value for this claim.

condition_Code10
string or null <= 8 characters
condition_Code11
string or null <= 8 characters
condition_Code12
string or null <= 8 characters
condition_Code13
string or null <= 8 characters
condition_Code14
string or null <= 8 characters
condition_Code15
string or null <= 8 characters
condition_Code16
string or null <= 8 characters
condition_Code17
string or null <= 8 characters
condition_Code18
string or null <= 8 characters
condition_Code19
string or null <= 8 characters
condition_Code2
string or null <= 8 characters

The Condition Code value for this claim.

condition_Code20
string or null <= 8 characters
condition_Code21
string or null <= 8 characters
condition_Code22
string or null <= 8 characters
condition_Code23
string or null <= 8 characters
condition_Code24
string or null <= 8 characters
condition_Code3
string or null <= 8 characters

The Condition Code value for this claim.

condition_Code4
string or null <= 8 characters

The Condition Code value for this claim.

condition_Code5
string or null <= 8 characters

The Condition Code value for this claim.

condition_Code6
string or null <= 8 characters

The Condition Code value for this claim.

condition_Code7
string or null <= 8 characters

The Condition Code value for this claim.

condition_Code8
string or null <= 8 characters
condition_Code9
string or null <= 8 characters
coverage_Start
string or null <date-time>

The patients (or Subscribers) enrollment information, references Subenrollment.Group_Coverage_Start.

current_Illness_Date
string or null <date-time>

The current illness date for this claim.

drG_Code
string or null <= 4 characters

The DRG Code for this claim, if applicable. References the DRGCodes.DRG_Code.

drG_Quantity
number or null <double>

The quantity associated with this DRG value.

death_Cert_Rec_Date
string or null <date-time>

Information field used in custom processing and reporting.

delivery_Date
string or null <date-time>

This identifies the date of delivery for disability due to pregnancy.

delivery_Type
string or null <= 1 characters

This will identify the type of delivery that is performed as a result of pregnancy.

dep_SSDI_End_Date
string or null <date-time>

This is an information only field that allows the tracking of Dependent SSI End Date.

diagnostic_Code1
string or null <= 8 characters

An assigned diagnostic code for this claim. This field, in the absence of a corresponding diagnosis pointer from a claim service line, indicates the primary diagnosis.

diagnostic_Code10
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code11
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code12
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code13
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code14
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code15
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code16
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code17
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code18
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code19
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code2
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code20
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code21
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code22
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code23
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code24
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code3
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code4
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code5
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code6
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code7
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code8
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code9
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code_Type
required
string [ 1 .. 16 ] characters

Indicates if the Diagnostic Code values on this claim are ICD9 or ICD10. Two possible values: 9 - ICD9 or 0 - ICD10.

disability_Date
string or null <date-time>

The calculated date of disability (or manually enetered) based on the disabilty advisor in VBASoftware.

disability_End_Date
string or null <date-time>

Information field used in custom processing and reporting.

disability_Type
string or null <= 20 characters

Used to identify the type of disability (Injury or Illness).

disabled_By_Physician
string or null <date-time>

This identifies the date the member was disabled by the Physician. This field, in combination with First Attended Physician Date and Last Day Worked, create the Disability Date for the Member.

discharge_Date
string or null <date-time>

Used to identify the date the member was discharged from the Hospital if hospitalized as part of this disability.

discharge_Hour
string or null <= 8 characters

For institutional Claims, holds the Discharge Hour.

division_ID
string or null <= 20 characters

The patients (or Subscribers) enrollment information, references Subenrollment.Division_ID.

eCode_Diagnostic_Code
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code10
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code11
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code12
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code2
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code3
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code4
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code5
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code6
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code7
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code8
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code9
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

epsdT_Condition_Indicator1
string or null <= 3 characters

Early and Periodic Screening, Diagnostic, and Treatment Indicator tracked from the claim submission.

epsdT_Condition_Indicator2
string or null <= 3 characters

Early and Periodic Screening, Diagnostic, and Treatment Indicator tracked from the claim submission.

epsdT_Condition_Indicator3
string or null <= 3 characters

Early and Periodic Screening, Diagnostic, and Treatment Indicator tracked from the claim submission.

epsdT_Referral_Given
string or null <= 1 characters

Early and Periodic Screening, Diagnostic, and Treatment tracking for if a referral was given for this claim.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

ex_Code1
string or null <= 6 characters

A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code.

ex_Code2
string or null <= 6 characters

A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code.

ex_Code3
string or null <= 8 characters

A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code.

ex_Code4
string or null <= 8 characters

A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code.

exhaust_Date
string or null <date-time>

This is the Exhaust Date of the members Disability.

expected_Typical_Duration
integer or null <int32>

Expected Typical Duration (ETD) is the duration of disability identified by the MDA based on the type of job the member has as well as the diagnosis of the disability.

ficA_Percent
number or null <double>

This will hold the FICA withhold amount for each payment. If tax calculation module is enabled, this option will be ignored.

federal_Withheld
number or null <double>

This will hold the federal withhold amount for each payment. If tax calculation module is enabled, this option will be ignored.

filing_Indicator
string or null <= 2 characters

No longer in use.

followUp_Date
string or null <date-time>

This will place a follow-up date on each payment as an additional identifier for when this disability should be reviewed.

followUp_Ex_Code
string or null <= 6 characters

This will place a follow-up ex code on each payment to allow the user to categorize what type of follow-up is being performed.

freq_Code
string or null <= 8 characters

Medicare Resubmission code for the claim. Indicated in Box 22 of the claim report.

group_ID
string or null <= 20 characters

The patients (or Subscribers) enrollment information, references Subenrollment.Group_ID.

hearing_Vision_RX_Date
string or null <date-time>

Information field used in custom processing and reporting.

image_File_Location
string or null <= 128 characters

Stores a reference, if applicable, to an image or document associated with this claim.

image_File_Location2
string or null <= 128 characters

Stores a reference, if applicable, to an image or document associated with this claim.

image_File_Location3
string or null <= 128 characters

Stores a reference, if applicable, to an image or document associated with this claim.

image_File_Location4
string or null <= 128 characters

Stores a reference, if applicable, to an image or document associated with this claim.

initial_Treatment_Date
string or null <date-time>

Information field to track the initial treatment date for this claim.

job_Type
string or null <= 2 characters

This is the job classification for the member going on disability.

ltD_Effective_Date
string or null <date-time>

This is an information only field that holds the date the member went on Long-Term Disability.

ltD_Packet_Date
string or null <date-time>

This is an information only field that tracks the date the Long-Term Disability Packet was sent.

last_Day_Worked
string or null <date-time>

This identifies the date the member last attended work prior to going on disability. This field, in combination with First Attended Physician Date and Disabled by Physician, create the Disability Date for the Member.

last_Physician_Warrant_Date
string or null <date-time>

This is an information only field that allows for the tracking of the Physician Warrant Date.

last_Seen_Date
string or null <date-time>

Information field to track the last time a phyician was seen at the time of this claim submission.

liability_Injury
required
boolean

This is an information only field that identifies if this disability is a liability injury. 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.

mail_To
string or null <= 1 characters

Notes if the payment should be mailed to an entity other than the "Send_Check_To".

member_Seq
string or null <= 2 characters

The Member Sequence of the patient for this claim.

months_Of_Treatment
integer or null <int32>

The number of months the orthodontic treatment will be.

network_ID
string or null <= 10 characters

Indicates the network this claim was paid against. If this value is NULL, the claim is considered "Out of Network".

note
string or null <= 24 characters

No longer in use. Replaced by Note Services.

occupational
required
boolean

Notes if the disability is related to the patiens occupation. 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.

occurrence_Code1
string or null <= 8 characters

The Occurrence Code value for this claim.

occurrence_Code10
string or null <= 8 characters
occurrence_Code11
string or null <= 8 characters
occurrence_Code12
string or null <= 8 characters
occurrence_Code13
string or null <= 8 characters
occurrence_Code14
string or null <= 8 characters
occurrence_Code15
string or null <= 8 characters
occurrence_Code16
string or null <= 8 characters
occurrence_Code17
string or null <= 8 characters
occurrence_Code18
string or null <= 8 characters
occurrence_Code19
string or null <= 8 characters
occurrence_Code2
string or null <= 8 characters

The Occurrence Code value for this claim.

occurrence_Code20
string or null <= 8 characters
occurrence_Code21
string or null <= 8 characters
occurrence_Code22
string or null <= 8 characters
occurrence_Code23
string or null <= 8 characters
occurrence_Code24
string or null <= 8 characters
occurrence_Code3
string or null <= 8 characters

The Occurrence Code value for this claim.

occurrence_Code4
string or null <= 8 characters

The Occurrence Code value for this claim.

occurrence_Code5
string or null <= 8 characters
occurrence_Code6
string or null <= 8 characters
occurrence_Code7
string or null <= 8 characters
occurrence_Code8
string or null <= 8 characters
occurrence_Code9
string or null <= 8 characters
occurrence_Date1
string or null <date-time>

The Occurrence Date associated to the assigned Occurrence Codes.

occurrence_Date10
string or null <date-time>
occurrence_Date11
string or null <date-time>
occurrence_Date12
string or null <date-time>
occurrence_Date13
string or null <date-time>
occurrence_Date14
string or null <date-time>
occurrence_Date15
string or null <date-time>
occurrence_Date16
string or null <date-time>
occurrence_Date17
string or null <date-time>
occurrence_Date18
string or null <date-time>
occurrence_Date19
string or null <date-time>
occurrence_Date2
string or null <date-time>

The Occurrence Date associated to the assigned Occurrence Codes.

occurrence_Date20
string or null <date-time>
occurrence_Date21
string or null <date-time>
occurrence_Date22
string or null <date-time>
occurrence_Date23
string or null <date-time>
occurrence_Date24
string or null <date-time>
occurrence_Date3
string or null <date-time>

The Occurrence Date associated to the assigned Occurrence Codes.

occurrence_Date4
string or null <date-time>

The Occurrence Date associated to the assigned Occurrence Codes.

occurrence_Date5
string or null <date-time>
occurrence_Date6
string or null <date-time>
occurrence_Date7
string or null <date-time>
occurrence_Date8
string or null <date-time>
occurrence_Date9
string or null <date-time>
occurrence_Span_Code
string or null <= 8 characters

The occurrence span indicator for the Occurrence Span From and Thru dates.

occurrence_Span_Code10
string or null <= 8 characters
occurrence_Span_Code11
string or null <= 8 characters
occurrence_Span_Code12
string or null <= 8 characters
occurrence_Span_Code13
string or null <= 8 characters
occurrence_Span_Code14
string or null <= 8 characters
occurrence_Span_Code15
string or null <= 8 characters
occurrence_Span_Code16
string or null <= 8 characters
occurrence_Span_Code17
string or null <= 8 characters
occurrence_Span_Code18
string or null <= 8 characters
occurrence_Span_Code19
string or null <= 8 characters
occurrence_Span_Code2
string or null <= 8 characters
occurrence_Span_Code20
string or null <= 8 characters
occurrence_Span_Code21
string or null <= 8 characters
occurrence_Span_Code22
string or null <= 8 characters
occurrence_Span_Code23
string or null <= 8 characters
occurrence_Span_Code24
string or null <= 8 characters
occurrence_Span_Code3
string or null <= 8 characters
occurrence_Span_Code4
string or null <= 8 characters
occurrence_Span_Code5
string or null <= 8 characters
occurrence_Span_Code6
string or null <= 8 characters
occurrence_Span_Code7
string or null <= 8 characters
occurrence_Span_Code8
string or null <= 8 characters
occurrence_Span_Code9
string or null <= 8 characters
occurrence_Span_From
string or null <date-time>

The occurrence span from for this claim.

occurrence_Span_From10
string or null <date-time>
occurrence_Span_From11
string or null <date-time>
occurrence_Span_From12
string or null <date-time>
occurrence_Span_From13
string or null <date-time>
occurrence_Span_From14
string or null <date-time>
occurrence_Span_From15
string or null <date-time>
occurrence_Span_From16
string or null <date-time>
occurrence_Span_From17
string or null <date-time>
occurrence_Span_From18
string or null <date-time>
occurrence_Span_From19
string or null <date-time>
occurrence_Span_From2
string or null <date-time>
occurrence_Span_From20
string or null <date-time>
occurrence_Span_From21
string or null <date-time>
occurrence_Span_From22
string or null <date-time>
occurrence_Span_From23
string or null <date-time>
occurrence_Span_From24
string or null <date-time>
occurrence_Span_From3
string or null <date-time>
occurrence_Span_From4
string or null <date-time>
occurrence_Span_From5
string or null <date-time>
occurrence_Span_From6
string or null <date-time>
occurrence_Span_From7
string or null <date-time>
occurrence_Span_From8
string or null <date-time>
occurrence_Span_From9
string or null <date-time>
occurrence_Span_Thru
string or null <date-time>

The occurrence span thru for this claim.

occurrence_Span_Thru10
string or null <date-time>
occurrence_Span_Thru11
string or null <date-time>
occurrence_Span_Thru12
string or null <date-time>
occurrence_Span_Thru13
string or null <date-time>
occurrence_Span_Thru14
string or null <date-time>
occurrence_Span_Thru15
string or null <date-time>
occurrence_Span_Thru16
string or null <date-time>
occurrence_Span_Thru17
string or null <date-time>
occurrence_Span_Thru18
string or null <date-time>
occurrence_Span_Thru19
string or null <date-time>
occurrence_Span_Thru2
string or null <date-time>
occurrence_Span_Thru20
string or null <date-time>
occurrence_Span_Thru21
string or null <date-time>
occurrence_Span_Thru22
string or null <date-time>
occurrence_Span_Thru23
string or null <date-time>
occurrence_Span_Thru24
string or null <date-time>
occurrence_Span_Thru3
string or null <date-time>
occurrence_Span_Thru4
string or null <date-time>
occurrence_Span_Thru5
string or null <date-time>
occurrence_Span_Thru6
string or null <date-time>
occurrence_Span_Thru7
string or null <date-time>
occurrence_Span_Thru8
string or null <date-time>
occurrence_Span_Thru9
string or null <date-time>
onset_Similar_Illness_Date
string or null <date-time>

Notes the date of the original illness if this claim is associated to that illness.

orthodontics_Treatment
required
boolean

When this flag is checked, it indicates the dental claim is for orthodontics. 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.

other_Insurance
required
boolean

Indicates if other insurance is applicable on this claim. This indicator unlocks COB amount fields on the ClaimDetail (service line). 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.

other_Procedure_Code1
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code10
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code11
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code12
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code13
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code14
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code15
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code16
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code17
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code18
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code19
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code2
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code20
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code21
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code22
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code23
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code3
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code4
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code5
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code6
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code7
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code8
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code9
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Date1
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date10
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date11
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date12
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date13
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date14
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date15
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date16
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date17
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date18
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date19
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date2
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date20
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date21
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date22
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date23
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date3
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date4
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date5
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date6
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date7
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date8
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date9
string or null <date-time>

Date associated with the additional procedure code.

override
string or null <= 1 characters

No longer in use.

override_Date
string or null <date-time>

No longer in use.

override_Network_ID
required
boolean

This indicator lets the system know that the front end user has assigned this network ID and not adjudication. 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.

override_Payor_Account
required
boolean

Users can choose the payor from the More Information screen and this flag prevents adjudication from using the expected payor. 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.

override_User
string or null <= 16 characters

No longer in use.

partial_Disability
required
boolean

This will identify if this is a partial disability payment. Partial Disability payments have additional tax and payment rules applied during adjudication. 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.

patient_Account
string or null <= 128 characters

For the servicing provider, this indicates the patient account identifier in their practice management system.

patient_Reason_for_Visit_Diagnostic_Code1
string or null <= 8 characters

Reason for Visit code on Diagnosis Code 1

patient_Reason_for_Visit_Diagnostic_Code2
string or null <= 8 characters

Reason for Visit code on Diagnosis Code 2

patient_Reason_for_Visit_Diagnostic_Code3
string or null <= 8 characters

Reason for Visit code on Diagnosis Code 3

patient_Relationship
string or null <= 8 characters

Holds the relationship of the patient to the insured.

patient_Signature
required
boolean

Indicates if the patient signature has been collected. 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.

patient_Signature_Date
string or null <date-time>

Indicates the date of the patient signature being collected.

patient_Status
string or null <= 8 characters

For institutional Claims, holds the Patient Status.

payee_ID
string or null <= 20 characters

The billing provider (payee) for this claim. References the ProviderPayee.Payee_ID (by Provider_ID).

payment_Status
string or null <= 1 characters

No longer in use.

payor_Claim_Control_Number
string or null <= 64 characters

A claim reference number used in conjunction with the Medicare Resubmission code. Indicated in Box 22 of the claim report.

payor_ID
string or null <= 20 characters

For claim funding, indicates the payor/account this claim would be paid from.

physician_Return_To_Work
string or null <date-time>

This is the Return to Work date identified by the Physician at the start of disability. This may or may not be the actual date the member returns to work.

place_Of_Service
string or null <= 5 characters

Some transactions hold the Place of Service at the header but typically this value is empty and the ClaimDetail.Place_Of_Service is used for each service line. This value is not used in standard processing.

plan_ID
string or null <= 20 characters

Holds the plan the patient is enrolled in and that benefits are assigned.

plan_Provider
string or null <= 1 characters

No longer in use.

plan_Year
string or null <= 8 characters

Indicates the Plan Year this claim is processed under. This drives accumulator calculations and referneces the GroupPlanYear.Plan_Year value.

present_On_Admission1
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 1.

present_On_Admission10
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 10.

present_On_Admission11
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 11.

present_On_Admission12
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 12.

present_On_Admission13
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 13.

present_On_Admission14
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 14.

present_On_Admission15
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 15.

present_On_Admission16
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 16.

present_On_Admission17
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 17.

present_On_Admission18
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 18.

present_On_Admission19
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 19.

present_On_Admission2
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 2.

present_On_Admission20
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 20.

present_On_Admission21
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 21.

present_On_Admission22
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 22.

present_On_Admission23
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 23.

present_On_Admission24
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 24.

present_On_Admission3
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 3.

present_On_Admission4
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 4.

present_On_Admission5
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 5.

present_On_Admission6
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 6.

present_On_Admission7
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 7.

present_On_Admission8
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 8.

present_On_Admission9
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 9.

present_On_Admission_ECode1
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 1.

present_On_Admission_ECode10
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 10.

present_On_Admission_ECode11
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 11.

present_On_Admission_ECode12
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 12.

present_On_Admission_ECode2
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 2.

present_On_Admission_ECode3
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 3.

present_On_Admission_ECode4
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 4.

present_On_Admission_ECode5
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 5.

present_On_Admission_ECode6
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 6.

present_On_Admission_ECode7
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 7.

present_On_Admission_ECode8
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 8.

present_On_Admission_ECode9
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 9.

pricing_Method
string or null <= 8 characters

For reprice claims (typically submitted via 837), this notes the reprice method used to reprice this claim.

pricing_Org_ID
string or null <= 50 characters

The ID of the pricing organization. Data is obtained in segment HCP04 on an 837.

pricing_Rate
number or null <double>

The rate associated with the reprice method (Pricing_Method).

principal_Procedure_Code
string or null <= 8 characters

The principal procedure (ICD10 Diagnosis) for this claim submission.

principal_Procedure_Date
string or null <date-time>

The principal procedure date.

prior_Placement_Date
string or null <date-time>

The date of a previous prosthetic or crown applied, if there was one.

processed_Date
string or null <date-time>

The date the claim was processed from batch.

prosthesis_Replacement
required
boolean

This flag indicates if this claim is for the replacement of a prosthesis. 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.

provider_ID
string or null <= 20 characters

The provider ID of the servicing provider. References Provider.Provider_ID.

qpA_Method
string or null <= 1 characters

Overrides the QPA Method set on the Plan for this claim.

received_Date
string or null <date-time>

The date this claim was received into the admin system.

referred_By
string or null <= 30 characters

Information field to track if a referral was sent for this claim.

refund_Claim
required
boolean

Indicates that this claim was part of a Refund 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.

refund_Funding_Key
integer or null <int32>

If this claim was part of a refund process, this will hold the reference to the receipt generated by the refund process.

related_To_Accident
required
boolean

Indicates if the claim is related to a non-car accident. 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.

related_To_Another_Party
required
boolean

Indicates if the claim was casued by a third party. 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.

related_To_Auto
required
boolean

Indicates if the claim is related to a car accident. 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.

related_To_Employment
required
boolean

Indicates if the claim is work related. 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.

relinquished_Care_Date
string or null <date-time>

Information field used in custom processing and reporting.

remittance_Printed
string or null <= 1 characters

No longer in use.

reprice_Printed
string or null <= 1 characters

No longer in use.

repriced_Network_ID
string or null <= 50 characters

As part of reprice claim submissions (via 837), this will hold the repricing network.

return_To_Work_Date
string or null <date-time>

This is the date the member Returned to Work. This date affects the total payments created as well as other calculations during adjudication.

salary_Continuation
required
boolean

This flag identifies that there is salary continuation during this disability. 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.

send_Check_To
string or null <= 1 characters

Indicates the entity that should be paid for this claim. S - Subscriber, G - Group, B - Beneficiary, P - Payee, or V - Provider.

sender_ID
string or null <= 15 characters

The Sender ID sent inbound for x12 (837) transactions.

service_Date
string or null <date-time>

The earliest Service_Date of all service lines on this claim.

service_Thru
string or null <date-time>

The latest Service_Thru for all service lines on this claim.

sick_Time
required
boolean

This flag identifies that there is sick time during this disability. 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.

statement_From_Date
string or null <date-time>

For Institutional Claims, holds the Statement Date.

statement_Thru_Date
string or null <date-time>

For Institutional Claims, holds the Statement Date.

subscriber_ID
string or null <= 9 characters

The Subscriber ID of the patient for this claim.

subscriber_Signature
required
boolean

Indicates if the insured signature has been collected. 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.

survivor_Benefit
required
boolean

Indicates if Survivor Benefit was applied for this disability payment. 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.

third_Party_Payment
required
boolean

For disability, indicates if this professional claim is a 3rd party payment (typically related to alimony, garnishment, etc.) 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.

total_COB
required
number <double>

COB total for all claim detail lines 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.

trading_Partner_Key
integer or null <int32>

No longer in use.

trans_837_Control_Num
string or null <= 9 characters

For 837 transactions, this is the control number assgined by the submitter.

transaction_837
required
boolean

Indicates this is a claim entered by an inbound 837. 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.

transaction_837_ID
string or null <= 30 characters

For 837 transactions, this holds the transaction ID assigned by the submission.

type_Of_Admission
string or null <= 6 characters

The Admission Type associated to this claim.

type_Of_Bill
string or null <= 6 characters

The Bill Type associated to this claim. References BillType.Type_Of_Bill.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

vacation
required
boolean

This flag identifies that there is vacation during this disability. 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.

value_Amount1
number or null <double>

The monetary amount related to the value code.

value_Amount10
number or null <double>
value_Amount11
number or null <double>
value_Amount12
number or null <double>
value_Amount13
number or null <double>
value_Amount14
number or null <double>
value_Amount15
number or null <double>
value_Amount16
number or null <double>
value_Amount17
number or null <double>
value_Amount18
number or null <double>
value_Amount19
number or null <double>
value_Amount2
number or null <double>

The monetary amount related to the value code.

value_Amount20
number or null <double>
value_Amount21
number or null <double>
value_Amount22
number or null <double>
value_Amount23
number or null <double>
value_Amount24
number or null <double>
value_Amount3
number or null <double>

The monetary amount related to the value code.

value_Amount4
number or null <double>

The monetary amount related to the value code.

value_Amount5
number or null <double>
value_Amount6
number or null <double>
value_Amount7
number or null <double>
value_Amount8
number or null <double>
value_Amount9
number or null <double>
value_Code1
string or null <= 2 characters

The code indicating a monetary condition which was used by the intermediary to process an institutional claim.

value_Code10
string or null <= 2 characters
value_Code11
string or null <= 2 characters
value_Code12
string or null <= 2 characters
value_Code13
string or null <= 2 characters
value_Code14
string or null <= 2 characters
value_Code15
string or null <= 2 characters
value_Code16
string or null <= 2 characters
value_Code17
string or null <= 2 characters
value_Code18
string or null <= 2 characters
value_Code19
string or null <= 2 characters
value_Code2
string or null <= 2 characters

The code indicating a monetary condition which was used by the intermediary to process an institutional claim.

value_Code20
string or null <= 2 characters
value_Code21
string or null <= 2 characters
value_Code22
string or null <= 2 characters
value_Code23
string or null <= 2 characters
value_Code24
string or null <= 2 characters
value_Code3
string or null <= 2 characters

The code indicating a monetary condition which was used by the intermediary to process an institutional claim.

value_Code4
string or null <= 2 characters

The code indicating a monetary condition which was used by the intermediary to process an institutional claim.

value_Code5
string or null <= 2 characters
value_Code6
string or null <= 2 characters
value_Code7
string or null <= 2 characters
value_Code8
string or null <= 2 characters
value_Code9
string or null <= 2 characters
void_Claim
required
boolean

Indicates that this claim was part of a Void 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.

volume_Override
required
boolean

Notes that the benefit amount, for disability claims, has been manually overridden. 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.

waiting_Period_Claim
required
boolean

Indicates if this disability payment is a waiting period payment. 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.

Responses
200

Success

401

Unauthorized

post/claims
Request samples
{
  • "claim_Number": 0,
  • "abF_Exported": true,
  • "abF_Exported_Date": "2019-08-24T14:15:22Z",
  • "aeoB_Claim": true,
  • "accident_Date": "2019-08-24T14:15:22Z",
  • "account_Key": 0,
  • "adjustment_Claim": true,
  • "admin_Amt": 0.1,
  • "admission_Date": "2019-08-24T14:15:22Z",
  • "admission_Diagnostic_Code": "string",
  • "admission_Hour": "string",
  • "admission_Source": "string",
  • "admit_Date": "2019-08-24T14:15:22Z",
  • "advance_Pay": true,
  • "advice_To_Pay": true,
  • "all_Docs_Rec_Date": "2019-08-24T14:15:22Z",
  • "ambulance_DropOff_Address": "string",
  • "ambulance_DropOff_Address2": "string",
  • "ambulance_DropOff_City": "string",
  • "ambulance_DropOff_Location": "string",
  • "ambulance_DropOff_Org_Name": "string",
  • "ambulance_DropOff_State": "string",
  • "ambulance_DropOff_Zip": "string",
  • "ambulance_PickUp_Address": "string",
  • "ambulance_PickUp_Address2": "string",
  • "ambulance_PickUp_City": "string",
  • "ambulance_PickUp_Location": "string",
  • "ambulance_PickUp_State": "string",
  • "ambulance_PickUp_Zip": "string",
  • "appliance_Placed_Date": "2019-08-24T14:15:22Z",
  • "assumed_Care_Date": "2019-08-24T14:15:22Z",
  • "attended_Physician_Date": "2019-08-24T14:15:22Z",
  • "auto_Flex": true,
  • "batch_Claim": 0,
  • "batch_Number": 0,
  • "beneficiary_ID": "string",
  • "cliA_Number": "string",
  • "calculate_Interest": true,
  • "capitation_Claim": true,
  • "ceridian_Exported": true,
  • "ceridian_Exported_Date": "2019-08-24T14:15:22Z",
  • "check_Batch": 0,
  • "check_ID": 0,
  • "check_Number": "string",
  • "claim_837_COB": "s",
  • "claim_Exported": true,
  • "claim_Exported_Date": "2019-08-24T14:15:22Z",
  • "claim_Funded_Status": "string",
  • "claim_ID": "string",
  • "claim_Priority": "s",
  • "claim_Status": "string",
  • "claim_Type": "string",
  • "closure_Effective_Date": "2019-08-24T14:15:22Z",
  • "condition_Code1": "string",
  • "condition_Code10": "string",
  • "condition_Code11": "string",
  • "condition_Code12": "string",
  • "condition_Code13": "string",
  • "condition_Code14": "string",
  • "condition_Code15": "string",
  • "condition_Code16": "string",
  • "condition_Code17": "string",
  • "condition_Code18": "string",
  • "condition_Code19": "string",
  • "condition_Code2": "string",
  • "condition_Code20": "string",
  • "condition_Code21": "string",
  • "condition_Code22": "string",
  • "condition_Code23": "string",
  • "condition_Code24": "string",
  • "condition_Code3": "string",
  • "condition_Code4": "string",
  • "condition_Code5": "string",
  • "condition_Code6": "string",
  • "condition_Code7": "string",
  • "condition_Code8": "string",
  • "condition_Code9": "string",
  • "coverage_Start": "2019-08-24T14:15:22Z",
  • "current_Illness_Date": "2019-08-24T14:15:22Z",
  • "drG_Code": "stri",
  • "drG_Quantity": 0.1,
  • "death_Cert_Rec_Date": "2019-08-24T14:15:22Z",
  • "delivery_Date": "2019-08-24T14:15:22Z",
  • "delivery_Type": "s",
  • "dep_SSDI_End_Date": "2019-08-24T14:15:22Z",
  • "diagnostic_Code1": "string",
  • "diagnostic_Code10": "string",
  • "diagnostic_Code11": "string",
  • "diagnostic_Code12": "string",
  • "diagnostic_Code13": "string",
  • "diagnostic_Code14": "string",
  • "diagnostic_Code15": "string",
  • "diagnostic_Code16": "string",
  • "diagnostic_Code17": "string",
  • "diagnostic_Code18": "string",
  • "diagnostic_Code19": "string",
  • "diagnostic_Code2": "string",
  • "diagnostic_Code20": "string",
  • "diagnostic_Code21": "string",
  • "diagnostic_Code22": "string",
  • "diagnostic_Code23": "string",
  • "diagnostic_Code24": "string",
  • "diagnostic_Code3": "string",
  • "diagnostic_Code4": "string",
  • "diagnostic_Code5": "string",
  • "diagnostic_Code6": "string",
  • "diagnostic_Code7": "string",
  • "diagnostic_Code8": "string",
  • "diagnostic_Code9": "string",
  • "diagnostic_Code_Type": "string",
  • "disability_Date": "2019-08-24T14:15:22Z",
  • "disability_End_Date": "2019-08-24T14:15:22Z",
  • "disability_Type": "string",
  • "disabled_By_Physician": "2019-08-24T14:15:22Z",
  • "discharge_Date": "2019-08-24T14:15:22Z",
  • "discharge_Hour": "string",
  • "division_ID": "string",
  • "eCode_Diagnostic_Code": "string",
  • "eCode_Diagnostic_Code10": "string",
  • "eCode_Diagnostic_Code11": "string",
  • "eCode_Diagnostic_Code12": "string",
  • "eCode_Diagnostic_Code2": "string",
  • "eCode_Diagnostic_Code3": "string",
  • "eCode_Diagnostic_Code4": "string",
  • "eCode_Diagnostic_Code5": "string",
  • "eCode_Diagnostic_Code6": "string",
  • "eCode_Diagnostic_Code7": "string",
  • "eCode_Diagnostic_Code8": "string",
  • "eCode_Diagnostic_Code9": "string",
  • "epsdT_Condition_Indicator1": "str",
  • "epsdT_Condition_Indicator2": "str",
  • "epsdT_Condition_Indicator3": "str",
  • "epsdT_Referral_Given": "s",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code1": "string",
  • "ex_Code2": "string",
  • "ex_Code3": "string",
  • "ex_Code4": "string",
  • "exhaust_Date": "2019-08-24T14:15:22Z",
  • "expected_Typical_Duration": 0,
  • "ficA_Percent": 0.1,
  • "federal_Withheld": 0.1,
  • "filing_Indicator": "st",
  • "followUp_Date": "2019-08-24T14:15:22Z",
  • "followUp_Ex_Code": "string",
  • "freq_Code": "string",
  • "group_ID": "string",
  • "hearing_Vision_RX_Date": "2019-08-24T14:15:22Z",
  • "image_File_Location": "string",
  • "image_File_Location2": "string",
  • "image_File_Location3": "string",
  • "image_File_Location4": "string",
  • "initial_Treatment_Date": "2019-08-24T14:15:22Z",
  • "job_Type": "st",
  • "ltD_Effective_Date": "2019-08-24T14:15:22Z",
  • "ltD_Packet_Date": "2019-08-24T14:15:22Z",
  • "last_Day_Worked": "2019-08-24T14:15:22Z",
  • "last_Physician_Warrant_Date": "2019-08-24T14:15:22Z",
  • "last_Seen_Date": "2019-08-24T14:15:22Z",
  • "liability_Injury": true,
  • "mail_To": "s",
  • "member_Seq": "st",
  • "months_Of_Treatment": 0,
  • "network_ID": "string",
  • "note": "string",
  • "occupational": true,
  • "occurrence_Code1": "string",
  • "occurrence_Code10": "string",
  • "occurrence_Code11": "string",
  • "occurrence_Code12": "string",
  • "occurrence_Code13": "string",
  • "occurrence_Code14": "string",
  • "occurrence_Code15": "string",
  • "occurrence_Code16": "string",
  • "occurrence_Code17": "string",
  • "occurrence_Code18": "string",
  • "occurrence_Code19": "string",
  • "occurrence_Code2": "string",
  • "occurrence_Code20": "string",
  • "occurrence_Code21": "string",
  • "occurrence_Code22": "string",
  • "occurrence_Code23": "string",
  • "occurrence_Code24": "string",
  • "occurrence_Code3": "string",
  • "occurrence_Code4": "string",
  • "occurrence_Code5": "string",
  • "occurrence_Code6": "string",
  • "occurrence_Code7": "string",
  • "occurrence_Code8": "string",
  • "occurrence_Code9": "string",
  • "occurrence_Date1": "2019-08-24T14:15:22Z",
  • "occurrence_Date10": "2019-08-24T14:15:22Z",
  • "occurrence_Date11": "2019-08-24T14:15:22Z",
  • "occurrence_Date12": "2019-08-24T14:15:22Z",
  • "occurrence_Date13": "2019-08-24T14:15:22Z",
  • "occurrence_Date14": "2019-08-24T14:15:22Z",
  • "occurrence_Date15": "2019-08-24T14:15:22Z",
  • "occurrence_Date16": "2019-08-24T14:15:22Z",
  • "occurrence_Date17": "2019-08-24T14:15:22Z",
  • "occurrence_Date18": "2019-08-24T14:15:22Z",
  • "occurrence_Date19": "2019-08-24T14:15:22Z",
  • "occurrence_Date2": "2019-08-24T14:15:22Z",
  • "occurrence_Date20": "2019-08-24T14:15:22Z",
  • "occurrence_Date21": "2019-08-24T14:15:22Z",
  • "occurrence_Date22": "2019-08-24T14:15:22Z",
  • "occurrence_Date23": "2019-08-24T14:15:22Z",
  • "occurrence_Date24": "2019-08-24T14:15:22Z",
  • "occurrence_Date3": "2019-08-24T14:15:22Z",
  • "occurrence_Date4": "2019-08-24T14:15:22Z",
  • "occurrence_Date5": "2019-08-24T14:15:22Z",
  • "occurrence_Date6": "2019-08-24T14:15:22Z",
  • "occurrence_Date7": "2019-08-24T14:15:22Z",
  • "occurrence_Date8": "2019-08-24T14:15:22Z",
  • "occurrence_Date9": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Code": "string",
  • "occurrence_Span_Code10": "string",
  • "occurrence_Span_Code11": "string",
  • "occurrence_Span_Code12": "string",
  • "occurrence_Span_Code13": "string",
  • "occurrence_Span_Code14": "string",
  • "occurrence_Span_Code15": "string",
  • "occurrence_Span_Code16": "string",
  • "occurrence_Span_Code17": "string",
  • "occurrence_Span_Code18": "string",
  • "occurrence_Span_Code19": "string",
  • "occurrence_Span_Code2": "string",
  • "occurrence_Span_Code20": "string",
  • "occurrence_Span_Code21": "string",
  • "occurrence_Span_Code22": "string",
  • "occurrence_Span_Code23": "string",
  • "occurrence_Span_Code24": "string",
  • "occurrence_Span_Code3": "string",
  • "occurrence_Span_Code4": "string",
  • "occurrence_Span_Code5": "string",
  • "occurrence_Span_Code6": "string",
  • "occurrence_Span_Code7": "string",
  • "occurrence_Span_Code8": "string",
  • "occurrence_Span_Code9": "string",
  • "occurrence_Span_From": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From10": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From11": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From12": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From13": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From14": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From15": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From16": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From17": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From18": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From19": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From2": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From20": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From21": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From22": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From23": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From24": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From3": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From4": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From5": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From6": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From7": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From8": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From9": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru10": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru11": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru12": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru13": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru14": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru15": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru16": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru17": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru18": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru19": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru2": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru20": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru21": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru22": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru23": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru24": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru3": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru4": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru5": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru6": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru7": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru8": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru9": "2019-08-24T14:15:22Z",
  • "onset_Similar_Illness_Date": "2019-08-24T14:15:22Z",
  • "orthodontics_Treatment": true,
  • "other_Insurance": true,
  • "other_Procedure_Code1": "string",
  • "other_Procedure_Code10": "string",
  • "other_Procedure_Code11": "string",
  • "other_Procedure_Code12": "string",
  • "other_Procedure_Code13": "string",
  • "other_Procedure_Code14": "string",
  • "other_Procedure_Code15": "string",
  • "other_Procedure_Code16": "string",
  • "other_Procedure_Code17": "string",
  • "other_Procedure_Code18": "string",
  • "other_Procedure_Code19": "string",
  • "other_Procedure_Code2": "string",
  • "other_Procedure_Code20": "string",
  • "other_Procedure_Code21": "string",
  • "other_Procedure_Code22": "string",
  • "other_Procedure_Code23": "string",
  • "other_Procedure_Code3": "string",
  • "other_Procedure_Code4": "string",
  • "other_Procedure_Code5": "string",
  • "other_Procedure_Code6": "string",
  • "other_Procedure_Code7": "string",
  • "other_Procedure_Code8": "string",
  • "other_Procedure_Code9": "string",
  • "other_Procedure_Date1": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date10": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date11": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date12": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date13": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date14": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date15": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date16": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date17": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date18": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date19": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date2": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date20": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date21": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date22": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date23": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date3": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date4": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date5": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date6": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date7": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date8": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date9": "2019-08-24T14:15:22Z",
  • "override": "s",
  • "override_Date": "2019-08-24T14:15:22Z",
  • "override_Network_ID": true,
  • "override_Payor_Account": true,
  • "override_User": "string",
  • "partial_Disability": true,
  • "patient_Account": "string",
  • "patient_Reason_for_Visit_Diagnostic_Code1": "string",
  • "patient_Reason_for_Visit_Diagnostic_Code2": "string",
  • "patient_Reason_for_Visit_Diagnostic_Code3": "string",
  • "patient_Relationship": "string",
  • "patient_Signature": true,
  • "patient_Signature_Date": "2019-08-24T14:15:22Z",
  • "patient_Status": "string",
  • "payee_ID": "string",
  • "payment_Status": "s",
  • "payor_Claim_Control_Number": "string",
  • "payor_ID": "string",
  • "physician_Return_To_Work": "2019-08-24T14:15:22Z",
  • "place_Of_Service": "strin",
  • "plan_ID": "string",
  • "plan_Provider": "s",
  • "plan_Year": "string",
  • "present_On_Admission1": "s",
  • "present_On_Admission10": "s",
  • "present_On_Admission11": "s",
  • "present_On_Admission12": "s",
  • "present_On_Admission13": "s",
  • "present_On_Admission14": "s",
  • "present_On_Admission15": "s",
  • "present_On_Admission16": "s",
  • "present_On_Admission17": "s",
  • "present_On_Admission18": "s",
  • "present_On_Admission19": "s",
  • "present_On_Admission2": "s",
  • "present_On_Admission20": "s",
  • "present_On_Admission21": "s",
  • "present_On_Admission22": "s",
  • "present_On_Admission23": "s",
  • "present_On_Admission24": "s",
  • "present_On_Admission3": "s",
  • "present_On_Admission4": "s",
  • "present_On_Admission5": "s",
  • "present_On_Admission6": "s",
  • "present_On_Admission7": "s",
  • "present_On_Admission8": "s",
  • "present_On_Admission9": "s",
  • "present_On_Admission_ECode1": "s",
  • "present_On_Admission_ECode10": "s",
  • "present_On_Admission_ECode11": "s",
  • "present_On_Admission_ECode12": "s",
  • "present_On_Admission_ECode2": "s",
  • "present_On_Admission_ECode3": "s",
  • "present_On_Admission_ECode4": "s",
  • "present_On_Admission_ECode5": "s",
  • "present_On_Admission_ECode6": "s",
  • "present_On_Admission_ECode7": "s",
  • "present_On_Admission_ECode8": "s",
  • "present_On_Admission_ECode9": "s",
  • "pricing_Method": "string",
  • "pricing_Org_ID": "string",
  • "pricing_Rate": 0.1,
  • "principal_Procedure_Code": "string",
  • "principal_Procedure_Date": "2019-08-24T14:15:22Z",
  • "prior_Placement_Date": "2019-08-24T14:15:22Z",
  • "processed_Date": "2019-08-24T14:15:22Z",
  • "prosthesis_Replacement": true,
  • "provider_ID": "string",
  • "qpA_Method": "s",
  • "received_Date": "2019-08-24T14:15:22Z",
  • "referred_By": "string",
  • "refund_Claim": true,
  • "refund_Funding_Key": 0,
  • "related_To_Accident": true,
  • "related_To_Another_Party": true,
  • "related_To_Auto": true,
  • "related_To_Employment": true,
  • "relinquished_Care_Date": "2019-08-24T14:15:22Z",
  • "remittance_Printed": "s",
  • "reprice_Printed": "s",
  • "repriced_Network_ID": "string",
  • "return_To_Work_Date": "2019-08-24T14:15:22Z",
  • "salary_Continuation": true,
  • "send_Check_To": "s",
  • "sender_ID": "string",
  • "service_Date": "2019-08-24T14:15:22Z",
  • "service_Thru": "2019-08-24T14:15:22Z",
  • "sick_Time": true,
  • "statement_From_Date": "2019-08-24T14:15:22Z",
  • "statement_Thru_Date": "2019-08-24T14:15:22Z",
  • "subscriber_ID": "string",
  • "subscriber_Signature": true,
  • "survivor_Benefit": true,
  • "third_Party_Payment": true,
  • "total_COB": 0.1,
  • "trading_Partner_Key": 0,
  • "trans_837_Control_Num": "string",
  • "transaction_837": true,
  • "transaction_837_ID": "string",
  • "type_Of_Admission": "string",
  • "type_Of_Bill": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "vacation": true,
  • "value_Amount1": 0.1,
  • "value_Amount10": 0.1,
  • "value_Amount11": 0.1,
  • "value_Amount12": 0.1,
  • "value_Amount13": 0.1,
  • "value_Amount14": 0.1,
  • "value_Amount15": 0.1,
  • "value_Amount16": 0.1,
  • "value_Amount17": 0.1,
  • "value_Amount18": 0.1,
  • "value_Amount19": 0.1,
  • "value_Amount2": 0.1,
  • "value_Amount20": 0.1,
  • "value_Amount21": 0.1,
  • "value_Amount22": 0.1,
  • "value_Amount23": 0.1,
  • "value_Amount24": 0.1,
  • "value_Amount3": 0.1,
  • "value_Amount4": 0.1,
  • "value_Amount5": 0.1,
  • "value_Amount6": 0.1,
  • "value_Amount7": 0.1,
  • "value_Amount8": 0.1,
  • "value_Amount9": 0.1,
  • "value_Code1": "st",
  • "value_Code10": "st",
  • "value_Code11": "st",
  • "value_Code12": "st",
  • "value_Code13": "st",
  • "value_Code14": "st",
  • "value_Code15": "st",
  • "value_Code16": "st",
  • "value_Code17": "st",
  • "value_Code18": "st",
  • "value_Code19": "st",
  • "value_Code2": "st",
  • "value_Code20": "st",
  • "value_Code21": "st",
  • "value_Code22": "st",
  • "value_Code23": "st",
  • "value_Code24": "st",
  • "value_Code3": "st",
  • "value_Code4": "st",
  • "value_Code5": "st",
  • "value_Code6": "st",
  • "value_Code7": "st",
  • "value_Code8": "st",
  • "value_Code9": "st",
  • "void_Claim": true,
  • "volume_Override": true,
  • "waiting_Period_Claim": true
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Get Claim

Gets Claim

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
claimNumber
required
integer <int32>

Claim Number

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/claims/{claimNumber}
Request samples
Response samples
No sample

Update Claim

Updates a specific Claim.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
claimNumber
required
integer <int32>

Claim Number

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
claim_Number
required
integer <int32>

Unique identifier assigned each time a claim is processed from batch. This value can change if a claim is returned to batch and reprocessed. 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.

abF_Exported
required
boolean

Used by VBA Backroom IT Services to track export status of a claim using ABF. This has since been moved to ClaimExport tables and is no longer in use. 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.

abF_Exported_Date
string or null <date-time>

Used by VBA Backroom IT Services to track export status of a claim using ABF. This has since been moved to ClaimExport tables and is no longer in use.

aeoB_Claim
required
boolean

A flag indicating a claim is an Advanced EOB and not a claim for payment. Part of the No Surprise Act. 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.

accident_Date
string or null <date-time>

The date of accident.

account_Key
integer or null <int32>

For claim funding, indicates the payor/account this claim would be paid from.

adjustment_Claim
required
boolean

Indicates that this claim was part of an 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.

admin_Amt
number or null <double>

No longer in use.

admission_Date
string or null <date-time>

For institutional Claims, holds the Admission Date.

admission_Diagnostic_Code
string or null <= 8 characters

The admission diagnosis code if applicable for this claim.

admission_Hour
string or null <= 8 characters

For institutional Claims, holds the Admission Hour.

admission_Source
string or null <= 8 characters

For institutional Claims, holds the Admission Source.

admit_Date
string or null <date-time>

Used to identify the date the member was admitted to the Hospital if hospitalized as part of this disability.

advance_Pay
required
boolean

Indicates if this claim, for disability, can be processed and paid in advance of that service dates. 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.

advice_To_Pay
required
boolean

Notes this claim is advice to pay and will not go through funding. 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.

all_Docs_Rec_Date
string or null <date-time>

Information field used in custom processing and reporting.

ambulance_DropOff_Address
string or null <= 90 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_DropOff_Address2
string or null <= 90 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_DropOff_City
string or null <= 32 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_DropOff_Location
string or null <= 64 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_DropOff_Org_Name
string or null <= 512 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_DropOff_State
string or null <= 10 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_DropOff_Zip
string or null <= 32 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_PickUp_Address
string or null <= 90 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_PickUp_Address2
string or null <= 90 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_PickUp_City
string or null <= 32 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_PickUp_Location
string or null <= 64 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_PickUp_State
string or null <= 10 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_PickUp_Zip
string or null <= 32 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

appliance_Placed_Date
string or null <date-time>

The date the orthodontic appliance was placed.

assumed_Care_Date
string or null <date-time>

Information field used in custom processing and reporting.

attended_Physician_Date
string or null <date-time>

This identifies the date the member first visited the Physician. This field, in combination with Disabled by Physician Date and Last Day Worked, create the Disability Date for the Member.

auto_Flex
required
boolean

Notes if this Flex claim was auto-generated by the adjducation engine based on member responsibility configuration at the Group. 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.

batch_Claim
integer or null <int32>

This value, in combination with Batch_Number, creates a unique identifier for each claim that is maintained in both batch and processed.

batch_Number
integer or null <int32>

This value, in combination with Batch_Claim, creates a unique identifier for each claim that is maintained in both batch and processed.

beneficiary_ID
string or null <= 20 characters

Notes the beneficiary for Life & Disability claims. References the MemberBeneficiary.Beneficiary_ID.

cliA_Number
string or null <= 32 characters

No longer in use.

calculate_Interest
required
boolean

Notes if interest was calculated for this claim as part of adjudication. 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.

capitation_Claim
required
boolean

Indicates if this claim is 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.

ceridian_Exported
required
boolean

Used in custom integration with ceridian tax services. 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.

ceridian_Exported_Date
string or null <date-time>

Used in custom integration with ceridian tax services.

check_Batch
integer or null <int32>

This is the primary indicator if a claim is "Paid". When this value is NULL, the claim has been processed but not paid. When paid, this value will hold what Check Batch the claim was paid under. References CheckBatch.Check_Batch.

check_ID
integer or null <int32>

Holds the Check ID this claim was paid under. References Checks.Check_ID.

check_Number
string or null <= 20 characters

No longer in use.

claim_837_COB
string or null <= 1 characters

For 837 transactions, indicates COB has been submitted.

claim_Exported
required
boolean

Used by VBA Backroom IT Services to track export status of a claim. This has since been moved to ClaimExport tables and is no longer in use. 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.

claim_Exported_Date
string or null <date-time>

Used by VBA Backroom IT Services to track export status of a claim. This has since been moved to ClaimExport tables and is no longer in use.

claim_Funded_Status
string or null <= 32 characters

Indicates the Claim Funded Status for this claim, indicating if the claim is ready for funding, suspended, a candidate for payment, part of a funding request or funded.

claim_ID
string or null <= 32 characters

An identifier assigned by external vendors and used for integrations. Primarily comes from the REF*D9 value in the 837.

claim_Priority
string or null <= 1 characters

For 837 transactions, indicates the submitted claim priority.

claim_Status
string or null <= 8 characters

The status of the claim. Valid values reside in the ClaimStatus table.

claim_Type
string or null <= 20 characters

Notes the claim type for this claim. References ClaimType.Claim_Type.

closure_Effective_Date
string or null <date-time>

This is an information only field that allows the tracking of the Closure Effective Date.

condition_Code1
string or null <= 8 characters

The Condition Code value for this claim.

condition_Code10
string or null <= 8 characters
condition_Code11
string or null <= 8 characters
condition_Code12
string or null <= 8 characters
condition_Code13
string or null <= 8 characters
condition_Code14
string or null <= 8 characters
condition_Code15
string or null <= 8 characters
condition_Code16
string or null <= 8 characters
condition_Code17
string or null <= 8 characters
condition_Code18
string or null <= 8 characters
condition_Code19
string or null <= 8 characters
condition_Code2
string or null <= 8 characters

The Condition Code value for this claim.

condition_Code20
string or null <= 8 characters
condition_Code21
string or null <= 8 characters
condition_Code22
string or null <= 8 characters
condition_Code23
string or null <= 8 characters
condition_Code24
string or null <= 8 characters
condition_Code3
string or null <= 8 characters

The Condition Code value for this claim.

condition_Code4
string or null <= 8 characters

The Condition Code value for this claim.

condition_Code5
string or null <= 8 characters

The Condition Code value for this claim.

condition_Code6
string or null <= 8 characters

The Condition Code value for this claim.

condition_Code7
string or null <= 8 characters

The Condition Code value for this claim.

condition_Code8
string or null <= 8 characters
condition_Code9
string or null <= 8 characters
coverage_Start
string or null <date-time>

The patients (or Subscribers) enrollment information, references Subenrollment.Group_Coverage_Start.

current_Illness_Date
string or null <date-time>

The current illness date for this claim.

drG_Code
string or null <= 4 characters

The DRG Code for this claim, if applicable. References the DRGCodes.DRG_Code.

drG_Quantity
number or null <double>

The quantity associated with this DRG value.

death_Cert_Rec_Date
string or null <date-time>

Information field used in custom processing and reporting.

delivery_Date
string or null <date-time>

This identifies the date of delivery for disability due to pregnancy.

delivery_Type
string or null <= 1 characters

This will identify the type of delivery that is performed as a result of pregnancy.

dep_SSDI_End_Date
string or null <date-time>

This is an information only field that allows the tracking of Dependent SSI End Date.

diagnostic_Code1
string or null <= 8 characters

An assigned diagnostic code for this claim. This field, in the absence of a corresponding diagnosis pointer from a claim service line, indicates the primary diagnosis.

diagnostic_Code10
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code11
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code12
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code13
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code14
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code15
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code16
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code17
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code18
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code19
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code2
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code20
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code21
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code22
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code23
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code24
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code3
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code4
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code5
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code6
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code7
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code8
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code9
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code_Type
required
string [ 1 .. 16 ] characters

Indicates if the Diagnostic Code values on this claim are ICD9 or ICD10. Two possible values: 9 - ICD9 or 0 - ICD10.

disability_Date
string or null <date-time>

The calculated date of disability (or manually enetered) based on the disabilty advisor in VBASoftware.

disability_End_Date
string or null <date-time>

Information field used in custom processing and reporting.

disability_Type
string or null <= 20 characters

Used to identify the type of disability (Injury or Illness).

disabled_By_Physician
string or null <date-time>

This identifies the date the member was disabled by the Physician. This field, in combination with First Attended Physician Date and Last Day Worked, create the Disability Date for the Member.

discharge_Date
string or null <date-time>

Used to identify the date the member was discharged from the Hospital if hospitalized as part of this disability.

discharge_Hour
string or null <= 8 characters

For institutional Claims, holds the Discharge Hour.

division_ID
string or null <= 20 characters

The patients (or Subscribers) enrollment information, references Subenrollment.Division_ID.

eCode_Diagnostic_Code
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code10
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code11
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code12
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code2
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code3
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code4
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code5
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code6
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code7
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code8
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code9
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

epsdT_Condition_Indicator1
string or null <= 3 characters

Early and Periodic Screening, Diagnostic, and Treatment Indicator tracked from the claim submission.

epsdT_Condition_Indicator2
string or null <= 3 characters

Early and Periodic Screening, Diagnostic, and Treatment Indicator tracked from the claim submission.

epsdT_Condition_Indicator3
string or null <= 3 characters

Early and Periodic Screening, Diagnostic, and Treatment Indicator tracked from the claim submission.

epsdT_Referral_Given
string or null <= 1 characters

Early and Periodic Screening, Diagnostic, and Treatment tracking for if a referral was given for this claim.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

ex_Code1
string or null <= 6 characters

A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code.

ex_Code2
string or null <= 6 characters

A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code.

ex_Code3
string or null <= 8 characters

A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code.

ex_Code4
string or null <= 8 characters

A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code.

exhaust_Date
string or null <date-time>

This is the Exhaust Date of the members Disability.

expected_Typical_Duration
integer or null <int32>

Expected Typical Duration (ETD) is the duration of disability identified by the MDA based on the type of job the member has as well as the diagnosis of the disability.

ficA_Percent
number or null <double>

This will hold the FICA withhold amount for each payment. If tax calculation module is enabled, this option will be ignored.

federal_Withheld
number or null <double>

This will hold the federal withhold amount for each payment. If tax calculation module is enabled, this option will be ignored.

filing_Indicator
string or null <= 2 characters

No longer in use.

followUp_Date
string or null <date-time>

This will place a follow-up date on each payment as an additional identifier for when this disability should be reviewed.

followUp_Ex_Code
string or null <= 6 characters

This will place a follow-up ex code on each payment to allow the user to categorize what type of follow-up is being performed.

freq_Code
string or null <= 8 characters

Medicare Resubmission code for the claim. Indicated in Box 22 of the claim report.

group_ID
string or null <= 20 characters

The patients (or Subscribers) enrollment information, references Subenrollment.Group_ID.

hearing_Vision_RX_Date
string or null <date-time>

Information field used in custom processing and reporting.

image_File_Location
string or null <= 128 characters

Stores a reference, if applicable, to an image or document associated with this claim.

image_File_Location2
string or null <= 128 characters

Stores a reference, if applicable, to an image or document associated with this claim.

image_File_Location3
string or null <= 128 characters

Stores a reference, if applicable, to an image or document associated with this claim.

image_File_Location4
string or null <= 128 characters

Stores a reference, if applicable, to an image or document associated with this claim.

initial_Treatment_Date
string or null <date-time>

Information field to track the initial treatment date for this claim.

job_Type
string or null <= 2 characters

This is the job classification for the member going on disability.

ltD_Effective_Date
string or null <date-time>

This is an information only field that holds the date the member went on Long-Term Disability.

ltD_Packet_Date
string or null <date-time>

This is an information only field that tracks the date the Long-Term Disability Packet was sent.

last_Day_Worked
string or null <date-time>

This identifies the date the member last attended work prior to going on disability. This field, in combination with First Attended Physician Date and Disabled by Physician, create the Disability Date for the Member.

last_Physician_Warrant_Date
string or null <date-time>

This is an information only field that allows for the tracking of the Physician Warrant Date.

last_Seen_Date
string or null <date-time>

Information field to track the last time a phyician was seen at the time of this claim submission.

liability_Injury
required
boolean

This is an information only field that identifies if this disability is a liability injury. 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.

mail_To
string or null <= 1 characters

Notes if the payment should be mailed to an entity other than the "Send_Check_To".

member_Seq
string or null <= 2 characters

The Member Sequence of the patient for this claim.

months_Of_Treatment
integer or null <int32>

The number of months the orthodontic treatment will be.

network_ID
string or null <= 10 characters

Indicates the network this claim was paid against. If this value is NULL, the claim is considered "Out of Network".

note
string or null <= 24 characters

No longer in use. Replaced by Note Services.

occupational
required
boolean

Notes if the disability is related to the patiens occupation. 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.

occurrence_Code1
string or null <= 8 characters

The Occurrence Code value for this claim.

occurrence_Code10
string or null <= 8 characters
occurrence_Code11
string or null <= 8 characters
occurrence_Code12
string or null <= 8 characters
occurrence_Code13
string or null <= 8 characters
occurrence_Code14
string or null <= 8 characters
occurrence_Code15
string or null <= 8 characters
occurrence_Code16
string or null <= 8 characters
occurrence_Code17
string or null <= 8 characters
occurrence_Code18
string or null <= 8 characters
occurrence_Code19
string or null <= 8 characters
occurrence_Code2
string or null <= 8 characters

The Occurrence Code value for this claim.

occurrence_Code20
string or null <= 8 characters
occurrence_Code21
string or null <= 8 characters
occurrence_Code22
string or null <= 8 characters
occurrence_Code23
string or null <= 8 characters
occurrence_Code24
string or null <= 8 characters
occurrence_Code3
string or null <= 8 characters

The Occurrence Code value for this claim.

occurrence_Code4
string or null <= 8 characters

The Occurrence Code value for this claim.

occurrence_Code5
string or null <= 8 characters
occurrence_Code6
string or null <= 8 characters
occurrence_Code7
string or null <= 8 characters
occurrence_Code8
string or null <= 8 characters
occurrence_Code9
string or null <= 8 characters
occurrence_Date1
string or null <date-time>

The Occurrence Date associated to the assigned Occurrence Codes.

occurrence_Date10
string or null <date-time>
occurrence_Date11
string or null <date-time>
occurrence_Date12
string or null <date-time>
occurrence_Date13
string or null <date-time>
occurrence_Date14
string or null <date-time>
occurrence_Date15
string or null <date-time>
occurrence_Date16
string or null <date-time>
occurrence_Date17
string or null <date-time>
occurrence_Date18
string or null <date-time>
occurrence_Date19
string or null <date-time>
occurrence_Date2
string or null <date-time>

The Occurrence Date associated to the assigned Occurrence Codes.

occurrence_Date20
string or null <date-time>
occurrence_Date21
string or null <date-time>
occurrence_Date22
string or null <date-time>
occurrence_Date23
string or null <date-time>
occurrence_Date24
string or null <date-time>
occurrence_Date3
string or null <date-time>

The Occurrence Date associated to the assigned Occurrence Codes.

occurrence_Date4
string or null <date-time>

The Occurrence Date associated to the assigned Occurrence Codes.

occurrence_Date5
string or null <date-time>
occurrence_Date6
string or null <date-time>
occurrence_Date7
string or null <date-time>
occurrence_Date8
string or null <date-time>
occurrence_Date9
string or null <date-time>
occurrence_Span_Code
string or null <= 8 characters

The occurrence span indicator for the Occurrence Span From and Thru dates.

occurrence_Span_Code10
string or null <= 8 characters
occurrence_Span_Code11
string or null <= 8 characters
occurrence_Span_Code12
string or null <= 8 characters
occurrence_Span_Code13
string or null <= 8 characters
occurrence_Span_Code14
string or null <= 8 characters
occurrence_Span_Code15
string or null <= 8 characters
occurrence_Span_Code16
string or null <= 8 characters
occurrence_Span_Code17
string or null <= 8 characters
occurrence_Span_Code18
string or null <= 8 characters
occurrence_Span_Code19
string or null <= 8 characters
occurrence_Span_Code2
string or null <= 8 characters
occurrence_Span_Code20
string or null <= 8 characters
occurrence_Span_Code21
string or null <= 8 characters
occurrence_Span_Code22
string or null <= 8 characters
occurrence_Span_Code23
string or null <= 8 characters
occurrence_Span_Code24
string or null <= 8 characters
occurrence_Span_Code3
string or null <= 8 characters
occurrence_Span_Code4
string or null <= 8 characters
occurrence_Span_Code5
string or null <= 8 characters
occurrence_Span_Code6
string or null <= 8 characters
occurrence_Span_Code7
string or null <= 8 characters
occurrence_Span_Code8
string or null <= 8 characters
occurrence_Span_Code9
string or null <= 8 characters
occurrence_Span_From
string or null <date-time>

The occurrence span from for this claim.

occurrence_Span_From10
string or null <date-time>
occurrence_Span_From11
string or null <date-time>
occurrence_Span_From12
string or null <date-time>
occurrence_Span_From13
string or null <date-time>
occurrence_Span_From14
string or null <date-time>
occurrence_Span_From15
string or null <date-time>
occurrence_Span_From16
string or null <date-time>
occurrence_Span_From17
string or null <date-time>
occurrence_Span_From18
string or null <date-time>
occurrence_Span_From19
string or null <date-time>
occurrence_Span_From2
string or null <date-time>
occurrence_Span_From20
string or null <date-time>
occurrence_Span_From21
string or null <date-time>
occurrence_Span_From22
string or null <date-time>
occurrence_Span_From23
string or null <date-time>
occurrence_Span_From24
string or null <date-time>
occurrence_Span_From3
string or null <date-time>
occurrence_Span_From4
string or null <date-time>
occurrence_Span_From5
string or null <date-time>
occurrence_Span_From6
string or null <date-time>
occurrence_Span_From7
string or null <date-time>
occurrence_Span_From8
string or null <date-time>
occurrence_Span_From9
string or null <date-time>
occurrence_Span_Thru
string or null <date-time>

The occurrence span thru for this claim.

occurrence_Span_Thru10
string or null <date-time>
occurrence_Span_Thru11
string or null <date-time>
occurrence_Span_Thru12
string or null <date-time>
occurrence_Span_Thru13
string or null <date-time>
occurrence_Span_Thru14
string or null <date-time>
occurrence_Span_Thru15
string or null <date-time>
occurrence_Span_Thru16
string or null <date-time>
occurrence_Span_Thru17
string or null <date-time>
occurrence_Span_Thru18
string or null <date-time>
occurrence_Span_Thru19
string or null <date-time>
occurrence_Span_Thru2
string or null <date-time>
occurrence_Span_Thru20
string or null <date-time>
occurrence_Span_Thru21
string or null <date-time>
occurrence_Span_Thru22
string or null <date-time>
occurrence_Span_Thru23
string or null <date-time>
occurrence_Span_Thru24
string or null <date-time>
occurrence_Span_Thru3
string or null <date-time>
occurrence_Span_Thru4
string or null <date-time>
occurrence_Span_Thru5
string or null <date-time>
occurrence_Span_Thru6
string or null <date-time>
occurrence_Span_Thru7
string or null <date-time>
occurrence_Span_Thru8
string or null <date-time>
occurrence_Span_Thru9
string or null <date-time>
onset_Similar_Illness_Date
string or null <date-time>

Notes the date of the original illness if this claim is associated to that illness.

orthodontics_Treatment
required
boolean

When this flag is checked, it indicates the dental claim is for orthodontics. 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.

other_Insurance
required
boolean

Indicates if other insurance is applicable on this claim. This indicator unlocks COB amount fields on the ClaimDetail (service line). 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.

other_Procedure_Code1
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code10
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code11
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code12
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code13
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code14
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code15
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code16
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code17
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code18
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code19
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code2
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code20
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code21
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code22
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code23
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code3
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code4
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code5
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code6
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code7
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code8
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code9
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Date1
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date10
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date11
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date12
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date13
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date14
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date15
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date16
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date17
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date18
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date19
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date2
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date20
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date21
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date22
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date23
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date3
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date4
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date5
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date6
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date7
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date8
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date9
string or null <date-time>

Date associated with the additional procedure code.

override
string or null <= 1 characters

No longer in use.

override_Date
string or null <date-time>

No longer in use.

override_Network_ID
required
boolean

This indicator lets the system know that the front end user has assigned this network ID and not adjudication. 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.

override_Payor_Account
required
boolean

Users can choose the payor from the More Information screen and this flag prevents adjudication from using the expected payor. 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.

override_User
string or null <= 16 characters

No longer in use.

partial_Disability
required
boolean

This will identify if this is a partial disability payment. Partial Disability payments have additional tax and payment rules applied during adjudication. 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.

patient_Account
string or null <= 128 characters

For the servicing provider, this indicates the patient account identifier in their practice management system.

patient_Reason_for_Visit_Diagnostic_Code1
string or null <= 8 characters

Reason for Visit code on Diagnosis Code 1

patient_Reason_for_Visit_Diagnostic_Code2
string or null <= 8 characters

Reason for Visit code on Diagnosis Code 2

patient_Reason_for_Visit_Diagnostic_Code3
string or null <= 8 characters

Reason for Visit code on Diagnosis Code 3

patient_Relationship
string or null <= 8 characters

Holds the relationship of the patient to the insured.

patient_Signature
required
boolean

Indicates if the patient signature has been collected. 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.

patient_Signature_Date
string or null <date-time>

Indicates the date of the patient signature being collected.

patient_Status
string or null <= 8 characters

For institutional Claims, holds the Patient Status.

payee_ID
string or null <= 20 characters

The billing provider (payee) for this claim. References the ProviderPayee.Payee_ID (by Provider_ID).

payment_Status
string or null <= 1 characters

No longer in use.

payor_Claim_Control_Number
string or null <= 64 characters

A claim reference number used in conjunction with the Medicare Resubmission code. Indicated in Box 22 of the claim report.

payor_ID
string or null <= 20 characters

For claim funding, indicates the payor/account this claim would be paid from.

physician_Return_To_Work
string or null <date-time>

This is the Return to Work date identified by the Physician at the start of disability. This may or may not be the actual date the member returns to work.

place_Of_Service
string or null <= 5 characters

Some transactions hold the Place of Service at the header but typically this value is empty and the ClaimDetail.Place_Of_Service is used for each service line. This value is not used in standard processing.

plan_ID
string or null <= 20 characters

Holds the plan the patient is enrolled in and that benefits are assigned.

plan_Provider
string or null <= 1 characters

No longer in use.

plan_Year
string or null <= 8 characters

Indicates the Plan Year this claim is processed under. This drives accumulator calculations and referneces the GroupPlanYear.Plan_Year value.

present_On_Admission1
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 1.

present_On_Admission10
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 10.

present_On_Admission11
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 11.

present_On_Admission12
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 12.

present_On_Admission13
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 13.

present_On_Admission14
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 14.

present_On_Admission15
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 15.

present_On_Admission16
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 16.

present_On_Admission17
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 17.

present_On_Admission18
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 18.

present_On_Admission19
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 19.

present_On_Admission2
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 2.

present_On_Admission20
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 20.

present_On_Admission21
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 21.

present_On_Admission22
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 22.

present_On_Admission23
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 23.

present_On_Admission24
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 24.

present_On_Admission3
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 3.

present_On_Admission4
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 4.

present_On_Admission5
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 5.

present_On_Admission6
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 6.

present_On_Admission7
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 7.

present_On_Admission8
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 8.

present_On_Admission9
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 9.

present_On_Admission_ECode1
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 1.

present_On_Admission_ECode10
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 10.

present_On_Admission_ECode11
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 11.

present_On_Admission_ECode12
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 12.

present_On_Admission_ECode2
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 2.

present_On_Admission_ECode3
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 3.

present_On_Admission_ECode4
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 4.

present_On_Admission_ECode5
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 5.

present_On_Admission_ECode6
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 6.

present_On_Admission_ECode7
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 7.

present_On_Admission_ECode8
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 8.

present_On_Admission_ECode9
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 9.

pricing_Method
string or null <= 8 characters

For reprice claims (typically submitted via 837), this notes the reprice method used to reprice this claim.

pricing_Org_ID
string or null <= 50 characters

The ID of the pricing organization. Data is obtained in segment HCP04 on an 837.

pricing_Rate
number or null <double>

The rate associated with the reprice method (Pricing_Method).

principal_Procedure_Code
string or null <= 8 characters

The principal procedure (ICD10 Diagnosis) for this claim submission.

principal_Procedure_Date
string or null <date-time>

The principal procedure date.

prior_Placement_Date
string or null <date-time>

The date of a previous prosthetic or crown applied, if there was one.

processed_Date
string or null <date-time>

The date the claim was processed from batch.

prosthesis_Replacement
required
boolean

This flag indicates if this claim is for the replacement of a prosthesis. 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.

provider_ID
string or null <= 20 characters

The provider ID of the servicing provider. References Provider.Provider_ID.

qpA_Method
string or null <= 1 characters

Overrides the QPA Method set on the Plan for this claim.

received_Date
string or null <date-time>

The date this claim was received into the admin system.

referred_By
string or null <= 30 characters

Information field to track if a referral was sent for this claim.

refund_Claim
required
boolean

Indicates that this claim was part of a Refund 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.

refund_Funding_Key
integer or null <int32>

If this claim was part of a refund process, this will hold the reference to the receipt generated by the refund process.

related_To_Accident
required
boolean

Indicates if the claim is related to a non-car accident. 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.

related_To_Another_Party
required
boolean

Indicates if the claim was casued by a third party. 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.

related_To_Auto
required
boolean

Indicates if the claim is related to a car accident. 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.

related_To_Employment
required
boolean

Indicates if the claim is work related. 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.

relinquished_Care_Date
string or null <date-time>

Information field used in custom processing and reporting.

remittance_Printed
string or null <= 1 characters

No longer in use.

reprice_Printed
string or null <= 1 characters

No longer in use.

repriced_Network_ID
string or null <= 50 characters

As part of reprice claim submissions (via 837), this will hold the repricing network.

return_To_Work_Date
string or null <date-time>

This is the date the member Returned to Work. This date affects the total payments created as well as other calculations during adjudication.

salary_Continuation
required
boolean

This flag identifies that there is salary continuation during this disability. 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.

send_Check_To
string or null <= 1 characters

Indicates the entity that should be paid for this claim. S - Subscriber, G - Group, B - Beneficiary, P - Payee, or V - Provider.

sender_ID
string or null <= 15 characters

The Sender ID sent inbound for x12 (837) transactions.

service_Date
string or null <date-time>

The earliest Service_Date of all service lines on this claim.

service_Thru
string or null <date-time>

The latest Service_Thru for all service lines on this claim.

sick_Time
required
boolean

This flag identifies that there is sick time during this disability. 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.

statement_From_Date
string or null <date-time>

For Institutional Claims, holds the Statement Date.

statement_Thru_Date
string or null <date-time>

For Institutional Claims, holds the Statement Date.

subscriber_ID
string or null <= 9 characters

The Subscriber ID of the patient for this claim.

subscriber_Signature
required
boolean

Indicates if the insured signature has been collected. 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.

survivor_Benefit
required
boolean

Indicates if Survivor Benefit was applied for this disability payment. 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.

third_Party_Payment
required
boolean

For disability, indicates if this professional claim is a 3rd party payment (typically related to alimony, garnishment, etc.) 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.

total_COB
required
number <double>

COB total for all claim detail lines 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.

trading_Partner_Key
integer or null <int32>

No longer in use.

trans_837_Control_Num
string or null <= 9 characters

For 837 transactions, this is the control number assgined by the submitter.

transaction_837
required
boolean

Indicates this is a claim entered by an inbound 837. 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.

transaction_837_ID
string or null <= 30 characters

For 837 transactions, this holds the transaction ID assigned by the submission.

type_Of_Admission
string or null <= 6 characters

The Admission Type associated to this claim.

type_Of_Bill
string or null <= 6 characters

The Bill Type associated to this claim. References BillType.Type_Of_Bill.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

vacation
required
boolean

This flag identifies that there is vacation during this disability. 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.

value_Amount1
number or null <double>

The monetary amount related to the value code.

value_Amount10
number or null <double>
value_Amount11
number or null <double>
value_Amount12
number or null <double>
value_Amount13
number or null <double>
value_Amount14
number or null <double>
value_Amount15
number or null <double>
value_Amount16
number or null <double>
value_Amount17
number or null <double>
value_Amount18
number or null <double>
value_Amount19
number or null <double>
value_Amount2
number or null <double>

The monetary amount related to the value code.

value_Amount20
number or null <double>
value_Amount21
number or null <double>
value_Amount22
number or null <double>
value_Amount23
number or null <double>
value_Amount24
number or null <double>
value_Amount3
number or null <double>

The monetary amount related to the value code.

value_Amount4
number or null <double>

The monetary amount related to the value code.

value_Amount5
number or null <double>
value_Amount6
number or null <double>
value_Amount7
number or null <double>
value_Amount8
number or null <double>
value_Amount9
number or null <double>
value_Code1
string or null <= 2 characters

The code indicating a monetary condition which was used by the intermediary to process an institutional claim.

value_Code10
string or null <= 2 characters
value_Code11
string or null <= 2 characters
value_Code12
string or null <= 2 characters
value_Code13
string or null <= 2 characters
value_Code14
string or null <= 2 characters
value_Code15
string or null <= 2 characters
value_Code16
string or null <= 2 characters
value_Code17
string or null <= 2 characters
value_Code18
string or null <= 2 characters
value_Code19
string or null <= 2 characters
value_Code2
string or null <= 2 characters

The code indicating a monetary condition which was used by the intermediary to process an institutional claim.

value_Code20
string or null <= 2 characters
value_Code21
string or null <= 2 characters
value_Code22
string or null <= 2 characters
value_Code23
string or null <= 2 characters
value_Code24
string or null <= 2 characters
value_Code3
string or null <= 2 characters

The code indicating a monetary condition which was used by the intermediary to process an institutional claim.

value_Code4
string or null <= 2 characters

The code indicating a monetary condition which was used by the intermediary to process an institutional claim.

value_Code5
string or null <= 2 characters
value_Code6
string or null <= 2 characters
value_Code7
string or null <= 2 characters
value_Code8
string or null <= 2 characters
value_Code9
string or null <= 2 characters
void_Claim
required
boolean

Indicates that this claim was part of a Void 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.

volume_Override
required
boolean

Notes that the benefit amount, for disability claims, has been manually overridden. 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.

waiting_Period_Claim
required
boolean

Indicates if this disability payment is a waiting period payment. 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.

Responses
200

Success

401

Unauthorized

put/claims/{claimNumber}
Request samples
{
  • "claim_Number": 0,
  • "abF_Exported": true,
  • "abF_Exported_Date": "2019-08-24T14:15:22Z",
  • "aeoB_Claim": true,
  • "accident_Date": "2019-08-24T14:15:22Z",
  • "account_Key": 0,
  • "adjustment_Claim": true,
  • "admin_Amt": 0.1,
  • "admission_Date": "2019-08-24T14:15:22Z",
  • "admission_Diagnostic_Code": "string",
  • "admission_Hour": "string",
  • "admission_Source": "string",
  • "admit_Date": "2019-08-24T14:15:22Z",
  • "advance_Pay": true,
  • "advice_To_Pay": true,
  • "all_Docs_Rec_Date": "2019-08-24T14:15:22Z",
  • "ambulance_DropOff_Address": "string",
  • "ambulance_DropOff_Address2": "string",
  • "ambulance_DropOff_City": "string",
  • "ambulance_DropOff_Location": "string",
  • "ambulance_DropOff_Org_Name": "string",
  • "ambulance_DropOff_State": "string",
  • "ambulance_DropOff_Zip": "string",
  • "ambulance_PickUp_Address": "string",
  • "ambulance_PickUp_Address2": "string",
  • "ambulance_PickUp_City": "string",
  • "ambulance_PickUp_Location": "string",
  • "ambulance_PickUp_State": "string",
  • "ambulance_PickUp_Zip": "string",
  • "appliance_Placed_Date": "2019-08-24T14:15:22Z",
  • "assumed_Care_Date": "2019-08-24T14:15:22Z",
  • "attended_Physician_Date": "2019-08-24T14:15:22Z",
  • "auto_Flex": true,
  • "batch_Claim": 0,
  • "batch_Number": 0,
  • "beneficiary_ID": "string",
  • "cliA_Number": "string",
  • "calculate_Interest": true,
  • "capitation_Claim": true,
  • "ceridian_Exported": true,
  • "ceridian_Exported_Date": "2019-08-24T14:15:22Z",
  • "check_Batch": 0,
  • "check_ID": 0,
  • "check_Number": "string",
  • "claim_837_COB": "s",
  • "claim_Exported": true,
  • "claim_Exported_Date": "2019-08-24T14:15:22Z",
  • "claim_Funded_Status": "string",
  • "claim_ID": "string",
  • "claim_Priority": "s",
  • "claim_Status": "string",
  • "claim_Type": "string",
  • "closure_Effective_Date": "2019-08-24T14:15:22Z",
  • "condition_Code1": "string",
  • "condition_Code10": "string",
  • "condition_Code11": "string",
  • "condition_Code12": "string",
  • "condition_Code13": "string",
  • "condition_Code14": "string",
  • "condition_Code15": "string",
  • "condition_Code16": "string",
  • "condition_Code17": "string",
  • "condition_Code18": "string",
  • "condition_Code19": "string",
  • "condition_Code2": "string",
  • "condition_Code20": "string",
  • "condition_Code21": "string",
  • "condition_Code22": "string",
  • "condition_Code23": "string",
  • "condition_Code24": "string",
  • "condition_Code3": "string",
  • "condition_Code4": "string",
  • "condition_Code5": "string",
  • "condition_Code6": "string",
  • "condition_Code7": "string",
  • "condition_Code8": "string",
  • "condition_Code9": "string",
  • "coverage_Start": "2019-08-24T14:15:22Z",
  • "current_Illness_Date": "2019-08-24T14:15:22Z",
  • "drG_Code": "stri",
  • "drG_Quantity": 0.1,
  • "death_Cert_Rec_Date": "2019-08-24T14:15:22Z",
  • "delivery_Date": "2019-08-24T14:15:22Z",
  • "delivery_Type": "s",
  • "dep_SSDI_End_Date": "2019-08-24T14:15:22Z",
  • "diagnostic_Code1": "string",
  • "diagnostic_Code10": "string",
  • "diagnostic_Code11": "string",
  • "diagnostic_Code12": "string",
  • "diagnostic_Code13": "string",
  • "diagnostic_Code14": "string",
  • "diagnostic_Code15": "string",
  • "diagnostic_Code16": "string",
  • "diagnostic_Code17": "string",
  • "diagnostic_Code18": "string",
  • "diagnostic_Code19": "string",
  • "diagnostic_Code2": "string",
  • "diagnostic_Code20": "string",
  • "diagnostic_Code21": "string",
  • "diagnostic_Code22": "string",
  • "diagnostic_Code23": "string",
  • "diagnostic_Code24": "string",
  • "diagnostic_Code3": "string",
  • "diagnostic_Code4": "string",
  • "diagnostic_Code5": "string",
  • "diagnostic_Code6": "string",
  • "diagnostic_Code7": "string",
  • "diagnostic_Code8": "string",
  • "diagnostic_Code9": "string",
  • "diagnostic_Code_Type": "string",
  • "disability_Date": "2019-08-24T14:15:22Z",
  • "disability_End_Date": "2019-08-24T14:15:22Z",
  • "disability_Type": "string",
  • "disabled_By_Physician": "2019-08-24T14:15:22Z",
  • "discharge_Date": "2019-08-24T14:15:22Z",
  • "discharge_Hour": "string",
  • "division_ID": "string",
  • "eCode_Diagnostic_Code": "string",
  • "eCode_Diagnostic_Code10": "string",
  • "eCode_Diagnostic_Code11": "string",
  • "eCode_Diagnostic_Code12": "string",
  • "eCode_Diagnostic_Code2": "string",
  • "eCode_Diagnostic_Code3": "string",
  • "eCode_Diagnostic_Code4": "string",
  • "eCode_Diagnostic_Code5": "string",
  • "eCode_Diagnostic_Code6": "string",
  • "eCode_Diagnostic_Code7": "string",
  • "eCode_Diagnostic_Code8": "string",
  • "eCode_Diagnostic_Code9": "string",
  • "epsdT_Condition_Indicator1": "str",
  • "epsdT_Condition_Indicator2": "str",
  • "epsdT_Condition_Indicator3": "str",
  • "epsdT_Referral_Given": "s",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code1": "string",
  • "ex_Code2": "string",
  • "ex_Code3": "string",
  • "ex_Code4": "string",
  • "exhaust_Date": "2019-08-24T14:15:22Z",
  • "expected_Typical_Duration": 0,
  • "ficA_Percent": 0.1,
  • "federal_Withheld": 0.1,
  • "filing_Indicator": "st",
  • "followUp_Date": "2019-08-24T14:15:22Z",
  • "followUp_Ex_Code": "string",
  • "freq_Code": "string",
  • "group_ID": "string",
  • "hearing_Vision_RX_Date": "2019-08-24T14:15:22Z",
  • "image_File_Location": "string",
  • "image_File_Location2": "string",
  • "image_File_Location3": "string",
  • "image_File_Location4": "string",
  • "initial_Treatment_Date": "2019-08-24T14:15:22Z",
  • "job_Type": "st",
  • "ltD_Effective_Date": "2019-08-24T14:15:22Z",
  • "ltD_Packet_Date": "2019-08-24T14:15:22Z",
  • "last_Day_Worked": "2019-08-24T14:15:22Z",
  • "last_Physician_Warrant_Date": "2019-08-24T14:15:22Z",
  • "last_Seen_Date": "2019-08-24T14:15:22Z",
  • "liability_Injury": true,
  • "mail_To": "s",
  • "member_Seq": "st",
  • "months_Of_Treatment": 0,
  • "network_ID": "string",
  • "note": "string",
  • "occupational": true,
  • "occurrence_Code1": "string",
  • "occurrence_Code10": "string",
  • "occurrence_Code11": "string",
  • "occurrence_Code12": "string",
  • "occurrence_Code13": "string",
  • "occurrence_Code14": "string",
  • "occurrence_Code15": "string",
  • "occurrence_Code16": "string",
  • "occurrence_Code17": "string",
  • "occurrence_Code18": "string",
  • "occurrence_Code19": "string",
  • "occurrence_Code2": "string",
  • "occurrence_Code20": "string",
  • "occurrence_Code21": "string",
  • "occurrence_Code22": "string",
  • "occurrence_Code23": "string",
  • "occurrence_Code24": "string",
  • "occurrence_Code3": "string",
  • "occurrence_Code4": "string",
  • "occurrence_Code5": "string",
  • "occurrence_Code6": "string",
  • "occurrence_Code7": "string",
  • "occurrence_Code8": "string",
  • "occurrence_Code9": "string",
  • "occurrence_Date1": "2019-08-24T14:15:22Z",
  • "occurrence_Date10": "2019-08-24T14:15:22Z",
  • "occurrence_Date11": "2019-08-24T14:15:22Z",
  • "occurrence_Date12": "2019-08-24T14:15:22Z",
  • "occurrence_Date13": "2019-08-24T14:15:22Z",
  • "occurrence_Date14": "2019-08-24T14:15:22Z",
  • "occurrence_Date15": "2019-08-24T14:15:22Z",
  • "occurrence_Date16": "2019-08-24T14:15:22Z",
  • "occurrence_Date17": "2019-08-24T14:15:22Z",
  • "occurrence_Date18": "2019-08-24T14:15:22Z",
  • "occurrence_Date19": "2019-08-24T14:15:22Z",
  • "occurrence_Date2": "2019-08-24T14:15:22Z",
  • "occurrence_Date20": "2019-08-24T14:15:22Z",
  • "occurrence_Date21": "2019-08-24T14:15:22Z",
  • "occurrence_Date22": "2019-08-24T14:15:22Z",
  • "occurrence_Date23": "2019-08-24T14:15:22Z",
  • "occurrence_Date24": "2019-08-24T14:15:22Z",
  • "occurrence_Date3": "2019-08-24T14:15:22Z",
  • "occurrence_Date4": "2019-08-24T14:15:22Z",
  • "occurrence_Date5": "2019-08-24T14:15:22Z",
  • "occurrence_Date6": "2019-08-24T14:15:22Z",
  • "occurrence_Date7": "2019-08-24T14:15:22Z",
  • "occurrence_Date8": "2019-08-24T14:15:22Z",
  • "occurrence_Date9": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Code": "string",
  • "occurrence_Span_Code10": "string",
  • "occurrence_Span_Code11": "string",
  • "occurrence_Span_Code12": "string",
  • "occurrence_Span_Code13": "string",
  • "occurrence_Span_Code14": "string",
  • "occurrence_Span_Code15": "string",
  • "occurrence_Span_Code16": "string",
  • "occurrence_Span_Code17": "string",
  • "occurrence_Span_Code18": "string",
  • "occurrence_Span_Code19": "string",
  • "occurrence_Span_Code2": "string",
  • "occurrence_Span_Code20": "string",
  • "occurrence_Span_Code21": "string",
  • "occurrence_Span_Code22": "string",
  • "occurrence_Span_Code23": "string",
  • "occurrence_Span_Code24": "string",
  • "occurrence_Span_Code3": "string",
  • "occurrence_Span_Code4": "string",
  • "occurrence_Span_Code5": "string",
  • "occurrence_Span_Code6": "string",
  • "occurrence_Span_Code7": "string",
  • "occurrence_Span_Code8": "string",
  • "occurrence_Span_Code9": "string",
  • "occurrence_Span_From": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From10": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From11": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From12": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From13": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From14": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From15": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From16": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From17": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From18": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From19": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From2": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From20": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From21": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From22": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From23": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From24": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From3": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From4": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From5": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From6": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From7": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From8": "2019-08-24T14:15:22Z",
  • "occurrence_Span_From9": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru10": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru11": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru12": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru13": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru14": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru15": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru16": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru17": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru18": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru19": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru2": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru20": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru21": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru22": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru23": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru24": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru3": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru4": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru5": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru6": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru7": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru8": "2019-08-24T14:15:22Z",
  • "occurrence_Span_Thru9": "2019-08-24T14:15:22Z",
  • "onset_Similar_Illness_Date": "2019-08-24T14:15:22Z",
  • "orthodontics_Treatment": true,
  • "other_Insurance": true,
  • "other_Procedure_Code1": "string",
  • "other_Procedure_Code10": "string",
  • "other_Procedure_Code11": "string",
  • "other_Procedure_Code12": "string",
  • "other_Procedure_Code13": "string",
  • "other_Procedure_Code14": "string",
  • "other_Procedure_Code15": "string",
  • "other_Procedure_Code16": "string",
  • "other_Procedure_Code17": "string",
  • "other_Procedure_Code18": "string",
  • "other_Procedure_Code19": "string",
  • "other_Procedure_Code2": "string",
  • "other_Procedure_Code20": "string",
  • "other_Procedure_Code21": "string",
  • "other_Procedure_Code22": "string",
  • "other_Procedure_Code23": "string",
  • "other_Procedure_Code3": "string",
  • "other_Procedure_Code4": "string",
  • "other_Procedure_Code5": "string",
  • "other_Procedure_Code6": "string",
  • "other_Procedure_Code7": "string",
  • "other_Procedure_Code8": "string",
  • "other_Procedure_Code9": "string",
  • "other_Procedure_Date1": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date10": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date11": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date12": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date13": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date14": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date15": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date16": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date17": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date18": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date19": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date2": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date20": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date21": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date22": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date23": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date3": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date4": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date5": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date6": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date7": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date8": "2019-08-24T14:15:22Z",
  • "other_Procedure_Date9": "2019-08-24T14:15:22Z",
  • "override": "s",
  • "override_Date": "2019-08-24T14:15:22Z",
  • "override_Network_ID": true,
  • "override_Payor_Account": true,
  • "override_User": "string",
  • "partial_Disability": true,
  • "patient_Account": "string",
  • "patient_Reason_for_Visit_Diagnostic_Code1": "string",
  • "patient_Reason_for_Visit_Diagnostic_Code2": "string",
  • "patient_Reason_for_Visit_Diagnostic_Code3": "string",
  • "patient_Relationship": "string",
  • "patient_Signature": true,
  • "patient_Signature_Date": "2019-08-24T14:15:22Z",
  • "patient_Status": "string",
  • "payee_ID": "string",
  • "payment_Status": "s",
  • "payor_Claim_Control_Number": "string",
  • "payor_ID": "string",
  • "physician_Return_To_Work": "2019-08-24T14:15:22Z",
  • "place_Of_Service": "strin",
  • "plan_ID": "string",
  • "plan_Provider": "s",
  • "plan_Year": "string",
  • "present_On_Admission1": "s",
  • "present_On_Admission10": "s",
  • "present_On_Admission11": "s",
  • "present_On_Admission12": "s",
  • "present_On_Admission13": "s",
  • "present_On_Admission14": "s",
  • "present_On_Admission15": "s",
  • "present_On_Admission16": "s",
  • "present_On_Admission17": "s",
  • "present_On_Admission18": "s",
  • "present_On_Admission19": "s",
  • "present_On_Admission2": "s",
  • "present_On_Admission20": "s",
  • "present_On_Admission21": "s",
  • "present_On_Admission22": "s",
  • "present_On_Admission23": "s",
  • "present_On_Admission24": "s",
  • "present_On_Admission3": "s",
  • "present_On_Admission4": "s",
  • "present_On_Admission5": "s",
  • "present_On_Admission6": "s",
  • "present_On_Admission7": "s",
  • "present_On_Admission8": "s",
  • "present_On_Admission9": "s",
  • "present_On_Admission_ECode1": "s",
  • "present_On_Admission_ECode10": "s",
  • "present_On_Admission_ECode11": "s",
  • "present_On_Admission_ECode12": "s",
  • "present_On_Admission_ECode2": "s",
  • "present_On_Admission_ECode3": "s",
  • "present_On_Admission_ECode4": "s",
  • "present_On_Admission_ECode5": "s",
  • "present_On_Admission_ECode6": "s",
  • "present_On_Admission_ECode7": "s",
  • "present_On_Admission_ECode8": "s",
  • "present_On_Admission_ECode9": "s",
  • "pricing_Method": "string",
  • "pricing_Org_ID": "string",
  • "pricing_Rate": 0.1,
  • "principal_Procedure_Code": "string",
  • "principal_Procedure_Date": "2019-08-24T14:15:22Z",
  • "prior_Placement_Date": "2019-08-24T14:15:22Z",
  • "processed_Date": "2019-08-24T14:15:22Z",
  • "prosthesis_Replacement": true,
  • "provider_ID": "string",
  • "qpA_Method": "s",
  • "received_Date": "2019-08-24T14:15:22Z",
  • "referred_By": "string",
  • "refund_Claim": true,
  • "refund_Funding_Key": 0,
  • "related_To_Accident": true,
  • "related_To_Another_Party": true,
  • "related_To_Auto": true,
  • "related_To_Employment": true,
  • "relinquished_Care_Date": "2019-08-24T14:15:22Z",
  • "remittance_Printed": "s",
  • "reprice_Printed": "s",
  • "repriced_Network_ID": "string",
  • "return_To_Work_Date": "2019-08-24T14:15:22Z",
  • "salary_Continuation": true,
  • "send_Check_To": "s",
  • "sender_ID": "string",
  • "service_Date": "2019-08-24T14:15:22Z",
  • "service_Thru": "2019-08-24T14:15:22Z",
  • "sick_Time": true,
  • "statement_From_Date": "2019-08-24T14:15:22Z",
  • "statement_Thru_Date": "2019-08-24T14:15:22Z",
  • "subscriber_ID": "string",
  • "subscriber_Signature": true,
  • "survivor_Benefit": true,
  • "third_Party_Payment": true,
  • "total_COB": 0.1,
  • "trading_Partner_Key": 0,
  • "trans_837_Control_Num": "string",
  • "transaction_837": true,
  • "transaction_837_ID": "string",
  • "type_Of_Admission": "string",
  • "type_Of_Bill": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "vacation": true,
  • "value_Amount1": 0.1,
  • "value_Amount10": 0.1,
  • "value_Amount11": 0.1,
  • "value_Amount12": 0.1,
  • "value_Amount13": 0.1,
  • "value_Amount14": 0.1,
  • "value_Amount15": 0.1,
  • "value_Amount16": 0.1,
  • "value_Amount17": 0.1,
  • "value_Amount18": 0.1,
  • "value_Amount19": 0.1,
  • "value_Amount2": 0.1,
  • "value_Amount20": 0.1,
  • "value_Amount21": 0.1,
  • "value_Amount22": 0.1,
  • "value_Amount23": 0.1,
  • "value_Amount24": 0.1,
  • "value_Amount3": 0.1,
  • "value_Amount4": 0.1,
  • "value_Amount5": 0.1,
  • "value_Amount6": 0.1,
  • "value_Amount7": 0.1,
  • "value_Amount8": 0.1,
  • "value_Amount9": 0.1,
  • "value_Code1": "st",
  • "value_Code10": "st",
  • "value_Code11": "st",
  • "value_Code12": "st",
  • "value_Code13": "st",
  • "value_Code14": "st",
  • "value_Code15": "st",
  • "value_Code16": "st",
  • "value_Code17": "st",
  • "value_Code18": "st",
  • "value_Code19": "st",
  • "value_Code2": "st",
  • "value_Code20": "st",
  • "value_Code21": "st",
  • "value_Code22": "st",
  • "value_Code23": "st",
  • "value_Code24": "st",
  • "value_Code3": "st",
  • "value_Code4": "st",
  • "value_Code5": "st",
  • "value_Code6": "st",
  • "value_Code7": "st",
  • "value_Code8": "st",
  • "value_Code9": "st",
  • "void_Claim": true,
  • "volume_Override": true,
  • "waiting_Period_Claim": true
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete Claim

Deletes an Claim

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
claimNumber
required
integer <int32>

Claim Number

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/claims/{claimNumber}
Request samples

Create or Update Batch Claim

Create or Update multiple Claim at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
Array
claim_Number
required
integer <int32>

Unique identifier assigned each time a claim is processed from batch. This value can change if a claim is returned to batch and reprocessed. 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.

abF_Exported
required
boolean

Used by VBA Backroom IT Services to track export status of a claim using ABF. This has since been moved to ClaimExport tables and is no longer in use. 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.

abF_Exported_Date
string or null <date-time>

Used by VBA Backroom IT Services to track export status of a claim using ABF. This has since been moved to ClaimExport tables and is no longer in use.

aeoB_Claim
required
boolean

A flag indicating a claim is an Advanced EOB and not a claim for payment. Part of the No Surprise Act. 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.

accident_Date
string or null <date-time>

The date of accident.

account_Key
integer or null <int32>

For claim funding, indicates the payor/account this claim would be paid from.

adjustment_Claim
required
boolean

Indicates that this claim was part of an 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.

admin_Amt
number or null <double>

No longer in use.

admission_Date
string or null <date-time>

For institutional Claims, holds the Admission Date.

admission_Diagnostic_Code
string or null <= 8 characters

The admission diagnosis code if applicable for this claim.

admission_Hour
string or null <= 8 characters

For institutional Claims, holds the Admission Hour.

admission_Source
string or null <= 8 characters

For institutional Claims, holds the Admission Source.

admit_Date
string or null <date-time>

Used to identify the date the member was admitted to the Hospital if hospitalized as part of this disability.

advance_Pay
required
boolean

Indicates if this claim, for disability, can be processed and paid in advance of that service dates. 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.

advice_To_Pay
required
boolean

Notes this claim is advice to pay and will not go through funding. 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.

all_Docs_Rec_Date
string or null <date-time>

Information field used in custom processing and reporting.

ambulance_DropOff_Address
string or null <= 90 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_DropOff_Address2
string or null <= 90 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_DropOff_City
string or null <= 32 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_DropOff_Location
string or null <= 64 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_DropOff_Org_Name
string or null <= 512 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_DropOff_State
string or null <= 10 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_DropOff_Zip
string or null <= 32 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_PickUp_Address
string or null <= 90 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_PickUp_Address2
string or null <= 90 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_PickUp_City
string or null <= 32 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_PickUp_Location
string or null <= 64 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_PickUp_State
string or null <= 10 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

ambulance_PickUp_Zip
string or null <= 32 characters

If the claim utlized ambulance services (submitted via 837), we track that here.

appliance_Placed_Date
string or null <date-time>

The date the orthodontic appliance was placed.

assumed_Care_Date
string or null <date-time>

Information field used in custom processing and reporting.

attended_Physician_Date
string or null <date-time>

This identifies the date the member first visited the Physician. This field, in combination with Disabled by Physician Date and Last Day Worked, create the Disability Date for the Member.

auto_Flex
required
boolean

Notes if this Flex claim was auto-generated by the adjducation engine based on member responsibility configuration at the Group. 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.

batch_Claim
integer or null <int32>

This value, in combination with Batch_Number, creates a unique identifier for each claim that is maintained in both batch and processed.

batch_Number
integer or null <int32>

This value, in combination with Batch_Claim, creates a unique identifier for each claim that is maintained in both batch and processed.

beneficiary_ID
string or null <= 20 characters

Notes the beneficiary for Life & Disability claims. References the MemberBeneficiary.Beneficiary_ID.

cliA_Number
string or null <= 32 characters

No longer in use.

calculate_Interest
required
boolean

Notes if interest was calculated for this claim as part of adjudication. 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.

capitation_Claim
required
boolean

Indicates if this claim is 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.

ceridian_Exported
required
boolean

Used in custom integration with ceridian tax services. 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.

ceridian_Exported_Date
string or null <date-time>

Used in custom integration with ceridian tax services.

check_Batch
integer or null <int32>

This is the primary indicator if a claim is "Paid". When this value is NULL, the claim has been processed but not paid. When paid, this value will hold what Check Batch the claim was paid under. References CheckBatch.Check_Batch.

check_ID
integer or null <int32>

Holds the Check ID this claim was paid under. References Checks.Check_ID.

check_Number
string or null <= 20 characters

No longer in use.

claim_837_COB
string or null <= 1 characters

For 837 transactions, indicates COB has been submitted.

claim_Exported
required
boolean

Used by VBA Backroom IT Services to track export status of a claim. This has since been moved to ClaimExport tables and is no longer in use. 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.

claim_Exported_Date
string or null <date-time>

Used by VBA Backroom IT Services to track export status of a claim. This has since been moved to ClaimExport tables and is no longer in use.

claim_Funded_Status
string or null <= 32 characters

Indicates the Claim Funded Status for this claim, indicating if the claim is ready for funding, suspended, a candidate for payment, part of a funding request or funded.

claim_ID
string or null <= 32 characters

An identifier assigned by external vendors and used for integrations. Primarily comes from the REF*D9 value in the 837.

claim_Priority
string or null <= 1 characters

For 837 transactions, indicates the submitted claim priority.

claim_Status
string or null <= 8 characters

The status of the claim. Valid values reside in the ClaimStatus table.

claim_Type
string or null <= 20 characters

Notes the claim type for this claim. References ClaimType.Claim_Type.

closure_Effective_Date
string or null <date-time>

This is an information only field that allows the tracking of the Closure Effective Date.

condition_Code1
string or null <= 8 characters

The Condition Code value for this claim.

condition_Code10
string or null <= 8 characters
condition_Code11
string or null <= 8 characters
condition_Code12
string or null <= 8 characters
condition_Code13
string or null <= 8 characters
condition_Code14
string or null <= 8 characters
condition_Code15
string or null <= 8 characters
condition_Code16
string or null <= 8 characters
condition_Code17
string or null <= 8 characters
condition_Code18
string or null <= 8 characters
condition_Code19
string or null <= 8 characters
condition_Code2
string or null <= 8 characters

The Condition Code value for this claim.

condition_Code20
string or null <= 8 characters
condition_Code21
string or null <= 8 characters
condition_Code22
string or null <= 8 characters
condition_Code23
string or null <= 8 characters
condition_Code24
string or null <= 8 characters
condition_Code3
string or null <= 8 characters

The Condition Code value for this claim.

condition_Code4
string or null <= 8 characters

The Condition Code value for this claim.

condition_Code5
string or null <= 8 characters

The Condition Code value for this claim.

condition_Code6
string or null <= 8 characters

The Condition Code value for this claim.

condition_Code7
string or null <= 8 characters

The Condition Code value for this claim.

condition_Code8
string or null <= 8 characters
condition_Code9
string or null <= 8 characters
coverage_Start
string or null <date-time>

The patients (or Subscribers) enrollment information, references Subenrollment.Group_Coverage_Start.

current_Illness_Date
string or null <date-time>

The current illness date for this claim.

drG_Code
string or null <= 4 characters

The DRG Code for this claim, if applicable. References the DRGCodes.DRG_Code.

drG_Quantity
number or null <double>

The quantity associated with this DRG value.

death_Cert_Rec_Date
string or null <date-time>

Information field used in custom processing and reporting.

delivery_Date
string or null <date-time>

This identifies the date of delivery for disability due to pregnancy.

delivery_Type
string or null <= 1 characters

This will identify the type of delivery that is performed as a result of pregnancy.

dep_SSDI_End_Date
string or null <date-time>

This is an information only field that allows the tracking of Dependent SSI End Date.

diagnostic_Code1
string or null <= 8 characters

An assigned diagnostic code for this claim. This field, in the absence of a corresponding diagnosis pointer from a claim service line, indicates the primary diagnosis.

diagnostic_Code10
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code11
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code12
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code13
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code14
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code15
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code16
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code17
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code18
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code19
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code2
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code20
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code21
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code22
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code23
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code24
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code3
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code4
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code5
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code6
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code7
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code8
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code9
string or null <= 8 characters

An assigned diagnostic code for this claim.

diagnostic_Code_Type
required
string [ 1 .. 16 ] characters

Indicates if the Diagnostic Code values on this claim are ICD9 or ICD10. Two possible values: 9 - ICD9 or 0 - ICD10.

disability_Date
string or null <date-time>

The calculated date of disability (or manually enetered) based on the disabilty advisor in VBASoftware.

disability_End_Date
string or null <date-time>

Information field used in custom processing and reporting.

disability_Type
string or null <= 20 characters

Used to identify the type of disability (Injury or Illness).

disabled_By_Physician
string or null <date-time>

This identifies the date the member was disabled by the Physician. This field, in combination with First Attended Physician Date and Last Day Worked, create the Disability Date for the Member.

discharge_Date
string or null <date-time>

Used to identify the date the member was discharged from the Hospital if hospitalized as part of this disability.

discharge_Hour
string or null <= 8 characters

For institutional Claims, holds the Discharge Hour.

division_ID
string or null <= 20 characters

The patients (or Subscribers) enrollment information, references Subenrollment.Division_ID.

eCode_Diagnostic_Code
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code10
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code11
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code12
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code2
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code3
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code4
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code5
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code6
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code7
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code8
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

eCode_Diagnostic_Code9
string or null <= 8 characters

The external cause of injury code for this claim, if applicable.

epsdT_Condition_Indicator1
string or null <= 3 characters

Early and Periodic Screening, Diagnostic, and Treatment Indicator tracked from the claim submission.

epsdT_Condition_Indicator2
string or null <= 3 characters

Early and Periodic Screening, Diagnostic, and Treatment Indicator tracked from the claim submission.

epsdT_Condition_Indicator3
string or null <= 3 characters

Early and Periodic Screening, Diagnostic, and Treatment Indicator tracked from the claim submission.

epsdT_Referral_Given
string or null <= 1 characters

Early and Periodic Screening, Diagnostic, and Treatment tracking for if a referral was given for this claim.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

ex_Code1
string or null <= 6 characters

A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code.

ex_Code2
string or null <= 6 characters

A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code.

ex_Code3
string or null <= 8 characters

A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code.

ex_Code4
string or null <= 8 characters

A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code.

exhaust_Date
string or null <date-time>

This is the Exhaust Date of the members Disability.

expected_Typical_Duration
integer or null <int32>

Expected Typical Duration (ETD) is the duration of disability identified by the MDA based on the type of job the member has as well as the diagnosis of the disability.

ficA_Percent
number or null <double>

This will hold the FICA withhold amount for each payment. If tax calculation module is enabled, this option will be ignored.

federal_Withheld
number or null <double>

This will hold the federal withhold amount for each payment. If tax calculation module is enabled, this option will be ignored.

filing_Indicator
string or null <= 2 characters

No longer in use.

followUp_Date
string or null <date-time>

This will place a follow-up date on each payment as an additional identifier for when this disability should be reviewed.

followUp_Ex_Code
string or null <= 6 characters

This will place a follow-up ex code on each payment to allow the user to categorize what type of follow-up is being performed.

freq_Code
string or null <= 8 characters

Medicare Resubmission code for the claim. Indicated in Box 22 of the claim report.

group_ID
string or null <= 20 characters

The patients (or Subscribers) enrollment information, references Subenrollment.Group_ID.

hearing_Vision_RX_Date
string or null <date-time>

Information field used in custom processing and reporting.

image_File_Location
string or null <= 128 characters

Stores a reference, if applicable, to an image or document associated with this claim.

image_File_Location2
string or null <= 128 characters

Stores a reference, if applicable, to an image or document associated with this claim.

image_File_Location3
string or null <= 128 characters

Stores a reference, if applicable, to an image or document associated with this claim.

image_File_Location4
string or null <= 128 characters

Stores a reference, if applicable, to an image or document associated with this claim.

initial_Treatment_Date
string or null <date-time>

Information field to track the initial treatment date for this claim.

job_Type
string or null <= 2 characters

This is the job classification for the member going on disability.

ltD_Effective_Date
string or null <date-time>

This is an information only field that holds the date the member went on Long-Term Disability.

ltD_Packet_Date
string or null <date-time>

This is an information only field that tracks the date the Long-Term Disability Packet was sent.

last_Day_Worked
string or null <date-time>

This identifies the date the member last attended work prior to going on disability. This field, in combination with First Attended Physician Date and Disabled by Physician, create the Disability Date for the Member.

last_Physician_Warrant_Date
string or null <date-time>

This is an information only field that allows for the tracking of the Physician Warrant Date.

last_Seen_Date
string or null <date-time>

Information field to track the last time a phyician was seen at the time of this claim submission.

liability_Injury
required
boolean

This is an information only field that identifies if this disability is a liability injury. 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.

mail_To
string or null <= 1 characters

Notes if the payment should be mailed to an entity other than the "Send_Check_To".

member_Seq
string or null <= 2 characters

The Member Sequence of the patient for this claim.

months_Of_Treatment
integer or null <int32>

The number of months the orthodontic treatment will be.

network_ID
string or null <= 10 characters

Indicates the network this claim was paid against. If this value is NULL, the claim is considered "Out of Network".

note
string or null <= 24 characters

No longer in use. Replaced by Note Services.

occupational
required
boolean

Notes if the disability is related to the patiens occupation. 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.

occurrence_Code1
string or null <= 8 characters

The Occurrence Code value for this claim.

occurrence_Code10
string or null <= 8 characters
occurrence_Code11
string or null <= 8 characters
occurrence_Code12
string or null <= 8 characters
occurrence_Code13
string or null <= 8 characters
occurrence_Code14
string or null <= 8 characters
occurrence_Code15
string or null <= 8 characters
occurrence_Code16
string or null <= 8 characters
occurrence_Code17
string or null <= 8 characters
occurrence_Code18
string or null <= 8 characters
occurrence_Code19
string or null <= 8 characters
occurrence_Code2
string or null <= 8 characters

The Occurrence Code value for this claim.

occurrence_Code20
string or null <= 8 characters
occurrence_Code21
string or null <= 8 characters
occurrence_Code22
string or null <= 8 characters
occurrence_Code23
string or null <= 8 characters
occurrence_Code24
string or null <= 8 characters
occurrence_Code3
string or null <= 8 characters

The Occurrence Code value for this claim.

occurrence_Code4
string or null <= 8 characters

The Occurrence Code value for this claim.

occurrence_Code5
string or null <= 8 characters
occurrence_Code6
string or null <= 8 characters
occurrence_Code7
string or null <= 8 characters
occurrence_Code8
string or null <= 8 characters
occurrence_Code9
string or null <= 8 characters
occurrence_Date1
string or null <date-time>

The Occurrence Date associated to the assigned Occurrence Codes.

occurrence_Date10
string or null <date-time>
occurrence_Date11
string or null <date-time>
occurrence_Date12
string or null <date-time>
occurrence_Date13
string or null <date-time>
occurrence_Date14
string or null <date-time>
occurrence_Date15
string or null <date-time>
occurrence_Date16
string or null <date-time>
occurrence_Date17
string or null <date-time>
occurrence_Date18
string or null <date-time>
occurrence_Date19
string or null <date-time>
occurrence_Date2
string or null <date-time>

The Occurrence Date associated to the assigned Occurrence Codes.

occurrence_Date20
string or null <date-time>
occurrence_Date21
string or null <date-time>
occurrence_Date22
string or null <date-time>
occurrence_Date23
string or null <date-time>
occurrence_Date24
string or null <date-time>
occurrence_Date3
string or null <date-time>

The Occurrence Date associated to the assigned Occurrence Codes.

occurrence_Date4
string or null <date-time>

The Occurrence Date associated to the assigned Occurrence Codes.

occurrence_Date5
string or null <date-time>
occurrence_Date6
string or null <date-time>
occurrence_Date7
string or null <date-time>
occurrence_Date8
string or null <date-time>
occurrence_Date9
string or null <date-time>
occurrence_Span_Code
string or null <= 8 characters

The occurrence span indicator for the Occurrence Span From and Thru dates.

occurrence_Span_Code10
string or null <= 8 characters
occurrence_Span_Code11
string or null <= 8 characters
occurrence_Span_Code12
string or null <= 8 characters
occurrence_Span_Code13
string or null <= 8 characters
occurrence_Span_Code14
string or null <= 8 characters
occurrence_Span_Code15
string or null <= 8 characters
occurrence_Span_Code16
string or null <= 8 characters
occurrence_Span_Code17
string or null <= 8 characters
occurrence_Span_Code18
string or null <= 8 characters
occurrence_Span_Code19
string or null <= 8 characters
occurrence_Span_Code2
string or null <= 8 characters
occurrence_Span_Code20
string or null <= 8 characters
occurrence_Span_Code21
string or null <= 8 characters
occurrence_Span_Code22
string or null <= 8 characters
occurrence_Span_Code23
string or null <= 8 characters
occurrence_Span_Code24
string or null <= 8 characters
occurrence_Span_Code3
string or null <= 8 characters
occurrence_Span_Code4
string or null <= 8 characters
occurrence_Span_Code5
string or null <= 8 characters
occurrence_Span_Code6
string or null <= 8 characters
occurrence_Span_Code7
string or null <= 8 characters
occurrence_Span_Code8
string or null <= 8 characters
occurrence_Span_Code9
string or null <= 8 characters
occurrence_Span_From
string or null <date-time>

The occurrence span from for this claim.

occurrence_Span_From10
string or null <date-time>
occurrence_Span_From11
string or null <date-time>
occurrence_Span_From12
string or null <date-time>
occurrence_Span_From13
string or null <date-time>
occurrence_Span_From14
string or null <date-time>
occurrence_Span_From15
string or null <date-time>
occurrence_Span_From16
string or null <date-time>
occurrence_Span_From17
string or null <date-time>
occurrence_Span_From18
string or null <date-time>
occurrence_Span_From19
string or null <date-time>
occurrence_Span_From2
string or null <date-time>
occurrence_Span_From20
string or null <date-time>
occurrence_Span_From21
string or null <date-time>
occurrence_Span_From22
string or null <date-time>
occurrence_Span_From23
string or null <date-time>
occurrence_Span_From24
string or null <date-time>
occurrence_Span_From3
string or null <date-time>
occurrence_Span_From4
string or null <date-time>
occurrence_Span_From5
string or null <date-time>
occurrence_Span_From6
string or null <date-time>
occurrence_Span_From7
string or null <date-time>
occurrence_Span_From8
string or null <date-time>
occurrence_Span_From9
string or null <date-time>
occurrence_Span_Thru
string or null <date-time>

The occurrence span thru for this claim.

occurrence_Span_Thru10
string or null <date-time>
occurrence_Span_Thru11
string or null <date-time>
occurrence_Span_Thru12
string or null <date-time>
occurrence_Span_Thru13
string or null <date-time>
occurrence_Span_Thru14
string or null <date-time>
occurrence_Span_Thru15
string or null <date-time>
occurrence_Span_Thru16
string or null <date-time>
occurrence_Span_Thru17
string or null <date-time>
occurrence_Span_Thru18
string or null <date-time>
occurrence_Span_Thru19
string or null <date-time>
occurrence_Span_Thru2
string or null <date-time>
occurrence_Span_Thru20
string or null <date-time>
occurrence_Span_Thru21
string or null <date-time>
occurrence_Span_Thru22
string or null <date-time>
occurrence_Span_Thru23
string or null <date-time>
occurrence_Span_Thru24
string or null <date-time>
occurrence_Span_Thru3
string or null <date-time>
occurrence_Span_Thru4
string or null <date-time>
occurrence_Span_Thru5
string or null <date-time>
occurrence_Span_Thru6
string or null <date-time>
occurrence_Span_Thru7
string or null <date-time>
occurrence_Span_Thru8
string or null <date-time>
occurrence_Span_Thru9
string or null <date-time>
onset_Similar_Illness_Date
string or null <date-time>

Notes the date of the original illness if this claim is associated to that illness.

orthodontics_Treatment
required
boolean

When this flag is checked, it indicates the dental claim is for orthodontics. 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.

other_Insurance
required
boolean

Indicates if other insurance is applicable on this claim. This indicator unlocks COB amount fields on the ClaimDetail (service line). 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.

other_Procedure_Code1
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code10
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code11
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code12
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code13
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code14
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code15
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code16
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code17
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code18
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code19
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code2
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code20
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code21
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code22
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code23
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code3
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code4
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code5
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code6
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code7
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code8
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Code9
string or null <= 8 characters

Additional procedure code (ICD10 Diagnosis) values for this claim submission.

other_Procedure_Date1
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date10
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date11
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date12
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date13
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date14
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date15
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date16
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date17
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date18
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date19
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date2
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date20
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date21
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date22
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date23
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date3
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date4
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date5
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date6
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date7
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date8
string or null <date-time>

Date associated with the additional procedure code.

other_Procedure_Date9
string or null <date-time>

Date associated with the additional procedure code.

override
string or null <= 1 characters

No longer in use.

override_Date
string or null <date-time>

No longer in use.

override_Network_ID
required
boolean

This indicator lets the system know that the front end user has assigned this network ID and not adjudication. 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.

override_Payor_Account
required
boolean

Users can choose the payor from the More Information screen and this flag prevents adjudication from using the expected payor. 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.

override_User
string or null <= 16 characters

No longer in use.

partial_Disability
required
boolean

This will identify if this is a partial disability payment. Partial Disability payments have additional tax and payment rules applied during adjudication. 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.

patient_Account
string or null <= 128 characters

For the servicing provider, this indicates the patient account identifier in their practice management system.

patient_Reason_for_Visit_Diagnostic_Code1
string or null <= 8 characters

Reason for Visit code on Diagnosis Code 1

patient_Reason_for_Visit_Diagnostic_Code2
string or null <= 8 characters

Reason for Visit code on Diagnosis Code 2

patient_Reason_for_Visit_Diagnostic_Code3
string or null <= 8 characters

Reason for Visit code on Diagnosis Code 3

patient_Relationship
string or null <= 8 characters

Holds the relationship of the patient to the insured.

patient_Signature
required
boolean

Indicates if the patient signature has been collected. 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.

patient_Signature_Date
string or null <date-time>

Indicates the date of the patient signature being collected.

patient_Status
string or null <= 8 characters

For institutional Claims, holds the Patient Status.

payee_ID
string or null <= 20 characters

The billing provider (payee) for this claim. References the ProviderPayee.Payee_ID (by Provider_ID).

payment_Status
string or null <= 1 characters

No longer in use.

payor_Claim_Control_Number
string or null <= 64 characters

A claim reference number used in conjunction with the Medicare Resubmission code. Indicated in Box 22 of the claim report.

payor_ID
string or null <= 20 characters

For claim funding, indicates the payor/account this claim would be paid from.

physician_Return_To_Work
string or null <date-time>

This is the Return to Work date identified by the Physician at the start of disability. This may or may not be the actual date the member returns to work.

place_Of_Service
string or null <= 5 characters

Some transactions hold the Place of Service at the header but typically this value is empty and the ClaimDetail.Place_Of_Service is used for each service line. This value is not used in standard processing.

plan_ID
string or null <= 20 characters

Holds the plan the patient is enrolled in and that benefits are assigned.

plan_Provider
string or null <= 1 characters

No longer in use.

plan_Year
string or null <= 8 characters

Indicates the Plan Year this claim is processed under. This drives accumulator calculations and referneces the GroupPlanYear.Plan_Year value.

present_On_Admission1
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 1.

present_On_Admission10
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 10.

present_On_Admission11
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 11.

present_On_Admission12
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 12.

present_On_Admission13
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 13.

present_On_Admission14
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 14.

present_On_Admission15
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 15.

present_On_Admission16
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 16.

present_On_Admission17
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 17.

present_On_Admission18
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 18.

present_On_Admission19
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 19.

present_On_Admission2
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 2.

present_On_Admission20
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 20.

present_On_Admission21
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 21.

present_On_Admission22
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 22.

present_On_Admission23
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 23.

present_On_Admission24
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 24.

present_On_Admission3
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 3.

present_On_Admission4
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 4.

present_On_Admission5
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 5.

present_On_Admission6
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 6.

present_On_Admission7
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 7.

present_On_Admission8
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 8.

present_On_Admission9
string or null <= 1 characters

Indicates if the patient was present on admission for diagnosis 9.

present_On_Admission_ECode1
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 1.

present_On_Admission_ECode10
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 10.

present_On_Admission_ECode11
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 11.

present_On_Admission_ECode12
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 12.

present_On_Admission_ECode2
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 2.

present_On_Admission_ECode3
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 3.

present_On_Admission_ECode4
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 4.

present_On_Admission_ECode5
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 5.

present_On_Admission_ECode6
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 6.

present_On_Admission_ECode7
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 7.

present_On_Admission_ECode8
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 8.

present_On_Admission_ECode9
string or null <= 1 characters

Indicates if the patient was present for the external cause of injury diagnosis 9.

pricing_Method
string or null <= 8 characters

For reprice claims (typically submitted via 837), this notes the reprice method used to reprice this claim.

pricing_Org_ID
string or null <= 50 characters

The ID of the pricing organization. Data is obtained in segment HCP04 on an 837.

pricing_Rate
number or null <double>

The rate associated with the reprice method (Pricing_Method).

principal_Procedure_Code
string or null <= 8 characters

The principal procedure (ICD10 Diagnosis) for this claim submission.

principal_Procedure_Date
string or null <date-time>

The principal procedure date.

prior_Placement_Date
string or null <date-time>

The date of a previous prosthetic or crown applied, if there was one.

processed_Date
string or null <date-time>

The date the claim was processed from batch.

prosthesis_Replacement
required
boolean

This flag indicates if this claim is for the replacement of a prosthesis. 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.

provider_ID
string or null <= 20 characters

The provider ID of the servicing provider. References Provider.Provider_ID.

qpA_Method
string or null <= 1 characters

Overrides the QPA Method set on the Plan for this claim.

received_Date
string or null <date-time>

The date this claim was received into the admin system.

referred_By
string or null <= 30 characters

Information field to track if a referral was sent for this claim.

refund_Claim
required
boolean

Indicates that this claim was part of a Refund 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.

refund_Funding_Key
integer or null <int32>

If this claim was part of a refund process, this will hold the reference to the receipt generated by the refund process.

related_To_Accident
required
boolean

Indicates if the claim is related to a non-car accident. 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.

related_To_Another_Party
required
boolean

Indicates if the claim was casued by a third party. 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.

related_To_Auto
required
boolean

Indicates if the claim is related to a car accident. 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.

related_To_Employment
required
boolean

Indicates if the claim is work related. 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.

relinquished_Care_Date
string or null <date-time>

Information field used in custom processing and reporting.

remittance_Printed
string or null <= 1 characters

No longer in use.

reprice_Printed
string or null <= 1 characters

No longer in use.

repriced_Network_ID
string or null <= 50 characters

As part of reprice claim submissions (via 837), this will hold the repricing network.

return_To_Work_Date
string or null <date-time>

This is the date the member Returned to Work. This date affects the total payments created as well as other calculations during adjudication.

salary_Continuation
required
boolean

This flag identifies that there is salary continuation during this disability. 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.

send_Check_To
string or null <= 1 characters

Indicates the entity that should be paid for this claim. S - Subscriber, G - Group, B - Beneficiary, P - Payee, or V - Provider.

sender_ID
string or null <= 15 characters

The Sender ID sent inbound for x12 (837) transactions.

service_Date
string or null <date-time>

The earliest Service_Date of all service lines on this claim.

service_Thru
string or null <date-time>

The latest Service_Thru for all service lines on this claim.

sick_Time
required
boolean

This flag identifies that there is sick time during this disability. 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.

statement_From_Date
string or null <date-time>

For Institutional Claims, holds the Statement Date.

statement_Thru_Date
string or null <date-time>

For Institutional Claims, holds the Statement Date.

subscriber_ID
string or null <= 9 characters

The Subscriber ID of the patient for this claim.

subscriber_Signature
required
boolean

Indicates if the insured signature has been collected. 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.

survivor_Benefit
required
boolean

Indicates if Survivor Benefit was applied for this disability payment. 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.

third_Party_Payment
required
boolean

For disability, indicates if this professional claim is a 3rd party payment (typically related to alimony, garnishment, etc.) 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.

total_COB
required
number <double>

COB total for all claim detail lines 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.

trading_Partner_Key
integer or null <int32>

No longer in use.

trans_837_Control_Num
string or null <= 9 characters

For 837 transactions, this is the control number assgined by the submitter.

transaction_837
required
boolean

Indicates this is a claim entered by an inbound 837. 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.

transaction_837_ID
string or null <= 30 characters

For 837 transactions, this holds the transaction ID assigned by the submission.

type_Of_Admission
string or null <= 6 characters

The Admission Type associated to this claim.

type_Of_Bill
string or null <= 6 characters

The Bill Type associated to this claim. References BillType.Type_Of_Bill.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

vacation
required
boolean

This flag identifies that there is vacation during this disability. 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.

value_Amount1
number or null <double>

The monetary amount related to the value code.

value_Amount10
number or null <double>
value_Amount11
number or null <double>
value_Amount12
number or null <double>
value_Amount13
number or null <double>
value_Amount14
number or null <double>
value_Amount15
number or null <double>
value_Amount16
number or null <double>
value_Amount17
number or null <double>
value_Amount18
number or null <double>
value_Amount19
number or null <double>
value_Amount2
number or null <double>

The monetary amount related to the value code.

value_Amount20
number or null <double>
value_Amount21
number or null <double>
value_Amount22
number or null <double>
value_Amount23
number or null <double>
value_Amount24
number or null <double>
value_Amount3
number or null <double>

The monetary amount related to the value code.

value_Amount4
number or null <double>

The monetary amount related to the value code.

value_Amount5
number or null <double>
value_Amount6
number or null <double>
value_Amount7
number or null <double>
value_Amount8
number or null <double>
value_Amount9
number or null <double>
value_Code1
string or null <= 2 characters

The code indicating a monetary condition which was used by the intermediary to process an institutional claim.

value_Code10
string or null <= 2 characters
value_Code11
string or null <= 2 characters
value_Code12
string or null <= 2 characters
value_Code13
string or null <= 2 characters
value_Code14
string or null <= 2 characters
value_Code15
string or null <= 2 characters
value_Code16
string or null <= 2 characters
value_Code17
string or null <= 2 characters
value_Code18
string or null <= 2 characters
value_Code19
string or null <= 2 characters
value_Code2
string or null <= 2 characters

The code indicating a monetary condition which was used by the intermediary to process an institutional claim.

value_Code20
string or null <= 2 characters
value_Code21
string or null <= 2 characters
value_Code22
string or null <= 2 characters
value_Code23
string or null <= 2 characters
value_Code24
string or null <= 2 characters
value_Code3
string or null <= 2 characters

The code indicating a monetary condition which was used by the intermediary to process an institutional claim.

value_Code4
string or null <= 2 characters

The code indicating a monetary condition which was used by the intermediary to process an institutional claim.

value_Code5
string or null <= 2 characters
value_Code6
string or null <= 2 characters
value_Code7
string or null <= 2 characters
value_Code8
string or null <= 2 characters
value_Code9
string or null <= 2 characters
void_Claim
required
boolean

Indicates that this claim was part of a Void 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.

volume_Override
required
boolean

Notes that the benefit amount, for disability claims, has been manually overridden. 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.

waiting_Period_Claim
required
boolean

Indicates if this disability payment is a waiting period payment. 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.

Responses
207

Success

401

Unauthorized

put/claims-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}

List ClaimTimeline

Lists all ClaimTimeline

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
batch-id
required
integer <int32>

Batch ID

batch-claim-id
required
integer <int32>

Batch Claim ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/claim-timeline
Request samples
Response samples
No sample