EDI models Last updated: 2026-09-30

Two forms

The same transaction is published in two forms. The property names are the same in both, and they are the names in the JSON.

Every standard model is in the EDI spec library. HIPAA 5010 837P is model EdiNation.X12.HIPAA.005010, message 837P, version 005010X222A1. Download As OpenEDI JSON for the schema, or As ediFabric Native for the file Native loads. The C# for the same claim is EdiFabric.Examples.X12.T837P.DB, class TS837P in EdiFabric.Templates.Hipaa5010.

The same guide in both forms

A guide and a model use the same facts. The C# attributes and the OpenEDI extensions are two spellings of those facts. Customize EDI guidelines is the C# spelling. OpenEDI format is the OpenAPI spelling.

The 837P message in the C# template:

[Message("X12", "005010X222A1", "837")]
public class TS837P : EdiMessage
{
    [Pos(1)]
    public virtual ST ST { get; set; }

    [Required]
    [Pos(2)]
    public virtual BHT_BeginningOfHierarchicalTransaction_8 BHT_BeginningOfHierarchicalTransaction { get; set; }

    [Required]
    [Pos(3)]
    public virtual All_NM1_837P_6 AllNM1 { get; set; }

    [Required]
    [Pos(4)]
    public virtual List<Loop_2000A_837P> Loop2000A { get; set; }

    [Pos(5)]
    public virtual SE SE { get; set; }
}

The same message in OpenEDI. Property order is the position. Loop2000A is an array because the loop repeats.

{
  "TS837P": {
    "type": "object",
    "x-openedi-message-id": "837",
    "x-openedi-message-standard": "X12",
    "x-openedi-message-version": "005010X222A1",
    "properties": {
      "ST": { "$ref": "#/components/schemas/ST" },
      "BHT_BeginningOfHierarchicalTransaction": { "$ref": "#/components/schemas/BHT_BeginningOfHierarchicalTransaction_8" },
      "AllNM1": { "$ref": "#/components/schemas/All_NM1_837P_6" },
      "Loop2000A": { "type": "array", "items": { "$ref": "#/components/schemas/Loop_2000A_837P" } },
      "SE": { "$ref": "#/components/schemas/SE" }
    }
  }
}

BHT element 127 is SubmitterTransactionIdentifier_03 in both forms. In C# the length and the element id are attributes. In OpenEDI they are JSON Schema keywords and x-openedi-element-id.

[Required]
[StringLength(1, 50)]
[DataElement("127", typeof(X12_AN))]
[Pos(3)]
public string SubmitterTransactionIdentifier_03 { get; set; }

{
  "SubmitterTransactionIdentifier_03": {
    "type": "string",
    "format": "X12_AN",
    "minLength": 1,
    "maxLength": 50,
    "x-openedi-element-id": "127"
  }
}

Parsing 837P produces JSON with these names. The claim itself is on the 837P transaction page, and the path from EDI to that JSON in each product is in Convert between EDI and JSON.

Change the model to match the file

Keep the baseline model as you received it, and put partner changes in a separate copy. A partner file can differ in any of these ways:

• A code set is shorter, or it contains a private code.
• An optional element is mandatory, or a mandatory element is optional.
• A segment has an extra element.
• A loop or a segment sits in a different position, or it repeats a different number of times.
• You want a property on the class that is not part of the EDI, for your own application.

Change the C# template

ediFabric .NET has two ways, both in How to modify EDI templates. Derive a new class and hide the properties you change with the new keyword, or copy the template files into a partner project and edit the copy. Derived classes keep the original attributes. Load the partner assembly, or a type factory, when the interchange is from that partner, and load the baseline otherwise.

To make one element mandatory, add [Required]. To allow only the codes a partner sends, replace the [EdiCodes] class named by [DataElement]. To add an element, add a string property at the next [Pos]. A property with no template attributes is ignored by the reader and the writer, which is how you hang application data on the same object. Validate EDI with templates is the full set: [Required], [ListCount], [StringLength], [DataElement], and the conditional attributes for syntax notes and HIPAA situational rules. Call IsValid() on the parsed object.

Install the baseline from NuGet, from the C# files on a paid plan, or as a DLL from EdiNation. EDI templates and How to install EDI templates cover those three paths. Convert between EDI and JSON is the read and write that uses the class.

Change the OpenEDI schema

Open the model in the EDI spec library, or import a file in the EDI spec builder. The builder accepts OpenEDI JSON or YAML, a SEF file, or an ediFabric .NET template DLL. The JSON view is the OpenEDI schema. Edit it there. The same change as [Required] in C# is adding the property name to the schema's required array. A new element is a new property. A partner code set is a shorter enum. minLength and maxLength are the length.

When the schema matches the partner guide, use Download:

• As ediFabric Native saves the intermediary file. Pass it to set_map. ediFabric Native does not read the OpenEDI file or the C# template. The steps for 837P are in Convert between EDI and JSON for ediFabric Native.
• As ediFabric .NET saves a DLL of the messages in that version, for a reader that loads an assembly.
• As OpenEDI JSON saves the schema you edited. That file is also the input for the class generators below.

Update uploads the model to your ediFabric Cloud subscription. A custom model is not selected on its own. Pass it as the model query parameter on read, or set the Model property on the transaction. Create and import EDI specs is that upload, and EDI models is how Cloud resolves a model from the file when you do not name one. Convert between EDI and JSON for ediFabric Cloud is the 837P read and write.

Generate a class from OpenEDI

OpenEDI is an OpenAPI 3 schema, so a generator that reads OpenAPI can emit a class in Python, Java or C with the same property names as TS837P. The class is for your application. It is how Python, Java or C holds the JSON that Native parse or Cloud /read returns. It is not the file the engine loads. Native still needs the intermediary from As ediFabric Native. Cloud still needs the OpenEDI model. .NET still needs the C# template or the DLL.

Generators copy type, required, minLength, maxLength, enum and $ref. They do not copy x-openedi-*, and they do not understand format: X12_AN. Element ids and EDI types stay in the OpenEDI file.

Download en-837P-openedi.json from the 837P spec or from the spec builder, then generate.

Python

datamodel-code-generator writes Pydantic models. This command reads the 837P OpenEDI file:

pip install datamodel-code-generator
datamodel-codegen --input en-837P-openedi.json --input-file-type openapi --output hipaa_837p.py --use-annotated

The start of the output is the ST segment, the BHT segment, and the message. TransactionSetIdentifierCode_01 keeps the length from the schema. The tool drops underscores from the BHT class name and, because the field ST has the same name as its class, it emits that field as ST_1 with alias='ST'. The JSON key is still ST. Every other loop and segment in the file becomes a class the same way.

from __future__ import annotations

from typing import Annotated

from pydantic import BaseModel, Field


class ST(BaseModel):
    TransactionSetIdentifierCode_01: Annotated[str, Field(max_length=3, min_length=3)]
    TransactionSetControlNumber_02: str
    ImplementationConventionPreference_03: str | None = None


class BHTBeginningOfHierarchicalTransaction8(BaseModel):
    HierarchicalStructureCode_01: str | None = None
    TransactionSetPurposeCode_02: str | None = None
    SubmitterTransactionIdentifier_03: Annotated[
        str | None, Field(max_length=50, min_length=1)
    ] = None
    TransactionSetCreationDate_04: str | None = None
    TransactionSetCreationTime_05: str | None = None
    TransactionTypeCode_06: str | None = None


class TS837P(BaseModel):
    ST_1: Annotated[ST | None, Field(alias='ST')] = None
    BHT_BeginningOfHierarchicalTransaction: BHTBeginningOfHierarchicalTransaction8 | None = None

Other Python generators that read the same file:

• OpenAPI Generator, generator python or python-pydantic-v1.
• quicktype, which emits Python from the JSON Schema inside the OpenAPI document.

Java and C

The same en-837P-openedi.json is the input.

• Java. OpenAPI Generator with -g java emits a POJO per schema. jsonschema2pojo emits Java from the JSON Schema. quicktype emits Java as well.
• C. OpenAPI Generator with -g c emits a struct per schema, as part of its C client. C has no classes. quicktype emits C++ and Objective-C from the same schema; for ISO C, use OpenAPI Generator.

SwaggerHub can import the OpenEDI file and generate a client in those languages. That path is also noted under Model SDKs.

openapi-generator-cli generate -i en-837P-openedi.json -g java -o ./java
openapi-generator-cli generate -i en-837P-openedi.json -g c -o ./c

Where to read on

• Convert between EDI and JSON reads 837P and writes it back in .NET, Native and Cloud.
• Customize EDI guidelines, How to modify EDI templates, Validate EDI with templates, EDI templates and How to install EDI templates.
• OpenEDI format and EDI models for Cloud. Model operations is the API that lists and deletes models on a subscription.
• View and download EDI specs and Create and import EDI specs.
• OpenEDI specification.