835 ERA Report

Retrieve an 835 Electronic Remittance Advice (ERA) in JSON format

GET/change/medicalnetwork/reports/v2/{transactionId}/835

The 835 Electronic Remittance Advice (ERA) contains details about payments for specific services and explanations for any adjustments or denials. This endpoint retrieves processed 835 ERA transactions from Stedi.

  1. Call this endpoint with the transactionId of the 835 ERA you want to retrieve. You can retrieve the transaction ID through webhooks or through Stedi's API. Learn more
  2. The endpoint returns the 835 ERA in JSON format.

Note that the payer won't send 835 ERAs for rejected claims. If a claim is rejected in a 277CA claim acknowledgment, there's no adjudication or payment information to report.

Visit Correlate 835 ERA to learn how to match 835 ERAs to the original claim.

Claim status

You can't reliably determine a claim's status based on the amount paid in an 835 ERA. There are many instances in which a claim is accepted and the total amount paid is 0 dollars. For example, in Value-Based Care (VBC) scenarios, line item rates are usually 0 dollars, and providers are paid a flat rate per month or for a complete bundle of services.

Use the Real-Time Claim Status API to check the claim's status instead.

Authorization
RequiredHeader

A Stedi API Key for authentication.

Path Parameters

A unique identifier for the processed 835 transaction within Stedi. This ID is included in the transaction processed event, which you can receive automatically through Stedi webhooks. You can also retrieve it through the Poll Transactions endpoint or from the transaction's details page within the Stedi portal.

Response

application/json

ConvertReport835 200 response

meta
ObjectRequired

Metadata that helps Stedi track and debug the response.

Show attributes
applicationMode
meta.applicationMode
String

Whether this is a test or production ERA.

senderId
meta.senderId
String

An identifier for the most recent sender of the ERA. This is usually not the original sender, so this value is unlikely to be a payer ID. When Stedi processes and delivers ERAs through the clearinghouse, this value is always STEDI.

traceId
meta.traceId
String

Not currently used.

transactionId
meta.transactionId
String

The Stedi transaction identifier.

transactions
Array of Objects

The payer's 835 response.

Array item
controlNumber
transactions[].controlNumber
String

The control number the payer provided in the claim payment response. This is used to identify the transaction.

detailInfo
transactions[].detailInfo
Array of Objects

Detailed information about claims in this payment advice.

Array item
assignedNumber
transactions[].detailInfo[].assignedNumber
String

A unique ID assigned to identify this set of claim information within the response.

paymentInfo
transactions[].detailInfo[].paymentInfo
Array of Objects

Information relevant to the claim and claim payment, including the subscriber, providers, and service lines. Note that the amount paid may not match the claim amount, even when the claim was not denied. This can happen for several reasons, including adjustments and corrected balances due from other claims.

Array item
claimAdjustments
transactions[].detailInfo[].paymentInfo[].claimAdjustments
Array of Objects

Adjustments applied to this claim.

Array item
adjustmentAmount1
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentAmount1
String

The amount of the adjustment. A negative amount increases the claim payment and a positive amount decreases the claim payment.

adjustmentAmount2
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentAmount2
String

The amount of the adjustment. A negative amount increases the claim payment and a positive amount decreases the claim payment.

adjustmentAmount3
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentAmount3
String

The amount of the adjustment. A negative amount increases the claim payment and a positive amount decreases the claim payment.

adjustmentAmount4
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentAmount4
String

The amount of the adjustment. A negative amount increases the claim payment and a positive amount decreases the claim payment.

adjustmentAmount5
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentAmount5
String

The amount of the adjustment. A negative amount increases the claim payment and a positive amount decreases the claim payment.

adjustmentAmount6
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentAmount6
String

The amount of the adjustment. A negative amount increases the claim payment and a positive amount decreases the claim payment.

adjustmentQuantity1
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentQuantity1
String

The units of service being adjusted. A positive value decreases the covered days and a negative number increases the covered days.

adjustmentQuantity2
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentQuantity2
String

The units of service being adjusted. A positive value decreases the covered days and a negative number increases the covered days.

adjustmentQuantity3
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentQuantity3
String

The units of service being adjusted. A positive value decreases the covered days and a negative number increases the covered days.

adjustmentQuantity4
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentQuantity4
String

The units of service being adjusted. A positive value decreases the covered days and a negative number increases the covered days.

adjustmentQuantity5
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentQuantity5
String

The units of service being adjusted. A positive value decreases the covered days and a negative number increases the covered days.

adjustmentQuantity6
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentQuantity6
String

The units of service being adjusted. A positive value decreases the covered days and a negative number increases the covered days.

adjustmentReason1
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentReason1
String

A description identifying the detailed reason the adjustment was made.

adjustmentReason2
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentReason2
String

A description identifying the detailed reason the adjustment was made.

adjustmentReason3
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentReason3
String

A description identifying the detailed reason the adjustment was made.

adjustmentReason4
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentReason4
String

A description identifying the detailed reason the adjustment was made.

adjustmentReason5
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentReason5
String

A description identifying the detailed reason the adjustment was made.

adjustmentReason6
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentReason6
String

A description identifying the detailed reason the adjustment was made.

adjustmentReasonCode1
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentReasonCode1
String

A code identifying the detailed reason the adjustment was made. Visit Claim Adjustment Reason Codes in the X12 documentation for a complete list.

adjustmentReasonCode2
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentReasonCode2
String

A code identifying the detailed reason the adjustment was made. Visit Claim Adjustment Reason Codes in the X12 documentation for a complete list.

adjustmentReasonCode3
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentReasonCode3
String

A code identifying the detailed reason the adjustment was made. Visit Claim Adjustment Reason Codes in the X12 documentation for a complete list.

adjustmentReasonCode4
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentReasonCode4
String

A code identifying the detailed reason the adjustment was made. Visit Claim Adjustment Reason Codes in the X12 documentation for a complete list.

adjustmentReasonCode5
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentReasonCode5
String

A code identifying the detailed reason the adjustment was made. Visit Claim Adjustment Reason Codes in the X12 documentation for a complete list.

adjustmentReasonCode6
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].adjustmentReasonCode6
String

A code identifying the detailed reason the adjustment was made. Visit Claim Adjustment Reason Codes in the X12 documentation for a complete list.

claimAdjustmentGroupCode
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].claimAdjustmentGroupCode
String

The code identifying the category of adjustment reason codes. Visit ERA code lists for a complete list and usage notes.

Possible values
CO
OA
PI
PR
claimAdjustmentGroupCodeValue
transactions[].detailInfo[].paymentInfo[].claimAdjustments[].claimAdjustmentGroupCodeValue
String

The description of the claimAdjustmentGroupCode.

claimContactInformation
transactions[].detailInfo[].paymentInfo[].claimContactInformation
Array of Objects

Contact information for claim-related communications.

Array item
contactMethods
transactions[].detailInfo[].paymentInfo[].claimContactInformation[].contactMethods
Array of Objects
Array item
email
transactions[].detailInfo[].paymentInfo[].claimContactInformation[].contactMethods[].email
String

The email address.

fax
transactions[].detailInfo[].paymentInfo[].claimContactInformation[].contactMethods[].fax
String

The fax number.

phone
transactions[].detailInfo[].paymentInfo[].claimContactInformation[].contactMethods[].phone
String

The telephone number including the area code (if applicable). Phone numbers are formatted as AAABBBCCCC, where AAA represents the area code, BBB represents the telephone number prefix, and CCCC represents the telephone number. Phone numbers are provided without separators, such as dashes or parentheses. For example, 5551123345 for 555-112-3345.

phoneExtension
transactions[].detailInfo[].paymentInfo[].claimContactInformation[].contactMethods[].phoneExtension
String

The telephone extension, if applicable.

contactName
transactions[].detailInfo[].paymentInfo[].claimContactInformation[].contactName
String

The name of the contact person or entity.

claimPaymentInfo
transactions[].detailInfo[].paymentInfo[].claimPaymentInfo
Object

Basic claim payment information including amounts and status.

Show attributes
claimFilingIndicatorCode
transactions[].detailInfo[].paymentInfo[].claimPaymentInfo.claimFilingIndicatorCode
String

A code identifying the type of claim. For example DS - Disability. Visit ERA code lists for a complete list and usage notes.

Possible values
12
13
14
15
16
claimFrequencyCode
transactions[].detailInfo[].paymentInfo[].claimPaymentInfo.claimFrequencyCode
String

A code identifying the frequency of the claim. It matches what the payer received in the original claim. Visit Bill Type Frequency Codes for a complete list and definitions.

claimPaymentAmount
transactions[].detailInfo[].paymentInfo[].claimPaymentInfo.claimPaymentAmount
String

The total amount of the claim payment, expressed as a decimal. This value can be positive, zero, or negative.

claimStatusCode
transactions[].detailInfo[].paymentInfo[].claimPaymentInfo.claimStatusCode
String

The status of the claim. For example, 1 - Processed as Primary. Visit ERA code lists for a complete list and usage notes.

Possible values
1
2
3
4
19
diagnosisRelatedGroupDRGCode
transactions[].detailInfo[].paymentInfo[].claimPaymentInfo.diagnosisRelatedGroupDRGCode
String

Code indicating a patient's diagnosis group based on their medical symptoms.

diagnosisRelatedGroupDRGWeight
transactions[].detailInfo[].paymentInfo[].claimPaymentInfo.diagnosisRelatedGroupDRGWeight
String

The adjudicated diagnosis-related group (DRG) weight.

dischargeFraction
transactions[].detailInfo[].paymentInfo[].claimPaymentInfo.dischargeFraction
String

The adjudicated discharge fraction.

facilityTypeCode
transactions[].detailInfo[].paymentInfo[].claimPaymentInfo.facilityTypeCode
String

A code identifying where services were or may be performed. This is the Place of Service Codes for Professional or Dental Services.

patientControlNumber
transactions[].detailInfo[].paymentInfo[].claimPaymentInfo.patientControlNumber
String

The patient control number provided in the original claim. You can use this value to correlate the payer's response with the original claim.

patientResponsibilityAmount
transactions[].detailInfo[].paymentInfo[].claimPaymentInfo.patientResponsibilityAmount
String

The amount the patient is responsible for paying. This can include the deductible, non-covered services, co-pay, and co-insurance. This is not used for reversals.

payerClaimControlNumber
transactions[].detailInfo[].paymentInfo[].claimPaymentInfo.payerClaimControlNumber
String

The payer's internal control number for the claim.

totalClaimChargeAmount
transactions[].detailInfo[].paymentInfo[].claimPaymentInfo.totalClaimChargeAmount
String

The total amount of submitted charges for this claim, expressed as a decimal. This can be positive, zero, or negative. For example, this may contain a negative charge for a reversal claim.

claimReceivedDate
transactions[].detailInfo[].paymentInfo[].claimReceivedDate
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The date the claim was received by the payer.

claimStatementPeriodEnd
transactions[].detailInfo[].paymentInfo[].claimStatementPeriodEnd
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The claim period end date in ISO 8601 format (YYYY-MM-DD). This format is intentionally inconsistent with other date properties to maintain backwards compatibility.

claimStatementPeriodStart
transactions[].detailInfo[].paymentInfo[].claimStatementPeriodStart
StringRegex pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

The claim period start date in ISO 8601 format (YYYY-MM-DD). This format is intentionally inconsistent with other date properties to maintain backwards compatibility.

If the response doesn’t include a claimStatementPeriodEnd, you should assume the end date is the same as the start date.

claimSupplementalInformation
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformation
Object

Supplemental information about the claim.

Show attributes
coverageAmount
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformation.coverageAmount
String

The total covered charges. This is the sum of the original submitted provider charges that are considered for payment under the health plan. This excludes charges considered not covered, but includes reductions to payments of covered services, such as patient deductibles.

discountAmount
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformation.discountAmount
String

This is the Prompt Pay Discount Amount.

federalMedicareOrMedicaidPaymentMandateCategory1
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformation.federalMedicareOrMedicaidPaymentMandateCategory1
String

Federal Medicare or Medicaid Payment Mandate - Category 1.

federalMedicareOrMedicaidPaymentMandateCategory2
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformation.federalMedicareOrMedicaidPaymentMandateCategory2
String

Federal Medicare or Medicaid Payment Mandate - Category 2.

federalMedicareOrMedicaidPaymentMandateCategory3
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformation.federalMedicareOrMedicaidPaymentMandateCategory3
String

Federal Medicare or Medicaid Payment Mandate - Category 3.

federalMedicareOrMedicaidPaymentMandateCategory4
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformation.federalMedicareOrMedicaidPaymentMandateCategory4
String

Federal Medicare or Medicaid Payment Mandate - Category 4.

federalMedicareOrMedicaidPaymentMandateCategory5
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformation.federalMedicareOrMedicaidPaymentMandateCategory5
String

Federal Medicare or Medicaid Payment Mandate - Category 5.

interest
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformation.interest
String

The interest amount.

negativeLedgerBalance
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformation.negativeLedgerBalance
String

The negative ledger balance. Only used by Medicare Part A and Medicare Part B.

patientAmountPaid
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformation.patientAmountPaid
String

The amount the patient has already paid.

perDayLimit
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformation.perDayLimit
String

The per day limit.

tax
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformation.tax
String

The total taxes.

totalClaimBeforeTaxes
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformation.totalClaimBeforeTaxes
String

The total claim amount before taxes.

claimSupplementalInformationQuantities
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformationQuantities
Object

Supplemental quantity information about the claim.

Show attributes
coInsuredActual
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformationQuantities.coInsuredActual
String

The actual amount of co-insurance designated by the health plan.

coveredActual
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformationQuantities.coveredActual
String

The number of days covered.

federalMedicareOrMedicaidPaymentMandateCategory1
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformationQuantities.federalMedicareOrMedicaidPaymentMandateCategory1
String

Federal Medicare or Medicaid Payment Mandate - Category 1.

federalMedicareOrMedicaidPaymentMandateCategory2
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformationQuantities.federalMedicareOrMedicaidPaymentMandateCategory2
String

Federal Medicare or Medicaid Payment Mandate - Category 2.

federalMedicareOrMedicaidPaymentMandateCategory3
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformationQuantities.federalMedicareOrMedicaidPaymentMandateCategory3
String

Federal Medicare or Medicaid Payment Mandate - Category 3.

federalMedicareOrMedicaidPaymentMandateCategory4
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformationQuantities.federalMedicareOrMedicaidPaymentMandateCategory4
String

Federal Medicare or Medicaid Payment Mandate - Category 4.

federalMedicareOrMedicaidPaymentMandateCategory5
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformationQuantities.federalMedicareOrMedicaidPaymentMandateCategory5
String

Federal Medicare or Medicaid Payment Mandate - Category 5.

lifeTimeReserveActual
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformationQuantities.lifeTimeReserveActual
String

The actual lifetime reserve days.

lifeTimeReserveEstimated
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformationQuantities.lifeTimeReserveEstimated
String

The estimated lifetime reserve days.

nonCoveredEstimated
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformationQuantities.nonCoveredEstimated
String

The non-covered estimated amount.

notReplacedBloodUnits
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformationQuantities.notReplacedBloodUnits
String

The number of non-replaced blood units.

outlierDays
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformationQuantities.outlierDays
String

The number of outlier days.

prescription
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformationQuantities.prescription
String

The prescription.

visits
transactions[].detailInfo[].paymentInfo[].claimSupplementalInformationQuantities.visits
String

The number of visits.

correctedPatientOrInsuredName
transactions[].detailInfo[].paymentInfo[].correctedPatientOrInsuredName
Object

Corrected patient or insured name information.

Show attributes
firstName
transactions[].detailInfo[].paymentInfo[].correctedPatientOrInsuredName.firstName
String

The insured's first name.

insuredsChangedUniqueIdentificationNumber
transactions[].detailInfo[].paymentInfo[].correctedPatientOrInsuredName.insuredsChangedUniqueIdentificationNumber
String

The insured's changed unique identification number.

lastName
transactions[].detailInfo[].paymentInfo[].correctedPatientOrInsuredName.lastName
String

The insured's last name.

middleName
transactions[].detailInfo[].paymentInfo[].correctedPatientOrInsuredName.middleName
String

The insured's middle name or initial of the insured.

organizationName
transactions[].detailInfo[].paymentInfo[].correctedPatientOrInsuredName.organizationName
String

The business name of the insured when they are not an individual.

suffix
transactions[].detailInfo[].paymentInfo[].correctedPatientOrInsuredName.suffix
String

The insured's name suffix, such as Jr. or III.

correctedPriorityPayer
transactions[].detailInfo[].paymentInfo[].correctedPriorityPayer
Object

Corrected priority payer information.

Show attributes
blueCrossBlueShieldAssociationPlanCode
transactions[].detailInfo[].paymentInfo[].correctedPriorityPayer.blueCrossBlueShieldAssociationPlanCode
String

The provider's Blue Cross Blue Shield Association Plan Code.

centersForMedicareAndMedicaidServicesPlanId
transactions[].detailInfo[].paymentInfo[].correctedPriorityPayer.centersForMedicareAndMedicaidServicesPlanId
String

Used to report the provider's Health Plan ID (HPID) or Other Entity Identifier (OEID).

nationalAssociationOfInsuranceCommissionersIdentification
transactions[].detailInfo[].paymentInfo[].correctedPriorityPayer.nationalAssociationOfInsuranceCommissionersIdentification
String

The provider's National Association of Insurance Commissioners (NAIC) number.

organizationName
transactions[].detailInfo[].paymentInfo[].correctedPriorityPayer.organizationName
String

The provider's business name (when the provider is not an individual) or the provider's last name (when the provider is an individual).

payorId
transactions[].detailInfo[].paymentInfo[].correctedPriorityPayer.payorId
String

The provider's Payer Identification number.

pharmacyProcessorNumber
transactions[].detailInfo[].paymentInfo[].correctedPriorityPayer.pharmacyProcessorNumber
String

The provider's Pharmacy Processor Number.

taxId
transactions[].detailInfo[].paymentInfo[].correctedPriorityPayer.taxId
StringRegex pattern: ^\d{9}$

The provider's Federal Tax Identification Number.

coverageExpirationDate
transactions[].detailInfo[].paymentInfo[].coverageExpirationDate
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The expiration date of the patient's coverage.

crossoverCarrier
transactions[].detailInfo[].paymentInfo[].crossoverCarrier
Object

Crossover carrier information.

Show attributes
blueCrossBlueShieldAssociationPlanCode
transactions[].detailInfo[].paymentInfo[].crossoverCarrier.blueCrossBlueShieldAssociationPlanCode
String

The provider's Blue Cross Blue Shield Association Plan Code.

centersForMedicareAndMedicaidServicesPlanId
transactions[].detailInfo[].paymentInfo[].crossoverCarrier.centersForMedicareAndMedicaidServicesPlanId
String

Used to report the provider's Health Plan ID (HPID) or Other Entity Identifier (OEID).

nationalAssociationOfInsuranceCommissionersIdentification
transactions[].detailInfo[].paymentInfo[].crossoverCarrier.nationalAssociationOfInsuranceCommissionersIdentification
String

The provider's National Association of Insurance Commissioners (NAIC) number.

organizationName
transactions[].detailInfo[].paymentInfo[].crossoverCarrier.organizationName
String

The provider's business name (when the provider is not an individual) or the provider's last name (when the provider is an individual).

payorId
transactions[].detailInfo[].paymentInfo[].crossoverCarrier.payorId
String

The provider's Payer Identification number.

pharmacyProcessorNumber
transactions[].detailInfo[].paymentInfo[].crossoverCarrier.pharmacyProcessorNumber
String

The provider's Pharmacy Processor Number.

taxId
transactions[].detailInfo[].paymentInfo[].crossoverCarrier.taxId
StringRegex pattern: ^\d{9}$

The provider's Federal Tax Identification Number.

inpatientAdjudication
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication
Object

Inpatient adjudication information.

Show attributes
claimDRGAmount
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.claimDRGAmount
String

The Diagnosis Related Group (DRG) amount.

claimDisproportionateShareAmount
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.claimDisproportionateShareAmount
String

The Disproportionate Share amount.

claimIndirectTeachingAmount
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.claimIndirectTeachingAmount
String

The indirect teaching amount.

claimMSPPassThroughAmount
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.claimMSPPassThroughAmount
String

The Medicare Secondary Payer (MSP) pass-through amount.

claimPPSCapitalAmount
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.claimPPSCapitalAmount
String

The total Prospective Payment System (PPS) capital amount.

claimPPSCapitalOutlierAmount
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.claimPPSCapitalOutlierAmount
String

The Prospective Payment System (PPS) Capital Outlier amount.

claimPaymentRemarkCode1
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.claimPaymentRemarkCode1
String
claimPaymentRemarkCode2
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.claimPaymentRemarkCode2
String
claimPaymentRemarkCode3
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.claimPaymentRemarkCode3
String
claimPaymentRemarkCode4
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.claimPaymentRemarkCode4
String
claimPaymentRemarkCode5
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.claimPaymentRemarkCode5
String
costReportDayCount
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.costReportDayCount
String

The number of cost report days.

coveredDaysOrVisitsCount
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.coveredDaysOrVisitsCount
String

The number of days or visits covered by the health plan.

lifetimePsychiatricDaysCount
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.lifetimePsychiatricDaysCount
String

The number of psychiatric days for the patient's lifetime.

nonPayableProfessionalComponentAmount
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.nonPayableProfessionalComponentAmount
String

The professional component amount billed but not payable.

oldCapitalAmount
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.oldCapitalAmount
String

The old capital amount.

ppsCapitalDSHDRGAmount
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.ppsCapitalDSHDRGAmount
String

The Prospective Payment System (PPS) capital, disproportionate share, hospital Diagnosis Related Group (DRG) amount.

ppsCapitalExceptionAmount
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.ppsCapitalExceptionAmount
String

The capital exception amount.

ppsCapitalFSPDRGAmount
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.ppsCapitalFSPDRGAmount
String

The Prospective Payment System (PPS) capital, federal specific portion, Diagnosis Related Group (DRG) amount.

ppsCapitalHSPDRGAmount
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.ppsCapitalHSPDRGAmount
String

The Prospective Payment System (PPS) capital, hospital specific portion, Diagnosis Related Group (DRG), amount.

ppsCapitalIMEAmount
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.ppsCapitalIMEAmount
String

The Prospective Payment System (PPS) capital indirect medical education claim amount.

ppsOperatingFederalSpecificDRGAmount
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.ppsOperatingFederalSpecificDRGAmount
String

The federal specific Diagnosis Related Group (DRG) amount.

ppsOperatingHospitalSpecificDRGAmount
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.ppsOperatingHospitalSpecificDRGAmount
String

The hospital specific Diagnosis Related Group (DRG) Amount.

ppsOperatingOutlierAmount
transactions[].detailInfo[].paymentInfo[].inpatientAdjudication.ppsOperatingOutlierAmount
String

The Prospective Payment System (PPS) Operating Outlier amount, expressed as a decimal.

otherClaimRelatedIdentification
transactions[].detailInfo[].paymentInfo[].otherClaimRelatedIdentification
Object

Other claim-related identification numbers.

Show attributes
adjustedRePricedClaimReferenceNumber
transactions[].detailInfo[].paymentInfo[].otherClaimRelatedIdentification.adjustedRePricedClaimReferenceNumber
String

The adjusted repriced claim reference number.

authorizationNumber
transactions[].detailInfo[].paymentInfo[].otherClaimRelatedIdentification.authorizationNumber
String

An authorization number assigned by the adjudication process that was not provided prior to the services.

classOfContractCode
transactions[].detailInfo[].paymentInfo[].otherClaimRelatedIdentification.classOfContractCode
String

The class of contract code.

classOfContractCodes
transactions[].detailInfo[].paymentInfo[].otherClaimRelatedIdentification.classOfContractCodes
Array of Strings

A list of class of contract codes when multiple codes are applicable.

employeeIdentificationNumber
transactions[].detailInfo[].paymentInfo[].otherClaimRelatedIdentification.employeeIdentificationNumber
String

The employee identification number.

groupNumber
transactions[].detailInfo[].paymentInfo[].otherClaimRelatedIdentification.groupNumber
String

The other insured group number.

groupOrPolicyNumber
transactions[].detailInfo[].paymentInfo[].otherClaimRelatedIdentification.groupOrPolicyNumber
String

The group or policy number for the health plan.

insurancePolicyNumber
transactions[].detailInfo[].paymentInfo[].otherClaimRelatedIdentification.insurancePolicyNumber
String

The insurance policy number.

medicalRecordIdentificationNumber
transactions[].detailInfo[].paymentInfo[].otherClaimRelatedIdentification.medicalRecordIdentificationNumber
String

The medical record identification number.

memberIdentificationNumber
transactions[].detailInfo[].paymentInfo[].otherClaimRelatedIdentification.memberIdentificationNumber
String

The health plan member identification number.

originalReferenceNumber
transactions[].detailInfo[].paymentInfo[].otherClaimRelatedIdentification.originalReferenceNumber
String

The reference number for the original claim. This is included for correction claims.

predeterminationOfBenefitsIdentificationNumber
transactions[].detailInfo[].paymentInfo[].otherClaimRelatedIdentification.predeterminationOfBenefitsIdentificationNumber
String

The predetermination of benefits identification number.

priorAuthorizationNumber
transactions[].detailInfo[].paymentInfo[].otherClaimRelatedIdentification.priorAuthorizationNumber
String

The prior authorization number.

rePricedClaimReferenceNumber
transactions[].detailInfo[].paymentInfo[].otherClaimRelatedIdentification.rePricedClaimReferenceNumber
String

The repriced claim reference number.

ssn
transactions[].detailInfo[].paymentInfo[].otherClaimRelatedIdentification.ssn
StringRegex pattern: ^\d{9}$

The social security number (SSN).

otherSubscriber
transactions[].detailInfo[].paymentInfo[].otherSubscriber
Object

Other subscriber information.

Show attributes
firstName
transactions[].detailInfo[].paymentInfo[].otherSubscriber.firstName
String

The subscriber's first name.

lastName
transactions[].detailInfo[].paymentInfo[].otherSubscriber.lastName
String

The subscriber's last name.

memberId
transactions[].detailInfo[].paymentInfo[].otherSubscriber.memberId
String

The subscriber's member ID for their health plan.

middleName
transactions[].detailInfo[].paymentInfo[].otherSubscriber.middleName
String

The subscriber's middle name or initial.

organizationName
transactions[].detailInfo[].paymentInfo[].otherSubscriber.organizationName
String

The subscriber's business name, if the subscriber is not an individual.

standardUniqueHealthIdentifierForEachIndividualInTheUnitedStates
transactions[].detailInfo[].paymentInfo[].otherSubscriber.standardUniqueHealthIdentifierForEachIndividualInTheUnitedStates
String

Deprecated

suffix
transactions[].detailInfo[].paymentInfo[].otherSubscriber.suffix
String

The subscriber's name suffix, such as Jr. or III.

taxId
transactions[].detailInfo[].paymentInfo[].otherSubscriber.taxId
StringRegex pattern: ^\d{9}$

The subscriber's Federal Taxpayer's Identification Number. Only used when the subscriber is a business entity and not an individual.

outpatientAdjudication
transactions[].detailInfo[].paymentInfo[].outpatientAdjudication
Object

Outpatient adjudication information.

Show attributes
claimESRDPaymentAmount
transactions[].detailInfo[].paymentInfo[].outpatientAdjudication.claimESRDPaymentAmount
String

The End Stage Renal Disease (ESRD) payment amount.

claimHCPCSPayableAmount
transactions[].detailInfo[].paymentInfo[].outpatientAdjudication.claimHCPCSPayableAmount
String

The claim Health Care Financing Administration Common Procedural Coding System (HCPCS) payable amount, expressed as a decimal.

claimPaymentRemarkCode1
transactions[].detailInfo[].paymentInfo[].outpatientAdjudication.claimPaymentRemarkCode1
String
claimPaymentRemarkCode2
transactions[].detailInfo[].paymentInfo[].outpatientAdjudication.claimPaymentRemarkCode2
String
claimPaymentRemarkCode3
transactions[].detailInfo[].paymentInfo[].outpatientAdjudication.claimPaymentRemarkCode3
String
claimPaymentRemarkCode4
transactions[].detailInfo[].paymentInfo[].outpatientAdjudication.claimPaymentRemarkCode4
String
claimPaymentRemarkCode5
transactions[].detailInfo[].paymentInfo[].outpatientAdjudication.claimPaymentRemarkCode5
String
nonPayableProfessionalComponentAmount
transactions[].detailInfo[].paymentInfo[].outpatientAdjudication.nonPayableProfessionalComponentAmount
String

The professional component amount billed but not payable.

reimbursementRate
transactions[].detailInfo[].paymentInfo[].outpatientAdjudication.reimbursementRate
String

The reimbursement rate, expressed as a decimal.

patientName
transactions[].detailInfo[].paymentInfo[].patientName
Object

Patient name information.

Show attributes
firstName
transactions[].detailInfo[].paymentInfo[].patientName.firstName
String

The patient's first name.

healthInsuranceClaimNumber
transactions[].detailInfo[].paymentInfo[].patientName.healthInsuranceClaimNumber
String

The patient's Health Insurance Claim (HIC) Number.

lastName
transactions[].detailInfo[].paymentInfo[].patientName.lastName
String

The patient's last name.

medicaidRecipientIdentificationNumber
transactions[].detailInfo[].paymentInfo[].patientName.medicaidRecipientIdentificationNumber
String

The patient's Medicaid Recipient Identification Number.

memberId
transactions[].detailInfo[].paymentInfo[].patientName.memberId
String

The patient's member ID number for their health plan.

middleName
transactions[].detailInfo[].paymentInfo[].patientName.middleName
String

The patient's middle name or initial.

ssn
transactions[].detailInfo[].paymentInfo[].patientName.ssn
StringRegex pattern: ^\d{9}$

The patient's Social Security Number (SSN).

standardUniqueHealthIdentifierForEachIndividualInTheUnitedStates
transactions[].detailInfo[].paymentInfo[].patientName.standardUniqueHealthIdentifierForEachIndividualInTheUnitedStates
String

Deprecated.

suffix
transactions[].detailInfo[].paymentInfo[].patientName.suffix
String

The patient's name suffix, such as Jr or III.

renderingProvider
transactions[].detailInfo[].paymentInfo[].renderingProvider
Object

Information about the provider who rendered services.

Show attributes
blueCrossProviderNumber
transactions[].detailInfo[].paymentInfo[].renderingProvider.blueCrossProviderNumber
String

The rendering provider's Blue Cross Provider Number.

blueShieldProviderNumber
transactions[].detailInfo[].paymentInfo[].renderingProvider.blueShieldProviderNumber
String

The rendering provider's Blue Shield Provider Number.

firstName
transactions[].detailInfo[].paymentInfo[].renderingProvider.firstName
String

The rendering provider's first name.

lastName
transactions[].detailInfo[].paymentInfo[].renderingProvider.lastName
String

The rendering provider's last name.

medicaidProviderNumber
transactions[].detailInfo[].paymentInfo[].renderingProvider.medicaidProviderNumber
String

The rendering provider's Medicare Provider Number.

middleName
transactions[].detailInfo[].paymentInfo[].renderingProvider.middleName
String

The rendering provider's middle name or initial.

npi
transactions[].detailInfo[].paymentInfo[].renderingProvider.npi
StringRegex pattern: ^\d{10}$

The rendering provider's National Provider Identifier (NPI).

organizationName
transactions[].detailInfo[].paymentInfo[].renderingProvider.organizationName
String

The rendering provider's business name.

providerCommercialNumber
transactions[].detailInfo[].paymentInfo[].renderingProvider.providerCommercialNumber
String

The rendering provider's Provider Commercial Number.

stateLicenseNumber
transactions[].detailInfo[].paymentInfo[].renderingProvider.stateLicenseNumber
String

The rendering provider's State License Number.

suffix
transactions[].detailInfo[].paymentInfo[].renderingProvider.suffix
String

The rendering provider's name suffix, such as Jr. or III.

taxId
transactions[].detailInfo[].paymentInfo[].renderingProvider.taxId
StringRegex pattern: ^\d{9}$

The rendering provider's Federal Taxpayer Identification Number.

uniquePhysicianIdentificationNumber
transactions[].detailInfo[].paymentInfo[].renderingProvider.uniquePhysicianIdentificationNumber
String

Deprecated; replaced by NPI in 2007.

renderingProviderIdentification
transactions[].detailInfo[].paymentInfo[].renderingProviderIdentification
Object

Rendering provider identification information.

Show attributes
blueCrossProviderNumber
transactions[].detailInfo[].paymentInfo[].renderingProviderIdentification.blueCrossProviderNumber
String

The rendering provider's Blue Cross Provider Number.

blueShieldProviderNumber
transactions[].detailInfo[].paymentInfo[].renderingProviderIdentification.blueShieldProviderNumber
String

The rendering provider's Blue Shield Provider Number.

champusIdentificationNumber
transactions[].detailInfo[].paymentInfo[].renderingProviderIdentification.champusIdentificationNumber
String

The rendering provider's CHAMPUS Identification Number.

facilityIdNumber
transactions[].detailInfo[].paymentInfo[].renderingProviderIdentification.facilityIdNumber
String

The rendering provider's Facility ID Number.

locationNumber
transactions[].detailInfo[].paymentInfo[].renderingProviderIdentification.locationNumber
String

The rendering provider's Location Number.

medicaidProviderNumber
transactions[].detailInfo[].paymentInfo[].renderingProviderIdentification.medicaidProviderNumber
String

The rendering provider's Medicaid Provider Number.

medicareProviderNumber
transactions[].detailInfo[].paymentInfo[].renderingProviderIdentification.medicareProviderNumber
String

The rendering provider's Medicare Provider Number.

nationalCouncilForPrescriptionDrugProgramPharmacyNumber
transactions[].detailInfo[].paymentInfo[].renderingProviderIdentification.nationalCouncilForPrescriptionDrugProgramPharmacyNumber
String

The rendering provider's National Council for Prescription Drug Program Pharmacy Number.

providerCommercialNumber
transactions[].detailInfo[].paymentInfo[].renderingProviderIdentification.providerCommercialNumber
String

The rendering provider's Provider Commercial Number.

providerUPINNumber
transactions[].detailInfo[].paymentInfo[].renderingProviderIdentification.providerUPINNumber
String

Deprecated; replaced by NPI in 2007.

stateLicenseNumber
transactions[].detailInfo[].paymentInfo[].renderingProviderIdentification.stateLicenseNumber
String

The rendering provider's State License Number.

serviceLines
transactions[].detailInfo[].paymentInfo[].serviceLines
Array of Objects

Service lines included in this claim.

Array item
healthCareCheckRemarkCodes
transactions[].detailInfo[].paymentInfo[].serviceLines[].healthCareCheckRemarkCodes
Array of Objects

Healthcare check remark codes for this service.

Array item
codeListQualifierCode
transactions[].detailInfo[].paymentInfo[].serviceLines[].healthCareCheckRemarkCodes[].codeListQualifierCode
String

Code identifying the specific industry code list containing the remarkCode. Can be HE - Claim Payment Remark Codes or RX - National Council for Prescription Drug Programs Reject/Payment Codes.

codeListQualifierCodeValue
transactions[].detailInfo[].paymentInfo[].serviceLines[].healthCareCheckRemarkCodes[].codeListQualifierCodeValue
String

The description of the codeListQualifierCode. Can be Claim Payment Remark Codes or National Council for Prescription Drug Programs Reject/Payment Codes.

remark
transactions[].detailInfo[].paymentInfo[].serviceLines[].healthCareCheckRemarkCodes[].remark
String

The human readable description of the remark code.

remarkCode
transactions[].detailInfo[].paymentInfo[].serviceLines[].healthCareCheckRemarkCodes[].remarkCode
String

The code identifying the specific remark.

This property can either be a Remittance Advice Remark Code (RARC) (codeListQualifierCode set to HE) or a National Council for Prescription Drug Programs Reject/Payment Code (codeListQualifierCode set to RX).

healthCarePolicyIdentification
transactions[].detailInfo[].paymentInfo[].serviceLines[].healthCarePolicyIdentification
Array of Objects

Healthcare policy identification for this service.

Array item
policyFormIdentifyingNumber
transactions[].detailInfo[].paymentInfo[].serviceLines[].healthCarePolicyIdentification[].policyFormIdentifyingNumber
String

The identifying number for the policy form.

lineItemControlNumber
transactions[].detailInfo[].paymentInfo[].serviceLines[].lineItemControlNumber
String

The providerControlNumber submitted in the original claim to identify the service line.

renderingProviderInformation
transactions[].detailInfo[].paymentInfo[].serviceLines[].renderingProviderInformation
Object

Information about the provider who rendered this service.

Show attributes
blueCrossProviderNumber
transactions[].detailInfo[].paymentInfo[].serviceLines[].renderingProviderInformation.blueCrossProviderNumber
String

The rendering provider's Blue Cross Provider Number.

blueShieldProviderNumber
transactions[].detailInfo[].paymentInfo[].serviceLines[].renderingProviderInformation.blueShieldProviderNumber
String

The rendering provider's Blue Shield Provider Number.

champusIdentificationNumber
transactions[].detailInfo[].paymentInfo[].serviceLines[].renderingProviderInformation.champusIdentificationNumber
String

The rendering provider's CHAMPUS Identification Number.

facilityIdNumber
transactions[].detailInfo[].paymentInfo[].serviceLines[].renderingProviderInformation.facilityIdNumber
String

The rendering provider's Facility ID Number.

federalTaxpayerIdentificationNumber
transactions[].detailInfo[].paymentInfo[].serviceLines[].renderingProviderInformation.federalTaxpayerIdentificationNumber
String

The rendering provider's Federal Taxpayer Identification Number.

medicaidProviderNumber
transactions[].detailInfo[].paymentInfo[].serviceLines[].renderingProviderInformation.medicaidProviderNumber
String

The rendering provider's Medicaid Provider Number.

medicareProviderNumber
transactions[].detailInfo[].paymentInfo[].serviceLines[].renderingProviderInformation.medicareProviderNumber
String

The rendering provider's Medicare Provider Number.

nationalCouncilForPrescriptionDrugProgramPharmacyNumber
transactions[].detailInfo[].paymentInfo[].serviceLines[].renderingProviderInformation.nationalCouncilForPrescriptionDrugProgramPharmacyNumber
String

The rendering provider's National Council for Prescription Drug Programs Pharmacy Number.

npi
transactions[].detailInfo[].paymentInfo[].serviceLines[].renderingProviderInformation.npi
StringRegex pattern: ^\d{10}$

The rendering provider's National Provider Identifier (NPI).

providerCommercialNumber
transactions[].detailInfo[].paymentInfo[].serviceLines[].renderingProviderInformation.providerCommercialNumber
String

The Provider Commercial Number.

providerUPINNumber
transactions[].detailInfo[].paymentInfo[].serviceLines[].renderingProviderInformation.providerUPINNumber
String

Deprecated; replaced by NPI in 2007.

ssn
transactions[].detailInfo[].paymentInfo[].serviceLines[].renderingProviderInformation.ssn
StringRegex pattern: ^\d{9}$

The rendering provider's Social Security Number (SSN).

stateLicenseNumber
transactions[].detailInfo[].paymentInfo[].serviceLines[].renderingProviderInformation.stateLicenseNumber
String

The rendering provider's State License Number.

serviceAdjustments
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments
Array of Objects

Adjustments applied to this service line.

Array item
adjustmentAmount1
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentAmount1
String

The amount of the adjustment. A negative amount increases the claim payment and a positive amount decreases the claim payment.

adjustmentAmount2
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentAmount2
String

The amount of the adjustment. A negative amount increases the claim payment and a positive amount decreases the claim payment.

adjustmentAmount3
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentAmount3
String

The amount of the adjustment. A negative amount increases the claim payment and a positive amount decreases the claim payment.

adjustmentAmount4
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentAmount4
String

The amount of the adjustment. A negative amount increases the claim payment and a positive amount decreases the claim payment.

adjustmentAmount5
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentAmount5
String

The amount of the adjustment. A negative amount increases the claim payment and a positive amount decreases the claim payment.

adjustmentAmount6
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentAmount6
String

The amount of the adjustment. A negative amount increases the claim payment and a positive amount decreases the claim payment.

adjustmentQuantity1
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentQuantity1
String

The units of service being adjusted. A positive value decreases the covered days and a negative number increases the covered days.

adjustmentQuantity2
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentQuantity2
String

The units of service being adjusted. A positive value decreases the covered days and a negative number increases the covered days.

adjustmentQuantity3
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentQuantity3
String

The units of service being adjusted. A positive value decreases the covered days and a negative number increases the covered days.

adjustmentQuantity4
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentQuantity4
String

The units of service being adjusted. A positive value decreases the covered days and a negative number increases the covered days.

adjustmentQuantity5
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentQuantity5
String

The units of service being adjusted. A positive value decreases the covered days and a negative number increases the covered days.

adjustmentQuantity6
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentQuantity6
String

The units of service being adjusted. A positive value decreases the covered days and a negative number increases the covered days.

adjustmentReason1
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentReason1
String

A description identifying the detailed reason the adjustment was made.

adjustmentReason2
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentReason2
String

A description identifying the detailed reason the adjustment was made.

adjustmentReason3
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentReason3
String

A description identifying the detailed reason the adjustment was made.

adjustmentReason4
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentReason4
String

A description identifying the detailed reason the adjustment was made.

adjustmentReason5
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentReason5
String

A description identifying the detailed reason the adjustment was made.

adjustmentReason6
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentReason6
String

A description identifying the detailed reason the adjustment was made.

adjustmentReasonCode1
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentReasonCode1
String

A code identifying the detailed reason the adjustment was made. Visit Claim Adjustment Reason Codes in the X12 documentation for a complete list.

adjustmentReasonCode2
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentReasonCode2
String

A code identifying the detailed reason the adjustment was made. Visit Claim Adjustment Reason Codes in the X12 documentation for a complete list.

adjustmentReasonCode3
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentReasonCode3
String

A code identifying the detailed reason the adjustment was made. Visit Claim Adjustment Reason Codes in the X12 documentation for a complete list.

adjustmentReasonCode4
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentReasonCode4
String

A code identifying the detailed reason the adjustment was made. Visit Claim Adjustment Reason Codes in the X12 documentation for a complete list.

adjustmentReasonCode5
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentReasonCode5
String

A code identifying the detailed reason the adjustment was made. Visit Claim Adjustment Reason Codes in the X12 documentation for a complete list.

adjustmentReasonCode6
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].adjustmentReasonCode6
String

A code identifying the detailed reason the adjustment was made. Visit Claim Adjustment Reason Codes in the X12 documentation for a complete list.

claimAdjustmentGroupCode
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].claimAdjustmentGroupCode
String

The code identifying the category of adjustment reason codes. Visit ERA code lists for a complete list and usage notes.

Possible values
CO
OA
PI
PR
claimAdjustmentGroupCodeValue
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceAdjustments[].claimAdjustmentGroupCodeValue
String

The description of the claimAdjustmentGroupCode.

serviceDate
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceDate
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The date the service was rendered. Used for single-day services.

serviceEndDate
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceEndDate
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The date the service ended. Used for multi-day services.

serviceIdentification
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceIdentification
Object

Service identification details.

Show attributes
ambulatoryPatientGroupNumber
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceIdentification.ambulatoryPatientGroupNumber
String

The service line's Ambulatory Patient Group (APG) Number.

ambulatoryPaymentClassification
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceIdentification.ambulatoryPaymentClassification
String

The service line's Ambulatory Payment Classification Number.

attachmentCode
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceIdentification.attachmentCode
String

The service line's Attachment Code.

authorizationNumber
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceIdentification.authorizationNumber
String

The service line's Authorization Number.

locationNumber
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceIdentification.locationNumber
String

The payer's identification for the provider location.

preDeterminationOfBenefitsIdentificationNumber
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceIdentification.preDeterminationOfBenefitsIdentificationNumber
String

The service line's Predetermination of Benefits Identification Number.

priorAuthorizationNumber
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceIdentification.priorAuthorizationNumber
String

The service line's Prior Authorization Number.

rateCodeNumber
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceIdentification.rateCodeNumber
String

The service line's Rate code number, a percentage that reflects the Ambulatory Surgical Center (ASC) rate for Medicare. This is either 0, 50, 100, or 150.

servicePaymentInformation
transactions[].detailInfo[].paymentInfo[].serviceLines[].servicePaymentInformation
Object

Payment information for this service line.

Show attributes
adjudicatedProcedureCode
transactions[].detailInfo[].paymentInfo[].serviceLines[].servicePaymentInformation.adjudicatedProcedureCode
String

The adjudicated procedure code - an identifying number for a product or service.

adjudicatedProcedureModifierCodes
transactions[].detailInfo[].paymentInfo[].serviceLines[].servicePaymentInformation.adjudicatedProcedureModifierCodes
Array of Strings

A list of up to four modifiers that identify special circumstances related to the product or service.

lineItemChargeAmount
transactions[].detailInfo[].paymentInfo[].serviceLines[].servicePaymentInformation.lineItemChargeAmount
String

The submitted service charge, expressed as a decimal.

lineItemProviderPaymentAmount
transactions[].detailInfo[].paymentInfo[].serviceLines[].servicePaymentInformation.lineItemProviderPaymentAmount
String

The amount paid for the service, expressed as a decimal.

This amount is calculated as follows:

servicePaymentInformation.lineItemProviderPaymentAmount = servicePaymentInformation.lineItemChargeAmount - (sum(serviceAdjustments[].adjustmentAmount1) + sum(serviceAdjustments[].adjustmentAmount2) + sum(serviceAdjustments[].adjustmentAmount3) + sum(serviceAdjustments[].adjustmentAmount4) + sum(serviceAdjustments[].adjustmentAmount5) + sum(serviceAdjustments[].adjustmentAmount6))

All properties in the formula are within a single transactions.detailInfo.paymentInfo.serviceLines array entry. Note that serviceAdjustments is an object array that could contain up to 99 entries, each with up to 6 adjustment amounts in separate properties. This allows for up to 594 total adjustments.

Adjustments can be either positive or negative. When the adjustment amounts are positive, the payment decreases. When the adjustment amounts are negative, the payment amount increases, and will be larger than the lineItemChargeAmount.

nationalUniformBillingCommitteeRevenueCode
transactions[].detailInfo[].paymentInfo[].serviceLines[].servicePaymentInformation.nationalUniformBillingCommitteeRevenueCode
String

The National Uniform Billing Committee Revenue Code.

originalUnitsOfServiceCount
transactions[].detailInfo[].paymentInfo[].serviceLines[].servicePaymentInformation.originalUnitsOfServiceCount
String

The original number of units of service submitted, expressed as a decimal.

productOrServiceIDQualifier
transactions[].detailInfo[].paymentInfo[].serviceLines[].servicePaymentInformation.productOrServiceIDQualifier
String

The code identifying the source of the adjudicatedProcedureCode.

Possible values
HC
AD
ER
IV
N4
productOrServiceIDQualifierValue
transactions[].detailInfo[].paymentInfo[].serviceLines[].servicePaymentInformation.productOrServiceIDQualifierValue
String

The description of the productOrServiceIDQualifier.

submittedAdjudicatedProcedureCode
transactions[].detailInfo[].paymentInfo[].serviceLines[].servicePaymentInformation.submittedAdjudicatedProcedureCode
String

The submitted adjudicated procedure code - an identifying number for a product or service.

submittedAdjudicatedProcedureModifierCodes
transactions[].detailInfo[].paymentInfo[].serviceLines[].servicePaymentInformation.submittedAdjudicatedProcedureModifierCodes
Array of Strings

A list of up to four modifiers that identify special circumstances related to the product or service.

submittedProcedureCodeDescription
transactions[].detailInfo[].paymentInfo[].serviceLines[].servicePaymentInformation.submittedProcedureCodeDescription
String

A free-form description to further clarify the procedure code and any modifiers.

submittedProductOrServiceIDQualifier
transactions[].detailInfo[].paymentInfo[].serviceLines[].servicePaymentInformation.submittedProductOrServiceIDQualifier
String

The code identifying the source of the submittedAdjudicatedProcedureCode.

Possible values
HC
AD
ER
IV
N4
submittedProductOrServiceIDQualifierValue
transactions[].detailInfo[].paymentInfo[].serviceLines[].servicePaymentInformation.submittedProductOrServiceIDQualifierValue
String

The description of the submittedProductOrServiceIDQualifier.

unitsOfServicePaidCount
transactions[].detailInfo[].paymentInfo[].serviceLines[].servicePaymentInformation.unitsOfServicePaidCount
String

The number of units of service that were paid, expressed as a decimal. If not present, the value is assumed to be one.

serviceStartDate
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceStartDate
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The date the service began. Used for multi-day services.

serviceSupplementalAmounts
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceSupplementalAmounts
Object

Supplemental amount information for this service.

Show attributes
allowedActual
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceSupplementalAmounts.allowedActual
String

The payer payment plus any assigned patient responsibility.

deductionAmount
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceSupplementalAmounts.deductionAmount
String

This is the late filing reduction amount.

federalMedicareOrMedicaidPaymentMandateCategory1
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceSupplementalAmounts.federalMedicareOrMedicaidPaymentMandateCategory1
String

Federal Medicare or Medicaid Payment Mandate - Category 1.

federalMedicareOrMedicaidPaymentMandateCategory2
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceSupplementalAmounts.federalMedicareOrMedicaidPaymentMandateCategory2
String

Federal Medicare or Medicaid Payment Mandate - Category 2.

federalMedicareOrMedicaidPaymentMandateCategory3
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceSupplementalAmounts.federalMedicareOrMedicaidPaymentMandateCategory3
String

Federal Medicare or Medicaid Payment Mandate - Category 3.

federalMedicareOrMedicaidPaymentMandateCategory4
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceSupplementalAmounts.federalMedicareOrMedicaidPaymentMandateCategory4
String

Federal Medicare or Medicaid Payment Mandate - Category 4.

federalMedicareOrMedicaidPaymentMandateCategory5
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceSupplementalAmounts.federalMedicareOrMedicaidPaymentMandateCategory5
String

Federal Medicare or Medicaid Payment Mandate - Category 5.

tax
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceSupplementalAmounts.tax
String

The tax amount.

totalClaimBeforeTaxes
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceSupplementalAmounts.totalClaimBeforeTaxes
String

The total amount for the service charge before taxes.

serviceSupplementalQuantities
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceSupplementalQuantities
Object

Supplemental quantity information for this service.

Show attributes
federalMedicareOrMedicaidPaymentMandateCategory1
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceSupplementalQuantities.federalMedicareOrMedicaidPaymentMandateCategory1
String

Federal Medicare or Medicaid Payment Mandate - Category 1.

federalMedicareOrMedicaidPaymentMandateCategory2
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceSupplementalQuantities.federalMedicareOrMedicaidPaymentMandateCategory2
String

Federal Medicare or Medicaid Payment Mandate - Category 2.

federalMedicareOrMedicaidPaymentMandateCategory3
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceSupplementalQuantities.federalMedicareOrMedicaidPaymentMandateCategory3
String

Federal Medicare or Medicaid Payment Mandate - Category 3.

federalMedicareOrMedicaidPaymentMandateCategory4
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceSupplementalQuantities.federalMedicareOrMedicaidPaymentMandateCategory4
String

Federal Medicare or Medicaid Payment Mandate - Category 4.

federalMedicareOrMedicaidPaymentMandateCategory5
transactions[].detailInfo[].paymentInfo[].serviceLines[].serviceSupplementalQuantities.federalMedicareOrMedicaidPaymentMandateCategory5
String

Federal Medicare or Medicaid Payment Mandate - Category 5.

subscriber
transactions[].detailInfo[].paymentInfo[].subscriber
Object

Subscriber information for the insurance policy.

Show attributes
firstName
transactions[].detailInfo[].paymentInfo[].subscriber.firstName
String

The subscriber's first name.

lastName
transactions[].detailInfo[].paymentInfo[].subscriber.lastName
String

The subscriber's last name.

memberId
transactions[].detailInfo[].paymentInfo[].subscriber.memberId
String

The subscriber's member ID for their health plan.

middleName
transactions[].detailInfo[].paymentInfo[].subscriber.middleName
String

The subscriber's middle name or initial.

organizationName
transactions[].detailInfo[].paymentInfo[].subscriber.organizationName
String

The subscriber's business name, if the subscriber is not an individual.

standardUniqueHealthIdentifierForEachIndividualInTheUnitedStates
transactions[].detailInfo[].paymentInfo[].subscriber.standardUniqueHealthIdentifierForEachIndividualInTheUnitedStates
String

Deprecated

suffix
transactions[].detailInfo[].paymentInfo[].subscriber.suffix
String

The subscriber's name suffix, such as Jr. or III.

taxId
transactions[].detailInfo[].paymentInfo[].subscriber.taxId
StringRegex pattern: ^\d{9}$

The subscriber's Federal Taxpayer's Identification Number. Only used when the subscriber is a business entity and not an individual.

providerSummaryInformation
transactions[].detailInfo[].providerSummaryInformation
Object

Summary information about the provider.

Show attributes
facilityTypeCode
transactions[].detailInfo[].providerSummaryInformation.facilityTypeCode
String

A code identifying the type of facility where services were performed. This is the Place of Service Codes for Professional or Dental Services.

fiscalPeriodDate
transactions[].detailInfo[].providerSummaryInformation.fiscalPeriodDate
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The last day of the provider's fiscal year.

providerIdentifier
transactions[].detailInfo[].providerSummaryInformation.providerIdentifier
String

The provider number.

totalClaimChargeAmount
transactions[].detailInfo[].providerSummaryInformation.totalClaimChargeAmount
String

The total of the charges reported for all claims, expressed as a decimal.

totalClaimCount
transactions[].detailInfo[].providerSummaryInformation.totalClaimCount
String

The total number of claims.

totalHCPCSPayableAmount
transactions[].detailInfo[].providerSummaryInformation.totalHCPCSPayableAmount
String

The total of the charges reported for all HCPCS codes that are payable, expressed as a decimal.

totalHCPCSReportedChargeAmount
transactions[].detailInfo[].providerSummaryInformation.totalHCPCSReportedChargeAmount
String

The total of the charges reported for all Health Care Financing Administration Common Procedural Coding System (HCPCS) codes, expressed as a decimal.

totalMSPPatientLiabilityMetAmount
transactions[].detailInfo[].providerSummaryInformation.totalMSPPatientLiabilityMetAmount
String

The total Medicare Secondary Payer (MSP) patient liability met, expressed as a decimal.

totalMSPPayerAmount
transactions[].detailInfo[].providerSummaryInformation.totalMSPPayerAmount
String

The total Medicare Secondary Payer (MSP) primary payer amount, expressed as a decimal.

totalNonLabChargeAmount
transactions[].detailInfo[].providerSummaryInformation.totalNonLabChargeAmount
String

The total of non-laboratory charges, expressed as a decimal.

totalPIPAdjustmentAmount
transactions[].detailInfo[].providerSummaryInformation.totalPIPAdjustmentAmount
String

The total periodic interim payment (PIP) adjustment amount, expressed as a decimal.

totalPIPClaimCount
transactions[].detailInfo[].providerSummaryInformation.totalPIPClaimCount
String

The total periodic interim payment (PIP) number of claims, expressed as a decimal.

totalPatientReimbursementAmount
transactions[].detailInfo[].providerSummaryInformation.totalPatientReimbursementAmount
String

The total patient reimbursement amount, expressed as a decimal.

totalProfessionalComponentAmount
transactions[].detailInfo[].providerSummaryInformation.totalProfessionalComponentAmount
String

The total of the professional component charges, expressed as a decimal.

providerSupplementalSummaryInformation
transactions[].detailInfo[].providerSupplementalSummaryInformation
Object

Supplemental summary information about the provider.

Show attributes
averageDRGLengthOfStay
transactions[].detailInfo[].providerSupplementalSummaryInformation.averageDRGLengthOfStay
String

The average length of stay for diagnosis related group (DRG) claims.

averageDRGWeight
transactions[].detailInfo[].providerSupplementalSummaryInformation.averageDRGWeight
String

The average diagnosis-related group (DRG) weight.

totalCapitalAmount
transactions[].detailInfo[].providerSupplementalSummaryInformation.totalCapitalAmount
String

The total capital amount. This includes: capital federal-specfic amount, hospital federal-specfic amount, hold harmless amount, Indirect Medical Education amount, Disproportionate Share Hospital amount, and the exception amount. It does not include any capital outlier amount.

totalCostOutlierAmount
transactions[].detailInfo[].providerSupplementalSummaryInformation.totalCostOutlierAmount
String

The total cost outlier amount.

totalCostReportDayCount
transactions[].detailInfo[].providerSupplementalSummaryInformation.totalCostReportDayCount
String

The total number of cost report days.

totalCoveredDayCount
transactions[].detailInfo[].providerSupplementalSummaryInformation.totalCoveredDayCount
String

The total number of covered days.

totalDRGAmount
transactions[].detailInfo[].providerSupplementalSummaryInformation.totalDRGAmount
String

The total of the charges reported for all diagnosis-related group (DRG) codes.

totalDayOutlierAmount
transactions[].detailInfo[].providerSupplementalSummaryInformation.totalDayOutlierAmount
String

The total day outlier amount.

totalDischargeCount
transactions[].detailInfo[].providerSupplementalSummaryInformation.totalDischargeCount
String

The total number of discharges.

totalDisproportionateShareAmount
transactions[].detailInfo[].providerSupplementalSummaryInformation.totalDisproportionateShareAmount
String

The total disproportionate share amount.

totalFederalSpecificAmount
transactions[].detailInfo[].providerSupplementalSummaryInformation.totalFederalSpecificAmount
String

The total federal specific amount.

totalHospitalSpecificAmount
transactions[].detailInfo[].providerSupplementalSummaryInformation.totalHospitalSpecificAmount
String

The total hospital specific amount.

totalIndirectMedicalEducationAmount
transactions[].detailInfo[].providerSupplementalSummaryInformation.totalIndirectMedicalEducationAmount
String

The total indirect medical education amount.

totalMSPPassThroughAmount
transactions[].detailInfo[].providerSupplementalSummaryInformation.totalMSPPassThroughAmount
String

The total Medicare Secondary Payer (MSP) pass-through amount, calculated for a non-Medicare payer.

totalNonCoveredDayCount
transactions[].detailInfo[].providerSupplementalSummaryInformation.totalNonCoveredDayCount
String

The total number of non-covered days.

totalOutlierDayCount
transactions[].detailInfo[].providerSupplementalSummaryInformation.totalOutlierDayCount
String

The total number of outlier days.

totalPPSCapitalFSPDRGAmount
transactions[].detailInfo[].providerSupplementalSummaryInformation.totalPPSCapitalFSPDRGAmount
String

The total prospective payment system (PPS) capital, federal-specific portion, diagnosis-related group (DRG) amount.

totalPPSCapitalHSPDRGAmount
transactions[].detailInfo[].providerSupplementalSummaryInformation.totalPPSCapitalHSPDRGAmount
String

The total prospective payment system (PPS) capital, hospital-specific portion, diagnosis-related group (DRG) amount.

totalPPSDSHDRGAmount
transactions[].detailInfo[].providerSupplementalSummaryInformation.totalPPSDSHDRGAmount
String

The total prospective payment system (PPS) disproportionate share, hospital diagnosis-related group (DRG) amount.

financialInformation
transactions[].financialInformation
Object

Financial information about the payment including amounts and account details.

Show attributes
checkIssueOrEFTEffectiveDate
transactions[].financialInformation.checkIssueOrEFTEffectiveDate
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The date the payer considers the transaction to be settled. If the payment is made by automated clearinghouse (ACH), this is the date the funds are available to the provider. If the payment is made by check, this is the date the check is issued. If the payment is made by Federal Reserve Funds/wire transfer, this is the date that the payer anticipates the money to move.

creditOrDebitFlagCode
transactions[].financialInformation.creditOrDebitFlagCode
String

A code indicating whether the payment is a credit or debit. Can be set to C - Credit or D - Debit. Visit ERA code lists for usage notes.

Possible values
C
D
originatingCompanySupplementalCode
transactions[].financialInformation.originatingCompanySupplementalCode
String

A code that further identifies the payer by division or region.

payerIdentifier
transactions[].financialInformation.payerIdentifier
String

A unique identifier for the payer, mutually established between the financial institution and the payer.

paymentFormatCode
transactions[].financialInformation.paymentFormatCode
String

A code identifying the payment format. Can be set to CCP - Cash Concentration/Disbursement plus Addenda (CCD+) (ACH) or CTX - Corporate Trade Exchange (CTX) (ACH).

Possible values
CCP
CTX
paymentMethodCode
transactions[].financialInformation.paymentMethodCode
String

A code indicating the payment method. For example, ACH - Automated Clearing House or CHK - Check. Visit ERA code lists for a complete list and usage notes.

Possible values
ACH
BOP
CHK
FWT
NON
receiverAccountDetails
transactions[].financialInformation.receiverAccountDetails
Object

Account details for the payment receiver.

Show attributes
receiverAccountNumber
transactions[].financialInformation.receiverAccountDetails.receiverAccountNumber
String

The provider's account number.

receiverAccountNumberQualifier
transactions[].financialInformation.receiverAccountDetails.receiverAccountNumberQualifier
String

The code identifying the type of account. Can be either DA - Demand Deposit or SA - Savings.

Possible values
DA
SA
receiverDfiIdNumberQualifier
transactions[].financialInformation.receiverAccountDetails.receiverDfiIdNumberQualifier
String

The code identifying the type of identification number of the Depository Financial Institution (DFI). Can be either 01 - ABA Transit Routing Number Including Check Digits (9 digits) or 04 - Canadian Bank Branch Institution Number.

Possible values
01
04
receiverDfiIdentificationNumber
transactions[].financialInformation.receiverAccountDetails.receiverDfiIdentificationNumber
String

The identification number specified in receiverDfiIdNumberQualifier.

senderAccountDetails
transactions[].financialInformation.senderAccountDetails
Object

Account details for the payment sender.

Show attributes
senderAccountNumber
transactions[].financialInformation.senderAccountDetails.senderAccountNumber
String

The account number for the company originating the payment.

senderAccountNumberQualifier
transactions[].financialInformation.senderAccountDetails.senderAccountNumberQualifier
String

The code identifying the type of account the payment is being made from. Can be DA - Demand Deposit.

Possible values
DA
SA
senderDFIIdentifier
transactions[].financialInformation.senderAccountDetails.senderDFIIdentifier
String

The identifier specified by the senderDfiIdNumberQualifier.

senderDfiIdNumberQualifier
transactions[].financialInformation.senderAccountDetails.senderDfiIdNumberQualifier
String

The code identifying the type of identification number of the Depository Financial Institution (DFI). Can be either 01 - ABA Transit Routing Number Including Check Digits (9 digits) or 04 - Canadian Bank Branch Institution Number.

Possible values
01
04
totalActualProviderPaymentAmount
transactions[].financialInformation.totalActualProviderPaymentAmount
String

The total amount of the payment to the provider, expressed as a decimal.

transactionHandlingCode
transactions[].financialInformation.transactionHandlingCode
String

A code indicating the actions taken by both the sender and the receiver. For example, D - Make Payment Only. Visit ERA code lists for a complete list and usage notes.

Possible values
C
D
H
I
P
foreignCurrency
transactions[].foreignCurrency
String

The standard ISO code for the country whose currency is being used for payments. If this is not present, the currency is US dollars.

payee
transactions[].payee
Object

Information about the payee receiving the payment.

Show attributes
address
transactions[].payee.address
Object

The payee's address information.

Show attributes
address1
transactions[].payee.address.address1
String

The first line of the address.

address2
transactions[].payee.address.address2
String

The second line of the address.

city
transactions[].payee.address.city
String

The city where the address is located.

countryCode
transactions[].payee.address.countryCode
String

The standard code for the country from Part 1 of ISO 3166.

countrySubCode
transactions[].payee.address.countrySubCode
String

The standard code for the country subdivision from Part 2 of ISO 3166.

postalCode
transactions[].payee.address.postalCode
String

The postal code for the address, excluding punctuation and blanks.

state
transactions[].payee.address.state
String

The standard code for the state or province. For example PA for Pennsylvania.

centersForMedicareAndMedicaidServicesPlanId
transactions[].payee.centersForMedicareAndMedicaidServicesPlanId
StringDeprecated

Formerly used to report the payee's Centers for Medicare and Medicaid Services (CMS) Plan ID. This used to report the Health Plan ID (HPID) or Other Entity Identifier (OEID). The Centers for Medicare and Medicaid Services (CMS) no longer uses HPID, so this property will not be populated.

federalTaxPayersIdentificationNumber
transactions[].payee.federalTaxPayersIdentificationNumber
String

The payee's Federal Taxpayer's Identification Number (when the payee is a business) or the payee's social security number (when the payee is an individual provider).

name
transactions[].payee.name
String

The payee's name. This can be the name of an individual or an organization.

nationalCouncilForPrescriptionDrugProgramsPharmacyNumber
transactions[].payee.nationalCouncilForPrescriptionDrugProgramsPharmacyNumber
String

The payee's National Council for Prescription Drugs Pharmacy Number.

npi
transactions[].payee.npi
StringRegex pattern: ^\d{10}$

The payee's National Provider Identifier (NPI).

payeeIdentification
transactions[].payee.payeeIdentification
String

Other information necessary to identify the payee.

remittanceDeliveryMethod
transactions[].payee.remittanceDeliveryMethod
Object

Method for delivering remittance advice to the payee.

Show attributes
email
transactions[].payee.remittanceDeliveryMethod.email
String

The email address.

ftp
transactions[].payee.remittanceDeliveryMethod.ftp
String

Information for file transfer deliveries, such as SFTP, FTP, or FTPS.

name
transactions[].payee.remittanceDeliveryMethod.name
String

The name of the third party processor, if required, that would be the first recipient of the remittance.

onLine
transactions[].payee.remittanceDeliveryMethod.onLine
String

The web address of the online portal for secure hosted or other electronic delivery. The URL is typically provided without the scheme and separator. For example, stedi.com.

stateLicenseNumber
transactions[].payee.stateLicenseNumber
String

The payee's State License Number.

taxId
transactions[].payee.taxId
StringRegex pattern: ^\d{9}$

The payee's Federal Tax Identification Number (TIN).

payer
transactions[].payer
Object

Information about the payer making the payment.

Show attributes
address
transactions[].payer.address
Object

The payer's address information.

Show attributes
address1
transactions[].payer.address.address1
String

The first line of the address.

address2
transactions[].payer.address.address2
String

The second line of the address.

city
transactions[].payer.address.city
String

The city where the address is located.

countryCode
transactions[].payer.address.countryCode
String

The standard code for the country from Part 1 of ISO 3166.

countrySubCode
transactions[].payer.address.countrySubCode
String

The standard code for the country subdivision from Part 2 of ISO 3166.

postalCode
transactions[].payer.address.postalCode
String

The postal code for the address, excluding punctuation and blanks.

state
transactions[].payer.address.state
String

The standard code for the state or province. For example PA for Pennsylvania.

businessContactInformation
transactions[].payer.businessContactInformation
Object

A person or office.

Show attributes
contactMethods
transactions[].payer.businessContactInformation.contactMethods
Array of Objects
Array item
email
transactions[].payer.businessContactInformation.contactMethods[].email
String

The email address.

fax
transactions[].payer.businessContactInformation.contactMethods[].fax
String

The fax number.

phone
transactions[].payer.businessContactInformation.contactMethods[].phone
String

The telephone number including the area code (if applicable). Phone numbers are formatted as AAABBBCCCC, where AAA represents the area code, BBB represents the telephone number prefix, and CCCC represents the telephone number. Phone numbers are provided without separators, such as dashes or parentheses. For example, 5551123345 for 555-112-3345.

phoneExtension
transactions[].payer.businessContactInformation.contactMethods[].phoneExtension
String

The telephone extension, if applicable.

contactName
transactions[].payer.businessContactInformation.contactName
String

The name of the contact person or entity.

centersForMedicareAndMedicaidServicesPlanId
transactions[].payer.centersForMedicareAndMedicaidServicesPlanId
StringDeprecated

Formerly used to report the payer's Health Plan ID (HPID) or Other Entity Identifier (OEID). The Centers for Medicare and Medicaid Services (CMS) no longer uses HPID, so this property will not be populated.

healthIndustryNumber
transactions[].payer.healthIndustryNumber
String

The payer's health industry number.

name
transactions[].payer.name
String

The payer's business name, such as Cigna or Aetna.

nationalAssociationOfInsuranceCommissioners
transactions[].payer.nationalAssociationOfInsuranceCommissioners
String

The payer's National Association of Insurance Commissioners (NAIC) code.

payerIdentificationNumber
transactions[].payer.payerIdentificationNumber
String

An identifier for the payer. For Medicare carriers or intermediaries, this is the Medicare carrier or intermediary ID number. For Blue Cross and Blue Shield Plans, this is the Blue Cross Blue Shield association plan code.

Providers rarely use this identifier in practice.

payerWebSiteUrl
transactions[].payer.payerWebSiteUrl
String

The payer's web address. The URL is typically provided without the scheme and separator. For example, stedi.com.

submitterIdentificationNumber
transactions[].payer.submitterIdentificationNumber
String

An identifier for the payer. This is used when the original transaction sender is not the payer or has an identifier other than those already provided.

technicalContactInformation
transactions[].payer.technicalContactInformation
Array of Objects

A person or office.

Array item
contactMethods
transactions[].payer.technicalContactInformation[].contactMethods
Array of Objects

Available contact methods for technical support.

Array item
email
transactions[].payer.technicalContactInformation[].contactMethods[].email
String

The contact email address.

fax
transactions[].payer.technicalContactInformation[].contactMethods[].fax
String

The contact fax number.

phone
transactions[].payer.technicalContactInformation[].contactMethods[].phone
String

The contact telephone number including the area code. Phone numbers are formatted as AAABBBCCCC, where AAA represents the area code, BBB represents the telephone number prefix, and CCCC represents the telephone number. Phone numbers are provided without separators, such as dashes or parentheses. For example, 5551123345 for 555-112-3345.

phoneExtension
transactions[].payer.technicalContactInformation[].contactMethods[].phoneExtension
String

The contact telephone extension, if applicable.

url
transactions[].payer.technicalContactInformation[].contactMethods[].url
String

A web address to contact the person or entity. The URL is typically provided without the scheme and separator. For example, stedi.com.

contactName
transactions[].payer.technicalContactInformation[].contactName
String

The name of the contact person or entity.

paymentAndRemitReassociationDetails
transactions[].paymentAndRemitReassociationDetails
Object

Payment and remittance reassociation details for transaction tracking.

Show attributes
checkOrEFTTraceNumber
transactions[].paymentAndRemitReassociationDetails.checkOrEFTTraceNumber
String

This value uniquely identifies the transaction. This is either the check number, the EFT reference number, or a unique remittance advice identification number (for non-payment ERAs).

originatingCompanyIdentifier
transactions[].paymentAndRemitReassociationDetails.originatingCompanyIdentifier
String

A unique identifier for the payer. This is a 1 followed by the payer's Employer Identification Number (EIN) or Taxpayer Identification Number (TIN).

originatingCompanySupplementalCode
transactions[].paymentAndRemitReassociationDetails.originatingCompanySupplementalCode
String

A value that identifies a further subdivision within the payer's organization.

traceTypeCode
transactions[].paymentAndRemitReassociationDetails.traceTypeCode
String

Code that identifies which transaction is being referenced. This can be set to 1 - Current Transaction Trace Numbers.

Possible values
1
productionDate
transactions[].productionDate
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The end date for the adjudication production cycle for claims included in this ERA.

providerAdjustments
transactions[].providerAdjustments
Array of Objects

Provider-level adjustment information for debit or credit transactions such as: accelerated payments, cost report settlements for a fiscal year, and timeliness report penalties unrelated to a specific claim or service. These adjustments can either decrease the payment (a positive number) or increase the payment (a negative number).

Array item
adjustments
transactions[].providerAdjustments[].adjustments
Array of Objects

List of adjustments applied to the provider.

Array item
adjustmentReasonCode
transactions[].providerAdjustments[].adjustments[].adjustmentReasonCode
String

A code identifying the reason for the adjustment. Visit Provider Adjustment Reason Codes for a complete list and descriptions.

adjustmentReasonCodeValue
transactions[].providerAdjustments[].adjustments[].adjustmentReasonCodeValue
String

The description of the adjustmentReasonCode.

providerAdjustmentAmount
transactions[].providerAdjustments[].adjustments[].providerAdjustmentAmount
String

The amount of the adjustment, per the adjustment reason provided. A negative amount increases the claim payment and a positive amount decreases the claim payment.

providerAdjustmentIdentifier
transactions[].providerAdjustments[].adjustments[].providerAdjustmentIdentifier
String

An identifier used to assist the receiver in identifying, tracking, or reconciling the adjustment.

fiscalPeriodDate
transactions[].providerAdjustments[].fiscalPeriodDate
StringRegex pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$

The last day of the provider's fiscal year.

providerIdentifier
transactions[].providerAdjustments[].providerIdentifier
String

This is the provider's NPI.

receiverIdentifier
transactions[].receiverIdentifier
String

The business identification information for the entity initially receiving the transaction. This is typically included when the receiver of the transaction is not the payee, such as a clearinghouse or billing service.

versionIdentification
transactions[].versionIdentification
String

The version number of the adjudication system that generated the claim payments.