yahl7 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c227a65905fb5ad0563e0b261bd4109d85c6386a513d9aab13536cb5e6d72ab0
-  data.tar.gz: ca35e23d85f428b28bbcf7bfa190dea56372da467694a270ad3402b87dcbe083
+  metadata.gz: ead354fddaf6834942e7a7e23d46a965adf5f318cb730278844fefb728ad0a16
+  data.tar.gz: c6d4c697c4d32e1128401d37024d6518a57b798cb6400b73c4ec730fbf0085f4
 SHA512:
-  metadata.gz: 062d71e29fe0023d5d5f9a589ae13e2ab59dd2792b2106b096943f8c0be73df7860adb550346b4c429728664d38edebcdc8c41cdfcf83ad3a8f01c360f320bf9
-  data.tar.gz: 8d74af0d48e5d3afb462574e099c90a847ba7373154d265a606a603129529f5587f9a0dd74f3f3dbd076432d18d3e8c3dc82d17b2667d73f48fa7512c21ce9b6
+  metadata.gz: 3ff7e6dbfdc8b2a2c31c0025da6753c77a6b4c3dd400f57fd31010c6dca0439ecd17c3ad6e2c74140b3d16b970d9273f46d10efaa3c35204ef2b40b98765da71
+  data.tar.gz: f2c9a7572f48cfbc898ba902f3c0415b68a4d3509deb54b855856815bad69e6e33b3c3d41ec0b92d8d36f977d6429177d3ce6f16d3a970ff49e164dc0c4064ff

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+
+updates:
+  - package-ecosystem: "bundler" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"

data/CHANGELOG.md

@@ -5,6 +5,51 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.0] - 2021-09-01
+
+### Added
+
+- HL7 data types:
+  - `TQ` for timing and quantity
+
+### Changed
+
+- Mapped the following fields to the `TQ` data type:
+  - `OBR.27`
+  - `ORC.7`
+
+## [0.3.3] - 2021-09-01
+
+This version comes with a few bugfixes
+
+### Fixed
+
+- The mapping order of MSH fields was incorrect.
+- When `YAHL7::V2::FieldParser` was given a `nil` value, the program could
+  crash. This condition should now be resolved.
+
+## [0.3.2] - 2021-09-01
+
+0.3.1 introduced a bug that is fixed in this release.
+
+### Fixed
+
+- A bug in 0.3.1. We should have returned `YAHL7::V2::Message` but `nil` was
+  returned instead, resulting in an inconsistent API. This release fixed that
+  behavior and makes the API consistent again.
+
+## [0.3.1] - 2021-09-01
+
+This release fixes a bug under certain circumstances. More details are listed
+below.
+
+### Fixed
+
+- A bug that could be encountered where messages that do not contain a message
+  type field caused a crash. This crash should now be fixed. When calling
+  `YAHL7::V2::Message.message_type` on a message body that does not contain the
+  type field, `nil` should now be returned rather than crashing.
+
 ## [0.3.0] - 2021-08-31
 
 The most significant part of this release is the addition of HL7 data types,

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'date'
+
+require_relative 'ts'
+
+module YAHL7
+  module V2
+    class DataType
+      # This is the HL7 data type for a timing and quantity.
+      class TQ < YAHL7::V2::DataType
+        include YAHL7::V2::AliasPersonName
+        include YAHL7::V2::AliasFieldNames
+
+        define_field_names({
+                             quantity: 0,
+                             interval: 1,
+                             duration: 2,
+                             start_datetime: { index: 3, class: YAHL7::V2::DataType::TS },
+                             end_datetime: { index: 4, class: YAHL7::V2::DataType::TS },
+                             priority: 5,
+                             condition: 6,
+                             text: 7,
+                             conjunction: 8,
+                             order_sequencing: 9,
+                             occurrence_duration: 10,
+                             total_occurrences: 11
+                           })
+      end
+    end
+  end
+end

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

@@ -3,6 +3,8 @@
 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

data/lib/yahl7/v2/field_parser.rb

@@ -19,13 +19,8 @@ module YAHL7
       private
 
       def split_fields(body)
-        fields = split_body(body, parse_options.field_sep)
-
-        if fields.is_a?(String)
-          split_components(fields)
-        else
-          fields.map { |f| split_components(f) }
-        end
+        parts = split_body(body, parse_options.field_sep)
+        parts.is_a?(Array) ? parts.map { |f| split_components(f) } : split_components(parts)
       end
 
       def split_components(body)
@@ -43,6 +38,8 @@ module YAHL7
       end
 
       def split_body(body, separator)
+        return '' if body.nil?
+
         got = body.split(separator)
         got.count < 2 ? body : got
       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

@@ -45,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

@@ -3,6 +3,7 @@
 module YAHL7
   module V2
     class Segment
+      # AL1 segments contain patient allergy information.
       class AL1 < YAHL7::V2::Segment
         include YAHL7::V2::AliasFieldNames
 

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

@@ -3,6 +3,7 @@
 module YAHL7
   module V2
     class Segment
+      # DG1 segments contain patient diagnosis information.
       class DG1 < YAHL7::V2::Segment
         include YAHL7::V2::AliasFieldNames
 

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

@@ -3,6 +3,8 @@
 module YAHL7
   module V2
     class Segment
+      # EVN segments are used to communicate necessary trigger information to
+      # receiving applications.
       class EVN < YAHL7::V2::Segment
         include YAHL7::V2::AliasFieldNames
 

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

@@ -3,6 +3,7 @@
 module YAHL7
   module V2
     class Segment
+      # IN1 segments contain patient insurance coverage information.
       class IN1 < YAHL7::V2::Segment
         include YAHL7::V2::AliasFieldNames
 

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

@@ -3,31 +3,32 @@
 module YAHL7
   module V2
     class Segment
+      # MSH segments contain the intent, source, and destination of the HL7
+      # message.
       class MSH < YAHL7::V2::Segment
         include YAHL7::V2::AliasFieldNames
 
         define_field_names({
                              field_separator: 1,
-                             encoding_characters: 2,
-                             sending_application: 3,
-                             sending_facility: 4,
-                             receiving_application: 5,
-                             receiving_facility: 6,
-                             message_datetime: { index: 7, class: YAHL7::V2::DataType::TS },
-                             security: 8,
-                             message_type: 9,
-                             message_control_id: 10,
-                             processing_id: 11,
-                             version_id: 12,
-                             sequence_number: 13,
-                             continuation_pointer: 14,
-                             accept_acknowledgement_type: 15,
-                             application_acknowledgement_type: 16,
-                             country_code: 17,
-                             character_set: 18,
-                             principal_language: 19,
-                             alternate_character_set_handling_scheme: 20,
-                             message_profile_identifier: 21
+                             sending_application: 2,
+                             sending_facility: 3,
+                             receiving_application: 4,
+                             receiving_facility: 5,
+                             message_datetime: { index: 6, class: YAHL7::V2::DataType::TS },
+                             security: 7,
+                             message_type: 8,
+                             message_control_id: 9,
+                             processing_id: 10,
+                             version_id: 11,
+                             sequence_number: 12,
+                             continuation_pointer: 13,
+                             accept_acknowledgement_type: 14,
+                             application_acknowledgement_type: 15,
+                             country_code: 16,
+                             character_set: 17,
+                             principal_language: 18,
+                             alternate_character_set_handling_scheme: 19,
+                             message_profile_identifier: 20
                            })
       end
     end

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

@@ -3,6 +3,7 @@
 module YAHL7
   module V2
     class Segment
+      # NTE segments contain notes and comments.
       class NTE < YAHL7::V2::Segment
         include YAHL7::V2::AliasFieldNames
 

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

@@ -3,6 +3,7 @@
 module YAHL7
   module V2
     class Segment
+      # OBR segments contain observation request information about a patient.
       class OBR < YAHL7::V2::Segment
         include YAHL7::V2::AliasFieldNames
 
@@ -33,7 +34,7 @@ module YAHL7
                              diagnostic_service_section_id: 24,
                              result_status: 25,
                              parent_result: 26,
-                             quantity_timing: 27,
+                             quantity_timing: { index: 27, class: YAHL7::V2::DataType::TQ },
                              result_copies_to: 28,
                              parent: 29,
                              transportation_mode: 30,

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

@@ -3,6 +3,7 @@
 module YAHL7
   module V2
     class Segment
+      # OBX segments contain observation result information.
       class OBX < YAHL7::V2::Segment
         include YAHL7::V2::AliasFieldNames
 

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

@@ -3,6 +3,7 @@
 module YAHL7
   module V2
     class Segment
+      # ORC segments contain information common to all orders.
       class ORC < YAHL7::V2::Segment
         include YAHL7::V2::AliasFieldNames
 
@@ -13,7 +14,7 @@ module YAHL7
                              placer_group_number: 4,
                              order_status: 5,
                              response_flag: 6,
-                             quantity_timing: 7,
+                             quantity_timing: { index: 7, class: YAHL7::V2::DataType::TQ },
                              parent_order: 8,
                              transaction_datetime: 9,
                              entered_by: 10,

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

@@ -3,6 +3,7 @@
 module YAHL7
   module V2
     class Segment
+      # PD1 segments contain additional patient demographic information.
       class PD1 < YAHL7::V2::Segment
         include YAHL7::V2::AliasFieldNames
 

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

@@ -3,6 +3,7 @@
 module YAHL7
   module V2
     class Segment
+      # PID segments contain standard patient demographic information.
       class PID < YAHL7::V2::Segment
         include YAHL7::V2::AliasFieldNames
 

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

@@ -3,6 +3,7 @@
 module YAHL7
   module V2
     class Segment
+      # PV1 segments contain information about the patient visit.
       class PV1 < YAHL7::V2::Segment
         include YAHL7::V2::AliasFieldNames
 

data/lib/yahl7/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module YAHL7
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yahl7
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Mylan Connolly
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-31 00:00:00.000000000 Z
+date: 2021-09-01 00:00:00.000000000 Z
 dependencies: []
 description: A simple HL7 parser that focuses on being robust and easy to use
 email:
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/dependabot.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
@@ -42,6 +43,7 @@ files:
 - lib/yahl7/v2/data_type/dt.rb
 - lib/yahl7/v2/data_type/ft.rb
 - lib/yahl7/v2/data_type/ndl.rb
+- lib/yahl7/v2/data_type/tq.rb
 - lib/yahl7/v2/data_type/ts.rb
 - lib/yahl7/v2/data_type/xad.rb
 - lib/yahl7/v2/data_type/xpn.rb