Administrative APIs | REST

Version:
Download Open API Specification

Submit Healthcare (FX) Claim

https://api.wealthcare.com/system/Services/Transaction/HealthCareClaim/{tpaId}/{employerId}/{employeeId}

  • tpaId string required
    A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.
  • employerId string required
    Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
  • employeeId string required
    Unique identifier for the employee.
  • dependentId string
    ID of the dependent as it appears in WCA, if this claim is for a dependent.
  • externalClaimId string
    External Claim Number added to transactions to facilitate and track overpayments. This is something the admin creates.
  • claimLine integer
    The claim line number submitted with the claim by the insurance carrier.
  • claimDisposition enum<integer>
    Possible values: 0 or 00 = Original claim (debits account) 1 or 01 = Claim reversal / back-out (credits account) 2 or 02 = Reprocessed claim (debits account) 5 or 05 = Updated claim - Alegeus reverses claims with same claim number and replace with this new claim.
  • claimsCrossoverAutoPay boolean
    Determines if this is a crossover claim.
  • dateOfServiceFrom string
    Service start date, when the services began.
  • dateOfServiceTo string
    Service end date, when the services ended.
  • scCde string
    Service category code as it appears in WCA.
  • serviceProcedureCode string
    CPT, HCPCS or other service procedure type. This information is stored in the system for display to the administrator and participant. It is not used by the system to determine whether a claim is eligible.
  • billedAmount number
    This is the amount that the provider billed for the service and is only used for display only; no system business rules are performed using this amount.
  • insuranceAllowedAmount number
    This is either the network contracted amount (in-network) or the usual and customary rate (Out-of-network) for the service provided to the participant; only used for display; no system business rules are performed using this amount.
  • insurancePaidAmount number
    This is the amount that the insurance provide paid of the billed amount for the service and is only used for display; no system business rules are performed using this amount.
  • deductibleAmount number
    If provided, this amount will be used as the participant's deductible responsibility.
  • coinsuranceAmount number
    If provided, this amount will be used as the participant's Coinsurance responsibility.
  • copayAmount number
    If provided, this amount will be used as the participant's Copay responsibility.
  • benefitMaxMetAmount number
    Amount that would otherwise be covered but has been denied by the carrier due to a benefit maximum being met.
  • rbbExcessAmount number
    If provided, this amount will be used as the participant's Excess Amount responsibility.
  • notCoveredAmount number
    Amount denied as not covered by the insurance plan; typically, this amount will match the Billed Amount.
  • aboveRCAmount number
    The amount above the usual and customary rate.
  • merchantORProviderId string
    Required to pay Providers. Only if the employer is enabled for provider pay, the service category is enabled for pay provider, and the provider ID is setup in WCA will the claim be paid to the provider.
  • merchantORProviderName string
    The Provider Name as it will appear in WCA on the new claim entry page, as well as on all reimbursements and associated communications. Ok to pass blank if Rx/OON and payment could never go to member.
  • serviceCategoryTier string
    The Service Category Tier must be setup within the Service Category for this field to successfully process. Must match a Service Category tier setup in the WealthCare Administration system for a claim to be successfully processed.
  • trackingNumber string
    You can assign and use a number to identify specific claims. Note: WCA does not use this number for claims matching purposes.
  • recordTrackingNumber string
    The record tracking number is used to identify line numbers within an import record. If this field is sent during import, WCA will return these values in the result file.
  • note string
    Enter any comment relevant to the claim line.
  • claimReceivedDate string
    The date the claim was received by the carrier - not the date is was adjudicated.
  • generateDenialLetter boolean
    Indicates if a denial letter should be generated for the claim.
  • includeNotes boolean
    Indicates if the notes should be included in the manual claim letter.
  • EmployeeID string required
    ID of the participant the claim relates to.
  • ExternalClaimID string required
    The external claim ID.
  • ClaimLine integer required
    Claim line for which the reimbursement information is being provided.
  • TxnAmtApproved number required
    Amount of the transaction that was approved.
  • SplitDetail string required
    Details the amounts paid for each plan type for the claim line in total, such as: FSA:100.00|HRA:20.00
  • OffsetAmt number required
    This is the amount deducted from the Approved Amount as a result of ineligible card (POS) transaction offsetting.
  • BalancesAfterTheTransaction string required
    Details the balances in each affected account AFTER the transaction: FSA:100.00|HRA:20.00
  • DetailResponseCode string required
    Response or error code in detail.
  • ExternalReimbursementTotal number required
    The total amount to be paid by the external system for this claim. For example, an employer can be configured to have HRA payments made by an external system (i.e., external reimbursement method) and FSA payments.
  • ExternalReimbSplitDetail string required
    Details the amount by account type being reimbursed through an external reimbursement method: FSA:100.00|HRA:20.
  • RecordTrackingNumber string required
    Record Tracking Number sent on the incoming record.
  • TrackingNumber string required
    Number you assign to track claims. Note: WCA does not use this number.
  • DeductibleSplitDetail string required
    Details the amounts paid for each plan type for the claim line's coinsurance amount, such as: FSA:100.00|HRA:20.
  • CoinsuranceSplitDetail string required
    Details the amounts paid for each plan type for the claim line's coinsurance amount, such as: FSA:100.00|HRA:20 .
  • CopaySplitDetail string required
    Details the amounts paid for each plan type for the claim line's copay amount, such as: FSA:100.00|HRA:20.
  • ExcessAmountSplitDetail string required
    Details the amounts paid for each plan type for the claim line's Excess amount, such as: FSA:100.00|HRA:20
  • BenefitMaxMetSplitDetail string required
    Details the amounts paid for each plan type for the claim line's Benefit Max Met amount, such as: FSA:100.00|HRA:20
  • NotCoveredSplitDetail string required
    Details the amounts paid for each plan type for the claim line's Not Covered amount, such as: FSA:100.00|HRA:20
  • AbovRCSplitDetail string required
    Details the amounts paid for each plan type for the claim line's Above UCR amount, such as: FSA|100.00|HRA|20.00
  • ExcludedReasonCode string required
    The reason why an amount cannot be reimbursed from an account or why an account reimbursement amount has been reduced.
  • ErrorCode integer
  • ErrorDescription string
    Description of the error that occurred.