Apex EDI Vendor Portal

Apex EDI API V3 Documentation

Medical Claim Field Reference

This table documents the fields that may be used when submitting Medical claims. The Required column indicates whether the field is required on all claims. Optional fields may be required in certain situations. The Level column indicates whether the field appears at the claim level or the service line level of the claim.

For more definitions of the various enumerations, see Enumerations.

Click here to download this table as a PDF.

Click here to download this table as an Excel spreadsheet.

Level CMS 1500 Claim Form Locator 837P General Notes Name of JSON Field Data Type Min Value or Length Max Value or Length Required?
Item Number Title Loop ID Segment/Data Element Notes
ClaimApexApex Payer IDApex_PayerIdstringY
ClaimApexVendor Claim IDApex_VendorClaimIdstring150Y
ClaimheaderPayer Name2010BBNM103Carrier BlockF00_PayerNamestring160Y
ClaimheaderPayer Address 12010BBN301Carrier BlockF00_PayerAddress1string155N
ClaimheaderPayer Address 22010BBN302Carrier BlockF00_PayerAddress2string155N
ClaimheaderPayer City2010BBN401Carrier BlockF00_PayerCitystring230N
ClaimheaderPayer State2010BBN402Carrier BlockF00_PayerStatestring22N
ClaimheaderPayer Zip2010BBN403Carrier BlockF00_PayerZipstring315N
Claim1Medicare, Medicaid, TRICARE, CHAMPVA, Group Health Plan, FECA, Black Lung, Other2000BSBR09Claim Filing Indicator Code in the 837P.F01_ClaimTypeClaimCoverageType enumerationN
Claim1aInsured's ID Number2010BANM109Subscriber Primary Identifier in the 837P.F01A_InsuredIdstring280Y
Claim2Patient's Last Name2010CA or 2010BANM103F02_PatientNameLaststring160Y
Claim2Patient's First Name2010CA or 2010BANM104F02_PatientNameFirststring135Y
Claim2Patient's Middle Name2010CA or 2010BANM105F02_PatientNameMiddlestring125N
Claim2Patient's Suffix2010CA or 2010BANM107F02_PatientSuffixstring110N
Claim3Patient's Birth
Date
2010CA or 2010BADMG02F03_PatientDobdate YYYY-MM-DD1010Y
Claim3Patient's Sex2010CA or 2010BADMG03Sex is Gender in the 837P.M, F, UnknownF03_PatientSexSex enumerationY
Claim4Insured's Name2010BANM103Subscriber in the 837P.F04_InsuredNameLaststring160y
Claim4Insured's Name2010BANM104Subscriber in the 837P.F04_InsuredNameFirststring135N
Claim4Insured's Name2010BANM105Subscriber in the 837P.F04_InsuredNameMiddlestring125N
Claim4Insured's Name2010BANM107Subscriber in the 837P.F04_InsuredSuffixstring110N
Claim5Patient's Address2010CAN301F05_PatientAddress1string55N
Claim5Patient's Address2010CAN302F05_PatientAddress2string55N
Claim5Patient's Address2010CAN401F05_PatientCitystring230Y
Claim5Patient's Address2010CAN402F05_PatientStatestring22Y
Claim5Patient's Address2010CAN403F05_PatientZipstring315Y
Claim6Patient Relationship to
Insured
2000B
2000C
SBR02
PAT01
Individual Relationship Code in the 837P.Of the relationships in the enumeration, only Child, Other, Self, and Spouse are accepted in this context.F06_PatientRelationshipToInsuredRelationship enumerationY
Claim7Insured's Address2010BAN301Subscriber Address in the 837P.F07_InsuredAddress1string55Y
Claim7Insured's Address2010BAN302Subscriber Address in the 837P.F07_InsuredAddress2string55N
Claim7Insured's Address2010BAN401Subscriber Address in the 837P.F07_InsuredCitystring230Y
Claim7Insured's Address2010BAN402Subscriber Address in the 837P.F07_InsuredStatestring22Y
Claim7Insured's Address2010BAN403Subscriber Address in the 837P.F07_InsuredZipstring315Y
Claim9Other Insured's Name2330ANM103Other Subscriber Name in the 837P.F09_OtherInsuredNameLaststring160N
Claim9Other Insured's Name2330ANM104Other Subscriber Name in the 837P.F09_OtherInsuredNameFirststring35N
Claim9Other Insured's Name2330ANM105Other Subscriber Name in the 837P.F09_OtherInsuredNameMiddlestring25N
Claim9Other Insured's Name2330ANM107Other Subscriber Name in the 837P.F09_OtherInsuredSuffixstring10N
Claim9Other Insured's relation to patientF09_PatientRelationshipToInsuredRelationship enumerationN
Claim9aOther Insured's Policy or Group Number2320SBR03Insured Group or Policy Number in the 837P.F09A_OtherInsuredGroupNumstring50N
Claim9dInsurance Plan Name or
Program Name
2320SBR04Other Insured Group Name in the 837P.F09D_OtherPlanNamestring60N
Claim10aIs Patient's Condition Related to: Employment2300CLM11-1, CLM11-2, CLM11-3Related Causes Code in the 837P.Boolean - true/falseF10A_PatientCondEmploymentbooleanN
Claim10bIs Patient's Condition Related to: Auto Accident2300CLM11-1, CLM11-2, CLM11-3Related Causes Code in the 837P.F10B_PatientCondAutoAccident
- Boolean true/false
booleanN
Claim10bIs Patient's Condition Related to: Auto Accident2300CLM11-4Related Causes Code in the 837P.If F10B_PatientCondAutoAccident is set, then set F10B_PatientCondAutoAccidentState.F10B_PatientCondAutoAccidentStatestring22N
Claim10cIs Patient's Condition Related to: Other Accident2300CLM11-1, CLM11-2, CLM11-3Related Causes Code in the 837P.F10C_PatientCondOtherAccident
- Boolean true/false
booleanN
Claim11Insured's Policy,
Group, or FECA Number
2000BSBR03Subscriber Group or Policy Number in the 837P.F11_InsuredsPolicyGroupOrFecaNumberstring150N
Claim11aInsured's Date of Birth2010BADMG02Subscriber Birth Date in the 837P.F11A_InsuredDobdate YYYY-MM-DD1010Y
Claim11aInsured's Date of Birth, Sex2010BADMG03Subscriber Gender Code in the 837P.M, F, UnknownF11A_InsuredSexSex enumerationY
Claim11cInsurance Plan Name or Program Name2000BSBR04Subscriber Group Name in the 837P.F11C_PlanNamestring29N
Claim12Patient's or Authorized Person's Signature2300CLM09Release of Information Code in the 837P.F12_PatientAuthorization
Yes, InformedConsent
PatientAuthorization enumerationY
Claim12Patient's or Authorized Person's Signature Date2300CLM09Release of Information Code in the 837P.F12_PatientAuthorizationDatedate YYYY-MM-DD1010N
Claim13Insured's or Authorized Persons Signature2300CLM08Benefits Assignment Certification Indicator in the 837P.F13_InsuredAuthorizationInsuredAuthorization enumerationY
Claim14Date of Current Illness, Injury, Pregnancy2300DTP01
DTP03
In the 837P: Date - Onset of Current Illness or Symptom
Qualifier 431
F14_DateOfCurrentIllnessOrSymptomdate YYYY-MM-DD1010N
Claim14Date of Current Illness, Injury, Pregnancy2300DTP01
DTP03
In the 837P: Date - Last Menstrual Period
Qualifier 484
F14_LastMenstrualPeriodDatedate YYYY-MM-DD1010N
Claim15Other Date (previously If Patient Has Had Same or Similar Illness)2300DTP03Titled in the 837P: Date - Initial Treatment Date.
Qualifier 454
F15_InitialTreatmentDatedate YYYY-MM-DD1010N
Claim15Other Date (previously If Patient Has Had Same or Similar Illness)2300DTP03Titled in the 837P: Date - Last Seen Date.
Qualifier 304
F15_LastSeenDatedate YYYY-MM-DD1010N
Claim15Other Date (previously If Patient Has Had Same or Similar Illness)2300DTP03Titled in the 837P: Date - Acute Manifestation.
Qualifier 453
F15_AcuteManifestionDate
Required when Loop ID-2300 CR208 = "A" or "M", the claim involves spinal manipulation, and the payer is Medicare. If not required by this implementation guide, do not send.
This field is required when X12_AcuteManifestationCode is set to "AcuteCondition" or "AcuteManifestationOfAChronicCondition".F15_AcuteManifestionDatedate YYYY-MM-DD1010N
Claim15Other Date (previously If Patient Has Had Same or Similar Illness)2300DTP03Titled in the 837P: Date - Accident.
Qualifier 439
F15_AccidentDatedate YYYY-MM-DD1010N
Claim15Other Date (previously If Patient Has Had Same or Similar Illness)2300DTP03Titled in the 837P: Date - Last X-ray Date.
Qualifier 455
F15_LastXRayDatedate YYYY-MM-DD1010N
Claim15Other Date (previously If Patient Has Had Same or Similar Illness)2300DTP03Titled in the 837P: Date - Hearing and Vision Prescription Date.
Qualifier 471
F15_HearingAndVisionPrescriptionDatedate YYYY-MM-DD1010N
Claim15Other Date (previously If Patient Has Had Same or Similar Illness)2300DTP03Titled in the 837P: Date - Assumed and Relinquished Care Dates.
Qualifier 090
F15_AssumedCareStartDatedate YYYY-MM-DD1010N
Claim15Other Date (previously If Patient Has Had Same or Similar Illness)2300DTP03Titled in the 837P: Date - Assumed and Relinquished Care Dates.
Qualifier 091
F15_AssumedCareEndDatedate YYYY-MM-DD1010N
Claim15Other Date (previously If Patient Has Had Same or Similar Illness)2300DTP03Titled in the 837P: Date - Property and Casualty Date of First Contact.
Qualifier 444
F15_PropertyCasualtyFirstContactDatedate YYYY-MM-DD1010N
ClaimX12Dates Patient Unable to Work in Current Occupation2300DTP03
qualifier 360
Crosswalk: Disability From Date and Work Return Date in the 837P.
Apex: DTP - DATE - DISABILITY DATES, Implementation Name for DTP03 is Disability From Date
Qualifier 360
Either neither or both of F15_DisabilityDateFrom and F15_DisabilityDateTo must be set, in order to match the behavior of our electronic claim form. If both are set, they go in a single DTP segment with a qualifier of 314 and a syntax of RD8.
If X12_DisabilityDateTo is set, then this field must also be set.X12_DisabilityDateFromdate YYYY-MM-DD1010N
ClaimX12Dates Patient Unable to Work in Current Occupation2300DTP03
qualifier 361
Crosswalk: Disability From Date and Work Return Date in the 837P.
If both are set, they go in a single DTP segment with a qualifier of 314 and a syntax of RD8.
Apex: DTP - DATE - DISABILITY DATES, Implementation Name for DTP03 is Disability From Date
Qualifier 361 (DTP02 data element)
Either neither or both of F15_DisabilityDateFrom and F15_DisabilityDateTo must be set, in order to match the behavior of our electronic claim form. If X12_DisabilityDateFrom is set, then this field must also be set.X12_DisabilityDateTodate YYYY-MM-DD1010N
Claim16Dates Patient Unable to Work in Current Occupation2300DTP03
qualifier 297
Apex: Use this for F16 instead of Disability Date From.
DTP - DATE - LAST WORKED, Implementation Name for DTP03 is Work Return Date.
Qualifier 297
F16_LastWorkedDatedate YYYY-MM-DD1010N
Claim16Dates Patient Unable to Work in Current Occupation2300DTP03
qualifier 296
Crosswalk: Work Return Date in the 837P.
DTP - DATE - AUTHORIZED RETURN TO WORK, Implementation Name for DTP03 is Work Return Date.
Qualifier 296
F16_AuthorizedReturnedToWorkDatedate YYYY-MM-DD1010N
Claim17Name of Referring Provider or Other Source2310ANM103Qualifier DNLast NameF17_ReferringProviderNameLast60N
Claim17Name of Referring Provider or Other Source2310ANM104First NameF17_ReferringProviderNameFirst35N
Claim17Name of Referring Provider or Other Source2310ANM105Middle NameF17_ReferringProviderNameMiddle25N
Claim17Name of Referring Provider or Other Source2310ANM107SuffixF17_ReferringProviderSuffix10N
Claim17aOther ID#2310AREF02Referring Provider Secondary Identifier in the 837P.F17A_ReferringProviderIdNumber150N
Claim17bNPI #2310ANM109Referring Provider Identifier in the 837P.F17B_ReferringProviderNpi1010N
Claim17Name of Referring Provider or Other Source2310DNM103Qualifier DQLast NameF17_SupervisingProviderNameLast60N
Claim17Name of Referring Provider or Other Source2310DNM104First NameF17_SupervisingProviderNameFirst35N
Claim17Name of Referring Provider or Other Source2310DNM105Middle NameF17_SupervisingProviderNameMiddle25N
Claim17Name of Referring Provider or Other Source2310DNM107SuffixF17_SupervisingProviderSuffix10N
Claim17aOther ID#2310DREF02Supervising Provider Secondary Identifier in the 837P.F17A_SupervisingProviderIdNumber150N
Claim17bNPI #2310DNM109Supervising Provider Identifier in the 837P.F17B_SupervisingProviderNpi1010N
Claim17Name of Referring Provider or Other Source2420ENM103Qualifier DKLast NameF17_OrderingProviderNameLast60N
Claim17Name of Referring Provider or Other Source2420ENM104First NameF17_OrderingProviderNameFirst35N
Claim17Name of Referring Provider or Other Source2420ENM105Middle NameF17_OrderingProviderNameMiddle25N
Claim17Name of Referring Provider or Other Source2420ENM107SuffixF17_OrderingProviderSuffix10N
Claim17aOther ID#2420EREF02Ordering Provider Secondary Identifier in the 837P.F17A_OrderingProviderIdNumber150N
Claim17bNPI #2420ENM109Ordering Provider Identifier in the 837P.F17B_OrderingProviderNpi1010N
Claim18Hospitalization Dates Related to Current Services2300DTP03Related Hospitalization Admission Date in the 837P.YYYY-MM-DDF18_HospitalizationDateFromdate YYYY-MM-DD1010N
Claim18Hospitalization Dates Related to Current Services2300DTP03Related Hospitalization Discharge Date in the 837P.YYYY-MM-DDF18_HospitalizationDateTodate YYYY-MM-DD1010N
Claim19Additional Claim Information (previously Reserved for Local Use)2300NTE
NTE01=ADD
NTE - CLAIM NOTE
PWK - CLAIM SUPPLEMENTAL INFORMATION
Only the NTE segment with the ADD qualifier is supported at this time. The PWK - CLAIM SUPPLEMENTAL INFORMATION segment is not supported at this time
F19_ClaimSupplementalInfoNoteTextstring180N
Claim21Diagnosis or Nature of Illness or Injury2300HI01-2, HI02-2, HI03-2, HI04-2, HI05-2, HI06-2, HI07-2, HI08-2, HI09-2, HI10-2, HI11-2, HI12-2Outside Lab is on form - yes/no boxes - not in PS1, so don't know where it goes.2300 HI0X-1 Diagnosis Type = 9 or 10.
Date of service after 10/1/2015 requires 10.
F21_IcdIndicatorstring13N
Claim21Diagnosis or Nature of Illness or Injury2300HI01-2, HI02-2, HI03-2, HI04-2, HI05-2, HI06-2, HI07-2, HI08-2, HI09-2, HI10-2, HI11-2, HI12-22300 HI0X-2 Diagnosis Code - X is 1 through 12, at least one required.Array of strings - Up to 12
The first one is considered the primary diagnosis for the claim
F21_DiagnosisCodesarray of strings, each string 1 to 30 characters112Y
Claim22Medicaid Resubmission and/or Original Reference
Number
2300CLM05-3Claim Frequency Code in the 837P.F22_MedicaidResubmissionCodestring11N
Claim22Medicaid
Resubmission and/or Original Reference
Number
2300REF02Payer Claim Control Number in the 837P.F22_OriginalReferenceNumberstring50N
Claim23Prior Authorization Number2300REF02Prior Authorization Number in the 837P.F23_PriorAuthorizationNumberstring50N
Claim23Prior Authorization Number2300REF02Referral Number in the 837P.F23_ReferralNumberstring50N
Claim23Prior Authorization Number2300REF02Clinical Laboratory Improvement Amendment Number in the 837P.F23_ClinicalLaboratoryImprovementAmendmentNumberstring50N
Claim23Prior Authorization Number2300REF02Mammography Certification Number in the 837P.F23_MammographyCertificationNumberstring50N
ClaimThis JSON field contains an array of claim line objects. The line-level fields identified below are the fields of the claim line object.F24_ClaimLinesclaim line1Y
Line24 A-H Shaded LineNote2400NTE
NTE01=ADD
NTE - LINE NOTE
PWK - LINE SUPPLEMENTAL INFORMATION
Only the NTE segment with the ADD qualifier is supported at this time. The PWK - LINE SUPPLEMENTAL INFORMATION segment is not supported at this time.
F24_Shaded_LineNoteTextstring180N
Line24ADate(s) of Service2400DTP03Service Date in the 837P.F24A_DateOfServiceFromdate
YYYY-MM-DD
1010Y
Line24ADate(s) of Service2400DTP03Service Date in the 837P.F24A_DateOfServiceTodate
YYYY-MM-DD
1010N
Line24BPlace of Service2400SV105Place of Service Code in the 837P.X12_PlaceOfServiceCode is not present on the printed form, but it is required by Apex. F24B_PlaceOfServiceCode may be used to override the place of service for a particular claim line.F24B_PlaceOfServiceCode12Y
Line24CEMG2400SV109Emergency Indicator in the 837P.Boolean - true / falseF24C_EmgbooleanN
Line24DProcedures, Services, or
Supplies
2400SV101-1, SV101-2There are 4 qualifiers for SV101-1 in the spec, but only "HC" is supported at this time. F24D_HcpcsProcedureCode will be used for both Medicare and other claims. Product/Service ID in the 837P. The value placed in this field goes into SV101-2. Setting a value in this field implies a value of "HC" in SV101-1.F24D_HcpcsProcedureCode148Y
Line24DProcedures, Services, or
Supplies
2400SV101-3 to SV101-6Product/Service ID and Procedure Modifier in the 837P.If present, must contain 1 to 4 strings, each exactly two characters in length.F24D_Modifiersarray of strings14N
Line24DProcedures, Services, or
Supplies
2400SV101-7X12_Descriptionstring180N
Line24EDiagnosis Pointer2400SV107 (1-4)Diagnosis Code Pointer in the 837P.
Alpha pointers on the 1500 claim form MUST be converted to numeric pointers in the 837P.
Valid values are the single characters A through L. Each entry refers to a diagnosis code in F21_DiagnosisCodes, where A refers to the first diagnosis code in F21_DiagnosisCodes, B refers to the second, etc.F24E_DiagnosisPointersarray of strings maximum number of strings is 4, each string can only contain 1 character, A-L1 string,
1 char
4 strings,
1 char each
Y
Line24F$ Charges2400SV102Line Item Charge Amount in the 837P.Can't be less than 0, but 0 is acceptableF24F_ChargesdecimalY
Line24GDays or Units2400SV104Service Unit Count in the 837P.A numeric value with optional decimal point. Up to 8 digits are allowed, not including the decimal point. At most three digits may appear after the decimal point.F24G_DaysOrUnitsdecimal19N
Line24HEPSDT/Family
Plan
2400SV111EPSDT Indicator in the 837P.Boolean - true / falseF24H_EarlyPeriodicScreeningDiagnosisAndTreatmentbooleanN
Line24HEPSDT/Family
Plan
2400SV112Family Planning Indicator in the 837P.F24H_FamilyPlanning
- Boolean true/false
booleanN
Line24J
Shaded
Line
Rendering
Provider ID #
2420APRV01 - PRV03Provider Taxonomy Code in the 837P. Qualifier: PXC. The use of this field implicitly determines the qualifier in PRV02.For claim level information, see X12_RendProviderTaxonomyCode, etc.F24J_Shaded_RendProviderTaxonomyCodestring150N
Line24J
Shaded
Line
Rendering
Provider ID #
2420AREF01, REF02Rendering Provider Secondary Identifier in the 837P. The use of these fields implicitly determines the qualifier in REF01.F24J_Shaded_RendProviderStateLicenseNumber
F24J_Shaded_RendProviderUpinNumber
F24J_Shaded_RendProviderCommercialNumber
F24J_Shaded_RendProviderLocationNumber
string150N
Line24JRendering Provider ID #2420ANM109Rendering Provider Identifier in the 837P.For claim level rendering provider NPI, see X12_RenderingNPI.F24J_RenderingNpistring10N
Claim25Federal Tax ID Number2010AAREF02
REF01=EI
Reference Identification Qualifier and Billing Provider Tax
Identification Number in the 837P
REF - BILLING PROVIDER TAX
IDENTIFICATION.
EI=Employer Identification Number
Employer Identification Number used as the Billing Provider Tax Id. The value should contain no hyphens. At most one of F25_FederalTaxIdEin and F25_FederalTaxIdSsn should be set.F25_FederalTaxIdEinstring15N
Claim25Federal Tax ID Number2010AAREF02
REF01=SY
Reference Identification Qualifier and Billing Provider Tax
Identification Number in the 837P.
REF - BILLING PROVIDER TAX IDENTIFICATION
SY=Social Security Number.
Social Security Number used as the Billing Provider Tax Id. The value should contain no hyphens. At most one of F25_FederalTaxIdEin and F25_FederalTaxIdSsn should be set.F25_FederalTaxIdSsnstring99N
Claim26Patient's Account No.2300CLM01Patient Control Number in the 837P.F26_PatientAccountNumberstring38N
Claim27Accept Assignment?2300CLM07Assignment or Plan Participation Code in the 837P. Qualifiers are A (Assigned) B (Accept on Clinical Lab Services) C (Not Assigned)F27_AcceptAssignmentAssignmentOrPlanParticipationCode enumerationN
Claim28Total Charge2300CLM02Total Claim Charge Amount in the 837P.F28_TotalChargedecimalY
Claim29Amount Paid2300AMT02Patient Amount Paid in the 837P.F29_PatientAmountPaiddecimalN
Claim29Amount Paid2320AMT02Payer Paid Amount in the 837P.F29_PayerAmountPaiddecimalN
Claim31Signature of Physician or Supplier Including Degrees or Credentials2300CLM06Provider or Supplier Signature Indicator in the 837P.Boolean- true / falseF31_PhysicianOrSupplierSignatureIsOnFilebooleanY
Claim32Service Facility Location Information2310CNM103F32_FacilityNamestring60N
Claim32Service Facility Location Information2310CN301F32_FacilityAddress1string55N
Claim32Service Facility Location Information2310CN302F32_FacilityAddress2string55N
Claim32Service Facility Location Information2310CN401F32_FacilityCitystring230N
Claim32Service Facility Location Information2310CN402F32_FacilityStatestring22N
Claim32Service Facility Location Information2310CN403F32_FacilityZipstring315N
Claim32aNPI #2310CNM109Laboratory or Facility Primary Identifier in the 837P.F32A_FacilityNpistring1010N
Claim32bOther ID #2310CREF01
REF02
Reference Identification Qualifier and Laboratory or Facility Secondary Identifier in the 837P.F32B_FacilityIdStateLicenseNumberstring150N
Claim32bOther ID #2310CREF01
REF02
Reference Identification Qualifier and Laboratory or Facility Secondary Identifier in the 837P.F32B_FacilityIdProviderCommercialLicenseNumberstring150N
Claim32bOther ID #2310CREF01
REF02
Reference Identification Qualifier and Laboratory or Facility Secondary Identifier in the 837P.F32B_FacilityIdLocationNumberstring150N
Claim33Billing Provider
Info & Ph #
2010AANM103F33_BillingProviderNameLaststring160Y
Claim33Billing Provider
Info & Ph #
2010AANM104F33_BillingProviderNameFirststring135N
Claim33Billing Provider
Info & Ph #
2010AANM105F33_BillingProviderNameMiddlestring125N
Claim33Billing Provider
Info & Ph #
2010AANM107F33_BillingProviderSuffixstring110N
Claim33Billing Provider
Info & Ph #
2010AAN301F33_BillingProviderAddress1string155Y
Claim33Billing Provider
Info & Ph #
2010AAN302F33_BillingProviderAddress2string155N
Claim33Billing Provider
Info & Ph #
2010AAN401F33_BillingProviderCitystring230Y
Claim33Billing Provider
Info & Ph #
2010AAN402F33_BillingProviderStatestring22Y
Claim33Billing Provider
Info & Ph #
2010AAN403F33_BillingProviderZipstring315N
Claim33Billing Provider
Info & Ph #
2010AAPER04F33_BillingProviderPhoneNumberstring1256N
Claim33aNPI #2010AANM109Billing Provider Identifier in the 837P.F33A_BillingProviderNpistring1010Y
Claim33bOther ID #2000APRV1-PRV03Provider Taxonomy Code in the 837P.F33B_BillingProviderTaxonomyCodestring150N
Claim33bOther ID #2010AAREF01, REF02Titled Reference Identification Qualifier and Billing Provider Additional Identifier in the 837P.F33B_BillingProviderSsnstring150Y*
LineX12Anesthesia2400SV104 - Quantity
Other fields filled in because it is Anesthesia
SV1 - PROFESSIONAL SERVICE
-Looks like this is information in to make a specific Service Line (2400 SV1)
-SV101-1 (HC) Health Care Financing Administration Common Procedural Coding System (HCPCS) Codes
-SV101-2 Procedure Code - Anesthesia CPT code - ex 00142 lens surgery (see spec ex)
- SV101-3 - SV101-6 Procedure Modifier
- SV102 Monetary Amount
- SV103 Unit Or Base Measurement - For Anesthesia (MJ) Minutes
- SV104 Quantity (Service Unit Count) - Max length 8 digits - For Anesthesia this is where the minutes go
How to correlate with F24A - F24J Service Line Entry
Defaults to false (non-anesthesia). If true, then F24G_DaysOrUnits must be set to the number of minutes.X12_AnesthesiabooleanN
ClaimX12Claim Level Payer Amount2320AMT02Loop 2320 AMT AMT - COORDINATION OF BENEFITS (COB)PAYER PAID AMOUNT. Looks like this is claim level primary payer amount or the sum of all the line item primary payer paid amountsX12_ClaimPrimaryPayerPaidAmountnullable decimalN
LineX12F24_LineAdjudicationDate2430DTP01-03Loop 2420 DTP Line Check Or Remittance Date
DTP01 - 573, DTP02 - D8, DTP03 -Adjudication or Payment Date
X12_AdjudicationOrPaymentDatedate YYYY-MM-DD1010N
LineX12F24_LineAdjustments2430CAS01-19Should be an array of adjustments where the members have the info. Loop 2340 CAS - Group Code is in CAS01, and then up to 6 adjustments Reason Code, Amount, Quantity in 2-4, 5-7, 8-10, 11-13, 14-16 and 17-9 associated with that code.Each of these fields consists of an array of objects of type ServiceLineAdjustment, which is defined to consist of:
ReasonCode (string)
MonetaryAmount (monetary amount, decimal number)
Quantity (optional, decimal number)
X12_LineContractualObligationAdjustments
X12_LineCorrectionAndReversalAdjustments
X12_LineOtherAdjustments
X12_LinePayorInitiatedReductions
X12_LinePatientResponsibilityAdjustments
See X12_ClaimContractualObligationAdjustments, etc., for claim level adjustments.
array of objectsN
LineX12X12_LineTestResults2400MEALoop 2400 MEAAn array of objects with the fields MeasurementId (of type MeasurementReferenceIdCode enumeration, MEA01), MeasurementQualifier (of type MeasurementQualifier enumeration, MEA02), and MeasurementValue (decimal, MEA03).
Example:
X12_LineTestResults: [
{ "MeasurementId": "TestResults", "MeasurementQualifier": "Hemoglobin", "MeasurementValue": 113.4 },
{ "MeasurementId": "TestResults", "MeasurementQualifier": "Hematocrit", "MeasurementValue": 14.2 }
]
X12_LineTestResultsarray of objectsN
LineX12F24_NDC - In Mapping Spread Sheet2410LIN02-LIN03Must be in 5-4-2 format. Omit hyphens. If this field is set, then exactly one of X12_DrugQuantityInternationalUnits, X12_DrugQuantityGrams, X12_DrugQuantityMilligrams, X12_DrugQuantityMilliliters, or X12_DrugQuantityUnits must be set.X12_NdcCodestring1111N
LineX12F24_NDC - In Mapping Spread Sheet2410CTP04-CTP05If X12_NdcCode is used, then exactly one of these fields must be set. Otherwise, do not use.X12_DrugQuantityInternationalUnits
X12_DrugQuantityGrams
X12_DrugQuantityMilligrams
X12_DrugQuantityMilliliters
X12_DrugQuantityUnits
nullable decimalN
LineX12REF - PRESCRIPTION OR COMPOUND DRUG
ASSOCIATION NUMBER
2410REF01-REF02Loop 2410 REF01 - XZ (Pharmacy Prescription #)
Loop 2410 REF02 - Prescription Number
Loop 2410 REF01 - VY (Link #)
Loop 2410 REF02 - Link Number
F24_NDC - In Mapping Spread Sheet
At most one of these fields may be set.X12_NdcPharmacyPrescriptionNumber
X12_NdcLinkSequenceNumber
string150N
LineX12F24_PrimaryPayerPaidAmount2430SVD02Loop 2430 Line Adjudication Information
SVD02 Service Line Paid Amount??
X12_PrimaryPayerPaidAmountnullable decimalN
LineX12F24_ProviderControlNumber2400REF01-02Loop 2400 REF - Line Item Control Number
REF01 - 6R Provider Control Number / REF02 Line Item Control Number
X12_ProviderControlNumberstring150N
ClaimX122300CLM05-1Facility Code Value in the 837P.The place of service for the entire claim. May be overridden if necessary for a particular claim line by placing a value in F24B_PlaceOfServiceCode for that claim line.X12_PlaceOfServiceCodestring12N
ClaimX12Rendering Provider Last Name2310BNM103Provider Last or Organization NameClaim level. Not on formX12_RendProviderNameLaststring160N
ClaimX12Rendering Provider First Name2310BNM104Provider First NameClaim level. Not on formX12_RendProviderNameFirststring135N
ClaimX12Rendering Provider Middle Name2310BNM105Provider Middle NameClaim level. Not on formX12_RendProviderNameMiddlestring125N
ClaimX12Rendering Provider Suffix2310BNM106Provider SuffixClaim level. Not on formX12_RendProviderSuffixstring110N
ClaimX12Rendering Provider Taxonomy Code2310BPRV02, PRV03Provider Taxonomy Code in the 837P.Claim level rendering provider taxonomy code. Optional. This identifier may be overridden at the claim line level by F24J_Shaded_RendProviderTaxonomyCode.X12_RendProviderTaxonomyCodestring10N
ClaimX12Rendering Provider Secondary Identifier2310BREF01, REF02Provider Secondary Identifier in the 837P.Claim level rendering provider identifier. Optional. At most one of these may be set. This identifier may be overridden at the claim line level by one of the 24J_... Identifiers.X12_RendProviderStateLicenseNumber X12_RendProviderUpinNumber X12_RendProviderCommercialNumber X12_RendProviderLocationNumberstring10N
ClaimX12Rendering Provider NPI2310BNM109Rendering Provider Identifier in the 837P.This is the NPI of the rendering provider for the entire claim. This can be optionally overridden for a particular claim line by use of F24J_RenderingNpi.X12_RenderingNpistring10N
ClaimX12x12_AcuteManifestationConditionCode2300CR208CR2 - SPINAL MANIPULATION SERVICE INFORMATION
CR208 - Nature of Condition Code
A - Acute Condition
M - Acute Manifestation of a Chronic Condition
See also F15_AcuteManifestionDate.X12_AcuteManifestationCodeenumeration AcuteManifestationCodes11N
ClaimX12x12_AmountPaidByPrimary2320AMT022320 AMT - COB PayerPaid AmountRequired for secondary claims. Must reconcile with line item amounts.X12_ClaimPrimaryPaidAmountnullable decimalN
ClaimX12x12_AssumedCareDate2300DTP03 DTP01=090Qualifier - 090use F15_AssumedCareStartDate
ClaimX12x12_ClaimAdjudicationDate2330BDTP01-DTP03DTP - CLAIM CHECK OR REMITTANCE DATE. The Claim Adjudication Date (DTP) segment has been renamed to Claim Check or Remittance Date.X12_ClaimAdjudicationDatestringN
ClaimX122320CAS01-19See line level equivalents.See comments for line level adjustments, X12_LineContractualObligationAdjustments, etcX12_ClaimContractualObligationAdjustments
X12_ClaimCorrectionAndReversalAdjustments
X12_ClaimOtherAdjustments
X12_ClaimPayorInitiatedReductions
X12_ClaimPatientResponsibilityAdjustments
.
Each is and Array of Claims adjustmentsN
ClaimX12x12_MedicalRecordNumber2300REF02REF - MEDICAL RECORD NUMBERX12_MedicalRecordNumberstring150N
ClaimX122300CRCCRC - PATIENT CONDITION INFORMATION: VISION
The field names imply which code category: E1, E2, or E3 (CRC01). The boolean gives the value of CRC02. The array of ConditionCodes provide the values for CRC03-CRC07:
L1 General Standard of 20 Degree or .5 Diopter Sphere
or Cylinder Change Met
L2 Replacement Due to Loss or Theft
L3 Replacement Due to Breakage or Damage
L4 Replacement Due to Patient Preference
L5 Replacement Due to Medical Reason
Each field consists of an object with two fields: CertificationConditionIndicator (boolean), and ConditionCodes (array of one to five strings, "L1", "L2", etc.).
Example:
"X12_SpectacleLenses": {
"CertificationConditionIndicator": true,
"ConditionCodes": [ "L1", "L4" ]
}
X12_SpectacleLenses
X12_ContactLenses
X12_SpectacleFrames
N
ClaimX12X12_DelayReasonCode2300CN1CN1 - CONTRACT INFORMATIONX12_DelayReasonCodeDelayReasonCode enumerationN
ClaimX12X12_OtherPayerName2330BNM103Loop 2330B NM101 = PR (Payer) NM102 = 2 (Non-Person Entity) NM103 = Other Organization NameX12_OtherPayerNamestring160N
ClaimX12X12_AmbulanceCertifications2300CRCCRC - AMBULANCE CERTIFICATION
The CRC02 value is a boolean condition for Yes/No Condition or Response code. The array of ConditionCodes provide the values for CRC03-CRC07:
01 Patient was admitted to a hospital
04 Patient was moved by stretcher
05 Patient was unconscious or in shock
06 Patient was transported in an emergency situation
07 Patient had to be physically restrained
08 Patient had visible hemorrhaging
09 Ambulance service was medically necessary
12 Patient is confined to a bed or chair (Use code 12 to indicate patient was bedridden during transport)
Each field consists of an object with two fields: CertificationConditionIndicator (boolean), and ConditionCodes (array of one to five strings, "01", "04", "06", "09", etc.).
Example:
"X12_AmbulanceCertification": {
"CertificationConditionIndicator": true,
"ConditionCodes":["01","04","06","09"]
}
X12_AmbulanceCertificationN
ClaimX12X12_AmbulancePatientWeight2300CR102CR1 - AMBULANCE TRANSPORT INFORMATIONWeight of the patient at time of transport. Required when it is necessary to justify the medical necessity of the level of ambulance services.X12_AmbulancePatientWeightstring110N
ClaimX12X12_AmbulanceTransportReasonCode2300CR104CR1 - AMBULANCE TRANSPORT INFORMATION
Ambulance Transport Reason Code:
NearestFacility
PreferredPhysician
NearFamily
Specialist
Rehabilitation
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water).
The possible codes indicating the reason for ambulance transport. are aliases for the single letter codes of A-E indicated by the 837 spec. A = NearestFacility, B=PreferredPhysician, etc.
Example:
"X12_AmbulanceTransportReasonCode":"NearestFacility"
X12_AmbulanceTransportReasonCodestring11N
ClaimX12X12_AmbulanceTransportDistance2300CR106CR1 - AMBULANCE TRANSPORT INFORMATION
Ambulance Transport Distance
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water).
The value is in terms of Miles
Example:
"X12_AmbulanceTransportDistance":"5"
X12_AmbulanceTransportDistancestring115N
ClaimX12X12_AmbulanceRoundTripPurposeDescription2300CR109CR1 - AMBULANCE TRANSPORT INFORMATION
Round Trip Purpose Description
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water) and when the ambulance service is for a round trip
The value is in terms of Miles
Example:
"X12_AmbulanceRoundTripPurposeDescription":"Required round trip for surgery"
X12_AmbulanceRoundTripPurposeDescriptionstring180N
ClaimX12X12_AmbulanceStretcherPurposeDescription2300CR110CR1 - AMBULANCE TRANSPORT INFORMATION
Stretcher Purpose Description
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water) and when needed to justify usage of stretcher
The value is in terms of Miles
Example:
"X12_AmbulanceStretcherPurposeDescription":"Patient immobile"
X12_AmbulanceStretcherPurposeDescriptionstring180N
ClaimX12X12_AmbulancePickupAddress12310EN301N3 - AMBULANCE PICKUP LOCATION
Address
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water)
This is Address line 1
Example:
"X12_AmbulancePickupAddress1":"123 MAIN STREET"
X12_AmbulancePickupAddress1string155N
ClaimX12X12_AmbulancePickupAddress22310EN302N3 - AMBULANCE PICKUP LOCATION
Second Address Line (If Needed)
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water) and a second address line is needed
Example:
"X12_AmbulancePickupAddress2":"SUITE #200"
X12_AmbulancePickupAddress2string155N
ClaimX12X12_AmbulancePickupCity2310EN401N3 - AMBULANCE PICKUP LOCATION
City
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water)
This is the Ambulance Pickup Location city
Example:
"X12_AmbulancePickupCity":"MY TOWN"
X12_AmbulancePickupCitystring230N
ClaimX12X12_AmbulancePickupState2310EN402N3 - AMBULANCE PICKUP LOCATION
State or Province Code
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water)
This is the Ambulance Pickup Location State or Province Code
Example:
"X12_AmbulancePickupState":"NY"
X12_AmbulancePickupStatestring22N
ClaimX12X12_AmbulancePickupZip2310EN403N3 - AMBULANCE PICKUP LOCATION
Postal Code
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water)
This is the Postal Code
Example:
"X12_AmbulancePickupState":"10022"
X12_AmbulancePickupZipstring315N
ClaimX12X12_AmbulancePickupCountry2310EN404N3 - AMBULANCE PICKUP LOCATION
Country
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water)
This is the Country Code, required when the address is outside of the United States of America
Example:
"X12_AmbulancePickupState":"CAN"
X12_AmbulancePickupZipstring23N
ClaimX12X12_AmbulanceDropOffAddress12310EN301N3 - AMBULANCE DROP-OFF LOCATION
Address
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water)
This is Address line 1
Example:
"X12_AmbulanceDropOffAddress1":"123 MAIN STREET"
X12_AmbulanceDropOffAddress1string155N
ClaimX12X12_AmbulanceDropOffAddress22310FN302N3 - AMBULANCE DROP-OFF LOCATION
Second Address Line (If Needed)
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water) and a second address line is needed
Example:
"X12_AmbulanceDropOffAddress2":"SUITE #200"
X12_AmbulanceDropOffAddress2string155N
ClaimX12X12_AmbulanceDropOffCity2310FN401N3 - AMBULANCE DROP-OFF LOCATION
City
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water)
This is the Ambulance Pickup Location city
Example:
"X12_AmbulanceDropOffCity":"MY TOWN"
X12_AmbulanceDropOffCitystring230N
ClaimX12X12_AmbulanceDropOffState2310FN402N3 - AMBULANCE DROP-OFF LOCATION
State or Province Code
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water)
This is the Ambulance Pickup Location State or Province Code
Example:
"X12_AmbulanceDropOffState":"NY"
X12_AmbulanceDropOffStatestring22N
ClaimX12X12_AmbulanceDropOffZip2310FN403N3 - AMBULANCE DROP-OFF LOCATION
Postal Code
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water)
This is the Postal Code
Example:
"X12_AmbulanceDropOffState":"10022"
X12_AmbulanceDropOffZipstring315N
ClaimX12X12_AmbulanceDropOffCountry2310FN404N3 - AMBULANCE DROP-OFF LOCATION
Country
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water)
This is the Country Code, required when the address is outside of the United States of America
Example:
"X12_AmbulanceDropOffState":"CAN"
X12_AmbulanceDropOffZipstring23N
LineX12X12_AmbulanceCertifications2400CRCCRC - AMBULANCE CERTIFICATION
The CRC02 value is a boolean condition for Yes/No Condition or Response code. The array of ConditionCodes provide the values for CRC03-CRC07:
01 Patient was admitted to a hospital
04 Patient was moved by stretcher
05 Patient was unconscious or in shock
06 Patient was transported in an emergency situation
07 Patient had to be physically restrained
08 Patient had visible hemorrhaging
09 Ambulance service was medically necessary
12 Patient is confined to a bed or chair (Use code 12 to indicate patient was bedridden during transport)
Each field consists of an object with two fields: CertificationConditionIndicator (boolean), and ConditionCodes (array of one to five strings, "01", "04", "06", "09", etc.).
Example:
"X12_AmbulanceCertification": {
"CertificationConditionIndicator": true,
"ConditionCodes":["01","04","06","09"]
}
X12_AmbulanceCertificationN
LineX12X12_AmbulancePatientWeight2400CR102CR1 - AMBULANCE TRANSPORT INFORMATIONWeight of the patient at time of transport. Required when it is necessary to justify the medical necessity of the level of ambulance services.X12_AmbulancePatientWeightstring110N
LineX12X12_AmbulanceTransportReasonCode2400CR104CR1 - AMBULANCE TRANSPORT INFORMATION
Ambulance Transport Reason Code:
NearestFacility
PreferredPhysician
NearFamily
Specialist
Rehabilitation
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water).
The possible codes indicating the reason for ambulance transport. are aliases for the single letter codes of A-E indicated by the 837 spec. A = NearestFacility, B=PreferredPhysician, etc.
Example:
"X12_AmbulanceTransportReasonCode":"NearestFacility"
X12_AmbulanceTransportReasonCodestring11N
LineX12X12_AmbulanceTransportDistance2400CR106CR1 - AMBULANCE TRANSPORT INFORMATION
Ambulance Transport Distance
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water).
The value is in terms of Miles
Example:
"X12_AmbulanceTransportDistance":"5"
X12_AmbulanceTransportDistancestring115N
LineX12X12_AmbulanceRoundTripPurposeDescription2400CR109CR1 - AMBULANCE TRANSPORT INFORMATION
Round Trip Purpose Description
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water) and when the ambulance service is for a round trip
The value is in terms of Miles
Example:
"X12_AmbulanceRoundTripPurposeDescription":"Required round trip for surgery"
X12_AmbulanceRoundTripPurposeDescriptionstring180N
LineX12X12_AmbulanceStretcherPurposeDescription2400CR110CR1 - AMBULANCE TRANSPORT INFORMATION
Stretcher Purpose Description
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water) and when needed to justify usage of stretcher
The value is in terms of Miles
Example:
"X12_AmbulanceStretcherPurposeDescription":"Patient immobile"
X12_AmbulanceStretcherPurposeDescriptionstring180N
LineX12X12_AmbulancePickupAddress12420GN301N3 - AMBULANCE PICKUP LOCATION
Address
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water)
This is Address line 1
Example:
"X12_AmbulancePickupAddress1":"123 MAIN STREET"
X12_AmbulancePickupAddress1string155N
LineX12X12_AmbulancePickupAddress22420GN302N3 - AMBULANCE PICKUP LOCATION
Second Address Line (If Needed)
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water) and a second address line is needed
Example:
"X12_AmbulancePickupAddress2":"SUITE #200"
X12_AmbulancePickupAddress2string155N
LineX12X12_AmbulancePickupCity2420GN401N3 - AMBULANCE PICKUP LOCATION
City
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water)
This is the Ambulance Pickup Location city
Example:
"X12_AmbulancePickupCity":"MY TOWN"
X12_AmbulancePickupCitystring230N
LineX12X12_AmbulancePickupState2420GN402N3 - AMBULANCE PICKUP LOCATION
State or Province Code
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water)
This is the Ambulance Pickup Location State or Province Code
Example:
"X12_AmbulancePickupState":"NY"
X12_AmbulancePickupStatestring22N
LineX12X12_AmbulancePickupZip2420GN403N3 - AMBULANCE PICKUP LOCATION
Postal Code
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water)
This is the Postal Code
Example:
"X12_AmbulancePickupState":"10022"
X12_AmbulancePickupZipstring315N
LineX12X12_AmbulancePickupCountry2420GN404N3 - AMBULANCE PICKUP LOCATION
Country
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water)
This is the Country Code, required when the address is outside of the United States of America
Example:
"X12_AmbulancePickupState":"CAN"
X12_AmbulancePickupZipstring23N
LineX12X12_AmbulanceDropOffAddress12420HN301N3 - AMBULANCE DROP-OFF LOCATION
Address
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water)
This is Address line 1
Example:
"X12_AmbulanceDropOffAddress1":"124 MAIN STREET"
X12_AmbulanceDropOffAddress1string155N
LineX12X12_AmbulanceDropOffAddress22420HN302N3 - AMBULANCE DROP-OFF LOCATION
Second Address Line (If Needed)
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water) and a second address line is needed
Example:
"X12_AmbulanceDropOffAddress2":"SUITE #200"
X12_AmbulanceDropOffAddress2string155N
LineX12X12_AmbulanceDropOffCity2420HN401N3 - AMBULANCE DROP-OFF LOCATION
City
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water)
This is the Ambulance Pickup Location city
Example:
"X12_AmbulanceDropOffCity":"MY TOWN"
X12_AmbulanceDropOffCitystring230N
LineX12X12_AmbulanceDropOffState2420HN402N3 - AMBULANCE DROP-OFF LOCATION
State or Province Code
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water)
This is the Ambulance Pickup Location State or Province Code
Example:
"X12_AmbulanceDropOffState":"NY"
X12_AmbulanceDropOffStatestring22N
LineX12X12_AmbulanceDropOffZip2420HN403N3 - AMBULANCE DROP-OFF LOCATION
Postal Code
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water)
This is the Postal Code
Example:
"X12_AmbulanceDropOffState":"10022"
X12_AmbulanceDropOffZipstring315N
LineX12X12_AmbulanceDropOffCountry2420HN404N3 - AMBULANCE DROP-OFF LOCATION
Country
This field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water)
This is the Country Code, required when the address is outside of the United States of America
Example:
"X12_AmbulanceDropOffState":"CAN"
X12_AmbulanceDropOffZipstring23N
LineX12X12_AmbulancePatientCount2400QT02QTY - AMBULANCE PATIENT COUNTThis field is required only if PlaceOfService code is 41 (Ambulance by Land) or 42 (Ambulance by Air or Water) and when more than one patient is transported in the same vehicle for Ambulance or non-emergency transportation services.
Example:
"X12_AmbulancePatientCount":"2"
X12_AmbulanceDropOffZipstring115N
Dental Claim Field Reference
Apex EDI Vendor Portal

Apex EDI API V3 Documentation

Dental Claim Field Reference

This table documents the fields that may be used when submitting Dental claims. The Required column indicates whether the field is required on all claims. Optional fields may be required in certain situations. The Level column indicates whether the field appears at the claim level or the service line level of the claim.

For more definitions of the various enumerations, see Enumerations.

Click here to download this table as a PDF.

Click here to download this table as an Excel spreadsheet.

Level ADA 1900 Claim Form Locator 837D General Notes Name of JSON Field Data Type Min Value or Length Max Value or Length Required?
Item Number Title Loop ID Segment/Data Element Notes
ClaimApexVendor Claim IDApex_VendorClaimId150Y
ClaimApexApex Payer IDApex payer IDApex_PayerIdstringY
Claim1Type of Transaction2300CLM19/CLM12ActualServices, RequestForPreauth, EpsdtTitleXixF01_TypeOfTransactionenum TypeOfTransactionY
Claim2Preauthorization Number2300REF02 (G1)F02_PriorAuthNumstring50N
Claim3Payer Name2010BBNM103Insurance Company BlockF03_PayerNamestring160Y
Claim3Payer Address 12010BBN301Insurance Company BlockOne of payer address or payer ID must be present or claim will fail Apex validations. Both may also be present.F03_PayerAddress1string55N
Claim3Payer Address 22010BBN302Insurance Company BlockOne of payer address or payer ID must be present or claim will fail Apex validations. Both may also be present.F03_PayerAddress2string55N
Claim3Payer City2010BBN401Insurance Company BlockOne of payer address or payer ID must be present or claim will fail Apex validations. Both may also be present.F03_PayerCitystring30N
Claim3Payer State2010BBN402Insurance Company BlockOne of payer address or payer ID must be present or claim will fail Apex validations. Both may also be present. Standard postal abbreviationsF03_PayerStatestring22N
Claim3Payer Zip2010BBN403Insurance Company BlockOne of payer address or payer ID must be present or claim will fail Apex validations. Both may also be present.F03_PayerZipstring515N
Claim4Other Coverage2320SBRLoop/segment are present if true; not present if falseF04_OtherCoveragebooleanY
Claim5Other Insured's Last Name2330ANM103F05_OtherInsuredLastNamestring60N
Claim5Other Insured's First Name2330ANM104F05_OtherInsuredFirstNamestring35N
Claim5Other Insured's Middle Initial2330ANM105F05_OtherInsuredMIstring25N
Claim5Other Insured's Suffix2330ANM107F05_OtherInsuredSuffixstring10N
Claim8Other Insured ID2330ANM109F08_OtherInsuredPolicystring280N
Claim9Other Insured's Plan/Group Number2320SBR03F09_OtherInsuredGrpNumberstring150N
Claim10Patient Relationship to Other Insured2320SBR02https://developers.apexedi.com/v3/ClaimApiEnumerationsV3.aspF10_OtherPatientRelationshipenum OtherPatientRelationshipN
Claim11Other Payer Name2330BNM103Other Insurance Carrier BlockF11_OtherPayerNamestring60N
Claim11Other Payer Address2330BN301Other Insurance Carrier BlockF11_OtherPayerAddressstring55N
Claim11Other Payer City2330BN401Other Insurance Carrier BlockF11_OtherPayerCitystring30N
Claim11Other Payer State2330BN402Other Insurance Carrier BlockStandard postal abbreviationsF11_OtherPayerSTstring2N
Claim11Other Payer Zip2330BN403Other Insurance Carrier BlockF11_OtherPayerZipstring515N
Claim12Insured's Last Name2010BANM103F12_InsuredLastNamestring160Y
Claim12Insured's First Name2010BANM104F12_InsuredFirstNamestring135Y
Claim12Insured's Middle Initial2010BANM105F12_InsuredMIstring25N
Claim12Insured's Suffix2010BANM107F12_InsuredSuffixstring10N
Claim12Insured's Address2010BAN301*If subscriber is patient then required.F12_InsuredAddressstring55N*
Claim12Insured's City2010BAN401*If subscriber is patient then required.F12_InsuredCitystring30N*
Claim12Insured's State2010BAN402*If subscriber is patient then required. Standard postal abbreviationsF12_InsuredSTstring22N*
Claim12Insured's Zip Code2010BAN403*If subscriber is patient then required.F12_InsuredZipstring515N*
Claim13Insured's Date of Birth2010BADMG02*If subscriber is patient then required.F13_InsuredDOBdate YYYY-MM-DDN*
Claim14Insured's Gender2010BADMG03*If subscriber is patient then required. M, F, UnknownF14_InsuredSexenum SexN*
Claim15Insured's ID2010BANM109F15_InsuredIDstring280Y
Claim16Insured's Plan/Group Number2010BASBR03F16_InsuredGroupNumberstring50N
Claim18Patient Relationship to Insured2010CA/2010BAPAT01/SBR02https://developers.apexedi.com/v3/ClaimApiEnumerationsV3.aspF18_PatientRelationshipenum RelationshipY
Claim20Patient Last Name2010CANM103*If subscriber is patient then this information is given in subscriber loop - 2010BA - if patient is not subscriber then these fields are required.F20_PatientLastNamestring160N*
Claim20Patient First Name2010CANM104*If subscriber is patient then this information is given in subscriber loop - 2010BA - if patient is not subscriber then these fields are required.F20_PatientFirstNamestring135N*
Claim20Patient Middle Name2010CANM105F20_PatientMIstring25N
Claim20Patient Suffix2010CANM107F20_PatientSuffixstring10N
Claim20Patient Address2010CAN301*If subscriber is patient then this information is given in subscriber loop - 2010BA - if patient is not subscriber then these fields are required.F20_PatientAddressstring55N*
Claim20Patient City2010CAN401*If subscriber is patient then this information is given in subscriber loop - 2010BA - if patient is not subscriber then these fields are required.F20_PatientCitystring130N*
Claim20Patient State2010CAN402*If subscriber is patient then this information is given in subscriber loop - 2010BA - if patient is not subscriber then these fields are required. Standard postal abbreviation.F20_PatientSTstring22N*
Claim20Patient Zip Code2010CAN403*If subscriber is patient then this information is given in subscriber loop - 2010BA - if patient is not subscriber then these fields are required.F20_PatientZipstring515N*
Claim21Patient Date of Birth2010CADMG02*If subscriber is patient then this information is given in subscriber loop - 2010BA - if patient is not subscriber then these fields are required.F20_PatientDOBdate YYYY-MM-DDN*
Claim22Patient Gender2010CADMG03*If subscriber is patient then this information is given in subscriber loop - 2010BA - if patient is not subscriber then these fields are required.F22_PatientSexenum Sex1N*
Claim32Total Fee2300CLM02e.g. use "55000" for 550.00F32_TotalFeestring118Y
Claim33Missing Teeth2300DN201Missing teeth values are 1-32 and A-TF33_MissingTeetharray of stringsN
Claim34Diagnosis Code Qualifier2300HI01-1,HI02-1�Not supported at this time by Apex (not needed for dental claims)When implemented, "10" will be assumed.F34_DiagnosiseCodeQualifierstringN
Claim34aDiagnosis Code(s)2300HI01-2,HI02-2�Not supported at this time by Apex (not needed for dental claims)F34a_DiagnosisCodestringN
Claim35Remarks2300NTE02Up to 5 string remarks can be added to simulate multiple NTE segmentsF35_Remarksarray of strings, limit of 80 characters per remark5N
Claim36Patient Signature2300CLM09F36_PatientSignaturestring120Y
Claim37Subscriber Signature2300CLM08If field is empty or null, then "No" is sent, meaning provider does not accept assignment for
claim payment.
F37_InsuredSignaturestring20N
Claim38Place of Treatment2300CLM05-1F38_PlaceOfTreatmentstring12N
Claim40Treatment for Orthodontics2300DN1F40_OrthoTreatmentbooleanY
Claim41Date Appliance Placed2300DTP03 (452)F41_DateAppliancePlaceddate YYYY-MM-DDN
Claim42Months of Treatment Remaining2300DN102F42_MonthsTreatmentintegerN
Claim43Replacement of Prosthesis2400SV305F43_ProsthesisbooleanY
Claim44Date of Prior Placement2400DTP03F44_ProsthesisDateOfPriorPlacementdate YYYY-MM-DDN
Claim45Treatment Resulting from2300CLM11-1/CLM11-2Both elements populated with "EM", "AA", or "OA" depending on accident typeOptions: Occupational Injury, Auto Accident, Other AccidentF45_TreatmentResultingFromenum TreatmentResultingFromN
Claim46Date of Accident2300DTP03 (439)F46_AccidentDatedate YYYY-MM-DDN
Claim47Auto Accident State2300CLM11-4F47_AutoAccidentStatestring22N
Claim48Billing Dentist Last Name2010AANM103Last name of billing dentist or organization name of billing entity.Apex typically uses billing provider name on file, this will primarily be used to identify provider on the claimF48_BillingDentistLastNamestring160Y
Claim48Billing Dentist First Name2010AANM104F48_BillingDentistFirstNamestring35N
Claim48Billing Dentist Middle Name2010AANM105F48_BillingDentistMIstring25N
Claim48Billing Dentist Suffix2010AANM107F48_BillingDentistSuffixstring50N
Claim48Billing Dentist Address2010AAN301F48_BillingDentistAddressstring155Y
Claim48Billing Dentist City2010AAN401F48_BillingDentistCitystring130Y
Claim48Billing Dentist State2010AAN402F48_BillingDentistSTstring22Y
Claim48Billing Dentist Zip Code2010AAN403F48_BillingDentistZipstring515Y
Claim49Billing Dentist NPI2010AANM109F48_BillingDentistNPIstring1010Y
Claim50Billing Dentist License Number2010AAREF02 (0B)F50_BillingDentistLicensestring50N
Claim51Billing Dentist SSN or TIN2010AAREF02F51_BillingDentistTaxIDstring150Y
ClaimX12Billing Dentist SSN or TIN qualifier2010AAREF01Qualifier "SY" for SSN or "EI" for TINSY, EIX12_TINorSSNQualifierenum ReferenceIdQualifierY
Claim52Billing Dentist Phone Number2010AAPER(04,06, or 08)Apex uses provider phone number on file typicallyF52_BillingDentistPhonestring256N
Claim52aBilling Dentist Additional Provider ID2010AAREF02F52a_BillingDentistIDstring50N
Claim53Treating Dentist Signature2300CLM06F53_TreatingDentistSignaturestring130Y
ClaimX12Treating Dentist Last Name2310BNM1032310B is rendering provider loopApex typically uses rendering provider name on file, this will primarily be used to identify provider on the claim.
Required when billing entity is an organization.
X12_RenderingProvLastNamestring60N
ClaimX12Treating Dentist First Name2310BNM1042310B is rendering provider loopRequired when billing entity is an organization.X12_RenderingProvFirstNamestring35N
ClaimX12Treating Dentist Middle Name2310BNM1052310B is rendering provider loopX12_RenderingProvMIstring25N
ClaimX12Treating Dentist Suffix2310BNM1072310B is rendering provider loopX12_RenderingProvSuffixstring50N
Claim54Treating Dentist NPI2310BNM1092310B is rendering provider loopRequired when billing entity is an organization.F53_TreatingDentistNPIstring1010N
Claim55Treating Dentist License Number2310BREF02 (0B)2310B is rendering provider loopF55_TreatingDentistLicensestring50N
ClaimX12Treatment Facility Name2310CNM1032310C is service facility location loopX12_TreatmantLocationNamestring60N
Claim56Treatment Facility Address2310CN3012310C is service facility location loopF56_TreatmentAddressstring55N
Claim56Treatment Facility City2310CN4012310C is service facility location loopF56_TreatmentCitystring30N
Claim56Treatment Facility State2310CN4022310C is service facility location loopF56_TreatmentSTstring22N
Claim56Treatment Facility Zip2310CN4032310C is service facility location loopF56_TreatmentZipstring515N
ClaimX12Treatment Facility NPI2310CNM1092310C is service facility location loopX12_TreatmantLocationNPIstring80N
Claim56aTreating Dentist Specialty Code2310BPRV032310B is rendering provider loopApex uses specialty code on file typicallyF56a_DentistSpecialtyCodestring50N
Claim58Treating Dentist Additional Provider ID2310BREF02F58_TreatingDentistAddlIDstring50N
ClaimX12Pay to address2010ABN3Currently only the "pay to" address on file at Apex is used. Address on claim is not used. This if for future implementation.X12_Paytoaddressstring55N
ClaimX12Pay to City2010ABN401Currently only the "pay to" address on file at Apex is used. Address on claim is not used. This if for future implementation.X12_PaytoCitystring30N
ClaimX12Pay to ST2010ABN402Currently only the "pay to" address on file at Apex is used. Address on claim is not used. This if for future implementation.X12_PaytoSTstring22N
ClaimX12Pay to Zip2010ABN403Currently only the "pay to" address on file at Apex is used. Address on claim is not used. This if for future implementation.X12_PaytoZipstring515N
ClaimX12Attachment Report Type Code2300PWK01Several options - see spechttps://developers.apexedi.com/v3/ClaimApiEnumerationsV3.aspX12_AttachmentReportTypeenum AttachmentReportTypeN
ClaimX12Attachment Control Number2300PWK06X12_AttachmentControlNumberstring80N
ClaimX12Attachment Transmission Code2300PWK02By fax (FX), email (EM), electronically (EL), file transfer (FT), mail (BM), or available upon request (AA)X12_AttachmentTransmissionCodeenum AttachmentTransmissionCodeTypeN
ClaimX12Patient Amount Paid2300AMT02F5 qualifierX12_PatientAmountPaidstring18N
ClaimX12Prior Authorization Number2300REF02 (G3)Required when sending the Predetermination of Benefits Identification
Number for services that have been previously predetermined and are
now being submitted for payment
X12_PredeterminationIDstring50N
ClaimX12Claim Frequency Code2300CLM05-3X12_ClaimFrequencyCodestring11N
ClaimX12Payer Claim Control Number2300REF02 (F8)Required when CLM05-3 (Claim Frequency Code) indicates this claim is a
replacement or void to a previously adjudicated claim.
If not given, default value will be 1.X12_PayerControlNumberstring50N
ClaimX12Subscriber Identification Code Qualifier2010BANM108 (IL)II, MIX12_SubscriberIdentificationCodeQualifierstring12N
ClaimX12Subscriber Entity Type Qualifier2010BANM102 (IL)1 = Person, 2 = Non-Person EntityX12_SubscriberEntityTypeQualifierstring11Y
ClaimX12Service DateUsed in claim level informationdate YYYY-MM-DDY
Line24Procedure Date2300/2400DTP03 (472)F24_DateOfServiceFromdate YYYY-MM-DDY
Line24Procedure Date2300/2400DTP03 (472)F24_DateOfServiceTodate YYYY-MM-DDN
Line25Area of Oral Cavity2400SV304-1Options: 00, 01, 02, 10, 20, 30, 40CODE SOURCE 135: American Dental AssociationF25_AreaOfOralCavityarray of stringsN
Line26Tooth Sytem2400TOO01"JP" is only option, will be hard coded when TOO segment is usedF26_ToothSystemstring22N
Line29Procedure Code2400SV301-2F29_ProcedureCodestring148Y
Line29aDiagnosis Pointer(s)2400SV311Not supported at this time by Apex (not needed for dental claims)F29a_DiagnosisPointerstringN
Line29bQuantity2400SV306F29b_QuantityintegerN
Line30Description2400SV301-7F30_Descriptionstring80N
Line31Fee2400SV302F31_LineFeestring118Y
Line31aOther Fee2400AMT02 (T)This segment is for line item sales tax. "Other Fee" otherwise not used.Sales Tax AmountF31a_OtherFeestring18N
LineX12Line Item Control Number2400REF02 (6R)Must be uniqueX12_LineControlNumberstring50N
LineX12Treating Dentist Last Name2420ANM1032420A is the line level rendering provider loopX12_LineTreatingDentistLastnamestring60N
LineX12Treating Dentist First Name2420ANM1042420A is the line level rendering provider loopX12_LineTreatingDentistFirstnamestring35N
LineX12Treating Dentist Middle Name2420ANM1052420A is the line level rendering provider loopX12_LineTreatingDentistMIstring25N
LineX12Treating Dentist Suffix2420ANM1072420A is the line level rendering provider loopX12_LineTreatingDentistSuffixstring10N
LineX12Treating Dentist NPI2420ANM1092420A is the line level rendering provider loopX12_LineTreatingDentistNPIstring1010N
LineX12Treating Dentist Specialty Code2420APRV032420A is the line level rendering provider loopX12_LineTreatingDentistSpecialtyCodestring50N
LineX12Secondary Claim - Primary Paid Amount2430SVD02X12_PrimaryPaidAmountstring18N
LineX12Secondary claim units2430SVD05Paid units from primary EOBX12_UnitsPaidstring15N
LineX12Secondary Claim - Adjudication Date2430DTP03 (573)X12_AdjudicationDatedate YYYY-MM-DDN
LineX12Place of service codeX12_PlaceOfServiceCodestring2N
Tooth27Tooth Number(s) or Letter(s)2400TOO02F27_ToothstringN
Tooth28Tooth Surface(s)2400TOO0303-1,03-2�03-5F28_ToothSurfacearray of stringsN
AdjustmentX12Secondary Claims -Adjustment Group Code(s)2430CAS01Each AGC will be matched to corresponding list item in that ARC and $ amount elementsLimit of 5X12_AdjustmentGroupCodestring2N
AdjustmentX12Secondary Claims -Adjustment Reason Code(s)2430CAS02Each ARC will be matched to corresponding list item in that AGC and $ amount elementsLimit of 5X12_AdjustmentReasonCodestring5N
AdjustmentX12Secondary Claims -Adjustment Amount(s)2430CAS03Each $ amount will be matched to corresponding list item in that ARC and AGC elementsLimit of 5X12_AdjustmentAmountstring18N