hippo 0.0.4

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/*
+*.gem
+.bundle
+*.swp
+.DS_STORE
+Gemfile.lock

data/CHANGELOG

@@ -0,0 +1,9 @@
+0.0.3 - Pending
+	* Fix issue when no values are set in any subfield of a composite field.
+	* Add more segment tests.
+
+0.0.2 - 2011-09-06
+	* Import all segments and loops from the X12 CSV Table Data
+
+0.0.1 - 2011-02-05
+	* Intial version.

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in hippo.gemspec
+gemspec
+
+group :development do
+  gem 'rb-fsevent'
+  gem 'growl_notify'
+  gem 'guard-minitest'
+  gem 'pry'
+end

data/Guardfile

@@ -0,0 +1,14 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'minitest' do
+  # with Minitest::Unit
+  watch(%r|^test/test_(.*)\.rb|)
+  watch(%r|^lib/(.+).rb|)             { "test" }
+  watch(%r|^test/test_helper\.rb|)    { "test" }
+
+  # with Minitest::Spec
+  # watch(%r|^spec/(.*)_spec\.rb|)
+  # watch(%r|^lib/(.*)\.rb|)            { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end

data/README.md

@@ -0,0 +1,227 @@
+Hippo
+=====
+
+The Hippo library is an attempt at creating a simple DSL to generate and parse HIPAA 
+transaction sets.  HIPAA or the Health Insurance Portability Accountability Act is a 
+series of regulations which place restrictions and requirements on the way transaction 
+sets  (ie. Claims, Remittances, Eligibility, Claim Status, etc.) must be formatted.
+
+The HIPAA required transactions sets are created by the X12
+organization. The current production version (as of 2011/02/05) is 4010A1, but
+effective 2012/01/01 all organizations must be migrated to using version
+5010.
+
+To obtain copies of the implementation guides you must purchase them from the X12
+organization. The implementation data is also available in tabular format (CSV).  The 
+transaction sets, loops, and segments in Hippo were created from the X12 CSV Table Data.
+
+More information can be found at the following sites:
+
+* [General HIPAA information from CMS](https://www.cms.gov/HIPAAGenInfo/01_Overview.asp)
+* [Wikipedia HIPAA Article](http://en.wikipedia.org/wiki/Hipaa)
+* [5010 Implementation Timeline](https://www.cms.gov/ElectronicBillingEDITrans/18_5010D0.asp)
+* [X12 Store](https://store.x12.org)
+
+Installation
+------------
+    gem install hippo
+
+Usage
+-----
+This is very straight forward. Basically, create an instance of the
+transaction set that you will be working with, and start filling in the
+loops, segments, and fields.  For a complete example from the 222A1 (837-P) implementation
+guide please review [test/test_hipaa_837.rb](/promedical/hippo/test/test_hipaa_837.rb).
+
+Below is a small sample of how to create a transaction set.
+
+```ruby
+    ts = Hippo::TransactionSets::HIPAA_837::Base.new
+
+    ts.ST do |st|
+      st.TransactionSetControlNumber        = '0021'
+      st.ImplementationConventionReference  = '005010X222A1'
+    end
+
+    ts.BHT do |bht|
+      bht.TransactionSetPurposeCode = '00'
+      bht.ReferenceIdentification   = '244579'
+      bht.Date                      = '20061015'
+      bht.Time                      = '1023'
+      bht.TransactionTypeCode       = 'CH'
+    end
+
+    ts.L1000A do |l1000a|
+      l1000a.NM1 do |nm1|
+        nm1.EntityTypeQualifier        = '2'
+        nm1.NameLastOrOrganizationName = 'PREMIER BILLING SERVICE'
+        nm1.IdentificationCode         = 'TGJ23'
+      end
+
+      l1000a.PER do |per|
+        per.Name                            = 'JERRY'
+        per.CommunicationNumberQualifier_01 = 'TE'
+        per.CommunicationNumber_01          = '3055552222'
+        per.CommunicationNumberQualifier_02 = 'EX'
+        per.CommunicationNumber_02          = '231'
+      end
+    end
+
+    puts ts.to_s
+    
+    => "ST*837*0021*005010X222A1~BHT*0019*00*244579*20061015*1023*CH~NM1*41*2*PREMIER BILLING SERVICE*****46*TGJ23~PER*IC*JERRY*TE*3055552222*EX*231~"
+```    
+
+Transaction Set/Loop and Segment DSL
+------------------------------------
+Transaction Sets/Loops and Segments are defined with a very straight forward DSL.
+
+```ruby
+    module Hippo::Segments
+      class TestSimpleSegment < Hippo::Segments::Base
+        segment_identifier 'TSS'
+    
+        field :name => 'Field1'
+        field :name => 'Field2'
+        field :name => 'Field3'
+        field :name => 'Field4'
+        field :name => 'CommonName'
+        field :name => 'CommonName'
+      end
+    
+      class TestCompoundSegment < Hippo::Segments::Base
+        segment_identifier 'TCS'
+    
+        composite_field 'CompositeField' do
+          field :name => 'Field1'
+          field :name => 'Field2'
+          field :name => 'Field3'
+          field :name => 'CompositeCommonName'
+        end
+    
+        composite_field 'CompositeField' do
+          field :name => 'Field4'
+          field :name => 'Field5'
+          field :name => 'Field6'
+          field :name => 'CompositeCommonName'
+        end
+    
+        field :name => 'Field7'
+      end
+    end
+    
+    module Hippo::TransactionSets
+      module Test
+        class Base < Hippo::TransactionSets::Base
+    
+          segment Hippo::Segments::TestSimpleSegment,
+                    :name           => 'Test Simple Segment #1',
+                    :minimum        => 1,
+                    :maximum        => 5,
+                    :position       => 50,
+                    :defaults => {
+                      'TSS01' => 'Blah'
+                    }
+    
+          segment Hippo::Segments::TestCompoundSegment,
+                    :name           => 'Test Compound Segment #2',
+                    :minimum        => 1,
+                    :maximum        => 1,
+                    :position       => 100,
+                    :defaults => {
+                      'Field7' => 'Preset Field 7'
+                    }
+    
+          segment Hippo::Segments::TestSimpleSegment,
+                    :name           => 'Test Simple Segment #3',
+                    :minimum        => 1,
+                    :maximum        => 1,
+                    :position       => 50,
+                    :defaults => {
+                      'TSS01' => 'Last Segment'
+                    }
+        end
+      end
+    end
+```
+
+Quick Guide to Populating a Transaction Set
+-------------------------------------------
+Using the simple transaction set and segments defined above, here are a few ways to access
+the fields.
+
+To create a transaction set simple choose the set you want and call new on it's Base class.
+
+```ruby
+    ts = Hippo::TransactionSets::Test::Base.new
+```
+
+The segments can be accessed directly from the created transaction set using the segment
+identifier.
+
+```ruby
+    ts.TCS
+```
+
+Since the TSS segment can be repeated we must call #build to generate a new
+instance for each repeat. (You will be returned the first instance each time if you
+do not call #build.)
+
+```ruby
+    ts.TSS.build
+```
+
+The code above produces the following string output (notice how the values from 
+:defaults are prefilled, and the output is automatically sorted based on the order
+that the segments were declared):
+
+```ruby
+    # ts.to_s => 'TSS*Blah~TCS***Preset Field 7~'
+```
+
+To set field values on a given segment you can access it either by calling the field directly
+on the segment or by passing a block to the segment.
+
+```ruby
+    # this is one way to populate the fields
+    ts.TCS.Field1 = 'Foo'
+    ts.TSS.Field2 = 'Bar'
+
+    # this is another way
+    ts.TCS do |tcs|
+      tcs.Field1 = 'Foo'
+    end
+    
+    ts.TSS do |tss|
+      tss.Field2 = 'Bar'
+    end
+    
+    # both of the mechanisms above have the same string representation:
+    #
+    # ts.to_s => 'TSS*Blah*Bar~TCS*Foo**Preset Field 7~'
+```
+
+If you read the transaction set declaration from above you will notice that the TSS segment
+can be set in two different sequences (with different preset values).  By default (as you
+can see from the previous example) when we call TSS we are referring to the first segment,
+but if you need to access the second instance of TSS in the transaction set you would specify
+TSS_02 instead.
+
+```ruby
+    ts.TCS.Field1 = 'Foo'
+    ts.TSS.Field2 = 'Bar'
+    ts.TSS_02.Field2 = 'Baz'
+
+    # ts.to_s => 'TSS*Blah*Bar~TCS*Foo**Preset Field 7~TSS*Last Segment*Baz~'
+```
+
+The same technique can be used to reference fields within a segment that have the same name.
+
+```ruby
+    ts.TSS.CommonName = 'Value1'
+    ts.TSS.CommonName_02 = 'Value2'
+
+    # ts.to_s => 'TSS*Blah*Bar***Value1*Value2~TCS*Foo**Preset Field 7~TSS*Last Segment*Baz~'
+```
+
+For more example please review the test suite.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+require 'rake/testtask'
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/test_*.rb']
+  t.verbose = true
+end
+
+
+task :default => [:test]

data/bin/demo_270.rb

@@ -0,0 +1,280 @@
+require './lib/hippo.rb'
+require 'pp'
+
+class Demo270
+  def self.run
+    ts = Hippo::TransactionSets::HIPAA_270::Base.new
+
+    ts.ST do |seg|
+      seg.TransactionSetIdentifierCode = "270"
+      seg.TransactionSetControlNumber = rand(10 * 100)
+    end
+
+    ts.BHT do |seg|
+      seg.HierarchicalStructureCode = '0001'
+      seg.TransactionSetPurposeCode = '00'
+      seg.ReferenceIdentification = ''
+      seg.Date = ''
+      seg.Time = ''
+      seg.TransactionTypeCode = ''
+    end
+
+    ts.L2000A do |loop|
+      loop.HL do |seg|
+        seg.HierarchicalIdNumber = ''
+        seg.HierarchicalParentIdNumber = ''
+        seg.HierarchicalLevelCode = ''
+        seg.HierarchicalChildCode = ''
+      end 
+      loop.L2100A do |sub_loop|
+        sub_loop.NM1 do |seg|
+          seg.EntityIdentifierCode1 = ''
+          seg.EntityTypeQualifier = ''
+          seg.NameLastOrOrganizationName = ''
+          seg.NameFirst = ''
+        end
+      end
+    end
+    
+    ts.L2000B do |loop|
+      loop.HL do |seg|
+        seg.HierarchicalIdNumber = ''
+        seg.HierarchicalParentIdNumber = ''
+        seg.HierarchicalLevelCode = ''
+        seg.HierarchicalChildCode = ''
+      end
+      loop.L2100B do |sub_loop|
+        sub_loop.NM1 do |seg|
+          seg.EntityIdentifierCode1 = ''
+          seg.EntityTypeQualifier = ''
+          seg.NameLastOrOrganizationName = ''
+          seg.NameFirst = ''
+        end
+        sub_loop.REF do |seg|
+          seg.ReferenceIdentificationQualifier = ""
+          seg.ReferenceIdentification = ""
+          seg.Description = ""
+          seg.ReferenceIdentifier = ""
+        end
+        sub_loop.N3 do |seg|
+          seg.AddressInformation1 = ""
+          seg.AddressInformation2 = ""
+        end
+        sub_loop.N4 do |seg|
+					seg.CityName = ""
+					seg.StateOrProvinceCode = ""
+					seg.PostalCode = ""
+					seg.CountryCode = ""
+				end
+				sub_loop.PER do |seg|
+					seg.ContactFunctionCode = ""
+					seg.Name = ""
+				end
+				sub_loop.PRV do |seg|
+			    seg.ProviderCode = ""
+			    seg.ReferenceIdentificationQualifier = ""
+			    seg.ReferenceIdentification = ""
+			    seg.StateOrProvinceCode = ""
+			    seg.ProviderSpecialtyInformation = ""
+			    seg.ProviderOrganizationCode = ""
+			  end
+      end
+    end
+    
+    ts.L2000C do |loop|
+      loop.HL do |seg|
+        seg.HierarchicalIdNumber = ''
+        seg.HierarchicalParentIdNumber = ''
+        seg.HierarchicalLevelCode = ''
+        seg.HierarchicalChildCode = ''
+      end
+      loop.TRN do |seg|
+        seg.TraceTypeCode = rand(10 * 100)
+				seg.ReferenceIdentification1 = rand(10 * 100)
+				seg.OriginatingCompanyIdentifier = rand(10 * 100)
+				seg.ReferenceIdentification2 = rand(10 * 100)    
+      end
+      loop.L2100C do |sub_loop|
+        sub_loop.NM1 do |seg|
+          seg.EntityIdentifierCode1 = ''
+          seg.EntityTypeQualifier = ''
+          seg.NameLastOrOrganizationName = ''
+          seg.NameFirst = ''          
+        end
+        sub_loop.REF do |seg|
+          seg.ReferenceIdentificationQualifier = "00"
+          seg.ReferenceIdentification = "R0203"
+          seg.Description = "Description"
+          seg.ReferenceIdentifier = "1241"
+        end
+        sub_loop.N3 do |seg|
+          seg.AddressInformation1 = ""
+          seg.AddressInformation2 = ""
+        end
+        sub_loop.N4 do |seg|
+					seg.CityName = ""
+					seg.StateOrProvinceCode = ""
+					seg.PostalCode = ""
+					seg.CountryCode = ""
+				end
+				sub_loop.PRV do |seg|
+          seg.ProviderCode = ""
+          seg.ReferenceIdentificationQualifier = ""
+          seg.ReferenceIdentification = ""
+          seg.StateOrProvinceCode = ""
+          seg.ProviderSpecialtyInformation = ""
+          seg.ProviderOrganizationCode = ""			    
+			  end
+			  sub_loop.DMG do |seg|
+          seg.DateTimePeriodFormatQualifier = ''
+          seg.DateTimePeriod = ''
+          seg.GenderCode = ''
+          seg.MaritalStatusCode = ''
+          seg.CompositeRaceOrEthnicityInformation = ''
+          seg.CitizenshipStatusCode = ''
+          seg.CountryCode = ''
+          seg.BasisOfVerificationCode = ''
+          seg.Quantity = ''
+          seg.CodeListQualifierCode = ''
+          seg.IndustryCode = ''
+		    end
+		    sub_loop.INS do |seg|
+	        seg.YesNoConditionOrResponseCode = ''
+	        seg.IndividualRelationshipCode = ''
+	      end
+	      sub_loop.DTP do |seg|
+          seg.DateTimeQualifier = ''
+          seg.DateTimePeriodFormatQualifier = ''
+          seg.DateTimePeriod = ''
+        end
+        sub_loop.L2110C do |sub_loop_child|
+         sub_loop_child.EQ do |seg|
+          seg.ServiceTypeCode = ""
+          seg.CoverageLevelCode = ""
+          seg.InsuranceTypeCode = ""
+         end
+         sub_loop_child.AMT do |seg|
+           seg.AmountQualifierCode = ''
+           seg.MonetaryAmount = ''
+           seg.CreditDebitFlagCode = ''
+         end
+         sub_loop_child.III do |seg|
+          seg.CodeListQualifierCode = ""
+          seg.IndustryCode = ""
+         end
+         sub_loop_child.REF do |seg|
+           seg.ReferenceIdentificationQualifier = ""
+           seg.ReferenceIdentification = ""
+           seg.Description = ""
+           seg.ReferenceIdentifier = ""
+         end
+         sub_loop_child.DTP do |seg|
+           seg.DateTimeQualifier = ''
+           seg.DateTimePeriodFormatQualifier = ''
+           seg.DateTimePeriod = ''          
+         end
+        end
+      end
+    end  
+    
+    ts.L2000D do |loop|
+      loop.HL do |seg|
+        seg.HierarchicalIdNumber = ''
+        seg.HierarchicalParentIdNumber = ''
+        seg.HierarchicalLevelCode = ''
+        seg.HierarchicalChildCode = ''
+      end
+      loop.TRN do |seg|
+        seg.TraceTypeCode = rand(10 * 100)
+        seg.ReferenceIdentification1 = rand(10 * 100)
+        seg.OriginatingCompanyIdentifier = rand(10 * 100)
+        seg.ReferenceIdentification2 = rand(10 * 100)
+      end
+      loop.L2100D do |sub_loop|
+        sub_loop.NM1 do |seg|
+          seg.EntityIdentifierCode1 = ''
+          seg.EntityTypeQualifier = ''
+          seg.NameLastOrOrganizationName = ''
+          seg.NameFirst = ''
+        end
+        sub_loop.REF do |seg|
+          seg.ReferenceIdentificationQualifier = ""
+          seg.ReferenceIdentification = ""
+          seg.Description = ""
+          seg.ReferenceIdentifier = ""
+        end
+        sub_loop.N3 do |seg|
+          seg.AddressInformation1 = ""
+          seg.AddressInformation2 = ""
+        end
+        sub_loop.N4 do |seg|
+					seg.CityName = ""
+					seg.StateOrProvinceCode = ""
+					seg.PostalCode = ""
+					seg.CountryCode = ""
+				end
+				sub_loop.PRV do |seg|
+          seg.ProviderCode = ""
+          seg.ReferenceIdentificationQualifier = ""
+          seg.ReferenceIdentification = ""
+          seg.StateOrProvinceCode = ""
+          seg.ProviderSpecialtyInformation = ""
+          seg.ProviderOrganizationCode = ""			    
+			  end
+			  sub_loop.DMG do |seg|
+          seg.DateTimePeriodFormatQualifier = ''
+          seg.DateTimePeriod = ''
+          seg.GenderCode = ''
+          seg.MaritalStatusCode = ''
+          seg.CompositeRaceOrEthnicityInformation = ''
+          seg.CitizenshipStatusCode = ''
+          seg.CountryCode = ''
+          seg.BasisOfVerificationCode = ''
+          seg.Quantity = ''
+          seg.CodeListQualifierCode = ''
+          seg.IndustryCode = ''
+		    end
+		    sub_loop.INS do |seg|
+	        seg.YesNoConditionOrResponseCode = ''
+	        seg.IndividualRelationshipCode = ''
+	      end
+	      sub_loop.DTP do |seg|
+          seg.DateTimeQualifier = ''
+          seg.DateTimePeriodFormatQualifier = ''
+          seg.DateTimePeriod = ''
+        end
+        sub_loop.L2110D do |sub_loop_child|
+          sub_loop_child.EQ do |seg|
+            seg.ServiceTypeCode = ""
+            seg.CoverageLevelCode = ""
+            seg.InsuranceTypeCode = ""
+          end
+          sub_loop_child.III do |seg|
+             seg.CodeListQualifierCode = ""
+             seg.IndustryCode = ""
+          end
+          sub_loop_child.REF do |seg|
+            seg.ReferenceIdentificationQualifier = ""
+            seg.ReferenceIdentification = ""
+            seg.Description = ""
+            seg.ReferenceIdentifier = ""
+          end
+          sub_loop_child.DTP do |seg|
+            seg.DateTimeQualifier = ''
+            seg.DateTimePeriodFormatQualifier = ''
+            seg.DateTimePeriod = ''
+          end
+        end
+      end
+    end
+    ts.SE do |seg|
+      seg.NumberOfIncludedSegments = ''
+      seg.TransactionSetControlNumber = ''
+    end
+    puts ts.to_s 
+  end #end self.run
+end  #end Class Demo270
+
+if __FILE__ == $0
+  Demo270.run
+end