yahl7 0.1.0 → 0.3.2

data/lib/yahl7/v2/alias_person_name.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module YAHL7
+  module V2
+    # This module can be included into a class of a data type that includes the
+    # name components in order to add an `#assemble_name_family_first` method
+    # and an `#assemble_name_given_first` method.
+    module AliasPersonName
+      # This is the method the builds the "bare" name (i.e., without prefixes
+      # and/or suffixes) with the family name first.
+      def bare_name_family_first
+        buf = family_name.nil? || family_name == '' ? '' : "#{family_name}, "
+        buf += "#{given_name} " unless given_name.nil? || given_name == ''
+        buf += middle_name unless middle_name.nil? || middle_name == ''
+
+        buf.strip
+      end
+
+      # This is the method the builds the "bare" name (i.e., without prefixes
+      # and/or suffixes) with the given name first.
+      def bare_name_given_first
+        [given_name, middle_name, family_name]
+          .reject { |p| p.nil? || p == '' }
+          .join(' ')
+      end
+
+      # This is the method that builds the full name (i.e., with prefixes and/or
+      # suffixes) with the family name first.
+      def assemble_name_family_first
+        buf = prefix.nil? || prefix == '' ? '' : "#{prefix} "
+        buf += bare_name_family_first
+
+        s = suffixes
+        buf += ", #{s}" unless s == ''
+
+        buf
+      end
+
+      # We have two locations for suffix information on a name:
+      #
+      # 1. The suffix, which is meant to house information like Jr, II, etc.
+      # 2. The degree, which is meant to house information like MD, PhD, etc.
+      #
+      # This method is used to combine those into a single value to make name
+      # assembly easier.
+      def suffixes
+        [suffix, degree]
+          .reject { |p| p.nil? || p == '' }
+          .join(', ')
+      end
+
+      # This is the method that builds the full name (i.e., with prefixes and/or
+      # suffixes) with the given name first.
+      def assemble_name_given_first
+        buf = prefix.nil? || prefix == '' ? '' : "#{prefix} "
+        buf += bare_name_given_first
+
+        s = suffixes
+        buf += ", #{s}" unless s == ''
+
+        buf
+      end
+    end
+  end
+end

data/lib/yahl7/v2/data_type/cnn.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module YAHL7
+  module V2
+    class DataType
+      # This is the HL7 data type for a composite name and ID number.
+      class CNN < YAHL7::V2::DataType
+        include YAHL7::V2::AliasPersonName
+        include YAHL7::V2::AliasFieldNames
+
+        define_field_names({
+                             id_number: 0,
+                             family_name: 1,
+                             given_name: 2,
+                             middle_name: 3,
+                             suffix: 4,
+                             prefix: 5,
+                             degree: 6,
+                             source_table: 7,
+                             assigning_authority_namespace_id: 8,
+                             assigning_authority_universal_id: 9,
+                             assigning_authority_universal_id_type: 10
+                           })
+      end
+    end
+  end
+end

data/lib/yahl7/v2/data_type/dt.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module YAHL7
+  module V2
+    class DataType
+      # This is the HL7 data type for a single date. This should be in the
+      # format of YYYY[MM[DD]]
+      class DT < YAHL7::V2::DataType
+        def date
+          @date ||= parse_date
+        end
+
+        private
+
+        def parse_date
+          case @value.length
+          when 4 then Date.parse("#{@value}0101")
+          when 6 then Date.parse("#{@value}01")
+          when 8 then Date.parse(@value)
+          else raise YAHL7::V2::Error::InvalidFormatError, 'Unknown date format'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yahl7/v2/data_type/ft.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module YAHL7
+  module V2
+    class DataType
+      # This is the HL7 data type for formatted text
+      class FT < YAHL7::V2::DataType
+        def formatted
+          @formatted ||= parse_value
+        end
+
+        private
+
+        def parse_value
+          value.is_a?(Array) ? value.map { |v| parse_body(v) }.join("\n") : parse_body(value)
+        end
+
+        def parse_body(body)
+          YAHL7::V2::Formatter.format(body)
+        end
+      end
+    end
+  end
+end

data/lib/yahl7/v2/data_type/ndl.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'date'
+
+require_relative 'ts'
+
+module YAHL7
+  module V2
+    class DataType
+      # This is the HL7 data type for a name with a date and location.
+      class NDL < YAHL7::V2::DataType
+        include YAHL7::V2::AliasFieldNames
+
+        define_field_names({
+                             name: { index: 0, class: YAHL7::V2::DataType::CNN },
+                             start_datetime: { index: 1, class: YAHL7::V2::DataType::TS },
+                             end_datetime: { index: 2, class: YAHL7::V2::DataType::TS },
+                             point_of_care: 3,
+                             room: 4,
+                             bed: 5,
+                             facility: 6,
+                             location_status: 7,
+                             patient_location_type: 8,
+                             building: 9,
+                             floor: 10
+                           })
+      end
+    end
+  end
+end

data/lib/yahl7/v2/data_type/ts.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module YAHL7
+  module V2
+    class DataType
+      # This is the HL7 data type for a timestamp with a format of
+      # YYYY[MM[DD[HH[MM[SS[.S[S[S[S]]]]]]]]][+/-ZZZZ]
+      class TS < YAHL7::V2::DataType
+        def timestamp
+          @timestamp ||= parse_timestamp
+        end
+
+        private
+
+        def parse_timestamp
+          timestamp = @value.is_a?(Array) ? @value.first : @value
+          YAHL7::V2::DateTime.parse(timestamp)
+        end
+      end
+    end
+  end
+end

data/lib/yahl7/v2/data_type/xad.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module YAHL7
+  module V2
+    class DataType
+      # This is the HL7 data type for an extended address.
+      class XAD < YAHL7::V2::DataType
+        include YAHL7::V2::AliasFieldNames
+
+        define_field_names({
+                             street_address: 0,
+                             other_designation: 1,
+                             city: 2,
+                             state: 3,
+                             zip: 4,
+                             country: 5,
+                             address_type: 6,
+                             other_geographic_designation: 7,
+                             county_code: 8,
+                             census_tract: 9,
+                             address_representation_code: 10,
+                             address_validity_range: 11,
+                             effective_date: { index: 12, class: YAHL7::V2::DataType::TS },
+                             expiration_date: { index: 13, class: YAHL7::V2::DataType::TS }
+                           })
+      end
+    end
+  end
+end

data/lib/yahl7/v2/data_type/xpn.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module YAHL7
+  module V2
+    class DataType
+      # This is the HL7 data type for an extended person name. This is the data
+      # type used for patient names, etc.
+      class XPN < YAHL7::V2::DataType
+        include YAHL7::V2::AliasPersonName
+        include YAHL7::V2::AliasFieldNames
+
+        define_field_names({
+                             family_name: 0,
+                             given_name: 1,
+                             middle_name: 2,
+                             suffix: 3,
+                             prefix: 4,
+                             degree: 5,
+                             name_type_code: 6,
+                             name_representation_code: 7,
+                             name_context: 8,
+                             name_validity_range: 9,
+                             name_assembly_order: 10,
+                             effective_date: 11,
+                             expiration_date: 12,
+                             professional_suffix: 13
+                           })
+
+        def full_name
+          case name_assembly_order&.downcase
+          when 'f' then assemble_name_family_first
+          else assemble_name_given_first
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yahl7/v2/data_type/xtn.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module YAHL7
+  module V2
+    class DataType
+      # This is the HL7 data type for an extended telephone number.
+      class XTN < YAHL7::V2::DataType
+        include YAHL7::V2::AliasFieldNames
+
+        define_field_names({
+                             telephone_number: 0,
+                             telephone_use_code: 1,
+                             telephone_equipment_type: 2,
+                             email_address: 3,
+                             country_code: 4,
+                             area_city_code: 5,
+                             local_number: 6,
+                             extension: 7,
+                             any_text: 8,
+                             extension_prefix: 9,
+                             speed_dial_code: 10,
+                             unformatted_telephone_number: 11
+                           })
+      end
+    end
+  end
+end

data/lib/yahl7/v2/data_type.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+Dir[File.join(__dir__, 'data_type', '*.rb')].sort.each { |f| require f }
+
+module YAHL7
+  module V2
+    # This is the base data type class for custom HL7 data types.
+    class DataType
+      attr_accessor :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def [](index)
+        value[index]
+      end
+    end
+  end
+end

data/lib/yahl7/v2/date_time.rb

@@ -21,7 +21,7 @@ module YAHL7
         timezone = parts[1]
 
         format = timestamp_format(timestamp)
-        raise 'Unknown timestamp format' if format.nil?
+        raise YAHL7::V2::Error::InvalidFormatError, 'Unknown timestamp format' if format.nil?
 
         format += '%z' unless timezone.nil?
         ::DateTime.strptime(value, format)

data/lib/yahl7/v2/error/invalid_format_error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module YAHL7
+  module V2
+    module Error
+      # This error is raised when the input for a given data type is implausible
+      # or otherwise invalid.
+      class InvalidFormatError < StandardError
+      end
+    end
+  end
+end

data/lib/yahl7/v2/message/adt.rb

@@ -3,6 +3,8 @@
 module YAHL7
   module V2
     class Message
+      # ADT messages contain admit, discharge, and transfer information about
+      # patients.
       class ADT < YAHL7::V2::Message
       end
     end

data/lib/yahl7/v2/message/oru.rb

@@ -3,6 +3,7 @@
 module YAHL7
   module V2
     class Message
+      # ORU messages contain unsolicited observation results about a patient.
       class ORU < YAHL7::V2::Message
       end
     end

data/lib/yahl7/v2/message.rb

@@ -17,6 +17,10 @@ module YAHL7
                     .map { |s| Segment.parse(s, parse_options) }
       end
 
+      def to_s
+        @to_s ||= segments.join(parse_options.segment_sep)
+      end
+
       def [](index)
         case index
         when Integer then segments[index]
@@ -41,9 +45,15 @@ module YAHL7
       # information, as this method simply finds the type code and then hands it
       # off to `get_message_class` to find the class to use.
       def self.message_type(body, parse_options = nil)
+        return self if body.length < 8
+
         parse_options ||= ParseOptions.from_body(body)
         head = body.split(parse_options.segment_sep)[0]
+        return self if head.nil?
+
         type = head.split(parse_options.repetition_sep)[8]
+        return self if type.nil?
+
         code = type.split(parse_options.component_sep)[0]
         get_message_class(code)
       end

data/lib/yahl7/v2/segment/al1.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module YAHL7
+  module V2
+    class Segment
+      # AL1 segments contain patient allergy information.
+      class AL1 < YAHL7::V2::Segment
+        include YAHL7::V2::AliasFieldNames
+
+        define_field_names({
+                             set_id: 1,
+                             allergen_type_code: 2,
+                             allergen_code: 3,
+                             allergen_severity_code: 4,
+                             allergen_reaction_code: 5,
+                             identification_date: { index: 6, class: YAHL7::V2::DataType::DT }
+                           })
+      end
+    end
+  end
+end

data/lib/yahl7/v2/segment/dg1.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module YAHL7
+  module V2
+    class Segment
+      # DG1 segments contain patient diagnosis information.
+      class DG1 < YAHL7::V2::Segment
+        include YAHL7::V2::AliasFieldNames
+
+        define_field_names({
+                             set_id: 1,
+                             diagnosis_code_method: 2,
+                             diagnosis_code: 3,
+                             diagnosis_description: 4,
+                             diagnosis_datetime: { index: 5, class: YAHL7::V2::DataType::TS },
+                             diagnosis_type: 6,
+                             major_diagnosis_category: 7,
+                             diagnostic_related_group: 8,
+                             drg_approval_indicator: 9,
+                             drg_grouper_review_code: 10,
+                             outlier_type: 11,
+                             outlier_days: 12,
+                             outlier_cost: 13,
+                             grouper_version_and_type: 14,
+                             diagnostic_priority: 15,
+                             diagnosing_clinician: 16,
+                             diagnosis_classification: 17,
+                             confidential_indicator: 18,
+                             attestation_datetime: { index: 19, class: YAHL7::V2::DataType::TS },
+                             diagnosis_identifier: 20,
+                             diagnosis_action_code: 21
+                           })
+      end
+    end
+  end
+end