HDMA ASN Transaction History Guidelines

See How to Use this Guide before reading the below information.

Message Type: PT_SHIPMENT_TH_RECEIVED

Info Exchange Display Name: Received Transaction History

These fields are sent by the sender to TraceLink.

When sending an element in Date or DateTime format, a valid date must be given. "00" is not a valid day or month value and "0000" is not a valid year value.
Data Element Occurs Format Length Enums Req Description
856 [1…1] - - -   HDMA X12 856 ASN message.
  ISA [1…1] - - - M ISA interchange envelope. There are two enveloping options for all IB X12 messages to TraceLink:

Option 1: Address the ISA sender and receiver to your trading partner. Use GS02 and GS03 to send your TraceLink ServiceLinkId for the trading partner interface. Create one ISA for each receiving trading partner and one GS segment for each of your ServiceLinkID sender/receiver values.

Option 2: Address the ISA and GS receiver IDs to TraceLink. Create one ISA and GS envelope for all interfaces to TraceLink. Store your ServiceLinkId for your trading partner interface in the REF segment in HL level shipment with REF01 = ME.

All ISA envelope elements required for sender.
Every data element in the ISA envelope must be padded out to its full length.
  ISA01 [1…1] String [2/2] Authorization M Qualifier for authorization control number in ISA02. Valid values: *1
  • 00 - No authorization info present. TL: Read ServiceLinkId from GS segment.
  • 03 - Additional data identification. TL: Read ServiceLinkId from REF segment in HL level shipment where REF01 = "ME".
  ISA02 [1…1] String [10/10] - M Information for additional identification or authorization of the interchange sender or the data in the interchange.
  ISA03 [1…1] String [2/2] - M Qualifier for security information in ISA04. Valid values: *2
  • 00 - No security information present.
  • 01 - Password.
  ISA04 [1…1] String [10/10] - M Identifies security information about the interchange sender or data
  ISA05 [1…1] String [2/2] EDISenderType M Interchange sender partner ID qualifier. Valid values: *3
  • 01 - DUNS
  • 08 - EDI communications ID (GLN)
  • 11 - DEA
  • 16 - DUNS+4
  • 20 - HIN
  ISA06 [1…1] String [15/15] - M EDI sender ID defined by qualifier in ISA05. *4
  ISA07 [1…1] String [2/2] EDISenderType M Interchange sender partner ID qualifier. Valid values:  *5
  • 01 - DUNS
  • 08 - EDI communications ID (GLN)
  • 11 - DEA
  • 16 - DUNS+4
  • 20 - HIN
  ISA08 [1…1] String [15/15] - M EDI receiver ID defined by qualifier in ISA07. *6
  ISA09 [1…1] Date [6/6] - M Interchange date in 6 char YYMMDD format. *7
  ISA10 [1…1] Time [4/4] - M Interchange time in 4 char HHMM format. *8
  ISA11 [1…1] String [1/1] - M Interchange control standards identifier.

Valid value = U *9
  ISA12 [1…1] String [5/5] - M Interchange control version number.

Valid value depends on the version: *10

  • EDI 4010 = "00401"
  • EDI 4030 = "00403"
  ISA13 [1…1] String [9/9] - M Interchange Control Number. *11
  ISA14 [1…1] String [1/1] - M Interchange level acknowledgment requested. Valid values: *12
  • 0 - No acknowledgment requested.
  • 1 - Interchange level acknowledgment requested.
  ISA15 [1…1] String [1/1] UsageIndicator M Indicates whether the interchange is for production, test, or information purposes. *13
  ISA16 [1…1] String [1/1] - M Sub element Separator.
  ISA17 [1…1] String [1/1] - M Delimiter.
  GS [1…*] - - - M GS group functional envelope. Child of ISA. Only one GS group expected per interchange.
  GS01 [1…1] String [2/2] - M GS group function code.

Valid value: SH = Shipment. *14
  GS02 [1…1] String [2/15] - M Application Sender's Code. Use for ServiceLinkId concatenation when ISA01 = 00. *15
  GS03 [1…1] String [2/15] - M Application Receiver's Code. *16
  GS04 [1…1] Date [8/8] - M Current date stamp in 8 char X12 date format YYYYMMDD. *17
  GS05 [1…1] Time [4/8] - M Current time stamp in 6 char X12 time format HHMMSS. *18
  GS06 [1…1] String [1/9] - M Group Control ID Number. *19
  GS07 [1…1] String [1/2] - M Responsible Agency Code.

Valid value = X *20
  GS08 [1…1] String [1/12] - M X12 message version code.

Valid value depends on the version: *21

  • EDI 4010 = 004010
  • EDI 4030 = 004030
  ST [1…*] - - - M ST transaction set envelope. Child of GS group. Only one ST transaction expected.
  ST01 [1…1] String [3/3] - M Transaction set identifier code. *22
  ST02 [1…1] String [4/9] - M Transaction set ID number. Counter for each ST segment beginning with 1. *23
  BSN [1…1] - - - M Beginning Segment for Ship Notice. Child of ST transaction set.
  BSN01 [1…1] String [2/2] - M Transaction purpose code. Valid values: *24
  • 00 - Original
  • 05 - Replace
  BSN02 [1…1] String [2/30] - M Shipment identification number. *25
  BSN03 [1…1] Date [8/8] - M Transaction date in CCYYMMDD format. *26
  BSN04 [0…1] Time [6/6] - O ASN time in HHMMSS format. *27
  BSN05 [0…1] String [4/4] - O Hierarchical structure code indicating HL structure of a transaction set. Valid values: *28
  • 0001 - Shipment, Order, Packaging, Item.
  • 0004 - Shipment, Order, Item.
  BSN06 [0…1] String [2/2] - O Transaction type code. Valid values:
  • AS - Advanced ship notice.
  • DO - Drop ship notice.
  HL [1…*] - - - M Hierarchical Level - Shipment level. Child of ST transaction set.
  HL01 [1…1] String [1/12] - M Hierarchical ID number "1" for the initial HL segment and will be incremented by one in each subsequent HL segment within the message. *29
  HL02 [0…1] String [0/12] - O HL01 ID number of the parent segment for the current segment.
  HL03 [1…1] String [1/2] HLHierarchyLevels M Code identifying hierarchical level of current HL group. HL Shipment level = S. *30
  HL04 [0…1] String [0/1] - O Code indicating if there are child data segments subordinate to the current HL level.
  TD1 [0…20] - - - M Carrier Details - Quantity and Weight. Child of HL shipment.
  TD101 [0…1] String [3/5] - O Packaging code at shipment header level. Valid values: *31
  • CAS - Case
  • CTN - Carton
  • PLT - Pallet
  TD102 [0…1] Decimal [1/7] - O Lading quantity. Number of units (eaches) for the lading commodity, i.e. pallets or cartons, etc. *32
  TD106 [1…1] String [1/2] - M Weight qualifier.

Valid Value: G = Gross Weight.
  TD107 [1…1] Decimal [1/10] - M Gross Weight. *33
  TD108 [1…1] String [2/2] WeightUOM M Unit of measure. *34
  TD5 [0…1] - - - M Carrier Details – Routing. Child of HL shipment.
  TD501 [0…1] String [1/2] - O Routing sequence code describing relationship of a carrier to a specific shipment movement.

Valid value: O = Origin carrier, regardless of mode. *35
  TD502 [1…1] String [1/2] - M ID code qualifier.

Valid value: 2 = SCAC code for carrier. *36
  TD503 [1…1] String [2/80] - M ID code. 4 digit carrier code SCAC. *37
  TD504 [0…1] String [1/2] TransportTypeCode O Transportation method type code identifying the method or type of transport used for the shipment. *38
  TD505 [0…1] String [1/35] - O Routing. Free-form description of routing or requested routing for shipment or for originating carrier's identity.
  TD506 [0…1] String [2/2] - O Shipment status code. Status of order or shipment or disposition of any difference between quantity ordered and quantity shipped for a transaction. Valid values: *39
  • CC - Shipment complete.
  • PR - Partial shipment.
  TD3 [0…1] - - - O Carrier Details – Equipment. Child of HL shipment.
  TD301 [0…1] String [2/2] - O Equipment description code identifying type of equipment used for shipment. Valid values: *40
  • CN - Container
  • RR - Rail car
  • TL - Trailer
  • VE - Vessel, ocean
  TD302 [0…1] String [1/4] - O Equipment initial. Prefix or alphabetical part of equipment unit's identifying number. *41
  TD303 [0…1] String [1/10] - O Equipment identification number. Pure numeric form for equipment number preferred. *42
  REF [0…*] - - - O Reference Identification for additional shipping documents. Supports up to five instances of the REF segment for additional shipping documents or identifiers. Child of HL shipment.
  REF01 [1…1] String [2/3] ShipmentDocType M Reference ID qualifier. Valid values: *43
  • 2I = Tracking number.
  • BM = Bill of lading.
  • CN - Carrier's reference number.
  • MB - Master bill of lading.
  • SN - Seal number.
  REF02 [1…1] String [1/30] - M Reference ID number. *44
  DTM [0…10] - - - M DTM segment for shipping and delivery dates. Up to three instances of DTM segment can be sent. Child of HL shipment.
  DTM01 [0…1] String [0/3] ASNDateType M Date/Time qualifier. Valid values: *45
  • 011 - Shipped (Mandatory).
  • 017 = Estimated Delivery (Mandatory).
  • 067 = Current scheduled delivery date (Optional).
  DTM02 [0…1] Date [0/8] - M Date in CCYYMMDD format. *46
  DTM03 [0…1] Time [0/8] - O Time in HHMMSS format. *47
Mandatory for 017 estimated delivery date.
  N1 [1…1] - - - M Name. Ship to party instance of N1 looping group. Child of HL shipment.

To fulfill DQSA requirements, the following partner types are mandatory:

  • Sender business address info: party type SE.
  • Sender shipping address info: party type SF.
  • Receiver business address info: party type BT.
  • Receiver shipping address info: party type SH.
  N101 [1…1] String [2/3] - M Entity identifier code for shipping address of receiving business party.

Valid value: ST = Ship to. *48
  N102 [1…1] String [1/60] - M Name. *49
  N103 [1…1] String [1/2] AddressIdQualifier M Identifier code qualifier. *50
  N104 [1…1] String [2/80] - M Identifier code. Ship to HIN/DEA or both. *51
  N3 [1…1] - - - M Address. Child of Ship to N1 Name segment.
  N301 [1…1] String [1/55] - M Street address 1. *52
  N302 [0…1] String [0/55] - O Street address 2. *53
  N4 [1…1] - - - M Geographic Location. Child of Ship to N1 Name segment.
  N401 [1…1] String [2/30] - M City name. *54
  N402 [1…1] String [2/2] - M State or province code. Code (Standard state/province) as defined by appropriate government agency. *55
  N403 [1…1] String [1/15] - M Postal code. Code defining international postal zone code excluding punctuation and blanks (zip code for United States). *56
  N404 [0…1] String [2/3] - O Country code. *57
  N405 [0…1] String [0/2] - O Placeholder for future use of SGLN.
  N406 [0…1] String [0/30] - O Placeholder for future use. Origin or Destination Shipping Location ID. SGLN number.

NNI will not have SGLNs defined for any of their customers for the 2015 requirement.
  REF [0…1] - - - O Optional reference identification for license number when available for Ship To Customer. Child of Ship to N1 Name segment.
  REF01 [0…1] String [2/3] - O State License Number Qualifier Code. Valid values: *58
  • D3 = National Association of Boards of Pharmacy Number.
  • FW = State License Identification Number.
  REF02 [0…1] String [1/30] - O State license number for Ship To address. *59
  REF03 [0…1] String [1/80] - O Ship To State. *60
  N1 [1…1] - - - M Name. Bill to party instance of N1 name segment. Child of HL shipment.
  N101 [1…1] String [2/3] - M Entity identifier code for business address of receiving business party. Valid values: *61
  • BT = Bill to party.
  • BY = Buying party.
  N102 [1…1] String [1/60] - M Name. *62
  N103 [1…1] String [1/2] AddressIdQualifier M Identifier code qualifier. *63
  N104 [1…1] String [2/80] - M ID number of Bill to party. *64
  N3 [1…1] - - - M Address. Child of Bill To N1 Name segment.
  N301 [1…1] String [1/55] - M Street address 1. *65
  N302 [0…1] String [0/55] - O Street address 2. *66
  N4 [1…1] - - - M Geographic Location. Child of Bill To N1 Name segment.
  N401 [1…1] String [2/30] - M City name. *67
  N402 [1…1] String [2/2] - M State or province code. Code (Standard state/province) as defined by appropriate government agency. *68
  N403 [1…1] String [1/15] - M Postal code. Code defining international postal zone code excluding punctuation and blanks. *69
  N404 [0…1] String [2/3] - O Country code. *70
  N1 [1…1] - - - M Name. Ship from party instance of N1 name segment. Child of HL shipment.
  N101 [1…1] String [2/3] - M Entity identifier code for shipping address of sending business party.

Valid value: SF = Ship from. *71
  N102 [1…1] String [1/60] - M Name. *72
  N103 [1…1] String [1/2] AddressIdQualifier M Identifier code qualifier. *73
  N104 [1…1] String [2/80] - M GLN of Ship from location. *74
  N3 [1…1] - - - M Address. Child of Ship from N1 Name segment.
  N301 [1…1] String [1/55] - M Street address 1. *75
  N302 [0…1] String [0/55] - O Street address 2. *76
  N4 [1…1] - - - M Geographic Location. Child of Ship from N1 Name segment.
  N401 [1…1] String [2/30] - M City name. *77
  N402 [1…1] String [2/2] - M State or province code. Code (Standard state/province) as defined by appropriate government agency. *78
  N403 [1…1] String [1/15] - M Postal code. Code defining international postal zone code excluding punctuation and blanks. *79
  N404 [0…1] String [2/3] - O Country code. *80
  REF [0…1] - - - O Optional reference identification for license number when available for Ship from Customer. Child of Ship from N1 Name segment.
  REF01 [0…1] String [2/3] - O State License Number Qualifier Code. Valid values: *81
  • D3 = National Association of Boards of Pharmacy Number.
  • FW = State License Identification Number.
  REF02 [0…1] String [1/30] - O State license number for Ship from address. *82
  REF03 [0…1] String [1/80] - O Ship from state. *83
  PER [0…*] - - - O Administrative communications contact information. Child of Ship from N1 name segment.
  PER01 [0…1] String [2/2] - O Contact function code identifying major duty or responsibility of person or group named as contact.

Valid value: CE = Certifier. *84
  PER02 [0…1] String [1/60] - O Name of contact. *85
  PER03 [0…1] String [2/2] - O Communications number qualifier.

Valid value: TE = Telephone. *86
  PER04 [0…1] String [1/80] - O Communication number. *87
  N1 [1…1] - - - M Name. Selling Party instance of N1 name segment. Child of HL shipment.
  N101 [1…1] String [2/3] - M Entity identifier code for business address of sending business party.

Valid value: SE = Selling party. *88
  N102 [1…1] String [1/60] - M Name. *89
  N103 [1…1] String [1/2] AddressIdQualifier M Identifier code qualifier. *90
  N104 [1…1] String [2/80] - M Selling party ID number. *91
  N3 [1…1] - - - M Address. Child of Selling Party N1 Name segment.
  N301 [1…1] String [1/55] - M Street address 1. *92
  N302 [0…1] String [0/55] - O Street address 2. *93
  N4 [1…1] - - - M Geographic Location. Child of Selling Party N1 Name segment.
  N401 [1…1] String [2/30] - M City name. *94
  N402 [1…1] String [2/2] - M State or province code. Code (Standard state/province) as defined by appropriate government agency. *95
  N403 [1…1] String [1/15] - M Postal code. Code defining international postal zone code excluding punctuation and blanks. *96
  N404 [0…1] String [2/3] - O Country code. *97
  N1 [1…1] - - - M Name. Bill to and Ship to instance of N1 name segment. Child of HL shipment.
  N101 [1…1] String [2/3] - M Entity identifier code for business address of receiving business party.

Valid value: BS = Bill and Ship to party. *98
  N102 [1…1] String [1/60] - M Name. *99
  N103 [1…1] String [1/2] AddressIdQualifier M Identifier code qualifier. *100
  N104 [0…1] String [2/80] - O ID number of Bill to party. *101
  N3 [1…1] - - - M N3: Address. Child of Bill To N1 Name segment.
  N301 [1…1] String [1/55] - M Street address 1. *102
  N302 [0…1] String [0/55] - O Street address 2. *103
  N4 [1…1] - - - M N4: Geographic Location. Child of Bill To N1 Name segment.
  N401 [1…1] String [2/30] - M City name. *104
  N402 [1…1] String [2/2] - M State or province code. Code (Standard state/province) as defined by appropriate government agency. *105
  N403 [1…1] String [1/15] - M Postal code. Code defining international postal zone code excluding punctuation and blanks. *106
  N404 [0…1] String [2/3] - O Country code. *107
  YNQ(1) [1…10] - - - M Yes/No segment with transaction statement affirming compliance with DSCSA requirements. Child of HL shipment level.
  YNQ02 [1…1] String [2/2] - M Yes/No condition or response code for DSCSA compliance affirmation.

Valid value: Y = Yes. *108
  YNQ05 [1…1] String [1/264] - O Transaction statement free form text. TraceLink will accept any text supplied by the sender. If nothing is sent, the following text will be defaulted: "Seller has complied with each applicable subsection of FDCA Sec. 581(27)(A)–(G)." *109
  YNQ08 [1…1] String [1/3] - O Code list qualifier for TS purpose code.

Valid value: 99 = Purpose code. *110
  YNQ09 [1…1] String [1/3] - O Industry code.

Valid value: TS = Transaction statement. *111
  YNQ(2) [1…10] - - - O Yes/No segment for direct purchase statement at header if any line items include a direct purchase statement. Child of HL shipment level.
DSCSA requirement.
  YNQ02 [1…1] String [2/2] - M Yes/No condition or response code for DSCSA compliance affirmation.

Valid value: Y = Yes. *112
  YNQ05 [1…1] String [1/264] - O Direct Purchase statement free form text. TraceLink will accept any text supplied by the sender. If nothing is sent, the following text will be defaulted: " As indicated below, product was purchased directly from the manufacturer, manufacturer’s exclusive distributor, or repackager who purchased directly from a manufacturer." *113
  YNQ08 [1…1] String [1/3] - O Code list qualifier for Direct Purchase purpose code.

Valid value: 99 = Purpose code. *114
  YNQ09 [1…1] String [1/3] - O Industry code.

Valid value: DPS = Direct Purchase Statement. *115
  HL [1…*] - - - M Hierarchical Level - Order. Child of HL shipment level. Supports multiple customer purchase order numbers per shipment. Supports HL Hierarchy levels:
  • Order --> Tare --> Pack --> Inner Pack --> Item
  • Order --> Tare --> Pack --> Item OR Order --> Tare --> Item
  • Order --> Pack --> Inner Pack --> Item
  • Order --> Pack --> Item OR Order --> Item
  HL01 [1…1] String [1/12] - M Hierarchical ID number. Increment previous HL01 element by 1. *116
  HL02 [0…1] String [0/12] - O HL01 ID number of the parent segment for the current segment. *117
  HL03 [1…1] String [1/2] HLHierarchyLevels M Code identifying hierarchical level of current HL group. HL Order Level = O. *118
  HL04 [0…1] String [0/1] - O Code indicating if there are child data segments subordinate to the current HL level. *119
  PRF [1…1] - - - M Purchase Order Reference. Child of HL order level.
  PRF01 [1…1] String [1/22] - M Purchase order number. *120
  PRF02 [0…1] String [1/22] - O Purchase order release number. *121
  PRF04 [1…1] Date [8/8] - M Purchase order date in CCYYMMDD format. *122
  REF(1) [0…1] - - - O Optional reference document identification for purchase order. Child of PRF purchase order reference segment. Up to 2 instances of REF segment supported.
  REF01 [0…1] String [2/3] - O Reference document identification qualifier identifying seller's invoice. Valid values: *123
  • IV - Seller's invoice number.
  • VN - Vendor's order number.
  REF02 [0…1] String [1/30] - O PO reference document ID number. *124
  DTM [0…10] - - - O Invoice date for seller's invoice in REF.
  DTM01 [0…1] String [0/3] - M Date/Time qualifier.

Valid value: 003 = Invoice. *125
  DTM02 [0…1] Date [0/8] - M Date in CCYYMMDD format. *126
  DTM03 [0…1] Time [0/8] - O Time in HHMMSS format. *127
Mandatory for 017 estimated delivery date.
  HL [0…*] - - - C Hierarchical Level Tare. Child of HL Order level. The following HL Hierarchy levels are supported by HL level Tare:

Order --> Tare --> Pack --> Inner Pack --> Item

Order --> Tare --> Pack --> Item

Order --> Tare --> Item

Mandatory if a packing hierarchy includes a Tare level.
  HL01 [1…1] String [1/12] - M Hierarchical ID number. Increment previous HL01 element by 1. *128
  HL02 [0…1] String [0/12] - R HL01 ID number of the parent segment for the current segment. *129
  HL03 [1…1] String [1/2] HLHierarchyLevels M Code identifying hierarchical level of current HL group. HL level Tare (pallet) = T. *130
  HL04 [0…1] String [0/1] - O Code indicating if there are child data segments subordinate to the current HL level. *131
  MAN [0…*] - - - O Marks and numbers. Child of HL Tare level.

MAN is an optional segment, but TraceLink needs it to build the packing aggregation in the outbound ASN. If the MAN segment is not sent, the file is sent out from the TraceLink system in an SOI format: Shipment --> Order --> Item.
  MAN01 [1…1] String [1/2] - M Mark and number qualifier. Valid values: *132
  • GM = SSCC-18 identifier
  • W = Pallet number (optional)
  MAN02 [1…1] String [1/48] - M License Plate Number - SSCC ID number. *133
  HL [0…*] - - - C HL-Hierarchical Level Case/Pack. Child of HL Order level or child of HL level Tare. Supports HL Level hierarchies:
  • Order --> Tare --> Pack --> Inner Pack --> Item
  • Order --> Tare --> Pack --> Item
  • Order --> Pack --> Inner Pack --> Item
  • Order --> Pack --> Item
Mandatory if packing hierarchy includes a Pack level.
  HL01 [1…1] String [1/12] - M Hierarchical ID number. Increment previous HL01 element by 1. *134
  HL02 [0…1] String [0/12] - O HL01 ID number of the parent segment for the current segment. *135
  HL03 [1…1] String [1/2] HLHierarchyLevels M Code identifying hierarchical level of current HL group. HL level Pack/Case = P. *136
  HL04 [0…1] String [0/1] - O Code indicating if there are child data segments subordinate to the current HL level. *137
  MAN [0…*] - - - O Marks and numbers. Child of HL Pack/Case level.

MAN is an optional segment, but TraceLink needs it to build the packing aggregation in the outbound ASN. If the MAN segment is not sent, the file is sent out from the TraceLink system in an SOI format: Shipment --> Order --> Item.
  MAN01 [1…1] String [1/2] - M Mark and number qualifier. Valid values: *138
  • AI - UCC/EAN-128 Appliation identifier
  • GM - Pack Level
  MAN02 [1…1] String [1/48] - M Case shipping label. Can be FedEx or UPS tracking number. *139
  HL [0…*] - - - C HL-Hierarchical Level Inner Pack. Child of HL Pack level. Supports HL Level hierarchies:
  • Order --> Tare --> Pack --> Inner Pack --> Item
  • Order --> Pack --> Inner Pack --> Item
Mandatory if packing hierarchy includes an Inner Pack level.
  HL01 [1…1] String [1/12] - M Hierarchical ID number. Increment previous HL01 element by 1. *140
  HL02 [0…1] String [0/12] - O HL01 ID number of the parent segment for the current segment. *141
  HL03 [1…1] String [1/2] HLHierarchyLevels M Code identifying hierarchical level of current HL group. HL level Inner Pack = Q. *142
  HL04 [0…1] String [0/1] - O Code indicating if there are child data segments subordinate to the current HL level. *143
  MAN [0…*] - - - O Marks and numbers. Child of HL Inner Pack level.

MAN is an optional segment, but TraceLink needs it to build the packing aggregation in the outbound ASN. If the MAN segment is not sent, the file is sent out from the TraceLink system in an SOI format: Shipment --> Order --> Item.
  MAN01 [1…1] String [1/2] - M Mark and number qualifier for inner pack. Valid values:
  • AI = UCC/EAN Aplication identifier
  • GM = SSCC code
  MAN02 [1…1] String [1/48] - M Case shipping label. Can be FedEx or UPS tracking number.
  HL [1…*] - - - M Hierarchical Level - Item. Child of HL Order or Tare or Pack or Inner Pack levels. Supports HL Hierarchy levels:
  • Order --> Tare --> Pack --> Inner Pack --> Item
  • Order --> Tare --> Pack --> Item
  • Order --> Tare --> Item
  • Order --> Pack --> Inner Pack --> Item
  • Order --> Pack --> Item
  • Order --> Item
  HL01 [1…1] String [1/12] - M Hierarchical ID number. Increment previous HL01 element by 1. *144
  HL02 [0…1] String [0/12] - R HL01 ID number of the parent segment for the current segment. *145
  HL03 [1…1] String [1/2] HLHierarchyLevels M Code identifying hierarchical level of current HL group. HL level Item = I. *146
  HL04 [0…1] String [0/1] - O Code indicating if there are child data segments subordinate to the current HL level.
  LIN [1…1] - - - M Item Identification. Child of HL level Item.
  LIN01 [0…1] String [0/20] - R ASN Line Number or Original PO line Number. *147
  LIN02 [0…1] String [0/2] ProductCode O Product service ID qualifier for product code types. All product code types supported in all LIN product code field pairs including NDC codes, Lot numbers, and non-Rx product codes. *148

Any of these product code types may be present in any of the LIN product type-product code field pairs from LIN02/LIN03 to LIN18/LIN19. The message supports more than one non-Rox product code and type in any of the LIN qualifier-product code value pairs.

Either an NDC code or non-Rx product code is required in any one of the LIN product code type/product code field pairs, although both can be present. Lot number is optional.
  LIN03 [0…1] String [0/48] - O Product code identifier qualifier as defined by product code identifier type in LIN02. *149
  LIN04 [0…1] String [0/2] ProductCode O Product service ID qualifier for product code types. All product code types supported in all LIN product code field pairs including NDC codes, Lot numbers, and non-Rx product codes. *150
  LIN05 [0…1] String [0/48] - O Product code identifier qualifier as defined by product code identifier type in LIN04. *151
  LIN06 [0…1] String [0/2] ProductCode O Product service ID qualifier for product code types. All product code types supported in all LIN product code field pairs including NDC codes, Lot numbers, and non-Rx product codes. *152
  LIN07 [0…1] String [0/48] - O Product code identifier qualifier as defined by product code identifier type in LIN04. *153
  LIN08 [0…1] String [0/2] ProductCode O Product service ID qualifier for product code types. All product code types supported in all LIN product code field pairs including NDC codes, Lot numbers, and non-Rx product codes. *154
  LIN09 [0…1] String [0/48] - O Product code identifier qualifier as defined by product code identifier type in LIN08. *155
  LIN10 [0…1] String [0/2] ProductCode O Product service ID qualifier for product code types. All product code types supported in all LIN product code field pairs including NDC codes, Lot numbers, and non-Rx product codes. *156
  LIN11 [0…1] String [0/48] - O Product code identifier qualifier as defined by product code identifier type in LIN10. *157
  LIN12 [0…1] String [0/2] ProductCode O Product service ID qualifier for product code types. All product code types supported in all LIN product code field pairs including NDC codes, Lot numbers, and non-Rx product codes. *158
  LIN13 [0…1] String [0/48] - O Product code identifier qualifier as defined by product code identifier type in LIN12. *159
  LIN14 [0…1] String [0/2] ProductCode O Product service ID qualifier for product code types. All product code types supported in all LIN product code field pairs including NDC codes, Lot numbers, and non-Rx product codes. *160
  LIN15 [0…1] String [0/48] - O Product code identifier qualifier as defined by product code identifier type in LIN14. *161
  LIN16 [0…1] String [0/2] ProductCode O Product service ID qualifier for product code types. All product code types supported in all LIN product code field pairs including NDC codes, Lot numbers, and non-Rx product codes. *162
  LIN17 [0…1] String [0/48] - O Product code identifier qualifier as defined by product code identifier type in LIN16. *163
  LIN18 [0…1] String [0/2] ProductCode O Product service ID qualifier for product code types. All product code types supported in all LIN product code field pairs including NDC codes, Lot numbers, and non-Rx product codes. *164
  LIN19 [0…1] String [0/48] - O Product code identifier qualifier as defined by product code identifier type in LIN18. *165
  SN1 [1…1] - - - M Item Details. Child of HL level Item.
  SN101 [0…1] Decimal [1/20] - O ASN Line Number or Original PO line Number referenced in LIN01. *166
  SN102 [1…1] Decimal [1/10] - M Numeric value of units shipped in manufacturer's shipping units for a line item or message set. *167
  SN103 [1…1] String [2/2] QuantityUOM M Unit of measure for quantity. Expected value = EA. *168
  SN104 [1…1] Decimal [1/10] - O Numeric value of quantity of units shipped to date for a line item or message set.
  SN105 [1…1] Decimal [1/10] - O Numeric value of quantity of units ordered for a line item or message set.
  SN106 [1…1] String [2/2] QuantityUOM O Unit of measure for quantity. Expected value = EA.
  SN107 [1…1] String [2/2] QuantityUOM O Unit of measure for quantity. Expected value = EA.
  PID [0…200] - - - O Product/Item description segment. Child of HL level Item. Not mapping segment inbound to TraceLink.
  PID01 [0…1] String [1/1] - O Item description type “F” = Free-form.
  PID02 [0…1] String [2/3] - O Tag identifying product attribute carried in segment.
  PID05 [0…1] String [1/80] - O Free-form description.
  REF [0…*] - - - O Optional reference document identification for purchase order. Child of HL level item. Seller's invoice number segment at the ASN line item level. Use for consolidating billing invoicing where there are multiple invoices per shipment.
  REF01 [0…1] String [2/3] - O Reference document identification qualifier identifying seller's invoice.

Valid value: IV - Seller's invoice number. *169
  REF02 [0…1] String [1/30] - O Invoice number. *170
  DTM [0…10] - - - M Date/Time for Lot Expiry Date. Child of HL level Item.
  DTM01 [1…1] String [3/3] - M Date time qualifier.

Value: 208 = Lot Expiry Date. *171
  DTM02 [1…1] Date [8/8] - M Lot expiry date. *172
  N1 [0…*] - - - O Transfer From name segment. History at item level. Child of HL level Item. Transaction history.
  N101 [1…1] String [2/3] DSCSABusinessRole M Entity identifier code for history. Valid values: *173
  • DS - Exclusive distributor of goods.
  • MF - Original manufacturer of goods.
  • SU - Supplier/Manufacturer for indirect shipments.
  N102 [1…1] String [1/60] - M Name.
  N103 [0…1] String [0/2] AddressIdQualifier O Identifier code qualifier.
  N104 [0…1] String [0/80] - O Party ID number.
  N3 [0…1] - - - M Address of TransferFrom party. Child of TransferFrom N1 Name segment.
  N301 [1…1] String [1/55] - M Street address 1.
  N302 [0…1] String [0/55] - O Street address 2.
  N4 [0…1] - - - M Geographic Location for TransferFrom party. Child of TransferFrom N1 Name segment.
  N401 [1…1] String [2/30] - M City name.
  N402 [1…1] String [2/2] - M State or province code. Code (Standard state/province) as defined by appropriate government agency.
  N403 [1…1] String [1/15] - M Postal code. Code defining international postal zone code excluding punctuation and blanks.
  N404 [0…1] String [2/3] - O Country code.
  REF [0…*] - - - O Optional reference identification for delivery document/ASN and transaction date in Transaction History. Child of TransferFrom N1 name level for history.
  REF01 [0…1] String [2/3] - O Reference identification qualifier for transaction date.

Valid value: KK = Identifies transaction date for Transaction History. *174
  REF02 [0…1] String [1/30] - C Date of transaction for transfer parties in Transaction History in X12 date format YYYYMMDD. *175
Transaction date is optional for manufacturers (N101 = MF), but is mandatory for suppliers (N101 = SU) and distributors (N101 = DS).
  REF03 [0…1] String [1/80] - O Description storing advance ship notification document reference number. *176
  YNQ(1) [0…10] - - - R Yes/No condition response segment for Direct Purchase Statement at line item level. Child of HL level item.
  YNQ02 [1…1] String [2/2] - M Yes/No condition or response code.

Valid value: Y = Yes. *177
  YNQ08 [1…1] String [1/3] - O Code list qualifier for purpose code.

Valid value: 99 = Purpose code. *178
  YNQ09 [1…1] String [1/30] - O Industry code. Valid values: *179
  • DIR = Direct Purchase Statement.
  • RDPS = Received Direct Purchase Statement.
  YNQ(2) [0…1] - - - O Optional DSCSA exempt flag YNQ segment instance. Child of HL level Item. Segment is mapped if present. If not present, LIN is checked for NDC code. If no NDC code found in LIN, DSCSAExempt flag is set to true for over the counter product that does not require recording of Transaction History.
  YNQ02 [1…1] String [1/1] - O DSCSAExempt flag as a Yes/No binary. Valid values: *180
  • Y = No (false, item is not exempt).
  • N = Yes (true, item is EXEMPT).

If nothing is sent the default is Y, Not Exempt, unless LIN does not include an NDC code. Do not include NDC code in LIN if product is over the counter and does not require creation of Transaction History.
  YNQ08 [1…1] String [1/3] - M Code list qualifier for purpose code. Hard code valid value: 99 = Purpose code. *181
  YNQ09 [1…1] String [1/30] - M DSCSAExempt flag. Hard code valid value: EXEMPT. *182
  CTT [1…1] - - - M Transaction Totals.
  CTT01 [1…1] Integer [1/6] - M Number of HL segments Total number of line items in the transaction set.
  SE [1…1] - - - M ST … SE transaction set trailer envelope. Child of GS group. Only one ST transaction expected.
  SE01 [1…1] Integer [1/10] - M Total count of segments in ST … SE transaction set including ST and SE segments.
  SE02 [1…1] String [4/9] - M Transaction set control number.
  GE [1…1] - - - M GS … GE functional group trailer envelope. Child of ISA interchange. Only one GS group expected.
  GE01 [1…1] Integer [1/6] - M Number of transaction sets in functional group.
  GE02 [1…1] String [1/9] - M Functional group control number.
  IEA [1…1] - - - M ISA … IEA interchange control trailer envelope. Only one interchange expected per transmission.
  IEA01 [1…1] Integer [1/5] - M Number of functional groups in interchange.
  IEA02 [1…1] String [9/9] - M Interchange control number.