pipehat 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 321edea28b62f76b4ea8686bacea94d759caee4f0d9f43a581c01e373c0aacdb
+  data.tar.gz: 29ce16e9504f7f649eb78917842372157c21a8bff777597b4f3169194a5e966d
+SHA512:
+  metadata.gz: c51d419897f44c88f32d773a8f1536a6e026ebcb29acd56cb428b12c407e915980f52bdd1a6a886bfdaf92a712c76074438831ee844818eb020e544826581720
+  data.tar.gz: 69a196afd98264821be5906909e10972453ff64aab3f202c88ddfdbb3cd1e51240e7aba6041ca020fc95e46db21d569cd797d2e9d3c25e0990cfb99f807cb935

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,18 @@
+---
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Exclude:
+    - "**/test/*_test.rb"
+Metrics/MethodLength:
+  Exclude:
+    - "**/test/*_test.rb"

data/.travis.yml

@@ -0,0 +1,10 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tim@catminion.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pipehat.gemspec
+gemspec
+
+gem "minitest", "~> 5.0"
+gem "pry"
+gem "rake", "~> 12.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Tim Peters
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,184 @@
+# Pipehat [![Build Status](https://travis-ci.org/timocp/pipehat.svg?branch=master)](https://travis-ci.org/timocp/pipehat)
+
+Pipehat is a Ruby gem for reading and writing HL7 v.2.x messages.
+
+This library is experimental - the API is incomplete and may change, and it does
+not support a lot of segment and data types yet.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pipehat'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install pipehat
+
+## Usage
+
+Pipehat is aware of the type of each HL7v2 field.  This allows each field,
+component and sub-component to be accessed by name.
+
+### Parsing HL7
+
+Suppose the following simple example of an (incomplete) admission message
+and a PID message with 2 patient IDs (showing a repeating field and
+subcomponents).
+
+```ruby
+# Parse a message from a string
+hl7 = "MSH|^~\&|||||20200927212805+0930||ADT^A01^ADT_A01|1234567890|D|2.5\r" \
+      "PID||XXX|1234^^^System1&&L~ABC^^^System2&&L||Family^Given"
+msg = Pipehat::Message.new(hl7)
+```
+
+Messages are essentially an array of segments.  Individual segments can be
+accessed using `#segments`.  The optional parameter will filter by segment
+type.  This method returns an Enumerator.
+
+```ruby
+# Example, pick the first PID segment
+pid = msg.segments(:PID).first
+```
+
+Once a segment is accessed, fields, repeats, components and sub-components
+can be accessed by name.  Note that these methods return a subclass of
+Pipehat::Node, which is an index into the segment.  To retreive the string
+value at (or under) that position, call `@to_s` on the node.
+
+```ruby
+# Access the value of PID-2 (deprecated patient ID)
+pid.patient_id.to_s #=> "XXX"
+
+# Access the first repeat in PID-3 (patient ID list)
+pid.patient_identifier_list.first.to_s #=> "1234"
+
+# Which is equivalent to accessing the first component of the field, which 
+# can also be accessed by name as it is known to be a CX type:
+pid.patient_identifier_list.first.id_number.to_s #=> "1234"
+
+# The 4th component of PID-3 is a composite type (HD), so its parts can
+# also be accessed individually:
+pid.patient_identifier_list.first.assigning_authority.namespace_id.to_s #=> "System1"
+pid.patient_identifier_list.first.assigning_authority.universal_id_type.to_s #=> "L"
+
+# Field repetitions can be ignored - in this case, Pipehat will assume you
+# are referring to the first repeat.
+pid.patient_identifier_list.assigning_authority.namespace_id.to_s #=> "System1"
+
+# Access the second repeat in PID-3.  Indexes into repeats are 1-based, for
+# consistency with other HL7 positional indexing.
+pid.patient_identifier_list[2].to_s #=> "ABC"
+pid.patient_identifier_list[2].id_number.to_s #=> "ABC"
+pid.patient_identifier_list[2].assigning_authority.namespace_id.to_s #=> "System2"
+```
+
+Values can also be accessed positionally by index instead of name.  This could
+be useful to access values:
+
+* from a segment type this library doesn't understand
+* that have additional components in newer versions of HL7 which this library doesn't understand
+* that are invalid (eg, extra components or subcomponents)
+
+```ruby
+# Equivalent to the last example in the previous section
+pid.field(3).repeat(2).component(1).subcomponent(1) #=> "System2"
+
+# Again, repetitions can be ignored if you just want to read from the first
+pid.field(3).component(1).subcomponent(1) #=> "System1"
+```
+
+The method names way of accessing segments can be more verbose but is also
+more readable and self-documenting.
+
+### Generating HL7
+
+Example to generate a message the same as the above example.  Note that the
+field separator and encoding characters do not have to be provided, they are
+initialized automatically.
+
+```ruby
+msg = Pipehat::Message.new
+msg << Pipehat::Segment::MSH.new.tap do |msh|
+  msh.date_time_of_message = Time.now.strftime("%Y%m%d%H%M%S%z")
+  msh.message_type.message_code = "ADT"
+  msh.message_type.trigger_event = "A01"
+  msh.message_type.message_structure = "ADT_A01"
+  msh.message_control_id = "1234567890"
+  msh.processing_id = "D"
+  msh.version_id = "2.5"
+end
+msg << Pipehat::Segment::PID.new.tap do |pid|
+  pid.patient_id = "XXX"
+  pid.patient_name.family_name = "Family"
+  pid.patient_name.given_name = "Given"
+
+  # PID-3 first repeat (since no repeat is mentioned)
+  pid.patient_identifier_list.id_number = "1234"
+  pid.patient_identifier_list.assigning_authority.namespace_id = "System1"
+  pid.patient_identifier_list.assigning_authority.universal_id_type = "L"
+  # PID-3 second repeat
+  pid.patient_identifier_list[2].id_number = "ABC"
+  pid.patient_identifier_list[2].assigning_authority.namespace_id = "System2"
+  pid.patient_identifier_list[2].assigning_authority.universal_id_type = "L"
+end
+msg.to_hl7 #=> "MSH|^~\\&|||||20200927212805+0930||ADT^A01^ADT_A01|1234567890|D|2.5\r..."
+```
+
+The indexed based access looks slightly different due to ruby syntax; the `set`
+method must be called on the node object.  `set` can be called at any level
+from field to subcomponent and it will replace all current values.
+
+```ruby
+pid = Pipehat::Segment::PID.new
+pid.field(3).repeat(2).component(4).set("System2")
+pid.field(3).repeat(2).component(4).subcomponent(3).set("L")
+# is equivalent to:
+# pid.patient_identifier_list[2].assigning_authority = "System2"
+# pid.patient_identifier_list[2].assigning_authority.universal_id_type = "L"
+
+pid.to_hl7 #=> "PID|||~^^^System2&&L"
+```
+
+### HL7 Escaping
+
+Values returned by the `to_s` methods have HL7 escape codes automatically 
+unescaped.  Assigning a value will automatically be escaped.  The unescaped
+version can be read with `unescaped`.
+
+```ruby
+pid = Pipehat::Segment::PID.new("PID||123\\R\\456")
+pid.patient_id.to_s #=> "123~456"
+pid.patient_id.unescaped #=> "123\\R\\456"
+pid.patient_identifier_list = "A & B"
+pid.to_hl7 #=> "PID||123\\R\\456|A \\T\\ B"
+```
+
+Note there is currently no way to set a string without the escaping (this will
+be needed when writing, for example, HL7 Formatted Text).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/timocp/pipehat. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/timocp/pipehat/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Pipehat project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/timocp/pipehat/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pry"
+require "pipehat"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pipehat.rb

@@ -0,0 +1,22 @@
+require "pipehat/version"
+
+module Pipehat
+  class Error < StandardError; end
+end
+
+require "pipehat/parser"
+require "pipehat/segment/base"
+require "pipehat/node"
+require "pipehat/field/base"
+require "pipehat/repeat/base"
+require "pipehat/component/base"
+require "pipehat/subcomponent/base"
+require "pipehat/define_type"
+require "pipehat/message"
+
+Dir[File.join(__dir__, "pipehat", "types", "*.rb")].sort.each { |file| require file }
+Dir[File.join(__dir__, "pipehat", "segment", "*.rb")].sort.each { |file| require file }
+
+ObjectSpace.each_object(Pipehat::Segment::Base.singleton_class).each do |segment_class|
+  segment_class.field_names.freeze
+end

data/lib/pipehat/component/base.rb

@@ -0,0 +1,30 @@
+module Pipehat
+  module Component
+    class Base < Pipehat::Node
+      def initialize(segment, fnum, rnum, cnum)
+        @segment = segment
+        @fnum = fnum
+        @rnum = rnum
+        @cnum = cnum
+      end
+
+      attr_reader :segment, :fnum, :rnum, :cnum
+
+      def subcomponent(snum, type = Pipehat::Subcomponent::Base)
+        type.new(segment, fnum, rnum, cnum, snum)
+      end
+
+      def set(value)
+        segment.set_component(fnum, rnum, cnum, value)
+      end
+
+      def to_hl7
+        (segment.tree(fnum, rnum, cnum) || []).join(parser.subcomponent_sep)
+      end
+
+      def inspect
+        inspect_node(fnum, rnum, cnum)
+      end
+    end
+  end
+end

data/lib/pipehat/define_type.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Pipehat
+  class TypeDefinitionProxy
+    def initialize(fclass, rclass, cclass)
+      @fclass = fclass
+      @rclass = rclass
+      @cclass = cclass
+      @count = 0
+    end
+
+    def add_component(name, type)
+      setter = "#{name}=".to_sym
+      count = @count += 1
+
+      @fclass.component_names << name
+      @rclass.component_names << name
+      @cclass.component_names << name
+
+      # component for a field class is delegated to the first repeat and
+      # returns a Component
+      @fclass.send(:define_method, name) do
+        first.send(name)
+      end
+
+      @fclass.send(:define_method, setter) do |value|
+        first.send(setter, value)
+      end
+
+      # component in a repeat class returns a Component
+      @rclass.send(:define_method, name) do
+        component(count, Object.const_get("Pipehat::Component::#{type}"))
+      end
+
+      @rclass.send(:define_method, setter) do |value|
+        send(name).set(value)
+      end
+
+      # component in a component class returns a Subcomponent
+      @cclass.send(:define_method, name) do
+        subcomponent(count, Object.const_get("Pipehat::Subcomponent::#{type}"))
+      end
+
+      @cclass.send(:define_method, setter) do |value|
+        send(name).set(value)
+      end
+    end
+  end
+
+  def self.define_type(type, &block)
+    # define classes at each level
+    fclass = Pipehat::Field.const_set(type, Class.new(Pipehat::Field::Base))
+    rclass = Pipehat::Repeat.const_set(type, Class.new(Pipehat::Repeat::Base))
+    cclass = Pipehat::Component.const_set(type, Class.new(Pipehat::Component::Base))
+
+    if block_given?
+      # composite type
+      TypeDefinitionProxy.new(fclass, rclass, cclass).instance_eval(&block)
+      fclass.component_names.freeze
+      rclass.component_names.freeze
+      cclass.component_names.freeze
+    else
+      # primitive type
+      sclass = Pipehat::Subcomponent.const_set(type, Class.new(Pipehat::Subcomponent::Base))
+      sclass.component_names.freeze
+    end
+  end
+end