simple_hl7_parser 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e5f0cc54bb86dd2a890752e9a0219b9cb9284f4
-  data.tar.gz: e55a21329ccf060d502a8749df1d5e751c946769
+  metadata.gz: b26dec750f7b5252b1f4e68a88f7c0f586b219d7
+  data.tar.gz: 8a74f31a6bb6f4218190244968b0a1dba4184ec5
 SHA512:
-  metadata.gz: 7540f72fbe66a330fdafcb0ab40c43683f33c061e6c640a2f68b6f91f88db4b18291c7cd946ac46e118b068121a5a69d182f6ab3a874b91f3490d89992b552d2
-  data.tar.gz: 0d17444d62193ab12939ca95e60c87d4276cc8784cba180cca35370375c4f252334f68474c7f4dba394cd1e9b7419b949721e2671b2f5dede7380e6477c5d08d
+  metadata.gz: 1663363f3e54dcb62f8eea9697ca5c82c798c159eacc5fb733b0dca0782269c83708b563df2e35eee7ad54875dca93c02899d74230a4af23f4723c77d1d1a6e1
+  data.tar.gz: e01c04a69770da3edabc71197751f4f0a3f57c67be61a97d9385b9c83d7d7ad7aa269a6f230e8e56a681cb66fb9cec68187669b43e5253b30c6f1d41cc0248ce

data/README.md

@@ -38,16 +38,53 @@ msg.obx.first.observation_value        #=> "^182"
 msg.obx.first.units                    #=> "mg/dl"
 ```
 
-## Development
+## Contributing
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Bug reports and pull requests are welcome on GitHub at https://github.com/sufyanadam/simple_hl7_parser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### Adding support for a HL7 Segment
 
-## Contributing
+Just create a class under the `SimpleHL7Parser` module namespace called
+`XXXSegment` (where `XXX` is a segment name, such as `PID`), include the
+`Segment` module and define a column map. That's it! It's that simple; hence
+the name `SimpleHL7Parser`.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/sufyanadam/simple_hl7_parser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+The column map is a map of `segment_attribute => position_number`. For example,
+the `placer_order_number` is the third element in the `OBR` segment. So the
+column map would define `{placer_order_number: 2}`. The `segment_attribute`
+part of the column map becomes the name of the function you can call to
+retrieve the value of the attribute at the position it maps to.
+
+The example below demonstrates how `SimpleHL7Parser` currently
+supports parsing the `OBR` HL7 segment in Ruby:
+
+Example:
+
+```ruby
+# Extending SimpleHL7Parser to support another
+# HL7 Segment
+require 'simple_hl7_parser/segments/segment'
+
+module SimpleHL7Parser
+  class OBRSegment
+    include Segment
+
+    COLUMN_MAP = {
+      set_id:  1,
+      placer_order_number:  2,
+      filler_order_number:  3,
+      universal_service_id:  4,
+      priority:  5,
+      requested_date_time:  6,
+      observation_date_time:  7,
+      observation_end_date_time:  8,
+    }
+  end
+end
+```
 
+After adding support for a new segment, add a test that demonstrates
+it works correctly and make a pull request :)
 
 ## License
 

data/lib/simple_hl7_parser/hl7.rb

@@ -1,5 +1,9 @@
-require_relative 'hl7_message'
-require_relative 'segment'
+require 'simple_hl7_parser/hl7_message'
+require 'simple_hl7_parser/segments/msh_segment'
+require 'simple_hl7_parser/segments/pid_segment'
+require 'simple_hl7_parser/segments/orc_segment'
+require 'simple_hl7_parser/segments/obr_segment'
+require 'simple_hl7_parser/segments/obx_segment'
 
 module SimpleHL7Parser
   class HL7

data/lib/simple_hl7_parser/segments/msh_segment.rb

@@ -0,0 +1,29 @@
+require 'simple_hl7_parser/segments/segment'
+
+module SimpleHL7Parser
+  class MSHSegment
+    include Segment
+
+    COLUMN_MAP = {
+      field_separator: 1,
+      sending_application: 2,
+      sending_facility: 3,
+      receiving_application: 4,
+      receiving_facility: 5,
+      date_time_of_message: 6,
+      security: 7,
+      message_type: 8,
+      message_control_id: 9,
+      processing_id: 10,
+      version_id: 11,
+      sequence_number: 12,
+      continuation_pointer: 13,
+      accept_acknowledgment_type: 14,
+      application_acknowledgment_type: 15,
+      country_code: 16,
+      character_set: 17,
+      principal_language_of_message: 18,
+      alternate_character_set_handling_Scheme: 19,
+    }
+  end
+end

data/lib/simple_hl7_parser/segments/obr_segment.rb

@@ -0,0 +1,18 @@
+require 'simple_hl7_parser/segments/segment'
+
+module SimpleHL7Parser
+  class OBRSegment
+    include Segment
+
+    COLUMN_MAP = {
+      set_id:  1,
+      placer_order_number:  2,
+      filler_order_number:  3,
+      universal_service_id:  4,
+      priority:  5,
+      requested_date_time:  6,
+      observation_date_time:  7,
+      observation_end_date_time:  8,
+    }
+  end
+end

data/lib/simple_hl7_parser/segments/obx_segment.rb

@@ -0,0 +1,27 @@
+require 'simple_hl7_parser/segments/segment'
+
+module SimpleHL7Parser
+  class OBXSegment
+    include Segment
+
+    COLUMN_MAP = {
+      set_id:  1,
+      value_type:  2,
+      observation_identifier:  3,
+      observation_sub_id:  4,
+      observation_value:  5,
+      units:  6,
+      references_range:  7,
+      abnormal_flags:  8,
+      probability:  9,
+      nature_of_abnormal_test:  10,
+      observation_result_status:  11,
+      date_last_obs_normal_values:  12,
+      user_defined_access_checks:  13,
+      date_time_of_the_observation:  14,
+      producer_id:  15,
+      responsible_observer:  16,
+      observation_method:  17,
+    }
+  end
+end

data/lib/simple_hl7_parser/segments/orc_segment.rb

@@ -0,0 +1,34 @@
+require 'simple_hl7_parser/segments/segment'
+
+module SimpleHL7Parser
+  class ORCSegment
+    include Segment
+
+    COLUMN_MAP = {
+      order_control: 1,
+      placer_order_number: 2,
+      filler_order_number: 3,
+      placer_group_number: 4,
+      order_status: 5,
+      response_flag: 6,
+      quantity_timing: 7,
+      parent_order: 8,
+      date_time_of_transaction: 9,
+      entered_by: 10,
+      verified_by: 11,
+      ordering_provider: 12,
+      enterer_s_location: 13,
+      call_back_phone_number: 14,
+      order_effective_date_time: 15,
+      order_control_code_reason: 16,
+      entering_organization: 17,
+      entering_device: 18,
+      action_by: 19,
+      advanced_beneficiary_notice_code: 20,
+      ordering_facility_name: 21,
+      ordering_facility_address: 22,
+      ordering_facility_phone_number: 23,
+      ordering_provider_address: 24,
+    }
+  end
+end

data/lib/simple_hl7_parser/segments/pid_segment.rb

@@ -0,0 +1,39 @@
+require 'simple_hl7_parser/segments/segment'
+
+module SimpleHL7Parser
+  class PIDSegment
+    include Segment
+
+    COLUMN_MAP = {
+      patient_id:  2,
+      patient_identifier_list:  3,
+      alternae_patient_id:  4,
+      patientname:  5,
+      mother_maiden_name:  6,
+      date_of_birth:  7,
+      sex:  8,
+      patientalias:  9,
+      race:  10,
+      patient_address:  11,
+      county_ode:  12,
+      phone_nmber_home:  13,
+      phone_nmber_business:  14,
+      primary_language:  15,
+      marital_status:  16,
+      religion:  17,
+      patient_account_number:  18,
+      ssn_numer_patient:  19,
+      driver_license_number_patient:  20,
+      mothers_identifier:  21,
+      ethnic_roup:  22,
+      birth_pace:  23,
+      multiple_birth_indicator:  24,
+      birth_oder:  25,
+      citizenhip:  26,
+      veteran_military_status:  27,
+      nationaity:  28,
+      patient_death_date_and_time:  29,
+      patient_death_indicator:  30,
+    }
+  end
+end

data/lib/simple_hl7_parser/segments/segment.rb

@@ -0,0 +1,31 @@
+module SimpleHL7Parser
+  module Segment
+    attr_reader :segment_array, :obr
+
+    def initialize(segment_array, obr = nil)
+      @segment_array = segment_array
+      @obr = obr
+    end
+
+    def segment_type
+      segment_array.first
+    end
+
+    def method_missing(symbol, *args, &block)
+      if symbol.to_s.include?('?')
+        return "#{segment_type}?".to_sym == symbol.upcase
+      end
+
+      if self.class::COLUMN_MAP[symbol]
+        segment_array[self.class::COLUMN_MAP[symbol]]
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(symbol, include_private = false)
+      "#{segment_type}?".to_sym == symbol.upcase? ||
+        segment_array[self.class::COLUMN_MAP[symbol]] || super
+    end
+  end
+end

data/lib/simple_hl7_parser/version.rb

@@ -1,3 +1,3 @@
 module SimpleHL7Parser
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_hl7_parser
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Sufyan Adam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-15 00:00:00.000000000 Z
+date: 2017-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,7 +73,12 @@ files:
 - lib/simple_hl7_parser.rb
 - lib/simple_hl7_parser/hl7.rb
 - lib/simple_hl7_parser/hl7_message.rb
-- lib/simple_hl7_parser/segment.rb
+- lib/simple_hl7_parser/segments/msh_segment.rb
+- lib/simple_hl7_parser/segments/obr_segment.rb
+- lib/simple_hl7_parser/segments/obx_segment.rb
+- lib/simple_hl7_parser/segments/orc_segment.rb
+- lib/simple_hl7_parser/segments/pid_segment.rb
+- lib/simple_hl7_parser/segments/segment.rb
 - lib/simple_hl7_parser/version.rb
 - simple_hl7_parser.gemspec
 homepage: https://github.com/sufyanadam/simple_hl7_parser

data/lib/simple_hl7_parser/segment.rb

@@ -1,163 +0,0 @@
-module SimpleHL7Parser
-  module Segment
-    attr_reader :segment_array, :obr
-
-    def initialize(segment_array, obr = nil)
-      @segment_array = segment_array
-      @obr = obr
-    end
-
-    def segment_type
-      segment_array.first
-    end
-
-    def method_missing(symbol, *args, &block)
-      if symbol.to_s.include?('?')
-        return "#{segment_type}?".to_sym == symbol.upcase
-      end
-
-      if self.class::COLUMN_MAP[symbol]
-        segment_array[self.class::COLUMN_MAP[symbol]]
-      else
-        super
-      end
-    end
-
-    def respond_to_missing?(symbol, include_private = false)
-      "#{segment_type}?".to_sym == symbol.upcase? ||
-        segment_array[self.class::COLUMN_MAP[symbol]] || super
-    end
-  end
-
-  class MSHSegment
-    include Segment
-
-    COLUMN_MAP = {
-      field_separator: 1,
-      sending_application: 2,
-      sending_facility: 3,
-      receiving_application: 4,
-      receiving_facility: 5,
-      date_time_of_message: 6,
-      security: 7,
-      message_type: 8,
-      message_control_id: 9,
-      processing_id: 10,
-      version_id: 11,
-      sequence_number: 12,
-      continuation_pointer: 13,
-      accept_acknowledgment_type: 14,
-      application_acknowledgment_type: 15,
-      country_code: 16,
-      character_set: 17,
-      principal_language_of_message: 18,
-      alternate_character_set_handling_Scheme: 19,
-    }
-  end
-
-  class PIDSegment
-    include Segment
-
-    COLUMN_MAP = {
-      patient_id:  2,
-      patient_identifier_list:  3,
-      alternae_patient_id:  4,
-      patientname:  5,
-      mother_maiden_name:  6,
-      date_of_birth:  7,
-      sex:  8,
-      patientalias:  9,
-      race:  10,
-      patient_address:  11,
-      county_ode:  12,
-      phone_nmber_home:  13,
-      phone_nmber_business:  14,
-      primary_language:  15,
-      marital_status:  16,
-      religion:  17,
-      patient_account_number:  18,
-      ssn_numer_patient:  19,
-      driver_license_number_patient:  20,
-      mothers_identifier:  21,
-      ethnic_roup:  22,
-      birth_pace:  23,
-      multiple_birth_indicator:  24,
-      birth_oder:  25,
-      citizenhip:  26,
-      veteran_military_status:  27,
-      nationaity:  28,
-      patient_death_date_and_time:  29,
-      patient_death_indicator:  30,
-    }
-  end
-
-  class ORCSegment
-    include Segment
-
-    COLUMN_MAP = {
-      order_control: 1,
-      placer_order_number: 2,
-      filler_order_number: 3,
-      placer_group_number: 4,
-      order_status: 5,
-      response_flag: 6,
-      quantity_timing: 7,
-      parent_order: 8,
-      date_time_of_transaction: 9,
-      entered_by: 10,
-      verified_by: 11,
-      ordering_provider: 12,
-      enterer_s_location: 13,
-      call_back_phone_number: 14,
-      order_effective_date_time: 15,
-      order_control_code_reason: 16,
-      entering_organization: 17,
-      entering_device: 18,
-      action_by: 19,
-      advanced_beneficiary_notice_code: 20,
-      ordering_facility_name: 21,
-      ordering_facility_address: 22,
-      ordering_facility_phone_number: 23,
-      ordering_provider_address: 24,
-    }
-  end
-
-  class OBRSegment
-    include Segment
-
-    COLUMN_MAP = {
-      set_id:  1,
-      placer_order_number:  2,
-      filler_order_number:  3,
-      universal_service_id:  4,
-      priority:  5,
-      requested_date_time:  6,
-      observation_date_time:  7,
-      observation_end_date_time:  8,
-    }
-  end
-
-  class OBXSegment
-    include Segment
-
-    COLUMN_MAP = {
-      set_id:  1,
-      value_type:  2,
-      observation_identifier:  3,
-      observation_sub_id:  4,
-      observation_value:  5,
-      units:  6,
-      references_range:  7,
-      abnormal_flags:  8,
-      probability:  9,
-      nature_of_abnormal_test:  10,
-      observation_result_status:  11,
-      date_last_obs_normal_values:  12,
-      user_defined_access_checks:  13,
-      date_time_of_the_observation:  14,
-      producer_id:  15,
-      responsible_observer:  16,
-      observation_method:  17,
-    }
-  end
-end