X12 0.1.0 → 1.1.0

data/lib/X12/Base.rb

@@ -23,7 +23,7 @@
 #
 module X12
 
-  # $Id: Base.rb 49 2009-03-17 19:46:08Z ikk $
+  # $Id: Base.rb 70 2009-03-26 19:25:39Z ikk $
   #
   # Base class for Segment, Composite, and Loop. Contains setable
   # segment_separator, field_separator, and composite_separator fields.
@@ -113,8 +113,11 @@ module X12
       #puts "Finding [#{e}] in #{self.class} #{name}"
       case self
         when X12::Loop
+        # Breadth first
+        res = nodes.find{|i| e==i.name }
+        return res if res
+        # Depth now
         nodes.each{|i| 
-          return i if e==i.name
           res = i.find(e) if i.kind_of?(X12::Loop)
           return res unless res.nil? or EMPTY==res # otherwise keep looping
         }
@@ -143,6 +146,8 @@ module X12
     # The main method implementing Ruby-like access methods for nested elements
     def method_missing(meth, *args, &block)
       str = meth.id2name
+      str = str[1..str.length] if str =~ /^_\d+$/ # to avoid pure number names like 270, 997, etc.
+      #puts "Missing #{str}"
       if str =~ /=$/
         # Assignment
         str.chop!
@@ -170,6 +175,15 @@ module X12
       return self.to_a[args[0]] || EMPTY
     end
 
+    # Yields to accompanying block passing self as a parameter.
+    def with(&block)
+      if block_given?
+        yield self 
+      else
+        throw Exception.new("Method 'with' requires a block.")
+      end
+    end
+    
     # Returns number of repeats
     def size
       return self.to_a.size

data/lib/X12/Field.rb

@@ -23,7 +23,7 @@
 #
 module X12
 
-  # $Id: Field.rb 56 2009-03-18 19:56:01Z ikk $
+  # $Id: Field.rb 90 2009-05-13 19:51:27Z ikk $
   #
   # Class to represent a segment field. Please note, it's not a descendant of Base.
 
@@ -35,7 +35,7 @@ module X12
     def initialize(name, type, required, min_length, max_length, validation)
       @name       = name       
       @type       = type       
-      @required   = required == 'R' ? true : false   
+      @required   = required
       @min_length = min_length.to_i
       @max_length = max_length.to_i 
       @validation = validation
@@ -69,15 +69,22 @@ module X12
       @content = nil
     end
 
-    # Returns string regexp for this field, takes field separator as an argument
-    def str_regexp(sep)
-      min = required ? @min_length : 0
+    # Returns simplified string regexp for this field, takes field separator and segment separator as arguments
+    def simple_regexp(field_sep, segment_sep)
       case self.type
-      when 'I'      : "\\d{#{min},#{@max_length}}"
-      when 'S'      : "[^#{Regexp.escape(sep)}]{#{min},#{@max_length}}"
-      when /C.*/    : "[^#{Regexp.escape(sep)}]{#{min},#{@max_length}}"
       when /"(.*)"/ : $1
-      else ''
+      else "[^#{Regexp.escape(field_sep)}#{Regexp.escape(segment_sep)}]*"
+      end # case
+    end # simple_regexp
+
+    # Returns proper validating string regexp for this field, takes field separator and segment separator as arguments
+    def proper_regexp(field_sep, segment_sep)
+      case self.type
+      when 'I'      : "\\d{#{@min_length},#{@max_length}}"
+      when 'S'      : "[^#{Regexp.escape(field_sep)}#{Regexp.escape(segment_sep)}]{#{@min_length},#{@max_length}}"
+      when /C.*/    : "[^#{Regexp.escape(field_sep)}#{Regexp.escape(segment_sep)}]{#{@min_length},#{@max_length}}"
+      when /"(.*)"/ : $1
+      else "[^#{Regexp.escape(field_sep)}#{Regexp.escape(segment_sep)}]*"
       end # case
     end # str_regexp
 

data/lib/X12/Parser.rb

@@ -21,56 +21,76 @@
 #     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 #++
 #
+
+require "rexml/document"
+include REXML 
+
+require 'pp'
+
 module X12
 
-  # $Id: Parser.rb 54 2009-03-18 17:04:45Z ikk $
+  # $Id: Parser.rb 89 2009-05-13 19:36:20Z ikk $
   #
   # Main class for creating X12 parsers and factories.
 
   class Parser
 
+    # These constitute prohibited file names under Microsoft
+    MS_DEVICES = [   
+                  'CON',
+                  'PRN',
+                  'AUX',
+                  'CLOCK$',
+                  'NUL',
+                  'COM1',
+                  'LPT1',
+                  'LPT2',
+                  'LPT3',
+                  'COM2',
+                  'COM3',
+                  'COM4',
+                 ]
+
     # Creates a parser out of a definition
     def initialize(file_name)
       save_definition = @x12_definition
+
+      # Deal with Microsoft devices
+      base_name = File.basename(file_name, '.xml')
+      if MS_DEVICES.find{|i| i == base_name}
+        file_name = File.join(File.dirname, "#{base_name}_.xml")
+      end
       #puts "Reading definition from #{file_name}"
+
+      # Read and parse the definition
       str = File.open(file_name, 'r').read
-      @dir_name = File.dirname(file_name) # to look up other files if needed
-      treetop_parser = X12::X12syntaxParser.new
-      res = treetop_parser.parse(str)
-      throw Exception.new("Cannot parse X12 definition in #{file_name}") unless res
-      @x12_definition = res.get
+      @dir_name = File.dirname(File.expand_path(file_name)) # to look up other files if needed
+      @x12_definition = X12::XMLDefinitions.new(str)
 
       # Populate fields in all segments found in all the loops
       @x12_definition[X12::Loop].each_pair{|k, v|
-        #puts "Processing loop #{k}"
+        #puts "Populating definitions for loop #{k}"
         process_loop(v)
       } if @x12_definition[X12::Loop]
-#       @x12_definition.keys.each{|t|
-#         puts "**** #{t}"
-        
-#         case 
-#           when t==X12::Segment: @x12_definition[t].each{|i| puts i.inspect; puts i.regexp.source}
-#           when t==X12::Loop:    @x12_definition[t].each{|i| puts i.inspect.gsub(/\\*\"/, '"') ; puts i.regexp.source}
-#         else
-#           puts @x12_definition[t].inspect
-#         end
-#         puts "\n\n"
-#       }
-
-      # Merge the saved definition, if any, into the newly parsed one
-      return unless save_definition
-      save_definition.keys.each{|t|
-        @x12_definition[t] ||= {}
-        save_definition[t].keys.each{|u|
-          @x12_definition[t][u] = save_definition[t][u] 
+
+      # Merge the newly parsed definition into a saved one, if any.
+      if save_definition
+        @x12_definition.keys.each{|t|
+          save_definition[t] ||= {}
+          @x12_definition[t].keys.each{|u|
+            save_definition[t][u] = @x12_definition[t][u] 
+          }
+          @x12_definition = save_definition
         }
-      }
+      end
 
-    end
+      #puts PP.pp(self, '')
+    end # initialize
 
     # Parse a loop of a given name out of a string. Throws an exception if the loop name is not defined.
     def parse(loop_name, str)
       loop = @x12_definition[X12::Loop][loop_name]
+      #puts "Loops to parse #{@x12_definition[X12::Loop].keys}"
       throw Exception.new("Cannot find a definition for loop #{loop_name}") unless loop
       loop = loop.dup
       loop.parse(str)
@@ -85,6 +105,8 @@ module X12
       return loop
     end # factory
 
+    private
+
     # Recursively scan the loop and instantiate fields' definitions for all its
     # segments
     def process_loop(loop)
@@ -99,9 +121,10 @@ module X12
 
     # Instantiate segment's fields as previously defined
     def process_segment(segment)
+      #puts "Trying to process segment #{segment.inspect}"
       unless @x12_definition[X12::Segment] && @x12_definition[X12::Segment][segment.name]
         # Try to find it in a separate file if missing from the @x12_definition structure
-        initialize(File.join(@dir_name, segment.name+'.d12'))
+        initialize(File.join(@dir_name, segment.name+'.xml'))
         segment_definition = @x12_definition[X12::Segment][segment.name]
         throw Exception.new("Cannot find a definition for segment #{segment.name}") unless segment_definition
       else
@@ -113,7 +136,7 @@ module X12
         table = segment.nodes[i].validation
         if table
           unless @x12_definition[X12::Table] && @x12_definition[X12::Table][table]
-            initialize(File.join(@dir_name, table+'.d12'))
+            initialize(File.join(@dir_name, table+'.xml'))
             throw Exception.new("Cannot find a definition for table #{table}") unless @x12_definition[X12::Table] && @x12_definition[X12::Table][table]
           end
         end

data/lib/X12/Segment.rb

@@ -23,7 +23,7 @@
 #
 module X12
 
-  # $Id: Segment.rb 54 2009-03-18 17:04:45Z ikk $
+  # $Id: Segment.rb 82 2009-05-13 18:07:22Z ikk $
   #
   # Implements a segment containing fields or composites
     
@@ -69,14 +69,16 @@ module X12
         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|
-            s+i.str_regexp(field_separator)+Regexp.escape(field_separator)
-          } + '?'+Regexp.escape(segment_separator)
+            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 @regexp
+        #puts sprintf("%s %p", name, @regexp)
       end
       @regexp
     end

data/lib/X12/XMLDefinitions.rb

@@ -0,0 +1,160 @@
+#--
+#     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) 2008 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
+#++
+#
+
+require "rexml/document"
+include REXML 
+
+module X12
+
+  # $Id: XMLDefinitions.rb 90 2009-05-13 19:51:27Z ikk $
+  #
+  # A class for parsing X12 message definition expressed in XML format.
+
+  class XMLDefinitions < Hash
+
+    # Parse definitions out of XML file
+    def initialize(str)
+      doc = Document.new(str)
+      definitions = doc.root.name =~ /^Definition$/i ? doc.root.elements.to_a : [doc.root]
+      definitions.each { |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 # initialize
+
+    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 # case
+    end #parse_boolean
+
+    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 # case
+    end #parse_type
+
+    def parse_int(s)
+      return case s
+             when nil : 0
+             when /^\d+$/ : s.to_i
+             when /^inf(inite)?$/ : 999999
+             else
+               nil
+             end # case
+    end #parse_int
+
+    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 = 999999 if max == 0
+
+      return name, min, max, type, required, validation
+    end # parse_attributes
+
+    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 # parse_field
+
+    def parse_table(e)
+      name, min, max, type, required, validation = parse_attributes(e)
+
+      content = e.get_elements("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.get_elements("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.get_elements("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.elements.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 # case
+      }
+      Loop.new(name, components, Range.new(min, max))
+    end
+
+  end # Parser
+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>