D02A


Message D02A/DIRDEF

Directory definition message

This Directory definition message (DIRDEF) permits the transfer of the contents of a UN/EDIFACT or American National Standards Institute (ANSI) Accredited Standards Committee (ASC) X12 Directory set or parts thereof.

Message description

UNH

M(1) : Message header

A service segment starting and uniquely identifying a message. The message type code for the Directory definition message is DIRDEF. Note: Directory definition messages conforming to this document must contain the following data in segment UNH, composite S009: Data element 0065 DIRDEF 0052 D 0054 02A 0051 UN

BGM

M(1) : Beginning of message

A segment to indicate the beginning of the message and to transmit function, type and number of the message.

DII

M(1) : Directory identification

A segment specifying the identity of the directory set and giving its language and maintenance operation.

DTM

C(9) : Date/time/period

A segment specifying dates related to the directory set, such as date of approval, date of submission or WP.4 acceptance date.

FTX

C(9) : Free text

A segment providing free text information related to the directory set.

SG1 C(9) : NAD-SG2

A group of segments identifying the parties involved in the transaction with associated information.

NAD

M(1) : Name and address

A segment identifying the parties involved in the transaction, e.g. originator, requestor or secretariat.

SG2 C(9) : CTA-COM

A group of segments identifying a person or a department and identifying communication type(s) and number(s).

CTA

M(1) : Contact information

A segment identifying a person or a department for the party specified in the leading NAD segment to whom the communication should be directed.

COM

C(9) : Communication contact

A segment identifying communication type(s) and number(s) of person(s) or department(s) specified in the associated CTA segment.

SG3 C(9999) : MSG-ATT-FTX-DTM-SG4-SG6

A group of segments providing a message type directory.

MSG

M(1) : Message type identification

A segment identifying a message type to be specified.

ATT

C(99) : Attribute

A segment used to specify an attribute related to a message type. It may indicate whether the message is a batch or an interactive message, or may indicate the specific type of maintenance applied to the message in the current release of the message type directory.

FTX

C(999) : Free text

A segment providing textual information related to the message type, namely: message type name, Introduction, Scope, Functional definition, Principles, References and Terms and definitions.

DTM

M(1) : Date/time/period

This segment is used to indicate the release date of a message, as indicated on the cover page of the boilerplate.

SG4 C(999) : SGU-ATT-FTX-SG5

A group of segments specifying a message type structure and its related functional definition.

SGU

M(1) : Segment usage details

A segment specifying the usage of a segment in a message type structure.

ATT

C(9) : Attribute

A segment used to specify an attribute related to the usage of a segment in a message type structure. It may indicate the specific type of maintenance applied to the segment within the message structure in the current release of the message type directory.

FTX

C(99) : Free text

A segment providing textual information about segment usage. This information comprises part of the 'Data segment clarification' section.

SG5 C(1) : GRU-ATT-FTX

A group of segments identifying a segment group and providing details about segment group usage.

GRU

M(1) : Segment group usage details

A segment specifying the usage of a segment group in a message type structure.

ATT

C(9) : Attribute

A segment used to specify an attribute related to the usage of a segment group in a message type structure. It may indicate the specific type of maintenance applied to the segment group within the message structure in the current release of the message type directory.

FTX

C(99) : Free text

A segment providing the textual information about segment group usage. This information comprises part of the 'Data Segment Clarification' section.

SG6 C(99) : FNT-REL-GIR-ATT-FTX

A group of segments used to specify dependency notes or other notes about the usage of segments and/or segment groups in a message type structure.

FNT

M(1) : Footnote

A segment to provide the footnote identification for a dependency note or other note that is applicable to one or more segments and/or segment groups in the message type structure.

REL

C(1) : Relationship

A segment to provide the type of dependency relationship, where one exists.

GIR

C(9) : Related identification numbers

A segment to provide the position number(s) for segments and/or segment groups to which a dependency note or other note applies.

ATT

C(9) : Attribute

A segment to provide the change indicators at the note level.

FTX

C(9) : Free text

A segment to provide a free text description of the dependency note or other note.

SG7 C(9999) : SEG-ATT-FTX-ELU-SG8

A group of segments providing a segment directory.

SEG

M(1) : Segment identification

A segment identifying a segment type and specifying its class and maintenance operation.

ATT

C(9) : Attribute

A segment used to specify an attribute related to a segment type. It may indicate whether the segment is a batch or an interactive segment, or may indicate the specific type of maintenance applied to the segment in the current release of the segment directory.

FTX

C(9) : Free text

A segment specifying the name and functional definition of a segment type.

ELU

C(99) : Data element usage details

A segment specifying the contents of data elements in a segment type.

SG8 C(99) : FNT-REL-GIR-ATT-FTX

A group of segments used to specify dependency notes or other notes about the usage of data elements in a segment type.

FNT

M(1) : Footnote

A segment to provide the footnote identification for a dependency note or other note that is applicable to one or more data elements in a segment type.

REL

C(1) : Relationship

A segment to provide the type of dependency relationship, where one exists.

GIR

C(9) : Related identification numbers

A segment to provide the position number(s) for a data element to which a dependency note or other note applies.

ATT

C(9) : Attribute

A segment to provide the change indicators at the note level.

FTX

C(9) : Free text

A segment to provide a free text description of the dependency note or other note.

SG9 C(9999) : CMP-ATT-FTX-ELU-SG10

A group of segments providing a composite data element directory.

CMP

M(1) : Composite data element identification

A segment identifying a composite data element and specifying its class and maintenance operation.

ATT

C(9) : Attribute

A segment used to specify an attribute related to a composite data element type. It may indicate whether the composite data element is a batch or an interactive composite data element, or may indicate the specific type of maintenance applied to the composite data element in the current release of the composite data element directory.

FTX

C(9) : Free text

A segment specifying the name and functional definition of a composite data element type.

ELU

C(99) : Data element usage details

A segment specifying component data elements in a composite data element and its related information.

SG10 C(99) : FNT-REL-GIR-ATT-FTX

A group of segments used to specify dependency notes or other notes about the usage of component data elements in a composite data element type.

FNT

M(1) : Footnote

A segment to provide the footnote identification for a dependency note or other note that is applicable to one or more component data elements in a composite data element type.

REL

C(1) : Relationship

A segment to provide the type of dependency relationship, where one exists.

GIR

C(9) : Related identification numbers

A segment to provide the position number(s) for a data element to which a dependency note or other note applies.

ATT

C(9) : Attribute

A segment to provide the change indicators at the note level.

FTX

C(9) : Free text

A segment to provide a free text description of the dependency note or other note.

SG11 C(9999) : ELM-ATT-FTX

A group of segments providing a data element directory.

ELM

M(1) : Simple data element details

A segment identifying a simple data element and giving related information.

ATT

C(9) : Attribute

A segment used to specify an attribute related to a simple data element type. It may indicate whether the data element is a batch, or an interactive, or both a batch and an interactive simple data element. It may indicate the specific type of maintenance applied to the data element in the current release of the simple data element directory.

FTX

C(9) : Free text

A segment specifying the name and functional definition of a simple data element.

SG12 C(9999) : CDS-FTX-SG13

A group of segments providing a code list directory.

CDS

M(1) : Code set identification

A segment specifying a code set. In DIRDEF data element 9434 shall not be used.

FTX

C(9) : Free text

A segment providing textual information related to the code list.

SG13 C(9999) : CDV-ATT-FTX

A group of segments specifying a code value and its functional definition.

CDV

M(1) : Code value definition

A segment specifying a code value.

ATT

C(9) : Attribute

A segment used to specify an attribute related to a code value. It may indicate the specific type of maintenance applied to the code value in the current release of the code list directory.

FTX

C(9) : Free text

A segment specifying the name and functional definition of a code value.

UNT

M(1) : Message trailer

A service segment ending a message, giving the total number of segments in the message (including the UNH & UNT) and the control reference number of the message.

Message structure

UNH, Message header                           M        1
BGM, Beginning of message                     M        1
DII, Directory identification                 M        1
DTM, Date/time/period                         C        9
FTX, Free text                                C        9

--- Segment Group 1 ------------------------- C        9 -------+
NAD, Name and address                         M        1        |
                                                                |
--- Segment Group 2 ------------------------- C        9 ------+|
CTA, Contact information                      M        1       ||
COM, Communication contact                    C        9       ||
---- ----------------------------------------------------------++

--- Segment Group 3 ------------------------- C     9999 -------+
MSG, Message type identification              M        1        |
ATT, Attribute                                C       99        |
FTX, Free text                                C      999        |
DTM, Date/time/period                         M        1        |
                                                                |
--- Segment Group 4 ------------------------- C      999 ------+|
SGU, Segment usage details                    M        1       ||
ATT, Attribute                                C        9       ||
FTX, Free text                                C       99       ||
                                                               ||
--- Segment Group 5 ------------------------- C        1 -----+||
GRU, Segment group usage details              M        1      |||
ATT, Attribute                                C        9      |||
FTX, Free text                                C       99      |||
---- ---------------------------------------------------------++|
                                                                |
--- Segment Group 6 ------------------------- C       99 ------+|
FNT, Footnote                                 M        1       ||
REL, Relationship                             C        1       ||
GIR, Related identification numbers           C        9       ||
ATT, Attribute                                C        9       ||
FTX, Free text                                C        9       ||
---- ----------------------------------------------------------++

--- Segment Group 7 ------------------------- C     9999 -------+
SEG, Segment identification                   M        1        |
ATT, Attribute                                C        9        |
FTX, Free text                                C        9        |
ELU, Data element usage details               C       99        |
                                                                |
--- Segment Group 8 ------------------------- C       99 ------+|
FNT, Footnote                                 M        1       ||
REL, Relationship                             C        1       ||
GIR, Related identification numbers           C        9       ||
ATT, Attribute                                C        9       ||
FTX, Free text                                C        9       ||
---- ----------------------------------------------------------++

--- Segment Group 9 ------------------------- C     9999 -------+
CMP, Composite data element identification    M        1        |
ATT, Attribute                                C        9        |
FTX, Free text                                C        9        |
ELU, Data element usage details               C       99        |
                                                                |
--- Segment Group 10 ------------------------ C       99 ------+|
FNT, Footnote                                 M        1       ||
REL, Relationship                             C        1       ||
GIR, Related identification numbers           C        9       ||
ATT, Attribute                                C        9       ||
FTX, Free text                                C        9       ||
---- ----------------------------------------------------------++

--- Segment Group 11 ------------------------ C     9999 -------+
ELM, Simple data element details              M        1        |
ATT, Attribute                                C        9        |
FTX, Free text                                C        9        |
---- -----------------------------------------------------------+

--- Segment Group 12 ------------------------ C     9999 -------+
CDS, Code set identification                  M        1        |
FTX, Free text                                C        9        |
                                                                |
--- Segment Group 13 ------------------------ C     9999 ------+|
CDV, Code value definition                    M        1       ||
ATT, Attribute                                C        9       ||
FTX, Free text                                C        9       ||
---- ----------------------------------------------------------++
UNT, Message trailer                          M        1