PayerList Filter and Sort

Attribute/PropertyFilter OnSort On
systemYesYes
payerPlanNameYesYes
payerPlanAliasYesYes
setupAdditionalPayerIdYesYes
secondaryClaimsYesYes
transactionTypeYesYes
chiPayerYesYes
assurancePayerYesYes
lchcPayerYesYes
allowsDualClearinghouseEnrollmentYesYes
stateDoingBusinessYesYes
deactivationDateYesYes
reportTypeYesYes
attachmentTypeYesYes
parPayerYesYes
rpaPayerIdYesYes
workersCompensationYesYes
imnPayerIdYesYes
dentalPayerIdYesYes
payerIdYesYes
industryPayerIdYesYes
enrollmentRequiredYesYes
exchangeInstitutionalCPIDYesYes
exchangeProfessionalCPIDYesYes
iediInstClaimPayerIdYesYes
iediProfClaimPayerIdYesYes
statusYesYes
payerNotesYesYes
enrollmentNotesYesYes
additionalPayerIDsYesYes
activationDateYesYes
standInIndicatorYesYes
serviceRestoredYesYes
connectionTypeYesYes
lastUpdatedAfterYesYes

Search ParameterDescription
systemAt a hierarchical level, system is the highest level; gets a complete list of payers and transactions with their related information for a specific system/clearinghouse. /payerlist/v1/payers?system=[SYSTEM]&transactionType=[TRANSACTIONTYPE_1] &transactionType=[TRANSACTIONTYPE_2] &transactionType=[TRANSACTIONTYPE_N]
lastUpdatedAfterDate in format YYYY-MM-DD to compare against lastUpdated. Returns records greater than or equal to the comparison.
If missing, returns all.
lastUpdatedAfter=[YYYY-MM-DD]
wildcardSearch
  • wildcardSearch= TRUE: A wildcard search is performed for payerPlanName
  • wildcardSearch= FALSE: An exact match is performed for payerPlanName
✍️ The default value is TRUE.
pageSizeThe number of records to return.
If missing, returns all.
size=[#]
pageThe record number to start retrieval from.
If missing, starts at 0.
start=[#]
sortSort=[property], payerid,asc|STATUS,desc
exportFieldsReturns the payer list in a CSV format.

linkedPayerIds

exchangeProfessionalCPID
exchangeInstitutionalCPID
additionalPayerIDs
iediDentalCPID
iediInstitutionalCPID
iediProfessionalCPID

  • lastUpdatedAfter returns records last updated after a given date.
    lastUpdatedAfter=2024-12-04
  • payerPlanName can be searched for, by exact matches or wildcard matches using wildcard=yes or no. The default is wildcard=yes.
    • sorting can be done by setting a value of sort and by suffixing asc or desc to the parameter:
      sort=payerPlanName,asc
      Multiple sorts are applied in the left to right order.