Intro to Object Schemas for JSON

The schema documentation lists all objects and fields produced by the EDI Converter when converting X12 EDI files to JSON or NDJSON.

See the CSV data dictionary if you’re converting to CSV or Excel.

Notation

Each object is listed in a separate table.

The mapping to EDI is specified in the “EDI Element” column.

This column contains an X12 “Reference Designator” for data elements. E.g., CLM01 (patient control number) refers to the CLM segment and the element in the first position.

For example, in CLM*26463774*100***11:B:1*Y*A*Y*I~, “26463774” is the value of the CLM01 element.

Note that certain elements can be unused for many segments, so the numbering is not sequential.

In some instances, we also provide the qualifier code for the field, prefixed by *. For example, in the EDI string DTP*435*D8*20030108~, the code 435 signifies an admission date, so the admissionDate field has *435 next to the DTP02 element’s reference designator.

The combination of the reference designator and the qualifier code gives you an exact mapping to the element/segment definition in an X12 standard, where you can find additional details (requires a paid subscription).

“EDI Element” is blank for the fields that are not populated from EDI data. These fields are calculated based on other fields (e.g., totalAdjAmount) or generated by the converter (id).

All root objects contain links to our interactive examples. Open any example, select “EDI View” and click on any segment name to see the element designator.

OpenAPI Schemas

You can find OpenAPI 3.1.1 schemas in our GitHub repo.

Each object is defined in a separate schema file.

We use the following OpenAPI extensions (custom properties) in our schemas:

  • x-edi-elt-designators: The EDI element reference designator for the field.
  • x-edi-qualifiers:: The qualifier code for the field, if applicable.
  • x-edi-seg-ids:: The EDI segment name for the object.
  • x-edi-loop-ids: The EDI loop identifier for the object.
  • x-since: The version of the EDI converter that introduced the field.

Note that all “x-edi” properties are lists, since JSON fields can be mapped to multiple EDI elements.

The purpose of these extensions is to clearly define a direct mapping between EDI segments and elements and JSON objects.

The extensions also facilitate tracking of changes between EDI converter versions.

You can also download the entire OpenAPI specification, including endpoints, operations and schemas, from the API Reference Guide.