IMPDEF EDI implementation guide definition message (D02A)

This is the standard EDIFACT D02A spec, with 13 loops and 41 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.

Standard spec Customize in Spec Builder
Loading the spec…
The spec as an OpenAPI 3 schema with x-openedi-* extensions, for ediFabric Native, ediFabric Cloud and the EDI Spec Builder. Download OpenEDI (73 KB) Generate classes
The ediFabric .NET template, class TSIMPDEF. It needs the common segments, composites and codes of EDIFACT D02A, one download for every transaction in the version. Download C# (1 KB) Common files (57 KB)
The intermediary model ediFabric Native loads with set_map. Native supports X12 today, and EDIFACT is coming. Download Native (1 KB)

Use the IMPDEF 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 IMPDEF files into TSIMPDEF objects. See ediFabric .NET.

ediFabric Native

Native supports X12 today, and EDIFACT is coming. When it's available, map version D02A to this Native model with set_map to parse IMPDEF files to JSON from Python, Java, C or C#. See ediFabric Native.

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 IMPDEF classes in Python, Java, Node.js, Go, Rust or C

The OpenEDI file describes each IMPDEF as JSON. To work with IMPDEF data as typed objects, generate classes from the OpenEDI file in your language; the root class is TSIMPDEF. The classes keep the loops, segments, lengths and code lists, but not the EDI data formats. Read more in Generate a class from OpenEDI.

Python: datamodel-code-generator. Node.js: openapi-typescript. Java, Go, Rust and C: OpenAPI Generator.

IMPDEF structure

Loops and segments of the standard IMPDEF, with their usage and maximum repeats.

IDNameUsageMax use
UNHMessage HeaderOptional1
BGMBEGINNING OF MESSAGEMandatory1
MSGMESSAGE TYPE IDENTIFICATIONMandatory1
RCSREQUIREMENTS AND CONDITIONSOptional1
DIIDIRECTORY IDENTIFICATIONMandatory1
RFFREFERENCEOptional99
DTMDATE/TIME/PERIODOptional9
FTXFREE TEXTOptional999
Loop PNAPARTY IDENTIFICATIONOptional5
PNAPARTY IDENTIFICATIONMandatory1
ADRADDRESSOptional1
Loop CTACONTACT INFORMATIONOptional9999
CTACONTACT INFORMATIONMandatory1
COMCOMMUNICATION CONTACTOptional5
Loop DFNDEFINITION FUNCTIONOptional99999
DFNDEFINITION FUNCTIONMandatory1
FTXFREE TEXTOptional99
Loop GRUSEGMENT GROUP USAGE DETAILSOptional1
GRUSEGMENT GROUP USAGE DETAILSMandatory1
FTXFREE TEXTOptional99
Loop SGUSEGMENT USAGE DETAILSOptional999
SGUSEGMENT USAGE DETAILSMandatory1
FTXFREE TEXTOptional99
Loop FNTFOOTNOTEOptional99
FNTFOOTNOTEMandatory1
RELRELATIONSHIPOptional1
GIRRELATED IDENTIFICATION NUMBERSOptional9
FTXFREE TEXTOptional99
Loop RFFREFERENCEOptional99
RFFREFERENCEMandatory1
FTXFREE TEXTOptional99
Loop ELUDATA ELEMENT USAGE DETAILSOptional99
ELUDATA ELEMENT USAGE DETAILSMandatory1
ELMSIMPLE DATA ELEMENT DETAILSOptional1
EDTEDITING DETAILSOptional1
IMDITEM DESCRIPTIONOptional9
GISGENERAL INDICATOROptional9
FTXFREE TEXTOptional99
Loop MEAMEASUREMENTSOptional999
MEAMEASUREMENTSMandatory1
FTXFREE TEXTOptional99
Loop ELVELEMENT VALUE DEFINITIONOptional99999
ELVELEMENT VALUE DEFINITIONMandatory1
FTXFREE TEXTOptional99
Loop CDVCODE VALUE DEFINITIONOptional99999
CDVCODE VALUE DEFINITIONMandatory1
FTXFREE TEXTOptional99
Loop DRDDATA REPRESENTATION DETAILSOptional99999
DRDDATA REPRESENTATION DETAILSMandatory1
FTXFREE TEXTOptional99
Loop AUTAUTHENTICATION RESULTOptional1
AUTAUTHENTICATION RESULTMandatory1
DTMDATE/TIME/PERIODOptional1
UNTMessage TrailerOptional1