834 Benefit Enrollment and Maintenance (004020)
This is the standard X12 004020 spec, with 17 loops and 103 segment positions, as OpenEDI JSON, an ediFabric C# template and an ediFabric Native model. To change it for a trading partner, customize it in the EDI Spec Builder.
Use the 834 spec in your code
ediFabric .NET
Add the C# template and its common files to your project, or reference the template NuGet package, and read 834 files into TS834 objects. See ediFabric .NET.
ediFabric Native
Map version 004020 to the Native model with set_map, then parse 834 files to JSON from Python, Java, C or C#. See Convert between EDI and JSON.
OpenEDI
Select Customize in Spec Builder to copy the spec under your own name, change it for your partner, and parse files against it in EdiNation, ediFabric Native or ediFabric Cloud. Read about OpenEDI.
Generate 834 classes in Python, Java, Node.js, Go, Rust or C
ediFabric Native returns each 834 as JSON, with the property names of the OpenEDI schema. To work with that JSON as typed objects, generate classes from the OpenEDI file in your language and deserialize the JSON into TS834. Serialize the objects back to JSON to build EDI with ediFabric Native. The classes keep the loops, segments, lengths and code lists, but not the EDI data formats, so validate files with ediFabric Native. Read more in Generate a class from OpenEDI.
Python: datamodel-code-generator. Node.js: openapi-typescript. Java, Go, Rust and C: OpenAPI Generator.
834 structure
Loops and segments of the standard 834, with their usage and maximum repeats.
| ID | Name | Usage | Max use |
|---|---|---|---|
| ST | Transaction Set Header | Optional | 1 |
| BGN | Beginning Segment | Mandatory | 1 |
| REF | Reference Identification | Optional | >1 |
| DTP | Date or Time or Period | Optional | >1 |
| AMT | Monetary Amount | Optional | >1 |
| QTY | Quantity | Optional | >1 |
| Loop N1 | Name | Mandatory | >1 |
| N1 | Name | Mandatory | 1 |
| N2 | Additional Name Information | Optional | 2 |
| N3 | Address Information | Optional | 2 |
| N4 | Geographic Location | Optional | 1 |
| PER | Administrative Communications Contact | Optional | 3 |
| Loop ACT | Account Identification | Optional | 10 |
| ACT | Account Identification | Mandatory | 1 |
| REF | Reference Identification | Optional | 5 |
| N3 | Address Information | Optional | 1 |
| N4 | Geographic Location | Optional | 1 |
| PER | Administrative Communications Contact | Optional | 5 |
| DTP | Date or Time or Period | Optional | 1 |
| AMT | Monetary Amount | Optional | 1 |
| Loop INS | Insured Benefit | Optional | >1 |
| INS | Insured Benefit | Mandatory | 1 |
| REF | Reference Identification | Mandatory | >1 |
| DTP | Date or Time or Period | Optional | >1 |
| Loop NM1 | Individual or Organizational Name | Optional | >1 |
| NM1 | Individual or Organizational Name | Mandatory | 1 |
| PER | Administrative Communications Contact | Optional | 1 |
| N3 | Address Information | Optional | 1 |
| N4 | Geographic Location | Optional | 1 |
| DMG | Demographic Information | Optional | 1 |
| PM | Electronic Funds Transfer Information | Optional | 1 |
| EC | Employment Class | Optional | >1 |
| ICM | Individual Income | Optional | 1 |
| AMT | Monetary Amount | Optional | 10 |
| HLH | Health Information | Optional | 1 |
| HI | Health Care Information Codes | Optional | 10 |
| LUI | Language Use | Optional | >1 |
| Loop DSB | Disability Information | Optional | 4 |
| DSB | Disability Information | Mandatory | 1 |
| DTP | Date or Time or Period | Optional | 10 |
| AD1 | Adjustment Amount | Optional | 10 |
| Loop HD | Health Coverage | Optional | 99 |
| HD | Health Coverage | Mandatory | 1 |
| DTP | Date or Time or Period | Optional | 10 |
| AMT | Monetary Amount | Optional | 3 |
| REF | Reference Identification | Optional | 5 |
| IDC | Identification Card | Optional | >1 |
| Loop LX | Assigned Number | Optional | 30 |
| LX | Assigned Number | Mandatory | 1 |
| NM1 | Individual or Organizational Name | Optional | 1 |
| N1 | Name | Optional | 3 |
| N2 | Additional Name Information | Optional | 1 |
| N3 | Address Information | Optional | 2 |
| N4 | Geographic Location | Optional | 2 |
| PER | Administrative Communications Contact | Optional | 2 |
| PRV | Provider Information | Optional | 1 |
| DTP | Date or Time or Period | Optional | 6 |
| PLA | Place or Location | Optional | 1 |
| Loop COB | Coordination of Benefits | Optional | 5 |
| COB | Coordination of Benefits | Mandatory | 1 |
| REF | Reference Identification | Optional | >1 |
| N1 | Name | Optional | 1 |
| N2 | Additional Name Information | Optional | 1 |
| N3 | Address Information | Optional | 2 |
| N4 | Geographic Location | Optional | 1 |
| DTP | Date or Time or Period | Optional | 2 |
| Loop LC | Life Coverage | Optional | 10 |
| LC | Life Coverage | Mandatory | 1 |
| AMT | Monetary Amount | Optional | 5 |
| DTP | Date or Time or Period | Optional | 2 |
| REF | Reference Identification | Optional | >1 |
| Loop BEN | Beneficiary or Owner Information | Optional | 20 |
| BEN | Beneficiary or Owner Information | Mandatory | 1 |
| NM1 | Individual or Organizational Name | Optional | 1 |
| N1 | Name | Optional | 1 |
| N2 | Additional Name Information | Optional | 1 |
| N3 | Address Information | Optional | 1 |
| N4 | Geographic Location | Optional | 1 |
| DMG | Demographic Information | Optional | 1 |
| Loop FSA | Flexible Spending Account | Optional | 5 |
| FSA | Flexible Spending Account | Mandatory | 1 |
| AMT | Monetary Amount | Optional | 10 |
| DTP | Date or Time or Period | Optional | 10 |
| REF | Reference Identification | Optional | >1 |
| Loop RP | Retirement Product | Optional | >1 |
| RP | Retirement Product | Mandatory | 1 |
| DTP | Date or Time or Period | Optional | >1 |
| REF | Reference Identification | Optional | >1 |
| INV | Investment Vehicle Selection | Optional | >1 |
| AMT | Monetary Amount | Optional | 20 |
| QTY | Quantity | Optional | 20 |
| K3 | File Information | Optional | 3 |
| REL | Relationship | Optional | 1 |
| Loop NM1 | Individual or Organizational Name | Optional | >1 |
| NM1 | Individual or Organizational Name | Mandatory | 1 |
| N2 | Additional Name Information | Optional | 1 |
| DMG | Demographic Information | Optional | 1 |
| BEN | Beneficiary or Owner Information | Optional | 1 |
| REF | Reference Identification | Optional | >1 |
| Loop NX1 | Property or Entity Identification | Optional | >1 |
| NX1 | Property or Entity Identification | Mandatory | 1 |
| N3 | Address Information | Optional | 1 |
| N4 | Geographic Location | Optional | 1 |
| DTP | Date or Time or Period | Optional | >1 |
| Loop FC | Financial Contribution | Optional | >1 |
| FC | Financial Contribution | Mandatory | 1 |
| DTP | Date or Time or Period | Optional | >1 |
| Loop INV | Investment Vehicle Selection | Optional | >1 |
| INV | Investment Vehicle Selection | Mandatory | 1 |
| DTP | Date or Time or Period | Optional | >1 |
| QTY | Quantity | Optional | >1 |
| ENT | Entity | Optional | >1 |
| REF | Reference Identification | Optional | >1 |
| AMT | Monetary Amount | Optional | 20 |
| K3 | File Information | Optional | 3 |
| Loop AIN | Income | Optional | >1 |
| AIN | Income | Mandatory | 1 |
| QTY | Quantity | Optional | >1 |
| DTP | Date or Time or Period | Optional | >1 |
| SE | Transaction Set Trailer | Optional | 1 |