tcd_x12 1.6.0

data/lib/x12/segment.rb

@@ -0,0 +1,89 @@
+module X12
+
+  # Implements a segment containing fields or composites
+  class Segment < Base
+    # Parses this segment out of a string, puts the match into value,
+    # returns the rest of the string - nil if cannot parse.
+    def parse(str)
+      s = str
+      # puts "Parsing segment #{name} from #{s} with regexp [#{regexp.source}]"
+      m = regexp.match(s)
+      # puts "Matched #{m ? m[0] : 'nothing'}"
+
+      return nil unless m
+
+      s = m.post_match
+      self.parsed_str = m[0]
+      s = do_repeats(s)
+
+      # puts "Parsed segment "+self.inspect
+      return s
+    end
+
+    # Render all components of this segment as string suitable for EDI.
+    def render
+      self.to_a.inject('') { |repeat_str, i|
+        if i.repeats.begin < 1 and !i.has_content?
+          # Skip optional empty segments
+          repeat_str
+        else
+          # Have to render no matter how empty
+          repeat_str += i.name + i.nodes.reverse.inject('') { |nodes_str, j|
+            field = j.render
+            (j.required or nodes_str != '' or field != '') ? field_separator + field + nodes_str : nodes_str
+          } + segment_separator
+        end
+      }
+    end
+
+    # Returns a regexp that matches this particular segment.
+    def regexp
+      unless @regexp
+        if self.nodes.find { |i| i.type =~ /^".+"$/ }
+          # It's a very special regexp if there are constant fields
+          re_str = self.nodes.inject("^#{name}#{Regexp.escape(field_separator)}") { |s, i|
+            field_re = i.simple_regexp(field_separator, segment_separator) + Regexp.escape(field_separator) + '?'
+            field_re = "(#{field_re})?" unless i.required
+            s + field_re
+          } + Regexp.escape(segment_separator)
+          @regexp = Regexp.new(re_str)
+        else
+          # Simple match
+          @regexp = Regexp.new("^#{name}#{Regexp.escape(field_separator)}[^#{Regexp.escape(segment_separator)}]*#{Regexp.escape(segment_separator)}")
+        end
+        # puts sprintf("%s %p", name, @regexp)
+      end
+      @regexp
+    end
+
+    # Finds a field in the segment. Returns EMPTY if not found.
+    def find_field(str)
+      # puts "Finding field [#{str}] in #{self.class} #{name}"
+      # If there is such a field to begin with
+      field_num = nil
+      self.nodes.each_index{ |i|
+        field_num = i if str == self.nodes[i].name
+      }
+      return EMPTY if field_num.nil?
+      # puts field_num
+
+      # Parse the segment if not parsed already
+      unless @fields
+        @fields = self.to_s.chop.split(Regexp.new(Regexp.escape(field_separator)))
+        self.nodes.each_index { |i| self.nodes[i].content = @fields[i + 1] }
+      end
+      # puts self.nodes[field_num].inspect
+      return self.nodes[field_num]
+    end
+
+    # provides loopong through multiple segments within the loop
+    def each
+      res = self.to_a
+      0.upto(res.length - 1) do |x|
+        yield res[x]
+      end
+    end
+
+  end
+
+end

data/lib/x12/table.rb

@@ -0,0 +1,21 @@
+module X12
+
+  # This just a named hash to store validation tables.
+  class Table < Hash
+    attr_reader :name
+
+    # Create a new table with given name and hash content.
+    def initialize(name, name_values)
+      @name = name
+      self.merge!(name_values)
+    end
+
+    # Return a printable string representing this table
+    # @return [String]
+    def inspect
+      "Table #{name} -- #{super.inspect}"
+    end
+
+  end
+
+end

data/lib/x12/version.rb

@@ -0,0 +1,4 @@
+module X12
+  # @type [String]
+  VERSION = '1.6.0'.freeze
+end

data/lib/x12/xmldefinitions.rb

@@ -0,0 +1,147 @@
+module X12
+  # A class for parsing X12 message definition expressed in XML format.
+  class XMLDefinitions < Hash
+
+    # Parse definitions out of XML file.
+    # @param str [String]
+    def initialize(str)
+      doc = LibXML::XML::Document.string(str)
+      definitions = doc.root.name =~ /^Definition$/i ? doc.root.find('*').to_a : [doc.root]
+
+      definitions.each do |element|
+        # puts element.name
+        syntax_element = case element.name
+                         when /table/i
+                           parse_table(element)
+                         when /segment/i
+                           parse_segment(element)
+                         when /composite/i
+                           parse_composite(element)
+                         when /loop/i
+                           parse_loop(element)
+                         end
+        self[syntax_element.class] ||= {}
+        self[syntax_element.class][syntax_element.name] = syntax_element
+      end
+    end
+
+    private
+
+    def parse_boolean(s)
+      return case s
+             when nil
+               false
+             when ''
+               false
+             when /(^y(es)?$)|(^t(rue)?$)|(^1$)/i
+               true
+             when /(^no?$)|(^f(alse)?$)|(^0$)/i
+               false
+             else
+               nil
+             end
+    end
+
+    def parse_type(s)
+      return case s
+             when nil
+               'string'
+             when /^C.+$/
+               s
+             when /^i(nt(eger)?)?$/i
+               'int'
+             when /^l(ong)?$/i
+               'long'
+             when /^d(ouble)?$/i
+               'double'
+             when /^s(tr(ing)?)?$/i
+               'string'
+             else
+               nil
+             end
+    end
+
+    def parse_int(s)
+      return case s
+             when nil then 0
+             when /^\d+$/ then s.to_i
+             when /^inf(inite)?$/ then 999_999
+             else
+               nil
+             end
+    end
+
+    def parse_attributes(e)
+      throw Exception.new("No name attribute found for : #{e.inspect}")          unless name = e.attributes['name']
+      throw Exception.new("Cannot parse attribute 'min' for: #{e.inspect}")      unless min = parse_int(e.attributes['min'])
+      throw Exception.new("Cannot parse attribute 'max' for: #{e.inspect}")      unless max = parse_int(e.attributes['max'])
+      throw Exception.new("Cannot parse attribute 'type' for: #{e.inspect}")     unless type = parse_type(e.attributes['type'])
+      throw Exception.new("Cannot parse attribute 'required' for: #{e.inspect}") if (required = parse_boolean(e.attributes['required'])).nil?
+
+      validation = e.attributes['validation']
+      min = 1 if required and min < 1
+      max = 999_999 if max.zero?
+
+      return name, min, max, type, required, validation
+    end
+
+    def parse_field(e)
+      name, min, max, type, required, validation = parse_attributes(e)
+
+      # FIXME: for compatibility with d12 - constants are stored in attribute 'type' and are enclosed in
+      # double quotes
+      const_field = e.attributes['const']
+      if const_field
+        type = "\"#{const_field}\""
+      end
+
+      Field.new(name, type, required, min, max, validation)
+    end
+
+    def parse_table(e)
+      name, min, max, type, required, validation = parse_attributes(e)
+
+      content = e.find('Entry').inject({}) { |t, entry|
+        t[entry.attributes['name']] = entry.attributes['value']
+        t
+      }
+      Table.new(name, content)
+    end
+
+    def parse_segment(e)
+      name, min, max, type, required, validation = parse_attributes(e)
+
+      fields = e.find('Field').inject([]) { |f, field|
+        f << parse_field(field)
+      }
+      Segment.new(name, fields, Range.new(min, max))
+    end
+
+    def parse_composite(e)
+      name, min, max, type, required, validation = parse_attributes(e)
+
+      fields = e.find('Field').inject([]) { |f, field|
+        f << parse_field(field)
+      }
+      Composite.new(name, fields)
+    end
+
+    def parse_loop(e)
+      name, min, max, type, required, validation = parse_attributes(e)
+
+      components = e.find('*').to_a.inject([]) { |r, element|
+        r << case element.name
+             when /loop/i
+               parse_loop(element)
+             when /segment/i
+               parse_segment(element)
+             else
+               throw Exception.new("Cannot recognize syntax for: #{element.inspect} in loop #{e.inspect}")
+             end
+      }
+      Loop.new(name, components, Range.new(min, max))
+    end
+
+  end
+
+end

data/lib/x12.rb

@@ -0,0 +1,23 @@
+require 'libxml'
+require 'pp'
+
+require 'x12/base'
+require 'x12/composite'
+require 'x12/empty'
+require 'x12/field'
+require 'x12/loop'
+require 'x12/parser'
+require 'x12/segment'
+require 'x12/table'
+require 'x12/version'
+require 'x12/xmldefinitions'
+
+# X12 implements direct manipulation of X12 structures using Ruby syntax.
+module X12
+  include LibXML
+
+  # @type [X12::Empty]
+  EMPTY = Empty.new()
+  # @type [Integer]
+  TEST_REPEAT = 1
+end

data/misc/270.xml

@@ -0,0 +1,152 @@
+<!--
+   This file is part of the X12Parser library that provides tools to
+   manipulate X12 messages using Ruby native syntax.
+
+   http://x12parser.rubyforge.org 
+   
+   Copyright (C) 2009 APP Design, Inc.
+
+   This library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 2.1 of the License, or (at your option) any later version.
+
+   This library is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   Lesser General Public License for more details.
+
+   You should have received a copy of the GNU Lesser General Public
+   License along with this library; if not, write to the Free Software
+   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+   $Id: 270.xml 81 2009-05-13 18:05:32Z ikk $
+-->
+
+<Loop name="270" comment="This X12 Transaction Set contains the format and establishes the data contents of the Eligibility, Coverage or Benefit Inquiry Transaction Set (270) for use within the context of an Electronic Data Interchange (EDI) environment. This transaction set can be used to inquire about the eligibility, coverages or benefits associated with a benefit plan, employer, plan sponsor, subscriber or a dependent under the subscriber's policy. The transaction set is intended to be used by all lines of insurance such as Health, Life, and Property and Casualty.">
+
+  <Segment name="ST" required="y" max="1">
+    <Field name="TransactionSetIdentifierCode" const="270" comment="Code uniquely identifying a Transaction Set"/>
+    <Field name="TransactionSetControlNumber" min="4" max="9" comment="Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set"/>
+  </Segment>
+  <Segment name="BHT" required="y" max="1" comment="To define the business hierarchical structure of the transaction set and identify the business application purpose and reference data, i.e., number, date, and time">
+    <Field name="HierarchicalStructureCode" required="y" const="0022"                       comment="Code indicating the hierarchical application structure of a transaction set that utilizes the HL segment to define the structure of the transaction set"/>
+    <Field name="TransactionSetPurposeCode" required="y" min="2" max="2"  validation="T353" comment="Code identifying purpose of transaction set"/>
+    <Field name="ReferenceIdentification"                min="1" max="50"                   comment="Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier"/>
+    <Field name="Date"                      required="y" min="8" max="8"                    comment="Date expressed as CCYYMMDD where CC represents the first two digits of the calendar year"/>
+    <Field name="Time"                      required="y" min="4" max="8"                    comment="Time expressed in 24-hour clock time as follows: HHMM, or HHMMSS, or HHMMSSD, or HHMMSSDD, where H = hours (00-23), M = minutes (00-59), S = integer seconds (00-59) and DD = decimal seconds; decimal seconds are expressed as follows: D = tenths (0-9) and DD = hundredths (00-99)"/>
+    <Field name="TransactionTypeCode"       required="n" min="2" max="2"  validation="T640" comment="Code specifying the type of transaction"/>
+  </Segment>
+
+  <Loop name="L2000A" max="inf" required="y">
+    <Segment name="HL" min="1" max="1" comment="To identify dependencies among and the content of hierarchically related groups of data segments">
+      <Field name="HierarchicalIdNumber"             required="y" min="1" max="12" comment="A unique number assigned by the sender to identify a particular data segment in a hierarchical structure"/>
+      <Field name="HierarchicalParentIdNumber"       required="n" min="1" max="12" comment="Identification number of the next higher hierarchical data segment that the data segment being described is subordinate to"/>
+      <Field name="HierarchicalLevelCode" const="20" required="y"                  comment="Code defining the characteristic of a level in a hierarchical structure"/>
+      <Field name="HierarchicalChildCode"            required="n" min="1" max="1" validation="T736" comment="Code indicating if there are hierarchical child data segments subordinate to the level being described"/>
+    </Segment>
+    <Loop name="L2100A" min="1" max="1" required="y">
+      <Segment name="NM1" required="y" max="1"/>
+    </Loop>
+  </Loop>
+
+  <Loop name="L2000B" max="inf" required="y">
+    <Segment name="HL" min="1" max="1" comment="To identify dependencies among and the content of hierarchically related groups of data segments">
+      <Field name="HierarchicalIdNumber"             required="y" min="1" max="12" comment="A unique number assigned by the sender to identify a particular data segment in a hierarchical structure"/>
+      <Field name="HierarchicalParentIdNumber"       required="n" min="1" max="12" comment="Identification number of the next higher hierarchical data segment that the data segment being described is subordinate to"/>
+      <Field name="HierarchicalLevelCode" const="21" required="y"                  comment="Code defining the characteristic of a level in a hierarchical structure"/>
+      <Field name="HierarchicalChildCode"            required="n" min="1" max="1" validation="T736" comment="Code indicating if there are hierarchical child data segments subordinate to the level being described"/>
+    </Segment>
+    <Loop name="L2100B" min="1" max="1" required="y">
+      <Segment name="NM1" required="y" max="1"/>
+      <Segment name="REF" required="n" max="9"/>
+      <Segment name="N3"  required="n" max="1"/>
+      <Segment name="N4"  required="n" max="1"/>
+      <Segment name="PER" required="n" max="3"/>
+      <Segment name="PRV" required="n" max="1"/>
+    </Loop>
+  </Loop>
+
+  <Loop name="L2000C" max="inf" required="y">
+    <Segment name="HL" min="1" max="1" comment="To identify dependencies among and the content of hierarchically related groups of data segments">
+      <Field name="HierarchicalIdNumber"             required="y" min="1" max="12" comment="A unique number assigned by the sender to identify a particular data segment in a hierarchical structure"/>
+      <Field name="HierarchicalParentIdNumber"       required="n" min="1" max="12" comment="Identification number of the next higher hierarchical data segment that the data segment being described is subordinate to"/>
+      <Field name="HierarchicalLevelCode" const="22" required="y"                  comment="Code defining the characteristic of a level in a hierarchical structure"/>
+      <Field name="HierarchicalChildCode"            required="n" min="1" max="1" validation="T736" comment="Code indicating if there are hierarchical child data segments subordinate to the level being described"/>
+    </Segment>
+    <Segment name="TRN" required="n" max="2"/>
+    <Loop name="L2100C" min="1" max="1" required="y">
+      <!-- Note the difference from 'standard' NM1: IdentificationCodeQualifier and IdentificationCode are not
+           required -->
+      <Segment name="NM1" required="y" max="1" comment="To supply the full name of an individual or organizational entity">
+        <Field name="EntityIdentifierCode1"       required="y" min="2" max="3"  validation="T98"   comment="Code identifying an organizational entity, a physical location, property or an individual"/>
+        <Field name="EntityTypeQualifier"         required="y" min="1" max="1"  validation="T1065" comment="Code qualifying the type of entity"/>
+        <Field name="NameLastOrOrganizationName"  required="n" min="1" max="60"                    comment="Individual last name or organizational name"/>
+        <Field name="NameFirst"                   required="n" min="1" max="35"                    comment="Individual first name"/>
+        <Field name="NameMiddle"                  required="n" min="1" max="25"                    comment="Individual middle name or initial"/>
+        <Field name="NamePrefix"                  required="n" min="1" max="10"                    comment="Prefix to individual name"/>
+        <Field name="NameSuffix"                  required="n" min="1" max="10"                    comment="Suffix to individual name"/>
+        <Field name="IdentificationCodeQualifier" required="n" min="1" max="2"  validation="T66"   comment="Code designating the system/method of code structure used for Identification Code (67)"/>
+        <Field name="IdentificationCode"          required="n" min="2" max="80"                    comment="Code identifying a party or other code"/>
+        <Field name="EntityRelationshipCode"      required="n" min="2" max="2"  validation="T706"  comment="Code describing entity relationship"/>
+        <Field name="EntityIdentifierCode"        required="n" min="2" max="3"  validation="T98"   comment="Code identifying an organizational entity, a physical location, property or an individual"/>
+      </Segment>
+      <Segment name="REF" required="n" max="9"/>
+      <Segment name="N3"  required="n" max="1"/>
+      <Segment name="N4"  required="n" max="1"/>
+      <Segment name="PRV" required="n" max="1"/>
+      <Segment name="DMG" required="n" max="3"/>
+      <Segment name="INS" required="n" max="1"/>
+      <Segment name="DTP" required="n" max="2"/>
+      <Loop name="L2110C" max="99" required="n">
+        <Segment name="EQ"  required="n" max="1"/>
+        <Segment name="AMT" required="n" max="1"/>
+        <Segment name="III" required="n" max="10"/>
+        <Segment name="REF" required="n" max="1"/>
+        <Segment name="DTP" required="n" max="1"/>
+      </Loop>
+    </Loop>
+  </Loop>
+
+  <Loop name="L2000D" max="inf" required="n">
+    <Segment name="HL" min="1" max="1" comment="To identify dependencies among and the content of hierarchically related groups of data segments">
+      <Field name="HierarchicalIdNumber"             required="y" min="1" max="12" comment="A unique number assigned by the sender to identify a particular data segment in a hierarchical structure"/>
+      <Field name="HierarchicalParentIdNumber"       required="n" min="1" max="12" comment="Identification number of the next higher hierarchical data segment that the data segment being described is subordinate to"/>
+      <Field name="HierarchicalLevelCode" const="23" required="y"                  comment="Code defining the characteristic of a level in a hierarchical structure"/>
+      <Field name="HierarchicalChildCode" const="0"  required="y"                  comment="Code indicating if there are hierarchical child data segments subordinate to the level being described"/>
+    </Segment>
+    <Segment name="TRN" required="n" max="2"/>
+    <Loop name="L2100D" min="0" max="1" required="n">
+      <!-- Note the difference from 'standard' NM1: IdentificationCodeQualifier and IdentificationCode are not
+           required -->
+      <Segment name="NM1" required="y" max="1" comment="To supply the full name of an individual or organizational entity">
+        <Field name="EntityIdentifierCode1"       required="y" min="2" max="3"  validation="T98"   comment="Code identifying an organizational entity, a physical location, property or an individual"/>
+        <Field name="EntityTypeQualifier"         required="y" min="1" max="1"  validation="T1065" comment="Code qualifying the type of entity"/>
+        <Field name="NameLastOrOrganizationName"  required="n" min="1" max="60"                    comment="Individual last name or organizational name"/>
+        <Field name="NameFirst"                   required="n" min="1" max="35"                    comment="Individual first name"/>
+        <Field name="NameMiddle"                  required="n" min="1" max="25"                    comment="Individual middle name or initial"/>
+        <Field name="NamePrefix"                  required="n" min="1" max="10"                    comment="Prefix to individual name"/>
+        <Field name="NameSuffix"                  required="n" min="1" max="10"                    comment="Suffix to individual name"/>
+        <Field name="IdentificationCodeQualifier" required="n" min="1" max="2"  validation="T66"   comment="Code designating the system/method of code structure used for Identification Code (67)"/>
+        <Field name="IdentificationCode"          required="n" min="2" max="80"                    comment="Code identifying a party or other code"/>
+        <Field name="EntityRelationshipCode"      required="n" min="2" max="2"  validation="T706"  comment="Code describing entity relationship"/>
+        <Field name="EntityIdentifierCode"        required="n" min="2" max="3"  validation="T98"   comment="Code identifying an organizational entity, a physical location, property or an individual"/>
+      </Segment>
+      <Segment name="REF" required="n" max="9"/>
+      <Segment name="N3"  required="n" max="1"/>
+      <Segment name="N4"  required="n" max="1"/>
+      <Segment name="PRV" required="n" max="1"/>
+      <Segment name="DMG" required="n" max="3"/>
+      <Segment name="INS" required="n" max="1"/>
+      <Segment name="DTP" required="n" max="2"/>
+      <Loop name="L2110D" max="99" required="n">
+        <Segment name="EQ"  required="y" max="1"/>
+        <Segment name="III" required="n" max="10"/>
+        <Segment name="REF" required="n" max="1"/>
+        <Segment name="DTP" required="n" max="1"/>
+      </Loop>
+    </Loop>
+  </Loop>
+
+  <Segment name="SE" min="1" max="1"/>
+</Loop>

data/misc/270interchange.xml

@@ -0,0 +1,164 @@
+<!--
+    This file is part of the X12Parser library that provides tools to
+    manipulate X12 messages using Ruby native syntax.
+
+    http://x12parser.rubyforge.org
+
+    Copyright (C) 2009 APP Design, Inc.
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+    $Id: 270interchange.xml 79 2009-05-13 17:22:33Z ikk $
+  -->
+
+<Loop name="270interchange" min="1" max="1">
+  <Segment name="ISA" min="1" max="1"/>
+
+  <Loop name="FG" min="1" max="inf">
+    <Segment name="GS" min="1" max="1"/>
+
+    <Loop name="270" comment="This X12 Transaction Set contains the format and establishes the data contents of the Eligibility, Coverage or Benefit Inquiry Transaction Set (270) for use within the context of an Electronic Data Interchange (EDI) environment. This transaction set can be used to inquire about the eligibility, coverages or benefits associated with a benefit plan, employer, plan sponsor, subscriber or a dependent under the subscriber's policy. The transaction set is intended to be used by all lines of insurance such as Health, Life, and Property and Casualty.">
+      <Segment name="ST" required="y" max="1">
+        <Field name="TransactionSetIdentifierCode" const="270" comment="Code uniquely identifying a Transaction Set"/>
+        <Field name="TransactionSetControlNumber" min="4" max="9" comment="Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set"/>
+        <Field name="ImplementationConventionReference" required="n" min="1" max="35" comment="Reference assigned to identify Implementation Convention"/>
+      </Segment>
+      <Segment name="BHT" required="y" max="1" comment="To define the business hierarchical structure of the transaction set and identify the business application purpose and reference data, i.e., number, date, and time">
+        <Field name="HierarchicalStructureCode" required="y" const="0022"                       comment="Code indicating the hierarchical application structure of a transaction set that utilizes the HL segment to define the structure of the transaction set"/>
+        <Field name="TransactionSetPurposeCode" required="y" min="2" max="2"  validation="T353" comment="Code identifying purpose of transaction set"/>
+        <Field name="ReferenceIdentification"                min="1" max="50"                   comment="Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier"/>
+        <Field name="Date"                      required="y" min="8" max="8"                    comment="Date expressed as CCYYMMDD where CC represents the first two digits of the calendar year"/>
+        <Field name="Time"                      required="y" min="4" max="8"                    comment="Time expressed in 24-hour clock time as follows: HHMM, or HHMMSS, or HHMMSSD, or HHMMSSDD, where H = hours (00-23), M = minutes (00-59), S = integer seconds (00-59) and DD = decimal seconds; decimal seconds are expressed as follows: D = tenths (0-9) and DD = hundredths (00-99)"/>
+        <Field name="TransactionTypeCode"       required="n" min="2" max="2"  validation="T640" comment="Code specifying the type of transaction"/>
+      </Segment>
+
+      <Loop name="L2000A" max="inf" required="y">
+        <Segment name="HL" min="1" max="1" comment="To identify dependencies among and the content of hierarchically related groups of data segments">
+          <Field name="HierarchicalIdNumber"             required="y" min="1" max="12" comment="A unique number assigned by the sender to identify a particular data segment in a hierarchical structure"/>
+          <Field name="HierarchicalParentIdNumber"       required="n" min="1" max="12" comment="Identification number of the next higher hierarchical data segment that the data segment being described is subordinate to"/>
+          <Field name="HierarchicalLevelCode" const="20" required="y"                  comment="Code defining the characteristic of a level in a hierarchical structure"/>
+          <Field name="HierarchicalChildCode"            required="n" min="1" max="1" validation="T736" comment="Code indicating if there are hierarchical child data segments subordinate to the level being described"/>
+        </Segment>
+        <Loop name="L2100A" min="1" max="1" required="y">
+          <Segment name="NM1" required="y" max="1"/>
+        </Loop>
+      </Loop>
+
+      <Loop name="L2000B" max="inf" required="y">
+        <Segment name="HL" min="1" max="1" comment="To identify dependencies among and the content of hierarchically related groups of data segments">
+          <Field name="HierarchicalIdNumber"             required="y" min="1" max="12" comment="A unique number assigned by the sender to identify a particular data segment in a hierarchical structure"/>
+          <Field name="HierarchicalParentIdNumber"       required="n" min="1" max="12" comment="Identification number of the next higher hierarchical data segment that the data segment being described is subordinate to"/>
+          <Field name="HierarchicalLevelCode" const="21" required="y"                  comment="Code defining the characteristic of a level in a hierarchical structure"/>
+          <Field name="HierarchicalChildCode"            required="n" min="1" max="1" validation="T736" comment="Code indicating if there are hierarchical child data segments subordinate to the level being described"/>
+        </Segment>
+        <Loop name="L2100B" min="1" max="1" required="y">
+          <Segment name="NM1" required="y" max="1"/>
+          <Segment name="REF" required="n" max="9"/>
+          <Segment name="N3"  required="n" max="1"/>
+          <Segment name="N4"  required="n" max="1"/>
+          <Segment name="PER" required="n" max="3"/>
+          <Segment name="PRV" required="n" max="1"/>
+        </Loop>
+      </Loop>
+
+      <Loop name="L2000C" max="inf" required="y">
+        <Segment name="HL" min="1" max="1" comment="To identify dependencies among and the content of hierarchically related groups of data segments">
+          <Field name="HierarchicalIdNumber"             required="y" min="1" max="12" comment="A unique number assigned by the sender to identify a particular data segment in a hierarchical structure"/>
+          <Field name="HierarchicalParentIdNumber"       required="n" min="1" max="12" comment="Identification number of the next higher hierarchical data segment that the data segment being described is subordinate to"/>
+          <Field name="HierarchicalLevelCode" const="22" required="y"                  comment="Code defining the characteristic of a level in a hierarchical structure"/>
+          <Field name="HierarchicalChildCode"            required="n" min="1" max="1" validation="T736" comment="Code indicating if there are hierarchical child data segments subordinate to the level being described"/>
+        </Segment>
+        <Segment name="TRN" required="n" max="2"/>
+        <Loop name="L2100C" min="1" max="1" required="y">
+          <!-- Note the difference from 'standard' NM1: IdentificationCodeQualifier and IdentificationCode are not
+               required -->
+          <Segment name="NM1" required="y" max="1" comment="To supply the full name of an individual or organizational entity">
+            <Field name="EntityIdentifierCode1"       required="y" min="2" max="3"  validation="T98"   comment="Code identifying an organizational entity, a physical location, property or an individual"/>
+            <Field name="EntityTypeQualifier"         required="y" min="1" max="1"  validation="T1065" comment="Code qualifying the type of entity"/>
+            <Field name="NameLastOrOrganizationName"  required="n" min="1" max="60"                    comment="Individual last name or organizational name"/>
+            <Field name="NameFirst"                   required="n" min="1" max="35"                    comment="Individual first name"/>
+            <Field name="NameMiddle"                  required="n" min="1" max="25"                    comment="Individual middle name or initial"/>
+            <Field name="NamePrefix"                  required="n" min="1" max="10"                    comment="Prefix to individual name"/>
+            <Field name="NameSuffix"                  required="n" min="1" max="10"                    comment="Suffix to individual name"/>
+            <Field name="IdentificationCodeQualifier" required="n" min="1" max="2"  validation="T66"   comment="Code designating the system/method of code structure used for Identification Code (67)"/>
+            <Field name="IdentificationCode"          required="n" min="2" max="80"                    comment="Code identifying a party or other code"/>
+            <Field name="EntityRelationshipCode"      required="n" min="2" max="2"  validation="T706"  comment="Code describing entity relationship"/>
+            <Field name="EntityIdentifierCode"        required="n" min="2" max="3"  validation="T98"   comment="Code identifying an organizational entity, a physical location, property or an individual"/>
+          </Segment>
+          <Segment name="REF" required="n" max="9"/>
+          <Segment name="N3"  required="n" max="1"/>
+          <Segment name="N4"  required="n" max="1"/>
+          <Segment name="PRV" required="n" max="1"/>
+          <Segment name="DMG" required="n" max="3"/>
+          <Segment name="INS" required="n" max="1"/>
+          <Segment name="DTP" required="n" max="2"/>
+          <Loop name="L2110C" max="99" required="n">
+            <Segment name="EQ"  required="n" max="1"/>
+            <Segment name="AMT" required="n" max="1"/>
+            <Segment name="III" required="n" max="10"/>
+            <Segment name="REF" required="n" max="1"/>
+            <Segment name="DTP" required="n" max="1"/>
+          </Loop>
+        </Loop>
+      </Loop>
+
+      <Loop name="L2000D" max="inf" required="n">
+        <Segment name="HL" min="1" max="1" comment="To identify dependencies among and the content of hierarchically related groups of data segments">
+          <Field name="HierarchicalIdNumber"             required="y" min="1" max="12" comment="A unique number assigned by the sender to identify a particular data segment in a hierarchical structure"/>
+          <Field name="HierarchicalParentIdNumber"       required="n" min="1" max="12" comment="Identification number of the next higher hierarchical data segment that the data segment being described is subordinate to"/>
+          <Field name="HierarchicalLevelCode" const="23" required="y"                  comment="Code defining the characteristic of a level in a hierarchical structure"/>
+          <Field name="HierarchicalChildCode" const="0"  required="y"                  comment="Code indicating if there are hierarchical child data segments subordinate to the level being described"/>
+        </Segment>
+        <Segment name="TRN" required="n" max="2"/>
+        <Loop name="L2100D" min="0" max="1" required="n">
+          <!-- Note the difference from 'standard' NM1: IdentificationCodeQualifier and IdentificationCode are not
+               required -->
+          <Segment name="NM1" required="y" max="1" comment="To supply the full name of an individual or organizational entity">
+            <Field name="EntityIdentifierCode1"       required="y" min="2" max="3"  validation="T98"   comment="Code identifying an organizational entity, a physical location, property or an individual"/>
+            <Field name="EntityTypeQualifier"         required="y" min="1" max="1"  validation="T1065" comment="Code qualifying the type of entity"/>
+            <Field name="NameLastOrOrganizationName"  required="n" min="1" max="60"                    comment="Individual last name or organizational name"/>
+            <Field name="NameFirst"                   required="n" min="1" max="35"                    comment="Individual first name"/>
+            <Field name="NameMiddle"                  required="n" min="1" max="25"                    comment="Individual middle name or initial"/>
+            <Field name="NamePrefix"                  required="n" min="1" max="10"                    comment="Prefix to individual name"/>
+            <Field name="NameSuffix"                  required="n" min="1" max="10"                    comment="Suffix to individual name"/>
+            <Field name="IdentificationCodeQualifier" required="n" min="1" max="2"  validation="T66"   comment="Code designating the system/method of code structure used for Identification Code (67)"/>
+            <Field name="IdentificationCode"          required="n" min="2" max="80"                    comment="Code identifying a party or other code"/>
+            <Field name="EntityRelationshipCode"      required="n" min="2" max="2"  validation="T706"  comment="Code describing entity relationship"/>
+            <Field name="EntityIdentifierCode"        required="n" min="2" max="3"  validation="T98"   comment="Code identifying an organizational entity, a physical location, property or an individual"/>
+          </Segment>
+          <Segment name="REF" required="n" max="9"/>
+          <Segment name="N3"  required="n" max="1"/>
+          <Segment name="N4"  required="n" max="1"/>
+          <Segment name="PRV" required="n" max="1"/>
+          <Segment name="DMG" required="n" max="3"/>
+          <Segment name="INS" required="n" max="1"/>
+          <Segment name="DTP" required="n" max="2"/>
+          <Loop name="L2110D" max="99" required="n">
+            <Segment name="EQ"  required="y" max="1"/>
+            <Segment name="III" required="n" max="10"/>
+            <Segment name="REF" required="n" max="1"/>
+            <Segment name="DTP" required="n" max="1"/>
+          </Loop>
+        </Loop>
+      </Loop>
+
+      <Segment name="SE" min="1" max="1"/>
+    </Loop>
+
+    <Segment name="GE" min="1" max="1"/>
+  </Loop>
+
+  <Segment name="IEA" min="1" max="1"/>
+</Loop>