Product: X12 EDI

Segment: HL

Article Link: http://help.truecommerce.com/en/articles/10040466-x12-hl-hierarchical-level

To identify dependencies among and the content of hierarchically related groups of data segments

Schema

Element	Name	Min/Max
HL01	Hierarchical ID Number	1/12
HL02	Hierarchical Parent ID Number	1/12
HL03	Hierarchical Level Code	1/2
HL04	Hierarchical Child Code	1/1

HL01 - Hierarchical ID Number

TYPE=AN MIN=1 MAX=12

A unique number assigned by the sender to identify a particular data segment in a hierarchical structure

HL02 - Hierarchical Parent ID Number

TYPE=AN MIN=1 MAX=12

Identification number of the next higher hierarchical data segment that the data segment being described is subordinate to

HL03 - Hierarchical Level Code

TYPE=ID MIN=1 MAX=2

Code defining the characteristic of a level in a hierarchical structure

Code	Description
0	Region
1	Service/Billing Provider
	*Code identifying the telecommunications company providing service/billing*
2	Billing Arrangement
	*Code identifying a specified billing arrangement*
3	Sub-Billing Arrangement
	*Code identifying a more detailed billing arrangement*
4	Group
5	Category
	*Code identifying the sub-division of the group*
6	Sub-Category
	*Code identifying a further breakdown of the category*
7	Type
	*Code identifying a further breakdown of the sub-category*
8	Charge Detail
	*Code identifying the lowest level of charges within a billing arrangement*
9	Line Detail
	*Code identifying the supporting detail associated with the charge or group*
A	Assembly
B	Buyer's Location
C	Date
D	Product Description
E	Transportation Equipment
F	Component
G	Quality Characteristics
	*A historical record of product quality characteristics and or discrepancies for a given item of supply*
H	Bill of Materials
I	Item
J	Part Characteristic
K	Kit
L	Supplier's Location
M	Measurement
N	Site of Service
O	Order
P	Pack
Q	Subpack
R	Quantity
S	Shipment
T	Shipping Tare
U	Subassembly
V	Address Information
	*The HL loop will identify entities associated with the shipment notice transaction*
W	Transaction Reference Number
	*The HL loop will identify shipment notice information for each reported transaction reference number*
X	Serial Number
	*Serial numbers applicable to a referenced item of supply*
Y	Suffix
	*The HL loop will identify shipment notice information for each reported suffix*
19	Provider of Service
20	Information Source
	*Identifies the payor, maintainer, or source of the information*
21	Information Receiver
	*Identifies the provider or party(ies) who are the recipient(s) of the information*
22	Subscriber
	*Identifies the employee or group member who is covered for insurance and to whom, or on behalf of whom, the insurer agrees to pay benefits*
23	Dependent
	*Identifies the individual who is affiliated with the subscriber, such as spouse, child, etc., and therefore may be entitled to benefits*
24	Supergroup
25	Subgroup
26	Member
27	Ancillary Facility or Department
28	Hospital
29	Franchisor
2A	Branch
2B	Direct Affiliate
	*Company in which a business owns a minority share*
2C	Director
2D	Headquarters
2E	Indirect Affiliate
	*Company where relationship is through management and/or stockholders*
2F	Management Antecedents
2G	Management or Principal
2H	Parent Company
2I	Stockholder
2J	Subsidiary
2K	Ultimate Domestic Parent Company
	*Top parent in the family tree located in the country*
2L	Ultimate Parent Company
	*Top parent in the family tree*
30	Franchisee
31	Franchisee Association
32	Health Industry Business Communications Council (HIBCC) Health Industry Number (HIN) Database
33	Activity
34	Location Record
35	Company/Corporation
	*Any company or business*
36	Operating Unit
	*Any operating business unit within a company or corporation*
37	Property
	*Any, building, structure, or body of land that is considered a single thing*
38	Tradename
	*A name by which the public identifies a business or product that is owned by a company or business*
39	Accountant
40	Financial Institution
41	Product Level
42	Activity Details
43	Payment Summary Score
44	Corporate Registration Filings
45	Bankruptcy Details
46	Company History
47	Complete Financial History
48	Balance Sheet
49	Comparative Figures
50	Payment Analysis
51	Special Notification
52	Public Record Financing Details
53	Public Record Financing Summary
54	Public Record Claim Details
55	Public Record Claim Summary
56	Statement of Work
	*A part of a description of what work needs to be performed under a contract*
57	Legal Action Details
58	Legal Action Summary
59	Company Evaluation
60	Company Summary
61	Credit Scores
62	Industry Averages
63	Referring Provider
64	Employee
65	Insurance Policy
66	Vehicle
67	Key Contributor
68	Public Record Summary
69	Delinquency Projections
70	Temporary Services Detail
71	Overnight Shipping Detail
72	Medical Supply Detail
73	Equipment Leasing Detail
AA	Insurer
AB	Claim Administrator
AC	Insured
AD	Administrative Information
AE	Car Rental Detail
AF	Lodging Detail
AG	Agent
AH	Transportation Detail
AI	Purchase Card Detail
AJ	Alternate Taxing Authority
AL	Alternate Specification - Lift Level
	*Designates the hierarchical level detail specifications of the largest warehouse/shop floor applications; alternate specification to be used as an option when the primary can not be provided*
AM	Amount Information
AP	Credential Action
AS	Animal Subject Group
AT	Account
BD	Building
BE	Business Entity
BP	Body Part
CB	Contractholder Branch Office
CC	Cost Center
	*A location to which incurred costs accrue*
CE	Cost Element
	*A element of cost within a total proposed price*
CH	Contractholder
CI	Cause of Injury
CL	Claimant
CN	Container
CO	Consortium
CP	Client or Party
CT	Cost Type
	*A breakdown of the type of cost being incurred*
CV	Coverage, Rider, or Supplementary Benefit
DG	Drawing
DM	Damage
DP	Department
	*An organization entity within a larger business entity*
DS	District
EB	Filer
EC	Receipts
ED	Engineering Data List
EF	Expenditures
EG	Receivables
EH	Payables
EI	Organizational Information
EL	Exhibit Line Item
	*A number for a document referenced in and appended to a procurement instrument that establishes a delivery requirement*
EM	Employer
EN	End Item
EV	Event
EX	Exception
FC	Function Code
	*A function within a larger set describing the total work to be performed*
FG	Functional Group
FI	Financial Information
FL	Fleet
FR	Frame
GC	Group Coverage Options
GP	Group Purchasing Organization
GW	Group Work Candidate
IA	Subline Item
	*A subdivision of the line item, typically used to describe a separate point of delivery*
IB	Contract
	*An agreement between partners*
IC	Contract Data Requirements List (CDRL)
IN	Interchange
IS	Installments
IT	Institution
IV	Individual
JU	Jurisdiction
KA	Accident History
KB	Chemical
KC	Control Device
KD	Discharge
KE	Emergency Response Plan
KF	Emission
KG	Emission Activity
KH	Emission Release Point
KI	Emission Unit
KJ	Flammable Mixture
KK	Flammables Alternate Release
KL	Flammables Worst Case
KM	Hazardous Waste Generation
KN	Hazardous Waste Received
KO	Off-Site Process
KP	On-Site Process
KQ	Parameter
KR	Prevention Program
KS	Process
KT	Reduction and Recycling
KV	Toxics Alternate Release
KW	Toxics Worst Case
KX	Transfer
LD	Lender or Mortgage Company
LN	Loan Data
LP	Party to the Loan
ML	Manufacturing Level
	*Nesting category for use in the HL segment that defines manufacturing or processing stages associated with specification, characteristics, controls, activities, or measurements*
NI	Nature of Injury
NS	National Stock Number
OS	Support
PA	Primary Administrator
PB	Personal Property
PC	Project Code
	*A part of a larger effort*
PD	Procedure
PE	Person
PH	Product Characteristic
PI	Property Identification
PK	Property Tax
PL	Primary Specification - Lift Level
	Designates the hierarchical level detailing specifications of the largest unitized configuration to be handled mechanically in warehouse/shop floor applications; "primary" indicates preferred or mandatory, and all subsequent "HL" segments contain specifications of upper or interior levels of the lift level as required
PP	Related Parties
PR	Principal
	*An entity granting authority to another to act in its behalf, such as a lobbyist's principal or an entity granting power of attorney.*
PS	Property Segment Group
PT	Patient
PY	Payment Detail
RA	Reporting Agency
RB	Response
RC	Response Details
RD	Response Sub-details
RE	Response Particular
RF	Medication
RG	Recommendation
RH	Review History
RL	Reference Location
RM	Room
RP	Report
	*The level of the hierarchical structure used to identify basic report information*
S1	Site
S2	Sample
S3	Test
SA	Secondary Administrator
SB	Substitute
SC	Subcontract Line Item
	*A further subdivision of a contract line item number, used for information or when a separate delivery is involved*
SD	Support Document
SE	Subexhibit Line Item
	*A further subdivision of a contract exhibit line item*
SF	Safety Fitness
SG	Safety Factor
SH	Sheet
SI	Source of Injury
SL	Solicitation
SP	Sub-Project
SR	Subroom
SS	Services
ST	State
SY	System
TA	Taxing Authority
TD	Tax Delinquency
TI	Technical Information Package
TS	Transaction Set
TU	Traffic Unit
TX	Tax Installment
UT	Unit or Lot
VI	Violation
WB	Work Breakdown Structure
	*An individual element of work portrayed in tree structure stages of the total performance of a contract*
WC	Work Candidate
	*Identifies a maintenance or repair requirement*
WL	Well
WP	Well Completion
WR	Wellbore
ZZ	Mutually Defined

HL04 - Hierarchical Child Code

TYPE=ID MIN=1 MAX=1

Code indicating if there are hierarchical child data segments subordinate to the level being described

Code	Description
0	No Subordinate HL Segment in This Hierarchical Structure.
1	Additional Subordinate HL Data Segment in This Hierarchical Structure.

Comments

Comments
00	The HL segment is used to identify levels of detail information using a hierarchical structure, such as relating line-item data to shipment data, and packaging data to line-item data.
00	The HL segment defines a top-down/left-right ordered structure.
01	HL01 shall contain a unique alphanumeric number for each occurrence of the HL segment in the transaction set. For example, HL01 could be used to indicate the number of occurrences of the HL segment, in which case the value of HL01 would be "1" for the initial HL segment and would be incremented by one in each subsequent HL segment within the transaction.
02	HL02 identifies the hierarchical ID number of the HL segment to which the current HL segment is subordinate.
03	HL03 indicates the context of the series of segments following the current HL segment up to the next occurrence of an HL segment in the transaction. For example, HL03 is used to indicate that subsequent segments in the HL loop form a logical grouping of data referring to shipment, order, or item-level information.
04	HL04 indicates whether or not there are subordinate (or child) HL segments related to the current HL segment.

rev 10/24/2024