Merge pull request #9 from CloudCray/location_limits

Eligibility or Benefit Additional Info (Place of Service)

Author: jdavisp3

README.md

@@ -1,6 +1,14 @@
 TigerShark is an X12 EDI message parser that can be tailored to
 a specific partner in the health care payment ecosystem.
 
+Version 0.3.2
+-------------
+
+* Support for EligibilityOrBenefitAdditionalInformation - `additional_information` property added to EligibilityOrBenefit to handle `III*ZZ*` segments
+* Adds `place_of_service` enum for corresponding `additional_information` property
+* Cleans up unittest warnings (`assertEquals` replaced with `assertEqual`)
+* More descriptive and reliable `.to_dict` and `.to_json` methods.
+
 Version 0.3.1
 -------------
 
@@ -248,5 +256,12 @@ the tests that currently exist, run the following in the current directory.
 python -m unittest discover
 ```
 
+To limit tests to the `tests` directory (ignoring all tests in the `web` directory), run the following:
+
+
+```sh
+python -m unittest discover -s 'tests'
+```
+
 Note that if you first `cd tests` and then run the unit tests, they will fail
 because the tests expect certain files to be in certain paths.

tests/271-example-3.txt

@@ -0,0 +1,78 @@
+ISA|00|          |00|          |ZZ|ZIRMED         |ZZ|10864          |160405|1354|}|00501|000184077|1|P|^~
+GS|HB|ZIRMED|10864|20160301|1354|184065|X|005010X279A1~
+ST|271|0001|005010X279A1~
+BHT|0022|11|94309|20160301|134403~
+HL|1||20|1~
+NM1|PR|2|MEDICA COM|||||PI|123456789~
+HL|2|1|21|1~
+NM1|1P|1|James|Barraret|J.|||XX|1234567894~
+HL|3|2|22|0~
+TRN|2|434343434|9ZIRMEDCOM|ELR ID~
+TRN|1|422422424|9ZIRMEDCOM|ELI ID~
+NM1|IL|1|SMITH|JOHN||||MI|1234567899~
+REF|18|0404044~
+REF|6P|030030001000120|NEVADA EXCHANGE~
+N3|4040 VILLAGE AB~
+N4|KANSAS CITY|MO|64108~
+DMG|D8|19430813|M~
+INS|Y|18|001|25~
+DTP|346|D8|20160201~
+DTP|472|D8|20160601~
+DTP|356|D8|20141208~
+EB|L|EMP|30|EP~
+MSG|PCP SELECTION NOT REQUIRED~
+EB|W~
+LS|2120~
+NM1|PR|2|Mala Compania~
+N3|PO Box 983322~
+N4|El Fixato|TX|68887~
+LE|2120~
+EB|1|EMP|30|EP|Open Access Elect Choice~
+EB|G|IND|30||||2100|||||Y~
+MSG|MAXIMUM SAVINGS,QUALIFIED HEALTH PLAN DESIGNATED PROVIDERS~
+MSG|INT MED AND RX~
+EB|G|IND|30|||29|2100|||||Y~
+EB|F|EMP|30|||||||||Y~
+MSG|PLAN REQUIRES PRECERT~
+EB|F|EMP|30~
+MSG|COMMERCIAL~
+EB|F|EMP|30|||32~
+MSG|UNLIMITED LIFETIME BENEFITS~
+EB|1|EMP|1}33}47}48}50}86}98}UC}AL}MH}88||Open Access Elect Choice~
+EB|A|EMP|33|||||0||||Y~
+MSG|MAXIMUM SAVINGS,QUALIFIED HEALTH PLAN DESIGNATED PROVIDERS~
+MSG|CHIROPRACTOR VISIT OR EVALUATION IN OFFICE~
+MSG|LAB PERFORMED BY CHIROPRACTOR IN OFFICE~
+MSG|XRAY BY CHIROPRACTOR IN OFFICE~
+EB|A|EMP|86|||||0||||Y~
+MSG|MAXIMUM SAVINGS,QUALIFIED HEALTH PLAN DESIGNATED PROVIDERS~
+MSG|EMERGENCY ROOM PHYSICIAN~
+MSG|EMERGENCY USE OF EMERGENCY ROOM~
+MSG|URGENT CARE~
+EB|A|EMP|98|||||.1||||Y~
+MSG|MAXIMUM SAVINGS,QUALIFIED HEALTH PLAN DESIGNATED PROVIDERS~
+MSG|GYN VISIT,COINS APPLIES TO OUT OF POCKET~
+MSG|SPECIALIST VISIT OR EVALUATION,COINS APPLIES TO OUT OF POCKET~
+MSG|PRIMARY CARE VISIT OR EVALUATION,COINS APPLIES TO OUT OF POCKET~
+III|ZZ|11~
+EB|B|EMP|33||||20|||||Y~
+MSG|MAXIMUM SAVINGS,QUALIFIED HEALTH PLAN DESIGNATED PROVIDERS~
+MSG|CHIROPRACTOR VISIT OR EVALUATION IN OFFICE,COPAY INCLUDED IN OOP~
+MSG|LAB PERFORMED BY CHIROPRACTOR IN OFFICE,COPAY INCLUDED IN OOP~
+MSG|XRAY BY CHIROPRACTOR IN OFFICE,COPAY INCLUDED IN OOP~
+EB|F|IND|33|||||||||Y~
+HSD|VS|35|||21|1~
+MSG|SHT TRM RHB OP,MANIPULATION BY CHIROPRACTOR,OCCUPATIONAL THERAPY BY CHIROPRACTOR,PHYSICAL THERAPY BY CHIROPRACTOR~
+EB|F|IND|33|||||||||Y~
+HSD|VS|35|||29~
+MSG|SHT TRM RHB OP~
+EB|I|EMP|86|||||||||Y~
+MSG|NON EMERGENCY USE OF EMERGENCY ROOM/EXCLUSION~
+EB|I|EMP|86}UC|||||||||Y~
+MSG|NON URGENT SERVICES AT AN URGENT CARE FACILITY/EXCLUSION~
+EB|F|EMP|1}33}48}50}86}98}UC~
+MSG|PLAN INCLUDES NAP~
+EB|I|EMP|1}33}48}50}86}98}UC|||||||||N~
+SE|74|0001~
+GE|1|184065~
+IEA|1|000184077~

tests/__init__.py

@@ -39,11 +39,13 @@
 from tigershark import X12_4010_X096A1
 from tigershark import X12_4010_X098A1
 from tigershark import X12_5010_X221A1
+from tigershark import X12_5010_X279A1
 
 # (Transaction Set, X12VersionTuple) -> test file name
 TEST_FILE_MAP = {
     ('271', X12_4010_X092A1): '271-dependent-benefits.txt',
     ('271', X12_4010_X092A1): '271-example-2.txt',
+    ('271', X12_5010_X279A1): '271-example-3.txt',
     ('271', X12_4010_X092A1): '271-example-dependent-rejection.txt',
     ('271', X12_4010_X092A1): '271-example.txt',
     ('271', X12_4010_X092A1): '271-related-entity.txt',

tests/test_271_benefit_additional_info.py

@@ -0,0 +1,29 @@
+import unittest
+import logging
+import sys
+
+
+from tigershark.facade import f271
+from tigershark.parsers import M271_5010_X279_A1
+
+
+class TestBenefitAdditionalInfo(unittest.TestCase):
+    def test_benefit_additional_info(self):
+        m = M271_5010_X279_A1.parsed_271
+        with open('tests/271-example-3.txt') as f:
+            parsed = m.unmarshall(f.read().strip())
+        f = f271.F271_5010(parsed)
+
+        subscriber = f.facades[0].subscribers[0]
+        benefit_row = subscriber.eligibility_or_benefit_information[11]
+        additional_information = benefit_row.additional_information[0]
+        self.assertEqual(additional_information, ('11', 'Office'))
+        self.assertEqual(len(benefit_row.messages), 4)
+
+
+if __name__ == "__main__":
+    logging.basicConfig(
+        stream=sys.stderr,
+        level=logging.INFO,
+    )
+    unittest.main()

tests/test_json_parsing.py

@@ -28,6 +28,38 @@ def test_json_271(self):
         except TypeError:
             self.fail(".to_json() raised TypeError")
 
+    def test_json_271_segments(self):
+        m = M271_4010_X092_A1.parsed_271
+        with open('tests/271-example-2.txt') as f:
+            parsed = m.unmarshall(f.read().strip())
+        f = f271.F271_4010(parsed)
+        js_data = f.to_dict()
+        self.assertEqual(js_data["transaction_set_identifier_code"], "271")
+
+        source = js_data["facades"][0]["source"]
+        self.assertEqual(source["loopName"], "2000A")
+
+        subscriber = source["receivers"][0]["subscribers"][0]
+        self.assertEqual(subscriber["personal_information"]["name"]["first_name"], "JANET")
+        self.assertEqual(
+            subscriber["personal_information"]["demographic_information"]["gender"],
+            {"code": "F", "label": "Female"}
+        )
+
+        elig_info = subscriber["eligibility_or_benefit_information"]
+        self.assertEqual(len(elig_info), 109)
+
+        benefit = elig_info[14]
+        self.assertEqual(benefit["coverage_information"]["benefit_amount"], 1500)
+        self.assertEqual(
+            benefit["coverage_information"]["coverage_level"],
+            {"code": "IND", "label": "Individual"}
+        )
+        self.assertEqual(
+            benefit["coverage_information"]["information_type"],
+            {"code": "G", "label": "Out of Pocket (Stop Loss)"}
+        )
+
     def test_json_835_5010(self):
         m = M835_5010_X221_A1.parsed_835
         with open('tests/5010-835-example-1.txt') as f:
@@ -48,6 +80,7 @@ def test_json_271_5010(self):
         except TypeError:
             self.fail(".to_json() raised TypeError")
 
+
 if __name__ == "__main__":
     logging.basicConfig(
         stream=sys.stderr,

tests/test_navigation.py

@@ -30,30 +30,30 @@ def setUp(self):
 
     def testChild(self):
         loops = self.message.child("LOOP")
-        self.assertEquals(1, len(loops))
+        self.assertEqual(1, len(loops))
         segs = self.message.child("SEGMENT")
-        self.assertEquals(0, len(segs))
+        self.assertEqual(0, len(segs))
         isaList = self.message.child("LOOP", name="ISA")
-        self.assertEquals(1, len(isaList))
+        self.assertEqual(1, len(isaList))
         ieaList = isaList[0].child("SEGMENT", name="IEA")
-        self.assertEquals(1, len(ieaList))
+        self.assertEqual(1, len(ieaList))
 
     def testDescendant(self):
         geList = self.message.descendant("SEGMENT", name="GE")
-        self.assertEquals(1, len(geList))
+        self.assertEqual(1, len(geList))
 
     def testParent(self):
         geList = self.message.descendant("SEGMENT", name="GE")
-        self.assertEquals(1, len(geList))
+        self.assertEqual(1, len(geList))
         ge = geList[0]
-        self.assertEquals(0, len(ge.parent("SEGMENT")))
+        self.assertEqual(0, len(ge.parent("SEGMENT")))
         parentList = ge.parent("LOOP")
-        self.assertEquals(1, len(parentList))
-        self.assertEquals("GS", parentList[0].name)
+        self.assertEqual(1, len(parentList))
+        self.assertEqual("GS", parentList[0].name)
 
     def testAncestor(self):
         geList = self.message.descendant("SEGMENT", name="GE")
-        self.assertEquals(1, len(geList))
+        self.assertEqual(1, len(geList))
         ge = geList[0]
         isaList = ge.ancestor("LOOP", name="ISA")
-        self.assertEquals(1, len(isaList))
+        self.assertEqual(1, len(isaList))

tests/test_parse.py

@@ -54,8 +54,8 @@ def testBadLoop(self):
             Message("bad", Properties(desc="bad")))
 
     def testMessage(self):
-        self.assertEquals(parse_278, loop2000F.message)
-        self.assertEquals("278", loop2000A.message.name)
+        self.assertEqual(parse_278, loop2000F.message)
+        self.assertEqual("278", loop2000A.message.name)
 
 
 class TestSegmentMatch(unittest.TestCase):
@@ -87,14 +87,14 @@ def setUp(self):
 
     def testTokenize(self):
         _, _, _, tokens = parse_278.tokenize(self.msg1)
-        self.assertEquals(28, len(tokens))
-        self.assertEquals(17, len(tokens[0]))  # The ISA Segment
-        self.assertEquals("ISA", tokens[0][0])
-        self.assertEquals("GS", tokens[1][0])
-        self.assertEquals("ST", tokens[2][0])
-        self.assertEquals("SE", tokens[-3][0])
-        self.assertEquals("GE", tokens[-2][0])
-        self.assertEquals("IEA", tokens[-1][0])
+        self.assertEqual(28, len(tokens))
+        self.assertEqual(17, len(tokens[0]))  # The ISA Segment
+        self.assertEqual("ISA", tokens[0][0])
+        self.assertEqual("GS", tokens[1][0])
+        self.assertEqual("ST", tokens[2][0])
+        self.assertEqual("SE", tokens[-3][0])
+        self.assertEqual("GE", tokens[-2][0])
+        self.assertEqual("IEA", tokens[-1][0])
 
     def testISAMatch(self):
         _, _, _, tokens = parse_278.tokenize(self.msg1)
@@ -104,7 +104,7 @@ def testISAMatch(self):
 
     def testParse(self):
         message = parse_278.unmarshall(self.msg1)
-        self.assertEquals(self.msg1, message.marshall())
+        self.assertEqual(self.msg1, message.marshall())
 
 
 class TestVisitor1(unittest.TestCase):
@@ -143,7 +143,7 @@ def testPythonVisitorWorks(self):
         self.assertEqual(type(parse_278), Message)
         msg = parse_278.unmarshall(self.msg1)
         # XXX - check the resulting structure
-        self.assertEquals(self.msg1, msg.marshall())
+        self.assertEqual(self.msg1, msg.marshall())
 
 
 class TestSQLVisitor(unittest.TestCase):

tests/test_wsClaims.py

@@ -60,18 +60,18 @@ def test_01_Load( self ):
         result= response.read()
         #print( result )
         self.client.close()
-        self.assertEquals( "CREATED", response.reason )
+        self.assertEqual( "CREATED", response.reason )
         object= json.loads(result)
-        self.assertEquals( claimId, object['claim_id'] )
+        self.assertEqual( claimId, object['claim_id'] )
     def test_02_Fetch( self ):
         claimId= self.claimDict["CLAIM-ID"]
         self.client.request( 'GET', "/claim/{0}/".format(claimId), headers=self.headers )
         response= self.client.getresponse()
         result= response.read()
         self.client.close()
         object= json.loads(result)
-        self.assertEquals( "OK", response.reason )
-        self.assertEquals( self.claimText, object['claim'] )
+        self.assertEqual( "OK", response.reason )
+        self.assertEqual( self.claimText, object['claim'] )
     def test_03_Fetch( self ):
         claimId= '837_example'
         self.client.request( 'GET', "/claim_837/{0}/".format(claimId), headers=self.headers )
@@ -80,7 +80,7 @@ def test_03_Fetch( self ):
         self.client.close()
         object= json.loads(result)
         #print( result )
-        self.assertEquals( "OK", response.reason )
+        self.assertEqual( "OK", response.reason )
         print( object['claim'] )
 
 def setUpModule():

tigershark/X12/parse.py

@@ -402,7 +402,7 @@ class Parser( object ):
     Message parsing breaks the source message down into
     a flat list of segment tokens.  Then the structure defined
     by Segment, Element and Loop is imposed on those segment tokens.
-    to build the X12Message from X12Loop and X12Segment.
+    to build the X12Message from tigershark.X12Loop and X12Segment.
 
     There are several properties:
 
@@ -513,10 +513,14 @@ def getParts( self, segments, theLoop ):
         """
         for part in self.structure:
             count= 0
-            for subloop in part.parse( segments ):
-                subloop.occurrence= count
-                theLoop.addChild( subloop )
-                count += 1
+            segment_parts = part.parse( segments )
+            try:
+                for subloop in segment_parts:
+                    subloop.occurrence= count
+                    theLoop.addChild( subloop )
+                    count += 1
+            except StopIteration:
+                return
     def visit( self, visitor, indent=0 ):
         """Iterate through the components."""
         try:
@@ -694,7 +698,7 @@ def parse( self, segments ):
                 theSegment= self.theFactory.makeSegment( segments.pop(0), compPunct, self )
                 yield theSegment
             elif not required:
-                raise StopIteration
+                return
             else:
                 error= ParseError(
                     "Could not unmarshall {seg_name} Segment, "\
@@ -756,7 +760,10 @@ def parse( self, segments ):
                     structure=[s.name for s in self.structure]))
                 theLoop = self.theFactory.makeLoop(self.name)
                 self.getParts(segments, theLoop)
-                yield theLoop
+                try:
+                    yield theLoop
+                except StopIteration:
+                    return                
             elif self.structure[i].situational and \
                     segments[0][0] in [s.name for s in self.structure]:
                 # Absence of a situational segment shouldn't exit
@@ -765,7 +772,7 @@ def parse( self, segments ):
                 i += 1
             else:
                 # Nothing left to check, so stop the iteration
-                raise StopIteration
+                return
 
     def match( self, candidate ):
         return self.structure[0].match( candidate )

tigershark/__init__.py

@@ -2,7 +2,7 @@
 TigerShark - An X12 EDI message parser.
 """
 __all__ = ['X12VersionTuple']
-__version__ = "0.3.1"
+__version__ = "0.3.2"
 __authors__ = [
     "Steven Buss <[email protected]>",
     "Steven Lott <[email protected]>",