Participant APIs | REST

Version:
Download Open API Specification

Get list of expenses

https://api.wealthcare.com/participant/services/participant/expenses/{tpaId}/{employerId}/{participantId}

Get list of expenses

  • 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.

  • participantId string Required

    Participant Id

  • Accept-Language enum<string>

    Specify the participant’s language preference. The corresponding response will then return text/string values in the language specified, defaulting to English if not specified or if an invalid value is sent. Note: If Spanish or French is requested and a particular field does not have a translated value (Spanish or French), then the English text value will be returned.

    Possible values: es en fr
  • dateFilter enum<string> Required

    Date filter

    Possible values: Last90Days Last6Months LastOneYear All
  • decrypt integer <int32>

    Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.

  • opt integer <int32>

    0: UnMask all dependent provider information. 1: Mask all dependent provider information. 2: Mask dependent provider information based on dependent privacy, default to 0.

  • participantExpenses array <object>
    • ClaimKey integer <int32>

      A unique identifier key for the claim, generated by WCA when the claim was created

    • TxnKey string

      Unique identifier key for the Transaction

    • SetlDte string

      Date the Transaction was finalized in WCA- Settlement Date

    • ETxnSeqNum integer <int32>

      Sequence Number of the FX, TC or “save expense for later” Expense

    • OffsetAmt number <double>

      Amount of the claim line that was eligible for reimbursement but offset or reduced the balance due on one or more claims

    • AppliedToDeductible number <double>

      For TC and FX claims, this is the amount that was applied to Deductible Manager or the amount applied to the DTR.

    • ExpenseStatus string

      Status for the FX or TC Claim line.

    • CarrierId string

      On an FX or TC claim, a unique identifier for the Carrier, as submitted on the FX or TC claim

    • ClaimId string

      On an FX claim, a unique identifier for the claim, as submitted on the FX record

    • ClaimLineNum integer <int32>

      The claim line number submitted with the claim by the insurance carrier.

    • ClaimTypeCde enum<string>

      Unique identifier for type of Claims : None = 0, Pharmacy = 1, Medical = 2,Dental = 4, Vision = 8, OTC = 16

      Possible values: None Pharmacy Medical Dental Vision OTC
    • BenefitMaxMetAmount number <double>

      On an FX or TC, this is the amount that is being denied by the insurance company due to the benefit being maxed out in number of visits or limit (such as a limit of 20 Physical Therapy visits per year). WCA can be configured to reimburse this amount since it would otherwise be covered by insurance were it not for the limit.

    • RbbExcessAmount number <double>

      The amount the insurance carrier deemed as “Excess Amount” by insurance. It can be used in adjudication as a participant reimbursable liability amount.

    • NotCoveredAmount number <double>

      The amount the insurance carrier deemed as “not covered” by insurance. It can be used in adjudication as a participant reimbursable liability amount.

    • AboveRcAmount number <double>

      On an FX or TC claim or a participant “save expense” for later, this is the amount above the usual and customary rate – for an out of network claim, it’s the amount the provider billed minus the insurance allowed amount. WCA can be configured to reimburse this amount by service category tier.

    • RenderingProvider string

      The provider who provided the service to the participant (this may be different than the billing provider name). It is recommended to use this field as the Provider Name to display.

    • BillingProviderTaxId string

      On a TC claim, a unique identifier for the Billing Provider, as submitted on the TC claim

    • ServiceCategoryTierId string

      The Service Categoriy Tier associated with the claim line.

    • DependentId string

      When the activity is for a dependent, this will be populated with an identifier for the dependent, as submitted on the TC or FX claim

    • ServiceCategoryCode string

      The Serive Category Code associated with the claim line

    • TotalPatientRespAmt number <double>

      Total of all the participant liability amount fields for the claim line Deductible, Coinsurance, Copay, Not Covered Amount, Benefit Max Met, Amount RBB Excess Amount

    • RenderingProviderId string

      Provider ID for the provider who performed the service for the participant.

    • FirstName string

      First Name of participant associated with the expense

    • LastName string

      Last Name of participant associated with the transaction

    • PayProviderKey integer <int32>

      Unique identifier key for the Provider, generated by WCA when the provider was first created in the system

    • ProviderAddress1 string

      Address line 1 associated with the provider’s mailing address

    • ProviderAddress2 string

      Address line 2 associated with the provider’s mailing address

    • ProviderCity string

      City associated with the provider’s mailing address

    • ProviderState string

      State associated with the provider’s mailing address

    • ProviderCountryCde string

      Country Code associated with the provider’s mailing address

    • ProviderZip string

      Zip Code associated with the provider’s mailing address

    • ProviderPhone string

      Phone associated with the provider’s mailing address

    • ProviderId string

      Identifier for the Provider, as entered into WCA when the provider was created

    • TpaId string

      A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

    • ExpenseKey integer <int64>

      Unique WCA generated identifier key for the FX, TC or “save expense for later” Expense

    • EmpeKey integer <int32>

      Unique identifier key for Employee, generated by WCA when the employee was created in the system

    • DepKey integer <int32>

      When the activity is for a dependent, this will be populated with a unique identifier for the dependent generated by WCA when the dependent was first entered into the system. This will be null if the activity was not linked to a dependent.

    • ServiceStartDte string <date-time>

      Beginning date of service for the claim line received by the participant.

    • ServiceEndDte string <date-time>

      Ending date of the service for the claim line provided to the participant

    • ProviderName string

      Name of the Provider

    • DescOfService string

      For a TC claim, this will be the description of service as submitted on the TC claim.

    • BilledAmt number <double>

      See prior definition in the Employee Activity section. This is the billed amount specific to the claim line.

    • InsAmtAllowed number <double>

      The amount the insurance carrier deemed eligible for the claim line service. It is not used in adjudication; only the participant’s responsibility fields are used in adjudication (Deductible, Coinsurance, Copay, etc.)

    • InsAmtPaid number <double>

      The amount the insurance carrier paid for the claim line service. It is not used in adjudication as this amount has already been paid to the provider; only the participant’s responsibility fields are used in adjudication (Deductible, Coinsurance, Copay, etc.)

    • EmpePaidAmt number <double>

      Employee Out-of-Pocket Paid Amount. The amount the participant has indicated as paid by other means and they are not seeking reimbursement for the amount. This amount reduces the remaining participant responsibility.

    • Notes string

      Notes entered by user related to the transaction

    • FileKey integer <int32>

      Unique identifier key for document attached to this claim line, generated by WCA when the document was first submitted

    • eClaimOptions integer <int64>

      Indicates whether this claim is a save expense for later submitted by the participant or a TC claim. 1 = participant submitted expense for later 0 = TC claim

    • DeductibleAmt number <double>

      The deductible amount as adjudicated by the insurance carrier on the FX or TC claim submitted to WCA. Note: WCA can be configured to reimburse this amount by service category code or not.

    • CoinsAmt number <double>

      The coinsurance amount as adjudicated by the insurance carrier on the FX or TC claim submitted to WCA. Note: WCA can be configured to reimburse this amount by service category code or not.

    • CoPayAmt number <double>

      The copay amount as adjudicated by the insurance carrier on the FX or TC claim submitted to WCA. Note: WCA can be configured to reimburse this amount by service category code or not.

    • TotalReimbAmt number <double>

      Total Amount of transaction which got reimbursed

    • OriginCde enum<string>

      Origin Code indicates which way claims initiated : None = 0,POSCardSwipe = 1,POSKeyedIn = 2,POSPhonedIn = 3,POSMbiSubmitted = 4,ManualScreen = 50,ManualEFT = 51, ManualAgent = 52, ParticipantManualScreen = 53,ParticipantMobileScreen = 54, HZDirect = 55, eClaimManagerManual = 56, eClaimManagerTPS = 57, WebServiceClaim = 58

      Possible values: None POSCardSwipe POSKeyedIn POSPhonedIn POSMbiSubmitted ManualScreen ManualEFT ManualAgent ParticipantManualScreen ParticipantMobileScreen HZDirect eClaimManagerManual eClaimManagerTPS WebServiceClaim
    • eClaimUIStatus enum<string>

      Current status of the eClaim : None = 0, New = 1, (New claim posted to portal but not yet submitted for reimbursement) Matched = 2 (Matched to card transaction) Reimbursed = 3, (Claim was approved but not in full) Not Allow Participant Claim Entry = 4 (Participant claim entry is not allowed. Note: in WCA, WCP, and WCM, an eclaim with this status will display as “not eligible for reimbursement”). Miss Participant Claim Entry UI Template = 5 (Claim can not be submitted as there is no claim entry template in WCA) In_Process = 6 (Claim has been submitted for adjudication, but has not yet been adjudicated) Fully_Paid = 7 (claim is fully approved)

      Possible values: None New Matched Reimbursed NotAllowParticipantClaimEntry MissParticipantClaimEntryUITemplate In_Process Fully_Paid
  • labelAmounts array <object>
    • Label string
    • Description string

      Description related to the claim

    • Amount number <double>