simple_hl7 0.1.2 → 0.2.0

data/README.md

@@ -162,6 +162,18 @@ Outputs:
 MSH|^~\&|
 NTE|||Testing \T\ escaping notes
 ```
+### Segment Separator
+
+Some nonstandard HL7 implementations require a different segment separator
+character than "\r". To make this change pass the `segment_separator` option to
+the `Message` constructor.
+
+```ruby
+msg = SimpleHL7::Message.new(segment_separator: "\r\n")
+msg.pid[3] = "123456"
+msg.to_hl7
+=> "MSH|^~\\&|\r\nPID|||123456"
+```
 
 ### Parsing
 
@@ -179,6 +191,14 @@ msg.pid[5][1].to_s
 => "Doe"
 ```
 
+If the string to be parsed contains a nonstandard segment separator then it can
+be passed into the `parse` method as well:
+
+```ruby
+hl7_str = "MSH|^~\\&|||||||ADT^A04|12345678|D|2.5\r\nPID|||454545||Doe^John"
+msg = SimpleHL7::Message.parse(hl7_str, segment_separator: "\r\n")
+```
+
 ## Contributing
 
 1. Fork it

data/lib/simple_hl7/composite.rb

@@ -10,9 +10,7 @@ module SimpleHL7
     def initialize(value = nil)
       @subcomposites = {}
       cls = self.class
-      unless value.nil?
-        @subcomposites[cls.start_index] = cls.subcomposite_class.new(value)
-      end
+      @subcomposites[cls.start_index] = cls.subcomposite_class.new(value)
     end
 
     # Set the value of the specified subcomposite.

data/lib/simple_hl7/message.rb

@@ -1,8 +1,18 @@
 module SimpleHL7
   class Message
-    def initialize(default_msh = true)
+    # Constructor
+    # @param options [Hash] Options for the Message, keys are symbols, accepted
+    #   values are:
+    #   default_msh [boolean] True to create a default MSH segment, false
+    #     to create the message with no segments. Defaults to true.
+    #   segment_separator [String] The string to place between segments when
+    #     generating HL7, defaults to "\r".
+    def initialize(options = nil)
+      default_opts = {default_msh: true, segment_separator: "\r"}
+      opts = default_opts.merge(options || {})
+      @segment_separator = opts[:segment_separator]
       @segments = []
-      @segments << MSHSegment.new if default_msh
+      @segments << MSHSegment.new if opts[:default_msh]
     end
 
     def method_missing(meth, *args, &block)
@@ -16,15 +26,29 @@ module SimpleHL7
       end
     end
 
+    # Generate a HL7 string from this message
+    #
+    # @return [String] The generated HL7 string
     def to_hl7
       separator_chars = get_named_segment('MSH').separator_chars
-      @segments.map {|s| s.to_hl7(separator_chars)}.join("\r")
+      @segments.map {|s| s.to_hl7(separator_chars)}.join(@segment_separator)
     end
 
+    # Get an array representation of the HL7 message. This can be useful
+    # to help debug problems.
+    #
+    # @return [Array] The HL7 message as an array where each subcomposites is
+    #   also represented as an array.
     def to_a
       @segments.reduce([]) {|a, s| a << s.to_a}
     end
 
+    # Get the specified segment
+    #
+    # @param name [String] The 3 letter segment name, case insensitive
+    # @param index [Integer] The segment number to get if there are multiple
+    #   in the message. This index starts at 1 because that's what most HL7
+    #   specs do.
     def segment(name, index=1)
       all = all_segments(name)
       seg = nil
@@ -32,12 +56,20 @@ module SimpleHL7
       seg
     end
 
+    # Add a segment to the message
+    #
+    # @param name [String] The 3 letter segment name, case insensitive.
+    # @return [Segment] The segment that was just created
     def add_segment(name)
       segment = Segment.new(name)
       @segments << segment
       segment
     end
 
+    # Appends a segment to the message
+    #
+    # @param segment [Segment] The segment to append.
+    # @return [Segment] The segment just appended
     def append_segment(segment)
       @segments << segment
       segment
@@ -60,9 +92,19 @@ module SimpleHL7
       segment
     end
 
-    def self.parse(str)
-      msg = new(false)
-      segment_strs = str.split("\r")
+    # Parses a HL7 string into a Message
+    #
+    # @param str [String] The string to parse.
+    # @param options [Hash] Options for parsing, keys are symbols, accepted
+    #   values:
+    #   segment_separator [String] The string to place between segments when
+    #     generating HL7, defaults to "\r".
+    # @return [Message] The parsed HL7 Message
+    def self.parse(str, options = nil)
+      default_opts = {default_msh: true, segment_separator: "\r"}
+      opts = default_opts.merge(options || {})
+      msg = new(default_msh: false)
+      segment_strs = str.split(opts[:segment_separator])
       msh = MSHSegment.parse(segment_strs[0])
       msg.append_segment(msh)
       segment_strs[1, segment_strs.length].each do |seg_str|

data/lib/simple_hl7/segment.rb

@@ -12,6 +12,14 @@ module SimpleHL7
       separator_chars.field
     end
 
+    def initialize(name = nil)
+      if name
+        super(name.upcase)
+      else
+        super
+      end
+    end
+
     def name
       self[0].to_s
     end

data/lib/simple_hl7/subcomponent.rb

@@ -1,5 +1,11 @@
 module SimpleHL7
-  class Subcomponent < Struct.new(:value)
+  class Subcomponent
+    attr_accessor :value
+
+    def initialize(value)
+      @value = value.nil? ? '' : value
+    end
+
     def to_hl7(separator_chars)
       hl7 = value
       hl7.gsub!(separator_chars.escape, "\\E\\")

data/lib/simple_hl7/version.rb

@@ -1,3 +1,3 @@
 module SimpleHL7
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/spec/simple_hl7/component_spec.rb

@@ -9,6 +9,11 @@ module SimpleHL7
         field[2] = "bar"
         field.to_hl7(SeparatorCharacters.defaults).should == "foo&bar"
       end
+
+      it "returns an empty string when initialized with a nil" do
+        field = Component.new(nil)
+        field.to_hl7(SeparatorCharacters.defaults).should == ''
+      end
     end
 
     describe "[]" do

data/spec/simple_hl7/field_spec.rb

@@ -10,6 +10,11 @@ module SimpleHL7
         field.r(2)[1] = "bar"
         field.to_hl7(SeparatorCharacters.defaults).should == 'foo^baz~bar'
       end
+
+      it "generates an empty message for a nil value" do
+        field = Field.new(nil)
+        field.to_hl7(SeparatorCharacters.defaults).should == ''
+      end
     end
   end
 end

data/spec/simple_hl7/message_spec.rb

@@ -10,6 +10,23 @@ module SimpleHL7
         msg.pid[5][2] = "Test"
         msg.to_hl7.should == "MSH|^~\\&||||accountid\rPID|||||User^Test"
       end
+
+      it "generates an hl7 message with a nil field" do
+        msg = Message.new
+        msg.msh[6] = "accountid"
+        msg.pid[5] = "User"
+        msg.pid[5][2] = "Test"
+        msg.msh[5] = nil
+        msg.to_hl7.should == "MSH|^~\\&||||accountid\rPID|||||User^Test"
+      end
+
+      it "generates a message with a non-default segment separator" do
+        msg = Message.new(segment_separator: "\r\n")
+        msg.msh[6] = "accountid"
+        msg.pid[5] = "User"
+        msg.pid[5][2] = "Test"
+        msg.to_hl7.should == "MSH|^~\\&||||accountid\r\nPID|||||User^Test"
+      end
     end
 
     describe "#add_segment" do
@@ -32,6 +49,14 @@ module SimpleHL7
         msg.pid[5][2].to_s.should == "Test"
         msg.pid[5].r(2)[1].to_s.should == "Repeat"
       end
+
+      it "properly parses a hl7 string with nonstandard separators" do
+        msg = Message.parse("MSH|^~\\&||||accountid\r\nPID|||||User^Test",
+                            segment_separator: "\r\n")
+        msg.msh[6].to_s.should == "accountid"
+        msg.pid[5].to_s.should == "User"
+        msg.pid[5][2].to_s.should == "Test"
+      end
     end
   end
 end

data/spec/simple_hl7/segment_spec.rb

@@ -3,6 +3,13 @@ require "simple_hl7"
 
 module SimpleHL7
   describe Segment do
+    describe "#initialize" do
+      it "is not case sensitive to the segment name" do
+        seg = Segment.new('pId')
+        seg.name.should == 'PID'
+      end
+    end
+
     describe "#to_hl7" do
       it "generates a message using the specified separator chars" do
         sep_chars = SeparatorCharacters.defaults

data/spec/simple_hl7/subcomponent_spec.rb

@@ -2,6 +2,17 @@ require "simple_hl7"
 
 module SimpleHL7
   describe Subcomponent do
+    describe "#initialize" do
+      it "changes a nil value to an empty string" do
+        subc = Subcomponent.new(nil)
+        subc.value.should == ''
+      end
+
+      it "initializes with a value" do
+        subc = Subcomponent.new('test')
+        subc.value.should == 'test'
+      end
+    end
     describe "#to_hl7" do
       it "returns the value" do
         subf = Subcomponent.new('test')
@@ -18,6 +29,13 @@ module SimpleHL7
         default_chars = SeparatorCharacters.defaults
         subc.to_hl7(default_chars).should == "\\E\\\\T\\\\S\\\\R\\\\F\\"
       end
+
+      context "when initialized with an empty string" do
+        it "returns an empty string" do
+          subc = Subcomponent.new(nil)
+          subc.to_hl7(SeparatorCharacters.defaults).should == ''
+        end
+      end
     end
 
     describe "#parse" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_hl7
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-05 00:00:00.000000000 Z
+date: 2014-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry