UNH M 1 MESSAGE HEADER

  • Mandatory
  • Max repeat: 1
A service segment starting and uniquely identifying a message. The message type code for the Application error and acknowledgement message is APERAK.
0062
MESSAGE REFERENCE NUMBER
  • Mandatory
  • Type: an
  • Length: 0..14
Unique message reference assigned by the sender.
S009
MESSAGE IDENTIFIER
  • Mandatory
Identification of the type, version, etc. of the message being interchanged.
0065
Message type
  • Mandatory
  • Type: an
  • Length: 0..6
Code identifying a type of message and assigned by its controlling agency.
0052
Message version number
  • Mandatory
  • Type: an
  • Length: 0..3
Version number of a message type.
0054
Message release number
  • Mandatory
  • Type: an
  • Length: 0..3
Release number within the current message version number.
0051
Controlling agency, coded
  • Mandatory
  • Type: an
  • Length: 0..3
Code identifying a controlling agency.
0057
Association assigned code
  • Conditional
  • Type: an
  • Length: 0..6
Code, assigned by the association responsible for the design and maintenance of the message type concerned, which further identifies the message.
0110
Code list directory version number
  • Conditional
  • Type: an
  • Length: 0..6
Version number of the code list directory.
0113
Message type sub-function identification
  • Conditional
  • Type: an
  • Length: 0..6
Code identifying a sub-function of a message type.
0068
COMMON ACCESS REFERENCE
  • Conditional
  • Type: an
  • Length: 0..35
Reference serving as a key to relate all subsequent transfers of data to the same business case or file.
S010
STATUS OF THE TRANSFER
  • Conditional
Statement that the message is one in a sequence of transfers relating to the same topic.
0070
Sequence of transfers
  • Mandatory
  • Type: n
  • Length: 0..2
Number assigned by the sender indicating the transfer sequence of a message related to the same topic. The message could be an addition or a change to an earlier transfer related to the same topic.
0073
First and last transfer
  • Conditional
  • Type: a
  • Length: 1
Indication used for the first and last message in a sequence of messages related to the same topic.
S016
MESSAGE SUBSET IDENTIFICATION
  • Conditional
Identification of a message subset by its identifier, version, release and source.
0115
Message subset identification
  • Mandatory
  • Type: an
  • Length: 0..14
Coded identification of a message subset, assigned by its controlling agency.
0116
Message subset version number
  • Conditional
  • Type: an
  • Length: 0..3
Version number of the message subset.
0118
Message subset release number
  • Conditional
  • Type: an
  • Length: 0..3
Release number within the message subset version number.
0051
Controlling agency, coded
  • Conditional
  • Type: an
  • Length: 0..3
Code identifying a controlling agency.
S017
MESSAGE IMPLEMENTATION GUIDELINE IDENTIFICATION
  • Conditional
Identification of a message implementation guideline by its identifier, version, release and source.
0121
Message implementation guideline identification
  • Mandatory
  • Type: an
  • Length: 0..14
Coded identification of the message implementation guideline, assigned by its controlling agency.
0122
Message implementation guideline version number
  • Conditional
  • Type: an
  • Length: 0..3
Version number of the message implementation guideline.
0124
Message implementation guideline release number
  • Conditional
  • Type: an
  • Length: 0..3
Release number within the message implementation guideline version number.
0051
Controlling agency, coded
  • Conditional
  • Type: an
  • Length: 0..3
Code identifying a controlling agency.
S018
SCENARIO IDENTIFICATION
  • Conditional
Identification of a scenario.
0127
Scenario identification
  • Mandatory
  • Type: an
  • Length: 0..14
Code identifying scenario.
0128
Scenario version number
  • Conditional
  • Type: an
  • Length: 0..3
Version number of a scenario.
0130
Scenario release number
  • Conditional
  • Type: an
  • Length: 0..3
Release number within the scenario version number.
0051
Controlling agency, coded
  • Conditional
  • Type: an
  • Length: 0..3
Code identifying a controlling agency.

BGM M 1 BEGINNING OF MESSAGE

  • Mandatory
  • Max repeat: 1
A segment to indicate the type and function of the message and to transmit the identifying number.
C002
DOCUMENT/MESSAGE NAME
  • Conditional
Identification of a type of document/message by code or name. Code preferred.
1001
Document/message name, coded
  • Conditional
  • Type: an
  • Length: 0..3
Document/message identifier expressed in code.
1131
Code list qualifier
  • Conditional
  • Type: an
  • Length: 0..3
Identification of a code list.
3055
Code list responsible agency, coded
  • Conditional
  • Type: an
  • Length: 0..3
Code identifying the agency responsible for a code list.
1000
Document/message name
  • Conditional
  • Type: an
  • Length: 0..35
Plain language identifier specifying the function of a document/message.
C106
DOCUMENT/MESSAGE IDENTIFICATION
  • Conditional
Identification of a document/message by its number and eventually its version or revision.
1004
Document/message number
  • Conditional
  • Type: an
  • Length: 0..35
Reference number assigned to the document/message by the issuer.
1056
Version
  • Conditional
  • Type: an
  • Length: 0..9
To specify the version number or name of an object.
1060
Revision number
  • Conditional
  • Type: an
  • Length: 0..6
To specify a revision number.
1225
MESSAGE FUNCTION, CODED
  • Conditional
  • Type: an
  • Length: 0..3
Code indicating the function of the message.
4343
RESPONSE TYPE, CODED
  • Conditional
  • Type: an
  • Length: 0..3
Code specifying the type of acknowledgment required or transmitted.

DTM C 9 DATE/TIME/PERIOD

  • Conditional
  • Max repeat: 9
A segment to specify related date/time.
C507
DATE/TIME/PERIOD
  • Mandatory
Date and/or time, or period relevant to the specified date/time/period type.
2005
Date/time/period qualifier
  • Mandatory
  • Type: an
  • Length: 0..3
Code giving specific meaning to a date, time or period.
2380
Date/time/period
  • Conditional
  • Type: an
  • Length: 0..35
The value of a date, a date and time, a time or of a period in a specified representation.
2379
Date/time/period format qualifier
  • Conditional
  • Type: an
  • Length: 0..3
Specification of the representation of a date, a date and time or of a period.

FTX C 9 FREE TEXT

  • Conditional
  • Max repeat: 9
A segment to specify free form or processable supplementary information related to the whole message. In computer-to-computer exchanges free form text will normally require the receiver to process this segment manually.
4451
TEXT SUBJECT QUALIFIER
  • Mandatory
  • Type: an
  • Length: 0..3
Code specifying subject of a free text.
4453
TEXT FUNCTION, CODED
  • Conditional
  • Type: an
  • Length: 0..3
Code specifying the purpose of the text.
C107
TEXT REFERENCE
  • Conditional
Coded reference to a standard text and its source.
4441
Free text identification
  • Mandatory
  • Type: an
  • Length: 0..17
Free text in coded form.
1131
Code list qualifier
  • Conditional
  • Type: an
  • Length: 0..3
Identification of a code list.
3055
Code list responsible agency, coded
  • Conditional
  • Type: an
  • Length: 0..3
Code identifying the agency responsible for a code list.
C108
TEXT LITERAL
  • Conditional
Free text; one to five lines.
4440
Free text
  • Mandatory
  • Type: an
  • Length: 0..70
Free text field available to the message sender for information.
4440
Free text
  • Conditional
  • Type: an
  • Length: 0..70
Free text field available to the message sender for information.
4440
Free text
  • Conditional
  • Type: an
  • Length: 0..70
Free text field available to the message sender for information.
4440
Free text
  • Conditional
  • Type: an
  • Length: 0..70
Free text field available to the message sender for information.
4440
Free text
  • Conditional
  • Type: an
  • Length: 0..70
Free text field available to the message sender for information.
3453
LANGUAGE, CODED
  • Conditional
  • Type: an
  • Length: 0..3
Code of language (ISO 639-1988).
4447
TEXT FORMATTING, CODED
  • Conditional
  • Type: an
  • Length: 0..3
Code specifying the formatting parameters for the text.

CNT C 9 CONTROL TOTAL

  • Conditional
  • Max repeat: 9
A segment to provide message control totals.
C270
CONTROL
  • Mandatory
Control total for checking integrity of a message or part of a message.
6069
Control qualifier
  • Mandatory
  • Type: an
  • Length: 0..3
Determines the source data elements in the message which forms the basis for 6066 Control value.
6066
Control value
  • Mandatory
  • Type: n
  • Length: 0..18
Value obtained from summing the values specified by the Control Qualifier throughout the message (Hash total).
6411
Measure unit qualifier
  • Conditional
  • Type: an
  • Length: 0..3
Indication of the unit of measurement in which weight (mass), capacity, length, area, volume or other quantity is expressed.

GRP1 C 99 DOC DTM

  • Conditional
  • Max repeat: 99
A segment group to provide information on the document being acknowledged.

DOC M 1 DOCUMENT/MESSAGE DETAILS

  • Mandatory
  • Max repeat: 1
A segment to provide the necessary identification information about the document being acknowledged.
C002
DOCUMENT/MESSAGE NAME
  • Mandatory
Identification of a type of document/message by code or name. Code preferred.
1001
Document/message name, coded
  • Conditional
  • Type: an
  • Length: 0..3
Document/message identifier expressed in code.
1131
Code list qualifier
  • Conditional
  • Type: an
  • Length: 0..3
Identification of a code list.
3055
Code list responsible agency, coded
  • Conditional
  • Type: an
  • Length: 0..3
Code identifying the agency responsible for a code list.
1000
Document/message name
  • Conditional
  • Type: an
  • Length: 0..35
Plain language identifier specifying the function of a document/message.
C503
DOCUMENT/MESSAGE DETAILS
  • Conditional
Identification of document/message by number, status, source and/or language.
1004
Document/message number
  • Conditional
  • Type: an
  • Length: 0..35
Reference number assigned to the document/message by the issuer.
1373
Document/message status, coded
  • Conditional
  • Type: an
  • Length: 0..3
To identify the status of a document/message.
1366
Document/message source
  • Conditional
  • Type: an
  • Length: 0..70
Indication of the source from which the printed information is to be or has been obtained.
3453
Language, coded
  • Conditional
  • Type: an
  • Length: 0..3
Code of language (ISO 639-1988).
1056
Version
  • Conditional
  • Type: an
  • Length: 0..9
To specify the version number or name of an object.
1060
Revision number
  • Conditional
  • Type: an
  • Length: 0..6
To specify a revision number.
3153
COMMUNICATION CHANNEL IDENTIFIER, CODED
  • Conditional
  • Type: an
  • Length: 0..3
Code identifying the type of communication channel being used.
1220
NUMBER OF COPIES OF DOCUMENT REQUIRED
  • Conditional
  • Type: n
  • Length: 0..2
Number of originals or copies of a document stipulated or referred to as being required.
1218
NUMBER OF ORIGINALS OF DOCUMENT REQUIRED
  • Conditional
  • Type: n
  • Length: 0..2
Specification of the number of originals of a stipulated document that are required.

DTM C 99 DATE/TIME/PERIOD

  • Conditional
  • Max repeat: 99
A segment to provide the relevant dates concerning the document being acknowledged.
C507
DATE/TIME/PERIOD
  • Mandatory
Date and/or time, or period relevant to the specified date/time/period type.
2005
Date/time/period qualifier
  • Mandatory
  • Type: an
  • Length: 0..3
Code giving specific meaning to a date, time or period.
2380
Date/time/period
  • Conditional
  • Type: an
  • Length: 0..35
The value of a date, a date and time, a time or of a period in a specified representation.
2379
Date/time/period format qualifier
  • Conditional
  • Type: an
  • Length: 0..3
Specification of the representation of a date, a date and time or of a period.

GRP2 C 9 RFF DTM

  • Conditional
  • Max repeat: 9
A group of segments to specify the document/message to which the current message relates, and related date and time.

RFF M 1 REFERENCE

  • Mandatory
  • Max repeat: 1
A segment to indicate the reference number of the document/message.
C506
REFERENCE
  • Mandatory
Identification of a reference.
1153
Reference qualifier
  • Mandatory
  • Type: an
  • Length: 0..3
Code giving specific meaning to a reference segment or a reference number.
1154
Reference number
  • Conditional
  • Type: an
  • Length: 0..35
Identification number the nature and function of which can be qualified by an entry in data element 1153 Reference qualifier.
1156
Line number
  • Conditional
  • Type: an
  • Length: 0..6
Number of the line in the document/message referenced in 1154 Reference number.
4000
Reference version number
  • Conditional
  • Type: an
  • Length: 0..35
To uniquely identify a reference by its version number.
1060
Revision number
  • Conditional
  • Type: an
  • Length: 0..6
To specify a revision number.

DTM C 9 DATE/TIME/PERIOD

  • Conditional
  • Max repeat: 9
A segment to specify the date and time of the referenced document/message.
C507
DATE/TIME/PERIOD
  • Mandatory
Date and/or time, or period relevant to the specified date/time/period type.
2005
Date/time/period qualifier
  • Mandatory
  • Type: an
  • Length: 0..3
Code giving specific meaning to a date, time or period.
2380
Date/time/period
  • Conditional
  • Type: an
  • Length: 0..35
The value of a date, a date and time, a time or of a period in a specified representation.
2379
Date/time/period format qualifier
  • Conditional
  • Type: an
  • Length: 0..3
Specification of the representation of a date, a date and time or of a period.

GRP3 C 9 NAD CTA COM

  • Conditional
  • Max repeat: 9
A group of segments to specify the identifications of message sender and message receiver with their contacts and communication channels.

NAD M 1 NAME AND ADDRESS

  • Mandatory
  • Max repeat: 1
A segment to specify the identification of the message issuer and message receiver.
3035
PARTY QUALIFIER
  • Mandatory
  • Type: an
  • Length: 0..3
Code giving specific meaning to a party.
C082
PARTY IDENTIFICATION DETAILS
  • Conditional
Identification of a transaction party by code.
3039
Party identification
  • Mandatory
  • Type: an
  • Length: 0..35
Code identifying a party involved in a transaction.
1131
Code list qualifier
  • Conditional
  • Type: an
  • Length: 0..3
Identification of a code list.
3055
Code list responsible agency, coded
  • Conditional
  • Type: an
  • Length: 0..3
Code identifying the agency responsible for a code list.
C058
NAME AND ADDRESS
  • Conditional
Unstructured name and address: one to five lines.
3124
Name and address line
  • Mandatory
  • Type: an
  • Length: 0..35
Free form name and address description.
3124
Name and address line
  • Conditional
  • Type: an
  • Length: 0..35
Free form name and address description.
3124
Name and address line
  • Conditional
  • Type: an
  • Length: 0..35
Free form name and address description.
3124
Name and address line
  • Conditional
  • Type: an
  • Length: 0..35
Free form name and address description.
3124
Name and address line
  • Conditional
  • Type: an
  • Length: 0..35
Free form name and address description.
C080
PARTY NAME
  • Conditional
Identification of a transaction party by name, one to five lines. Party name may be formatted.
3036
Party name
  • Mandatory
  • Type: an
  • Length: 0..35
Name of a party involved in a transaction.
3036
Party name
  • Conditional
  • Type: an
  • Length: 0..35
Name of a party involved in a transaction.
3036
Party name
  • Conditional
  • Type: an
  • Length: 0..35
Name of a party involved in a transaction.
3036
Party name
  • Conditional
  • Type: an
  • Length: 0..35
Name of a party involved in a transaction.
3036
Party name
  • Conditional
  • Type: an
  • Length: 0..35
Name of a party involved in a transaction.
3045
Party name format, coded
  • Conditional
  • Type: an
  • Length: 0..3
Specification of the representation of a party name.
C059
STREET
  • Conditional
Street address and/or PO Box number in a structured address: one to four lines.
3042
Street and number/p.o. box
  • Mandatory
  • Type: an
  • Length: 0..35
Street and number in plain language, or Post Office Box No.
3042
Street and number/p.o. box
  • Conditional
  • Type: an
  • Length: 0..35
Street and number in plain language, or Post Office Box No.
3042
Street and number/p.o. box
  • Conditional
  • Type: an
  • Length: 0..35
Street and number in plain language, or Post Office Box No.
3042
Street and number/p.o. box
  • Conditional
  • Type: an
  • Length: 0..35
Street and number in plain language, or Post Office Box No.
3164
CITY NAME
  • Conditional
  • Type: an
  • Length: 0..35
Name of a city (a town, a village) for addressing purposes.
3229
COUNTRY SUB-ENTITY IDENTIFICATION
  • Conditional
  • Type: an
  • Length: 0..9
Identification of the name of sub-entities (state, province) defined by appropriate governmental agencies.
3251
POSTCODE IDENTIFICATION
  • Conditional
  • Type: an
  • Length: 0..9
Code defining postal zones or addresses.
3207
COUNTRY, CODED
  • Conditional
  • Type: an
  • Length: 0..3
Identification of the name of a country or other geographical entity as specified in ISO 3166.

CTA C 9 CONTACT INFORMATION

  • Conditional
  • Max repeat: 9
A segment to specify a person or department inside the party's organization, to which communication should be directed.
3139
CONTACT FUNCTION, CODED
  • Conditional
  • Type: an
  • Length: 0..3
Code specifying the function of a contact (e.g. department or person).
C056
DEPARTMENT OR EMPLOYEE DETAILS
  • Conditional
Code and/or name of a department or employee. Code preferred.
3413
Department or employee identification
  • Conditional
  • Type: an
  • Length: 0..17
Internal identification code.
3412
Department or employee
  • Conditional
  • Type: an
  • Length: 0..35
The department or person within an organizational entity.

COM C 9 COMMUNICATION CONTACT

  • Conditional
  • Max repeat: 9
A segment to indicate communication channel type and number inside the party's organization, to which communication should be directed.
C076
COMMUNICATION CONTACT
  • Mandatory
Communication number of a department or employee in a specified channel.
3148
Communication number
  • Mandatory
  • Type: an
  • Length: 0..512
The communication number.
3155
Communication channel qualifier
  • Mandatory
  • Type: an
  • Length: 0..3
Code identifying the type of communication channel being used.

GRP4 C 99999 ERC FTX GRP5

  • Conditional
  • Max repeat: 99999
A group of segments to identify the application error(s) within a specified received message and to give specific details related to the error type or to precise the type of acknowledgement.

ERC M 1 APPLICATION ERROR INFORMATION

  • Mandatory
  • Max repeat: 1
A segment identifying the type of application error or acknowledgement within the referenced message. In case of an error, the error code may specify the error in detail (e.g. a measurement relating to a piece of equipment is wrong) or as a rough indication (e.g. a measurement is wrong).
C901
APPLICATION ERROR DETAIL
  • Mandatory
Code assigned by the recipient of a message to indicate a data validation error condition.
9321
Application error identification
  • Mandatory
  • Type: an
  • Length: 0..8
The code assigned by the receiver of a message to the identification of a data validation error condition.
1131
Code list qualifier
  • Conditional
  • Type: an
  • Length: 0..3
Identification of a code list.
3055
Code list responsible agency, coded
  • Conditional
  • Type: an
  • Length: 0..3
Code identifying the agency responsible for a code list.

FTX C 1 FREE TEXT

  • Conditional
  • Max repeat: 1
A segment to provide explanation and/or supplementary information related to the specified application error or acknowledgement. For example, the explanation may provide exact details relating to a generic error code.
4451
TEXT SUBJECT QUALIFIER
  • Mandatory
  • Type: an
  • Length: 0..3
Code specifying subject of a free text.
4453
TEXT FUNCTION, CODED
  • Conditional
  • Type: an
  • Length: 0..3
Code specifying the purpose of the text.
C107
TEXT REFERENCE
  • Conditional
Coded reference to a standard text and its source.
4441
Free text identification
  • Mandatory
  • Type: an
  • Length: 0..17
Free text in coded form.
1131
Code list qualifier
  • Conditional
  • Type: an
  • Length: 0..3
Identification of a code list.
3055
Code list responsible agency, coded
  • Conditional
  • Type: an
  • Length: 0..3
Code identifying the agency responsible for a code list.
C108
TEXT LITERAL
  • Conditional
Free text; one to five lines.
4440
Free text
  • Mandatory
  • Type: an
  • Length: 0..70
Free text field available to the message sender for information.
4440
Free text
  • Conditional
  • Type: an
  • Length: 0..70
Free text field available to the message sender for information.
4440
Free text
  • Conditional
  • Type: an
  • Length: 0..70
Free text field available to the message sender for information.
4440
Free text
  • Conditional
  • Type: an
  • Length: 0..70
Free text field available to the message sender for information.
4440
Free text
  • Conditional
  • Type: an
  • Length: 0..70
Free text field available to the message sender for information.
3453
LANGUAGE, CODED
  • Conditional
  • Type: an
  • Length: 0..3
Code of language (ISO 639-1988).
4447
TEXT FORMATTING, CODED
  • Conditional
  • Type: an
  • Length: 0..3
Code specifying the formatting parameters for the text.

GRP5 C 9 RFF FTX

  • Conditional
  • Max repeat: 9
A group of segments to specify the functional entity reference (e.g. goods item level, equipment level) relating to the specified error; further details can be added to identify the error more precisely.

RFF M 1 REFERENCE

  • Mandatory
  • Max repeat: 1
A segment to provide a reference relating to the acknowledgement type or the specified error (e.g. functional entity reference such as equipment level).
C506
REFERENCE
  • Mandatory
Identification of a reference.
1153
Reference qualifier
  • Mandatory
  • Type: an
  • Length: 0..3
Code giving specific meaning to a reference segment or a reference number.
1154
Reference number
  • Conditional
  • Type: an
  • Length: 0..35
Identification number the nature and function of which can be qualified by an entry in data element 1153 Reference qualifier.
1156
Line number
  • Conditional
  • Type: an
  • Length: 0..6
Number of the line in the document/message referenced in 1154 Reference number.
4000
Reference version number
  • Conditional
  • Type: an
  • Length: 0..35
To uniquely identify a reference by its version number.
1060
Revision number
  • Conditional
  • Type: an
  • Length: 0..6
To specify a revision number.

FTX C 9 FREE TEXT

  • Conditional
  • Max repeat: 9
A segment to provide additional details relating to the reference, e.g. the content of the wrong data (and its exact place in the message).
4451
TEXT SUBJECT QUALIFIER
  • Mandatory
  • Type: an
  • Length: 0..3
Code specifying subject of a free text.
4453
TEXT FUNCTION, CODED
  • Conditional
  • Type: an
  • Length: 0..3
Code specifying the purpose of the text.
C107
TEXT REFERENCE
  • Conditional
Coded reference to a standard text and its source.
4441
Free text identification
  • Mandatory
  • Type: an
  • Length: 0..17
Free text in coded form.
1131
Code list qualifier
  • Conditional
  • Type: an
  • Length: 0..3
Identification of a code list.
3055
Code list responsible agency, coded
  • Conditional
  • Type: an
  • Length: 0..3
Code identifying the agency responsible for a code list.
C108
TEXT LITERAL
  • Conditional
Free text; one to five lines.
4440
Free text
  • Mandatory
  • Type: an
  • Length: 0..70
Free text field available to the message sender for information.
4440
Free text
  • Conditional
  • Type: an
  • Length: 0..70
Free text field available to the message sender for information.
4440
Free text
  • Conditional
  • Type: an
  • Length: 0..70
Free text field available to the message sender for information.
4440
Free text
  • Conditional
  • Type: an
  • Length: 0..70
Free text field available to the message sender for information.
4440
Free text
  • Conditional
  • Type: an
  • Length: 0..70
Free text field available to the message sender for information.
3453
LANGUAGE, CODED
  • Conditional
  • Type: an
  • Length: 0..3
Code of language (ISO 639-1988).
4447
TEXT FORMATTING, CODED
  • Conditional
  • Type: an
  • Length: 0..3
Code specifying the formatting parameters for the text.

UNT M 1 MESSAGE TRAILER

  • Mandatory
  • Max repeat: 1
A service segment ending a message, giving the total number of segments in the message and the control reference number of the message.
0074
NUMBER OF SEGMENTS IN A MESSAGE
  • Mandatory
  • Type: n
  • Length: 0..10
The number of segments in a message body, plus the message header segment and message trailer segment.
0062
MESSAGE REFERENCE NUMBER
  • Mandatory
  • Type: an
  • Length: 0..14
Unique message reference assigned by the sender.