D.09B IMPDEF
EDI implementation guide definition message
Version historyMessage definition
UNHMESSAGE HEADERM 1
1Mandatory A service segment starting and uniquely identifying a message. The message type code for the EDI implementation guide definition message is IMPDEF.
0062
MESSAGE REFERENCE NUMBER
Mandatoryan0..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
Mandatoryan0..6
Code identifying a type of message and assigned by its controlling agency.
Show codelist0054
Message release number
Mandatoryan0..3
Release number within the current message version number.
Show codelist0057
Association assigned code
Conditionalan0..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
Conditionalan0..6
Version number of the code list directory.
0113
Message type sub-function identification
Conditionalan0..6
Code identifying a sub-function of a message type.
Show codelist0068
COMMON ACCESS REFERENCE
Conditionalan0..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
Mandatoryn0..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
Conditionala1
Indication used for the first and last message in a sequence of messages related to the same topic.
Show codelistS016
MESSAGE SUBSET IDENTIFICATION
Conditional
Identification of a message subset by its identifier, version, release and source.
0115
Message subset identification
Mandatoryan0..14
Coded identification of a message subset, assigned by its controlling agency.
0116
Message subset version number
Conditionalan0..3
Version number of the message subset.
0118
Message subset release number
Conditionalan0..3
Release number within the message subset version number.
S017
MESSAGE IMPLEMENTATION GUIDELINE IDENTIFICATION
Conditional
Identification of a message implementation guideline by its identifier, version, release and source.
0121
Message implementation guideline identification
Mandatoryan0..14
Coded identification of the message implementation guideline, assigned by its controlling agency.
0122
Message implementation guideline version number
Conditionalan0..3
Version number of the message implementation guideline.
0124
Message implementation guideline release number
Conditionalan0..3
Release number within the message implementation guideline version number.
S018
SCENARIO IDENTIFICATION
Conditional
Identification of a scenario.
0127
Scenario identification
Mandatoryan0..14
Code identifying scenario.
0128
Scenario version number
Conditionalan0..3
Version number of a scenario.
0130
Scenario release number
Conditionalan0..3
Release number within the scenario version number.
BGMBEGINNING OF MESSAGEM 1
1Mandatory A segment to indicate the beginning of the message and to transmit function, type and number of the message.
C002
DOCUMENT/MESSAGE NAME
Conditional
Identification of a type of document/message by code or name. Code preferred.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelist1000
Document name
Conditionalan0..35
Name of a document.
C106
DOCUMENT/MESSAGE IDENTIFICATION
Conditional
Identification of a document/message by its number and eventually its version or revision.
1004
Document identifier
Conditionalan0..70
To identify a document.
1056
Version identifier
Conditionalan0..9
To identify a version.
1060
Revision identifier
Conditionalan0..6
To identify a revision.
4343
RESPONSE TYPE CODE
Conditionalan0..3
Code specifying the type of acknowledgment required or transmitted.
Show codelist
MSGMESSAGE TYPE IDENTIFICATIONM 1
1Mandatory A segment identifying a message type to which the implementation details apply.
C709
MESSAGE IDENTIFIER
Mandatory
Identification of the message.
1003
Message type code
Mandatoryan0..6
Code specifying a type of message.
1056
Version identifier
Conditionalan0..9
To identify a version.
1058
Release identifier
Conditionalan0..9
To identify a release.
1476
Controlling agency identifier
Conditionalan0..2
To identify a controlling agency.
1523
Message implementation identification code
Conditionalan0..6
Code identifying an implementation of a message.
1060
Revision identifier
Conditionalan0..6
To identify a revision.
4513
MAINTENANCE OPERATION CODE
Conditionalan0..3
Code specifying a maintenance operation.
Show codelistC941
RELATIONSHIP
Conditional
Identification and/or description of a relationship.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelist9142
Relationship description
Conditionalan0..35
Free form description of a relationship.
RCSREQUIREMENTS AND CONDITIONSC 1
1Conditional A segment specifying the distribution conditions for the implementation.
7293
SECTOR AREA IDENTIFICATION CODE QUALIFIER
Mandatoryan0..3
Code qualifying identification of a subject area.
Show codelistC550
REQUIREMENT/CONDITION IDENTIFICATION
Conditional
To identify the specific rule/condition requirement.
7295
Requirement or condition description identifier
Mandatoryan0..17
Code specifying a requirement or condition.
Show codelist1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelist7294
Requirement or condition description
Conditionalan0..35
Free form description of a requirement or condition.
1229
ACTION CODE
Conditionalan0..3
Code specifying the action to be taken or already taken.
Show codelist3207
COUNTRY IDENTIFIER
Conditionalan0..3
Identification of the name of the country or other geographical entity as defined in ISO 3166-1 and UN/ECE Recommendation 3.
DIIDIRECTORY IDENTIFICATIONM 1
1Mandatory A segment specifying the identity of the source directory set and giving its language and maintenance operation. This identifies the underlying standard from which the standard message is drawn.
1056
VERSION IDENTIFIER
Mandatoryan0..9
To identify a version.
1058
RELEASE IDENTIFIER
Mandatoryan0..9
To identify a release.
9148
DIRECTORY STATUS IDENTIFIER
Conditionalan0..3
To identify the status of a directory set.
1476
CONTROLLING AGENCY IDENTIFIER
Conditionalan0..2
To identify a controlling agency.
3453
LANGUAGE NAME CODE
Conditionalan0..3
Code specifying the language name.
4513
MAINTENANCE OPERATION CODE
Conditionalan0..3
Code specifying a maintenance operation.
Show codelist
RFFREFERENCEC 99
99Conditional A segment carrying reference information for the implementation as a whole. This may specify the unique registration identifier of this implementation guide; it may carry references to graphical information to be used or displayed whenever the implementation is physically displayed.
C506
REFERENCE
Mandatory
Identification of a reference.
1154
Reference identifier
Conditionalan0..70
Identifies a reference.
1156
Document line identifier
Conditionalan0..6
To identify a line of a document.
1056
Version identifier
Conditionalan0..9
To identify a version.
1060
Revision identifier
Conditionalan0..6
To identify a revision.
DTMDATE/TIME/PERIODC 9
9Conditional A segment specifying dates related to the implementation guide, such as date of issue or date of approval.
C507
DATE/TIME/PERIOD
Mandatory
Date and/or time, or period relevant to the specified date/time/period type.
2005
Date or time or period function code qualifier
Mandatoryan0..3
Code qualifying the function of a date, time or period.
Show codelist2380
Date or time or period text
Conditionalan0..35
The value of a date, a date and time, a time or of a period in a specified representation.
2379
Date or time or period format code
Conditionalan0..3
Code specifying the representation of a date, time or period.
Show codelist
FTXFREE TEXTC 999
999Conditional A segment providing implementation guide notes which relate to the implementation as a whole. It may also carry various legal or contractual phrases which may apply to the ownership or copyright of the implementation guide, or contractual terms which will be incorporated by reference into any contract of which a data transmission using this implementation is a part.
C107
TEXT REFERENCE
Conditional
Coded reference to a standard text and its source.
4441
Free text description code
Mandatoryan0..17
Code specifying free form text.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelistC108
TEXT LITERAL
Conditional
Free text; one to five lines.
4440
Free text
Mandatoryan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
3453
LANGUAGE NAME CODE
Conditionalan0..3
Code specifying the language name.
GRP1 PNA ADR GRP2C 5
5Conditional A group of segments identifying the parties involved in the transaction with associated information. For publicly available implementation guides this includes details of the ownership and origination of the guide.
PNAPARTY IDENTIFICATIONM 1
1Mandatory A segment identifying the names of the parties involved in the transaction, e.g., originator, requester, author or secretariat.
3035
PARTY FUNCTION CODE QUALIFIER
Mandatoryan0..3
Code giving specific meaning to a party.
Show codelistC206
IDENTIFICATION NUMBER
Conditional
The identification of an object.
7402
Object identifier
Mandatoryan0..35
Code specifying the unique identity of an object.
7405
Object identification code qualifier
Conditionalan0..3
Code qualifying the identification of an object.
Show codelistC082
PARTY IDENTIFICATION DETAILS
Conditional
Identification of a transaction party by code.
3039
Party identifier
Mandatoryan0..35
Code specifying the identity of a party.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelistC816
NAME COMPONENT DETAILS
Conditional
To specify a name component.
3405
Name component type code qualifier
Mandatoryan0..3
Code qualifying the type of a name component.
Show codelist3398
Name component description
Conditionalan0..256
Free form description of a name component.
3401
Name component usage code
Conditionalan0..3
Code specifying the usage of a name component.
Show codelist3295
Name original alphabet code
Conditionalan0..3
Code specifying the alphabet originally used to represent a name.
Show codelistC816
NAME COMPONENT DETAILS
Conditional
To specify a name component.
3405
Name component type code qualifier
Mandatoryan0..3
Code qualifying the type of a name component.
Show codelist3398
Name component description
Conditionalan0..256
Free form description of a name component.
3401
Name component usage code
Conditionalan0..3
Code specifying the usage of a name component.
Show codelist3295
Name original alphabet code
Conditionalan0..3
Code specifying the alphabet originally used to represent a name.
Show codelistC816
NAME COMPONENT DETAILS
Conditional
To specify a name component.
3405
Name component type code qualifier
Mandatoryan0..3
Code qualifying the type of a name component.
Show codelist3398
Name component description
Conditionalan0..256
Free form description of a name component.
3401
Name component usage code
Conditionalan0..3
Code specifying the usage of a name component.
Show codelist3295
Name original alphabet code
Conditionalan0..3
Code specifying the alphabet originally used to represent a name.
Show codelistC816
NAME COMPONENT DETAILS
Conditional
To specify a name component.
3405
Name component type code qualifier
Mandatoryan0..3
Code qualifying the type of a name component.
Show codelist3398
Name component description
Conditionalan0..256
Free form description of a name component.
3401
Name component usage code
Conditionalan0..3
Code specifying the usage of a name component.
Show codelist3295
Name original alphabet code
Conditionalan0..3
Code specifying the alphabet originally used to represent a name.
Show codelistC816
NAME COMPONENT DETAILS
Conditional
To specify a name component.
3405
Name component type code qualifier
Mandatoryan0..3
Code qualifying the type of a name component.
Show codelist3398
Name component description
Conditionalan0..256
Free form description of a name component.
3401
Name component usage code
Conditionalan0..3
Code specifying the usage of a name component.
Show codelist3295
Name original alphabet code
Conditionalan0..3
Code specifying the alphabet originally used to represent a name.
Show codelist1229
ACTION CODE
Conditionalan0..3
Code specifying the action to be taken or already taken.
Show codelist
ADRADDRESSC 1
1Conditional A segment identifying the address of the party.
C817
ADDRESS USAGE
Conditional
To describe the usage of an address.
C090
ADDRESS DETAILS
Conditional
To specify the details of an address.
3286
Address component description
Mandatoryan0..70
Free form description of the component of an address.
3286
Address component description
Conditionalan0..70
Free form description of the component of an address.
3286
Address component description
Conditionalan0..70
Free form description of the component of an address.
3286
Address component description
Conditionalan0..70
Free form description of the component of an address.
3286
Address component description
Conditionalan0..70
Free form description of the component of an address.
3164
CITY NAME
Conditionalan0..35
Name of a city.
3251
POSTAL IDENTIFICATION CODE
Conditionalan0..17
Code specifying the postal zone or address.
3207
COUNTRY IDENTIFIER
Conditionalan0..3
Identification of the name of the country or other geographical entity as defined in ISO 3166-1 and UN/ECE Recommendation 3.
C819
COUNTRY SUBDIVISION DETAILS
Conditional
To specify a country subdivision, such as state, canton, county, prefecture.
3229
Country subdivision identifier
Conditionalan0..9
To identify a country subdivision, such as state, canton, county, prefecture.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelist3228
Country subdivision name
Conditionalan0..70
Name of a country subdivision, such as state, canton, county, prefecture.
C517
LOCATION IDENTIFICATION
Conditional
Identification of a location by code or name.
3225
Location identifier
Conditionalan0..35
To identify a location.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelist3224
Location name
Conditionalan0..256
Name of the location.
GRP2 CTA COMC 9999
9999Conditional A group of segments identifying a person or a department and identifying communication type and number.
CTACONTACT INFORMATIONM 1
1Mandatory A segment identifying a person or a department for the party to whom the communication should be directed.
3139
CONTACT FUNCTION CODE
Conditionalan0..3
Code specifying the function of a contact (e.g. department or person).
Show codelistC056
CONTACT DETAILS
Conditional
Code and/or name of a contact such as a department or employee. Code preferred.
3413
Contact identifier
Conditionalan0..17
To identify a contact, such as a department or employee.
3412
Contact name
Conditionalan0..256
Name of a contact, such as a department or employee.
COMCOMMUNICATION CONTACTC 5
5Conditional A segment identifying communication type and number of the person.
C076
COMMUNICATION CONTACT
Mandatory
Communication number of a department or employee in a specified channel.
3148
Communication address identifier
Mandatoryan0..512
To identify a communication address.
3155
Communication means type code
Mandatoryan0..3
Code specifying the type of communication address.
Show codelist
GRP3 DFN FTX GRP4 GRP5 GRP6 GRP7 GRP8 GRP9 GRP10 GRP11 GRP12C 99999
99999Conditional A group of segments to describe the usage of a segment, a segment group, a composite or an element, an alias, or a constraint in a MIG or IC. The iterations of this segment group form the bulk of the MIG or IC.
The MIG or IC consists of a series of iterations of this segment group which describe the target message hierarchy. Within the hierarchy, additional occurrences of this segment group may specify the conditions or relationships between the components.
Only the appropriate parts of this segment group should be used as necessary on any particular iteration. The other contained segment groups are ordered to minimise the number of iterations of this segment group. The 'Alias' and 'Constraint' instances of this segment group provide a mechanism for grouping or encapsulating blocks of components. An 'Alias' has no context, and therefore takes on the context of the point at which it is used. A 'Constraint' inherits the context in which it is defined, but may redefine any part of its context by using the appropriate optional segment groups within the main segment loop.
As well as its defining function, each component may also be used in a constraining manner. For example, a repeating segment may not only define its components, but also the number of times it is allowed to repeat; then, within each instance, a different combination of element requirements may be expressed. This conditionality may be based on either ordering or content criteria.
Once defined, an 'Alias' may be used throughout the MIG where required, by 'using' the definition which is identified by its 'name'. Similarly, in error reporting, an active constraint may be identified by its 'name'.
DFNDEFINITION FUNCTIONM 1
1Mandatory A segment identifying the object of the definition, and containing an optional 'name' or identifier.
9023
DEFINITION FUNCTION CODE
Mandatoryan0..3
Code specifying the function of a definition.
Show codelist4519
DEFINITION IDENTIFIER
Conditionalan0..35
To identify a definition.
FTXFREE TEXTC 99
99Conditional A segment providing implementation guide notes pertaining to the preceding definition, or to carry the text of a constraint expression.
C107
TEXT REFERENCE
Conditional
Coded reference to a standard text and its source.
4441
Free text description code
Mandatoryan0..17
Code specifying free form text.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelistC108
TEXT LITERAL
Conditional
Free text; one to five lines.
4440
Free text
Mandatoryan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
3453
LANGUAGE NAME CODE
Conditionalan0..3
Code specifying the language name.
GRP4 GRU FTXC 1
1Conditional A group of segments identifying a segment group and providing details about segment group usage. This segment group depends on a segment context having been established by an instance of a segment group describing segment usage.
This segment group defines a segment group context for the target message, and will immediately follow the definition of the trigger segment context, preceding the constituent elements within the trigger segment.
Several instances of the same segment group may be described, with the MEA segment group distinguishing which range or instance of the target message segment is being described.
GRUSEGMENT GROUP USAGE DETAILSM 1
1Mandatory A segment specifying the usage of a segment group in a definition. The segment may identify one or more instances of a target segment group.
9164
GROUP IDENTIFIER
Mandatoryan0..4
To identify a group.
7299
REQUIREMENT DESIGNATOR CODE
Conditionalan0..3
Code specifying the requirement designator.
Show codelist6176
OCCURRENCES MAXIMUM NUMBER
Conditionaln0..7
To specify the maximum number of occurrences.
4513
MAINTENANCE OPERATION CODE
Conditionalan0..3
Code specifying a maintenance operation.
Show codelist1050
SEQUENCE POSITION IDENTIFIER
Conditionalan0..10
To identify a position in a sequence.
FTXFREE TEXTC 99
99Conditional A segment providing implementation guide notes or textual information related to the specific group in the underlying message.
C107
TEXT REFERENCE
Conditional
Coded reference to a standard text and its source.
4441
Free text description code
Mandatoryan0..17
Code specifying free form text.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelistC108
TEXT LITERAL
Conditional
Free text; one to five lines.
4440
Free text
Mandatoryan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
3453
LANGUAGE NAME CODE
Conditionalan0..3
Code specifying the language name.
GRP5 SGU FTXC 999
999Conditional A group of segments specifying segment usage within the definition. There will be at least one instance of this segment group for each segment described in the implementation guide.
This segment group defines a segment context, and all the following components are deemed to be within the context of the segment whose usage is being defined until a subsequent segment context is defined.
Several instances of the same segment may be described, with the MEA segment group distinguishing which range or instance of the target message segment is being described.
SGUSEGMENT USAGE DETAILSM 1
1Mandatory A segment specifying the usage of a segment in a message type structure for this definition. As well as defining the specific usage of a particular target segment, this segment also provides the segment context for the following element usage details. The segment may identify one or more instances of usage for any particular segment in the target data message.
9166
SEGMENT TAG IDENTIFIER
Mandatoryan0..3
To identify the tag of a segment.
7299
REQUIREMENT DESIGNATOR CODE
Conditionalan0..3
Code specifying the requirement designator.
Show codelist6176
OCCURRENCES MAXIMUM NUMBER
Conditionaln0..7
To specify the maximum number of occurrences.
7168
LEVEL NUMBER
Conditionaln0..3
Number identifying a level.
1050
SEQUENCE POSITION IDENTIFIER
Conditionalan0..10
To identify a position in a sequence.
4513
MAINTENANCE OPERATION CODE
Conditionalan0..3
Code specifying a maintenance operation.
Show codelist
FTXFREE TEXTC 99
99Conditional A segment providing implementation guide notes, or textual information relating to the specific segment in the underlying message.
C107
TEXT REFERENCE
Conditional
Coded reference to a standard text and its source.
4441
Free text description code
Mandatoryan0..17
Code specifying free form text.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelistC108
TEXT LITERAL
Conditional
Free text; one to five lines.
4440
Free text
Mandatoryan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
3453
LANGUAGE NAME CODE
Conditionalan0..3
Code specifying the language name.
GRP6 FNT REL GIR FTXC 99
99Conditional A group of segments specifying formalised relationships among the various components of this implementation at a particular context, such as additional rules concerning syntax and semantics which are specific to an implementation.
The relationships may be both intra-component, such as between elements in a segment, or inter-component, such as between elements in different segments.
Depending on the context in which this segment group is used, it may specify relationships between segments or segment groups in a message, between data elements in a segment, or between data elements in a composite.
FNTFOOTNOTEM 1
1Mandatory A segment specifying a footnote identification number that may place the relationship in the current context.
C784
FOOTNOTE IDENTIFICATION
Mandatory
The identification of a footnote.
9432
Footnote identifier
Mandatoryan0..35
To identify a footnote.
7405
Object identification code qualifier
Conditionalan0..3
Code qualifying the identification of an object.
Show codelistC082
PARTY IDENTIFICATION DETAILS
Conditional
Identification of a transaction party by code.
3039
Party identifier
Mandatoryan0..35
Code specifying the identity of a party.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelist4513
MAINTENANCE OPERATION CODE
Conditionalan0..3
Code specifying a maintenance operation.
Show codelist
RELRELATIONSHIPC 1
1Conditional A segment specifying a relationship between the various components, typically data elements in a segment, in the current context.
9141
RELATIONSHIP TYPE CODE QUALIFIER
Mandatoryan0..3
Code qualifying a type of relationship.
Show codelistC941
RELATIONSHIP
Conditional
Identification and/or description of a relationship.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelist9142
Relationship description
Conditionalan0..35
Free form description of a relationship.
GIRRELATED IDENTIFICATION NUMBERSC 9
9Conditional A segment identifying the various components in a relationship, typically data elements in a segment, in the current context.
C206
IDENTIFICATION NUMBER
Mandatory
The identification of an object.
7402
Object identifier
Mandatoryan0..35
Code specifying the unique identity of an object.
7405
Object identification code qualifier
Conditionalan0..3
Code qualifying the identification of an object.
Show codelistC206
IDENTIFICATION NUMBER
Conditional
The identification of an object.
7402
Object identifier
Mandatoryan0..35
Code specifying the unique identity of an object.
7405
Object identification code qualifier
Conditionalan0..3
Code qualifying the identification of an object.
Show codelistC206
IDENTIFICATION NUMBER
Conditional
The identification of an object.
7402
Object identifier
Mandatoryan0..35
Code specifying the unique identity of an object.
7405
Object identification code qualifier
Conditionalan0..3
Code qualifying the identification of an object.
Show codelistC206
IDENTIFICATION NUMBER
Conditional
The identification of an object.
7402
Object identifier
Mandatoryan0..35
Code specifying the unique identity of an object.
7405
Object identification code qualifier
Conditionalan0..3
Code qualifying the identification of an object.
Show codelistC206
IDENTIFICATION NUMBER
Conditional
The identification of an object.
7402
Object identifier
Mandatoryan0..35
Code specifying the unique identity of an object.
7405
Object identification code qualifier
Conditionalan0..3
Code qualifying the identification of an object.
Show codelist
FTXFREE TEXTC 99
99Conditional A segment carrying text notes to the preceding relationship.
C107
TEXT REFERENCE
Conditional
Coded reference to a standard text and its source.
4441
Free text description code
Mandatoryan0..17
Code specifying free form text.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelistC108
TEXT LITERAL
Conditional
Free text; one to five lines.
4440
Free text
Mandatoryan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
3453
LANGUAGE NAME CODE
Conditionalan0..3
Code specifying the language name.
GRP7 RFF FTXC 99
99Conditional A group of segments carrying references, or constraints whose default context applies to the containing segment. This segment group may be used to change the constraint mechanism at the current and deeper levels in the message hierarchy. Additionally, this segment group may be used to carry legal and contractual terms which relate, either by way of explanation or to be incorporated by reference, in the particular context at which the group appears.
Depending on the context, the references may be applied to the target message as a whole, the current segment or element context, or the current code value context.
RFFREFERENCEM 1
1Mandatory A segment identifying a reference document or a following constraint expression.
C506
REFERENCE
Mandatory
Identification of a reference.
1154
Reference identifier
Conditionalan0..70
Identifies a reference.
1156
Document line identifier
Conditionalan0..6
To identify a line of a document.
1056
Version identifier
Conditionalan0..9
To identify a version.
1060
Revision identifier
Conditionalan0..6
To identify a revision.
FTXFREE TEXTC 99
99Conditional A segment carrying the text of a constraint expression or providing implementation guide notes pertaining to the preceding constraint.
C107
TEXT REFERENCE
Conditional
Coded reference to a standard text and its source.
4441
Free text description code
Mandatoryan0..17
Code specifying free form text.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelistC108
TEXT LITERAL
Conditional
Free text; one to five lines.
4440
Free text
Mandatoryan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
3453
LANGUAGE NAME CODE
Conditionalan0..3
Code specifying the language name.
GRP8 ELU ELM EDT IMD GEI FTXC 99
99Conditional A group of segments specifying implementation requirements for data elements in the current segment or composite context. Multiple instances of this segment group will typically be used to describe the usage of all the elements in any given segment or composite context. There will be at least one instance of this segment group for each element used, although a constraint structure may override or further define the specification in any particular context or sub-context. The MEA segment group may be used to provide repeat range or specific instance information for repeating data elements.
This segment group defines an element or composite context which will remain in force until the next element or composite context is defined, or a new segment context is established.
ELUDATA ELEMENT USAGE DETAILSM 1
1Mandatory A segment identifying the usage of a simple or composite data element in the current context. This segment starts a block of information about any one particular contextualised usage of a data element in a target data message.
The data element usage determines whether this segment is defining a composite context, a simple element context or a component element context.
9162
DATA ELEMENT TAG IDENTIFIER
Mandatoryan0..4
To identify the tag of a data element.
7299
REQUIREMENT DESIGNATOR CODE
Conditionalan0..3
Code specifying the requirement designator.
Show codelist1050
SEQUENCE POSITION IDENTIFIER
Conditionalan0..10
To identify a position in a sequence.
4513
MAINTENANCE OPERATION CODE
Conditionalan0..3
Code specifying a maintenance operation.
Show codelist6176
OCCURRENCES MAXIMUM NUMBER
Conditionaln0..7
To specify the maximum number of occurrences.
9285
VALIDATION CRITERIA CODE
Conditionalan0..3
Code specifying the validation criteria to be applied.
Show codelist9175
DATA ELEMENT USAGE TYPE CODE
Conditionalan0..3
Code specifying the usage type of a data element.
Show codelist
ELMSIMPLE DATA ELEMENT DETAILSC 1
1Conditional A segment providing details of any variation or restriction of the current data element as used in this context. Typically this segment will convey details of restricted size or character representation.
9150
SIMPLE DATA ELEMENT TAG IDENTIFIER
Mandatoryan0..4
To identify the tag of a simple data element.
9153
SIMPLE DATA ELEMENT CHARACTER REPRESENTATION CODE
Conditionalan0..3
Code specifying the character representation of a simple data element.
Show codelist9156
SIMPLE DATA ELEMENT MAXIMUM LENGTH MEASURE
Conditionaln0..3
To specify the value of the maximum length of a simple data element.
9158
SIMPLE DATA ELEMENT MINIMUM LENGTH MEASURE
Conditionaln0..3
To specify the value of the minimum length of a simple data element.
9161
CODE SET INDICATOR CODE
Conditionalan0..3
Code indicating whether a data element has an associated code set.
Show codelist4513
MAINTENANCE OPERATION CODE
Conditionalan0..3
Code specifying a maintenance operation.
Show codelist6432
SIGNIFICANT DIGITS QUANTITY
Conditionaln0..2
Count of the number of significant digits.
EDTEDITING DETAILSC 1
1Conditional A segment providing details of any editing information such as maximum field length and status that would be used by a screen-based editor, forms input or data output process when physical representation of the data carried in a data message using this implementation guide is required.
6178
EDIT FIELD LENGTH MEASURE
Conditionaln0..3
To specify the length of a field for editing.
9026
EDIT MASK FORMAT IDENTIFIER
Conditionalan0..35
To identify the format of an edit mask.
9031
EDIT MASK REPRESENTATION CODE
Conditionalan0..3
Code specifying the representation of the edit mask.
Show codelist
IMDITEM DESCRIPTIONC 9
9Conditional A segment providing further details of presentational information such as text alignment and style that might be used by a screen-based editor, forms input or data output process when physical representation of the data carried in a data message using this implementation guide is required.
7077
DESCRIPTION FORMAT CODE
Conditionalan0..3
Code specifying the format of a description.
Show codelistC272
ITEM CHARACTERISTIC
Conditional
To provide the characteristic of the item being described.
7081
Item characteristic code
Conditionalan0..3
Code specifying the characteristic of an item.
Show codelist1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelistC273
ITEM DESCRIPTION
Conditional
Description of an item.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelist7008
Item description
Conditionalan0..256
Free form description of an item.
7008
Item description
Conditionalan0..256
Free form description of an item.
3453
Language name code
Conditionalan0..3
Code specifying the language name.
7383
SURFACE OR LAYER CODE
Conditionalan0..3
Code specifying the surface or layer of an object.
Show codelist
GEIPROCESSING INFORMATIONC 9
9Conditional A segment providing further details of processing information such as data handling, positioning or control that might be used by a screen-based editor, forms input or data output process when data is carried, stored or collected by a data message using this implementation guide is required.
9649
PROCESSING INFORMATION CODE QUALIFIER
Mandatoryan0..3
Code qualifying the processing information.
Show codelistC012
PROCESSING INDICATOR
Conditional
Identification of the processing indicator.
7365
Processing indicator description code
Conditionalan0..3
Code specifying a processing indicator.
Show codelist1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelist7364
Processing indicator description
Conditionalan0..35
Free form description of a processing indicator.
FTXFREE TEXTC 99
99Conditional A segment providing implementation guide notes, or other textual information relating to this element usage. The segment will also be used to carry the final set of information that would be used by a screen-based editor; forms input or data output process; a legend or user-recognisable description; and a help text.
C107
TEXT REFERENCE
Conditional
Coded reference to a standard text and its source.
4441
Free text description code
Mandatoryan0..17
Code specifying free form text.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelistC108
TEXT LITERAL
Conditional
Free text; one to five lines.
4440
Free text
Mandatoryan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
3453
LANGUAGE NAME CODE
Conditionalan0..3
Code specifying the language name.
GRP9 MEA FTXC 999
999Conditional A group of segments specifying implementation requirements for the number of instances of repeating segments, segment groups or elements in the current context. Multiple instances of this segment group will typically be used to describe both the overall limits of usage and to identify individual instances in any given context.
MEAMEASUREMENTSM 1
1Mandatory A segment to measure the number of instances of usage of a component in a message. The segment may specify minima, maxima, range or instance criteria.
6311
MEASUREMENT PURPOSE CODE QUALIFIER
Mandatoryan0..3
Code qualifying the purpose of the measurement.
Show codelistC502
MEASUREMENT DETAILS
Conditional
Identification of measurement type.
6321
Measurement significance code
Conditionalan0..3
Code specifying the significance of a measurement.
Show codelist6155
Non-discrete measurement name code
Conditionalan0..17
Code specifying the name of a non-discrete measurement.
Show codelist6154
Non-discrete measurement name
Conditionalan0..70
Name of a non-discrete measurement.
C174
VALUE/RANGE
Conditional
Measurement value and relevant minimum and maximum values of the measurement range.
6411
Measurement unit code
Mandatoryan0..8
Code specifying the unit of measurement.
6314
Measure
Conditionalan0..18
To specify the value of a measurement.
6162
Range minimum quantity
Conditionaln0..18
To specify the minimum value of a range.
6152
Range maximum quantity
Conditionaln0..18
To specify the maximum value of a range.
6432
Significant digits quantity
Conditionaln0..2
Count of the number of significant digits.
7383
SURFACE OR LAYER CODE
Conditionalan0..3
Code specifying the surface or layer of an object.
Show codelist
FTXFREE TEXTC 99
99Conditional A segment providing implementation guide notes, or other textual information relating to this measurement.
C107
TEXT REFERENCE
Conditional
Coded reference to a standard text and its source.
4441
Free text description code
Mandatoryan0..17
Code specifying free form text.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelistC108
TEXT LITERAL
Conditional
Free text; one to five lines.
4440
Free text
Mandatoryan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
3453
LANGUAGE NAME CODE
Conditionalan0..3
Code specifying the language name.
GRP10 ELV FTXC 99999
99999Conditional A group of segments specifying the usage of values for a non- coded data element. Multiple instances of this segment group may be used to provide a complete set of ranges or specific values, including preferences. It can be used for any other type of data element, such as strings, numerics, dates and times. It can also specify a default value and associated implementation notes for a specific element in a particular context.
A simple element or component element context must have been established before this segment group is used.
ELVELEMENT VALUE DEFINITIONM 1
1Mandatory A segment identifying one or more components of an element value constraint series. It also may provide a default value for the current element context. This is expressed in a single text field so as to be used by or applicable to the broadest range of applications.
9422
VALUE TEXT
Conditionalan0..512
To specify a value.
7299
REQUIREMENT DESIGNATOR CODE
Conditionalan0..3
Code specifying the requirement designator.
Show codelist4513
MAINTENANCE OPERATION CODE
Conditionalan0..3
Code specifying a maintenance operation.
Show codelist
FTXFREE TEXTC 99
99Conditional A segment providing implementation guide notes, or other textual information related to the particular context. Such a context may include implementation guide notes for the default value.
C107
TEXT REFERENCE
Conditional
Coded reference to a standard text and its source.
4441
Free text description code
Mandatoryan0..17
Code specifying free form text.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelistC108
TEXT LITERAL
Conditional
Free text; one to five lines.
4440
Free text
Mandatoryan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
3453
LANGUAGE NAME CODE
Conditionalan0..3
Code specifying the language name.
GRP11 CDV FTXC 99999
99999Conditional A group of segments specifying the usage of code values for a coded data element. Multiple instances of this segment group may be used to provide a complete set of code values, including preferences.
A simple element or component element context must have been established before this segment group is used.
CDVCODE VALUE DEFINITIONM 1
1Mandatory A segment identifying the code value, its source and usage preference.
9426
CODE VALUE TEXT
Mandatoryan0..35
To specify a code value.
9434
CODE NAME
Conditionalan0..70
Name of a code.
4513
MAINTENANCE OPERATION CODE
Conditionalan0..3
Code specifying a maintenance operation.
Show codelist7299
REQUIREMENT DESIGNATOR CODE
Conditionalan0..3
Code specifying the requirement designator.
Show codelist
FTXFREE TEXTC 99
99Conditional A segment providing implementation guide notes, or other textual information related to the particular context.
C107
TEXT REFERENCE
Conditional
Coded reference to a standard text and its source.
4441
Free text description code
Mandatoryan0..17
Code specifying free form text.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelistC108
TEXT LITERAL
Conditional
Free text; one to five lines.
4440
Free text
Mandatoryan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
3453
LANGUAGE NAME CODE
Conditionalan0..3
Code specifying the language name.
GRP12 DRD FTXC 99999
99999Conditional A group of segments specifying data representation details for a component of the message. This segment group may be used in a segment, group, composite or simple data element context to describe the data representation that the implementation guide author intends to use to hold, store or represent the structure or data in a non-EDI environment.
DRDDATA REPRESENTATION DETAILSM 1
1Mandatory A segment identifying an underlying data representation by tag, basic data type and size. This is the representation itself, and not a pointer to an external document.
7512
STRUCTURE COMPONENT IDENTIFIER
Conditionalan0..35
To identify a component of a structure.
9169
DATA REPRESENTATION TYPE CODE
Conditionalan0..3
Code specifying a type of data representation.
Show codelist6174
SIZE MEASURE
Conditionaln0..15
To specify a magnitude.
FTXFREE TEXTC 99
99Conditional A segment providing implementation guide notes, or other relevant textual information.
C107
TEXT REFERENCE
Conditional
Coded reference to a standard text and its source.
4441
Free text description code
Mandatoryan0..17
Code specifying free form text.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelistC108
TEXT LITERAL
Conditional
Free text; one to five lines.
4440
Free text
Mandatoryan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
3453
LANGUAGE NAME CODE
Conditionalan0..3
Code specifying the language name.
GRP13 AUT DTMC 1
1Conditional A group of segments to provide authentication for the message.
AUTAUTHENTICATION RESULTM 1
1Mandatory A segment specifying the details of any authentication (validation) procedure applied to the IMPDEF message.
9280
VALIDATION RESULT TEXT
Mandatoryan0..35
To specify the value of a validation result.
9282
VALIDATION KEY IDENTIFIER
Conditionalan0..35
To identify the cryptographic key used for the calculation of the validation.
DTMDATE/TIME/PERIODC 1
1Conditional A segment specifying the date of authentication.
C507
DATE/TIME/PERIOD
Mandatory
Date and/or time, or period relevant to the specified date/time/period type.
2005
Date or time or period function code qualifier
Mandatoryan0..3
Code qualifying the function of a date, time or period.
Show codelist2380
Date or time or period text
Conditionalan0..35
The value of a date, a date and time, a time or of a period in a specified representation.
2379
Date or time or period format code
Conditionalan0..3
Code specifying the representation of a date, time or period.
Show codelist
UNTMESSAGE TRAILERM 1
1Mandatory 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.
0074
NUMBER OF SEGMENTS IN A MESSAGE
Mandatoryn0..10
The number of segments in a message body, plus the message header segment and message trailer segment.
0062
MESSAGE REFERENCE NUMBER
Mandatoryan0..14
Unique message reference assigned by the sender.