healthcare_phony 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd82a9bb551ceeeafe3a73126f9b09de624303e71abc98b26e1d5510fe226690
-  data.tar.gz: ac7a04cb59c0aca105b391a1db38f4492d4b220588273b604b36156df3ff9102
+  metadata.gz: 1de41607d3c9609a86c5cfdefd9562d07c17b30e316d24ea238324c882627d85
+  data.tar.gz: 353036ecec7fb8c01bf417fcb39d22dfbaec87645d3e500bc00ea47111ad6e62
 SHA512:
-  metadata.gz: 3ca23f7f3eb78eaa6a3c89ba444f7293a1879852ba9b44a64b56bf2d9b3386f27cdc1640513cac0603c0f9392c808667109a5d65bd75da4b91cd9b340af3a718
-  data.tar.gz: 7a03f56fb3d5ff4a6c9942148fd94f16c57bbdfd2a7288ebd1a21250bcf28159df91feec6de7157fca81c1f44a0a83df2544fd200b9eff01ce24744712a780ed
+  metadata.gz: 0b6064c6bc6770d87cfec29a3ca6539131b80583a2108944ed74bc361a8576aa5d7d46dcf2858e1e62acd8a0bf931a18cef04d464468e623463dad1b60326649
+  data.tar.gz: 29d10f206bc1b7190a9f08fed733c998919b77c7ece24a282d6bb58a7ef21df1e1ebc287a45bce3305cd71597fd5f477e0865257a471427559a3d78b8f2a8d39

data/README.md

@@ -272,6 +272,43 @@ The creation of the PatientVisit can be customized by sending the following para
 * discharge_location → Array of discharge locations to randomly choose from.  Specified as comma separated String or Ruby array. Otherwise a string of data is generated with Faker::Lorem.sentence
 * admit_datetime → The admit date/time associated with this visit.  If not specified the current date/time is used.
 
+### Hl7 Message
+
+```ruby
+hl7 = HealthcarePhony::Hl7Message.new
+```
+
+The above will give you a default Hl7Message object:
+
+```
+#<HealthcarePhony::Hl7Message:0x00007f81979beb58
+ @message_type="MDM",
+ @trigger_event="T04",
+ @message_control_id="PHONY8408942134",
+ @version="2.5.1", @sending_facility="",
+ @sending_application="",
+ @receiving_application="",
+ @receiving_facility="",
+ @message_datetime=2021-01-16 20:29:10 -0500,
+ @processing_id="P">
+```
+
+The creation of the Hl7Message object can be customized by sending the following parameters when initializing:
+
+* message_version - HL7v2 version (MSH.12)
+* message_processing_id - Typically P or T (MSH.11)
+* message_types - Array of Message Types (MSH.9.1) to randomly choose from.  Specified as comma separated String or Ruby array.
+* message_type_file - Location of file containing Message Types (MSH.9.1). If not specified then included [hl7_message_types.yml](https://github.com/austinmoody/healthcare_phony/blob/main/lib/healthcare_phony/data_files/hl7_message_types.yml) file will be used.
+* message_events - Generic array of Trigger Events (MSH.9.2) to randomly choose from.  Specified as command separated String or Ruby array.
+* adt_events - Array of ADT Trigger Events (MSH.9.2) to randomly choose from. Used (if specified) if the Message type for the message is ADT. ADT events from [adt_event_types.yml](https://github.com/austinmoody/healthcare_phony/blob/main/lib/healthcare_phony/data_files/adt_event_types.yml) will be used by default.
+* oru_events - Array of ORU Trigger Events (MSH.9.2) to randomly choose from. Used (if specified) if the Message type for the message is ORU. ORU events from [oru_event_types.yml](https://github.com/austinmoody/healthcare_phony/blob/main/lib/healthcare_phony/data_files/adt_event_types.yml) will be used by default.
+* mdm_events - Array of MDM Trigger Events (MSH.9.2) to randomly choose from. Used (if specified) if the Message type for the message is MDM. MDM events from [mdm_event_types.yml](https://github.com/austinmoody/healthcare_phony/blob/main/lib/healthcare_phony/data_files/adt_event_types.yml) will be used by default.
+* message_control_id_pattern - Regex pattern used to randomly generate MSH.10 values.  Default is PHONY\d{10} which will generate a value like: PHONY6850295805
+* message_sending_facility - Array of Sending Facilities (MSH.4) to randomly choose from.  Specified as comma separated String or Ruby Array.
+* message_sending_application - Array of Sending Applications (MSH.3) to randomly choose from.  Specified as comma separated String or Ruby Array.
+* message_receiving_application - Array of Receiving Applications (MSH.5) to randomly choose from.  Specified as comma separated String or Ruby Array.
+* message_receiving_facility - Array of Receiving Facilities (MSH.6) to randomly choose from.  Specified as comma separated String or Ruby Array.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/austinmoody/healthcare_phony. 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/[USERNAME]/healthcare_phony/blob/master/CODE_OF_CONDUCT.md).

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/lib/healthcare_phony.rb

@@ -11,21 +11,23 @@ Faker::Config.locale = 'en-US'
 
 module HealthcarePhony
   class Adt
-    attr_reader :template_file
+    attr_reader :template_file, :adt_arguments
 
-    def initialize(template_file = nil)
-      @template_file = if template_file.nil?
+    def initialize(**init_args)
+      @adt_arguments = init_args
+      @adt_arguments[:message_types] = 'ADT'
+      @template_file = if adt_arguments[:template_file].nil?
                          File.join(File.dirname(__FILE__), 'healthcare_phony', 'templates', 'adt_example.erb')
                        else
-                         template_file
+                         adt_arguments[:template_file]
                        end
     end
 
     def to_s
       template = ERB.new(File.read(@template_file))
-      message = Hl7Message.new
-      patient = Patient.new
-      visit = PatientVisit.new
+      message = Hl7Message.new(@adt_arguments)
+      patient = Patient.new(@adt_arguments)
+      visit = PatientVisit.new(@adt_arguments)
       template.result_with_hash({ patient: patient, hl7: message, visit: visit })
     end
   end

data/lib/healthcare_phony/hl7_message.rb

@@ -15,35 +15,38 @@ module HealthcarePhony
                    :processing_id
 
     # Public: Initializes an Address. Pass in hash of different parameters, currently this includes:
-    # version - HL7v2 version (MSH.12)
-    # processing_id - Typically P or T (MSH.11)
-    # types - Array of Message Types (MSH.9.1) to randomly choose from.  Specified as comma separated String or
+    # message_version - HL7v2 version (MSH.12)
+    # message_processing_id - Typically P or T (MSH.11)
+    # message_types - Array of Message Types (MSH.9.1) to randomly choose from.  Specified as comma separated String or
     # Ruby array.
     # message_type_file - Location of file containing Message Types (MSH.9.1). If not specified then included
     # {hl7_message_types.yml}[https://github.com/austinmoody/healthcare_phony/blob/main/lib/healthcare_phony/data_files/hl7_message_types.yml] file will be used.
-    # events - Array of Trigger Events (MSH.9.2) to randomly choose from.  Specified as command separated String or
-    # Ruby array.
-    # adt_events_file - Location of file containing ADT Trigger Events (MSH.9.2). If not specified then included
-    # {adt_event_types.yml}[https://github.com/austinmoody/healthcare_phony/blob/main/lib/healthcare_phony/data_files/adt_event_types.yml] file will be used.
-    # oru_events_file - Location of file containing ORU Trigger Events (MSH.9.2). If not specified then included
-    # {oru_event_types.yml}[https://github.com/austinmoody/healthcare_phony/blob/main/lib/healthcare_phony/data_files/adt_event_types.yml] file will be used.
-    # mdm_events_file - Location of file containing MDM Trigger Events (MSH.9.2). If not specified then included
-    # {mdm_event_types.yml}[https://github.com/austinmoody/healthcare_phony/blob/main/lib/healthcare_phony/data_files/adt_event_types.yml] file will be used.
-    # control_id_pattern - Regex pattern used to randomly generate MSH.10 values.  Default is PHONY\d{10} which will
+    # message_events - Generic array of Trigger Events (MSH.9.2) to randomly choose from.  Specified as command
+    # separated String or Ruby array.
+    # adt_events - Array of ADT Trigger Events (MSH.9.2) to randomly choose from. Used (if specified) if the Message
+    # type for the message is ADT. ADT events from {adt_event_types.yml}[https://github.com/austinmoody/healthcare_phony/blob/main/lib/healthcare_phony/data_files/adt_event_types.yml]
+    # will be used by default.
+    # oru_events - Array of ORU Trigger Events (MSH.9.2) to randomly choose from. Used (if specified) if the Message
+    # type for the message is ORU. ORU events from {oru_event_types.yml}[https://github.com/austinmoody/healthcare_phony/blob/main/lib/healthcare_phony/data_files/adt_event_types.yml]
+    # will be used by default.
+    # mdm_events - Array of MDM Trigger Events (MSH.9.2) to randomly choose from. Used (if speciifed) if the Message
+    # type for the message is MDM. MDM events from {mdm_event_types.yml}[https://github.com/austinmoody/healthcare_phony/blob/main/lib/healthcare_phony/data_files/adt_event_types.yml]
+    # will be used by default.
+    # message_control_id_pattern - Regex pattern used to randomly generate MSH.10 values.  Default is PHONY\d{10} which will
     # generate a value like: PHONY6850295805
-    # sending_facility - Array of Sending Facilities (MSH.4) to randomly choose from.  Specified as comma separated
+    # message_sending_facility - Array of Sending Facilities (MSH.4) to randomly choose from.  Specified as comma separated
     # String or Ruby Array.
-    # sending_application - Array of Sending Applications (MSH.3) to randomly choose from.  Specified as comma
+    # message_sending_application - Array of Sending Applications (MSH.3) to randomly choose from.  Specified as comma
     # separated String or Ruby Array.
-    # receiving_application - Array of Receiving Applications (MSH.5) to randomly choose from.  Specified as comma
+    # message_receiving_application - Array of Receiving Applications (MSH.5) to randomly choose from.  Specified as comma
     # separated String or Ruby Array.
-    # receiving_facility - Array of Receiving Facilities (MSH.6) to randomly choose from.  Specified as comma separated
+    # message_receiving_facility - Array of Receiving Facilities (MSH.6) to randomly choose from.  Specified as comma separated
     # String or Ruby Array.
     def initialize(**init_args)
       define_message_type(init_args)
       define_trigger_event(init_args)
       define_control_id(init_args)
-      @version = init_args[:version].nil? ? '2.5.1' : init_args[:version]
+      @version = init_args[:message_version].nil? ? '2.5.1' : init_args[:message_version]
       define_sending_facility(init_args)
       define_sending_application(init_args)
       define_receiving_application(init_args)
@@ -52,7 +55,7 @@ module HealthcarePhony
       # Potential use case to allow you to provide begin/end date?
       @message_datetime = Time.now
 
-      @processing_id = init_args[:processing_id].nil? ? 'P' : init_args[:processing_id]
+      @processing_id = init_args[:message_processing_id].nil? ? 'P' : init_args[:message_processing_id]
     end
 
     private
@@ -60,8 +63,8 @@ module HealthcarePhony
     def define_message_type(**init_args)
       file_name = "#{::File.expand_path(::File.join("..", "data_files"), __FILE__)}/hl7_message_types.yml"
       file_name = init_args[:message_type_file] unless init_args[:message_type_file].nil?
-      hl7_message_types = if !init_args[:types].nil?
-                            Helper.get_array(init_args[:types])
+      hl7_message_types = if !init_args[:message_types].nil?
+                            Helper.get_array(init_args[:message_types])
                           else
                             Psych.load_file(file_name)
                           end
@@ -69,10 +72,17 @@ module HealthcarePhony
     end
 
     def define_trigger_event(**init_args)
-      @trigger_event = Helper.get_array(init_args[:events]).sample
-      @trigger_event = define_adt_trigger_event(init_args) unless @message_type != 'ADT'
-      @trigger_event = define_oru_trigger_event(init_args) unless @message_type != 'ORU'
-      @trigger_event = define_mdm_trigger_event(init_args) unless @message_type != 'MDM'
+      @trigger_event = Helper.get_array(init_args[:message_events]).sample
+      return unless @trigger_event.nil?
+
+      case @message_type
+      when 'ADT'
+        @trigger_event = define_adt_trigger_event(init_args)
+      when 'ORU'
+        @trigger_event = define_oru_trigger_event(init_args)
+      when 'MDM'
+        @trigger_event = define_mdm_trigger_event(init_args)
+      end
     end
 
     def define_adt_trigger_event(**init_args)
@@ -92,44 +102,57 @@ module HealthcarePhony
 
     def get_adt_events(**init_args)
       file_name = "#{::File.expand_path(::File.join("..", "data_files"), __FILE__)}/adt_event_types.yml"
-      file_name = init_args[:adt_events_file] unless init_args[:adt_events_file].nil?
-      Psych.load_file(file_name)
+      if init_args[:adt_events].nil?
+        Psych.load_file(file_name)
+      else
+        Helper.get_array(init_args[:adt_events])
+      end
     end
 
     def get_oru_events(**init_args)
       file_name = "#{::File.expand_path(::File.join("..", "data_files"), __FILE__)}/oru_event_types.yml"
-      file_name = init_args[:oru_events_file] unless init_args[:oru_events_file].nil?
-      Psych.load_file(file_name)
+      if init_args[:oru_events].nil?
+        Psych.load_file(file_name)
+      else
+        Helper.get_array(init_args[:oru_events])
+      end
     end
 
     def get_mdm_events(**init_args)
       file_name = "#{::File.expand_path(::File.join("..", "data_files"), __FILE__)}/mdm_event_types.yml"
-      file_name = init_args[:mdm_events_file] unless init_args[:mdm_events_file].nil?
-      Psych.load_file(file_name)
+      if init_args[:mdm_events].nil?
+        Psych.load_file(file_name)
+      else
+        Helper.get_array(init_args[:mdm_events])
+      end
     end
 
     def define_control_id(**init_args)
-      control_id_pattern = init_args[:control_id_pattern].nil? ? 'PHONY\d{10}' : init_args[:control_id_pattern]
+      control_id_pattern = if init_args[:message_control_id_pattern].nil?
+                             'PHONY\d{10}'
+                           else
+                             init_args[:message_control_id_pattern]
+                           end
       @message_control_id = Regexp.new(control_id_pattern).random_example
     end
 
     def define_sending_facility(**init_args)
-      sf_choices = Helper.get_array(init_args[:sending_facility])
+      sf_choices = Helper.get_array(init_args[:message_sending_facility])
       @sending_facility = !sf_choices.empty? ? sf_choices.sample : ''
     end
 
     def define_sending_application(**init_args)
-      sa_choices = Helper.get_array(init_args[:sending_application])
+      sa_choices = Helper.get_array(init_args[:message_sending_application])
       @sending_application = !sa_choices.empty? ? sa_choices.sample : ''
     end
 
     def define_receiving_application(**init_args)
-      ra_choices = Helper.get_array(init_args[:receiving_application])
+      ra_choices = Helper.get_array(init_args[:message_receiving_application])
       @receiving_application = !ra_choices.empty? ? ra_choices.sample : ''
     end
 
     def define_receiving_facility(**init_args)
-      rf_choices = Helper.get_array(init_args[:receiving_facility])
+      rf_choices = Helper.get_array(init_args[:message_receiving_facility])
       @receiving_facility = !rf_choices.empty? ? rf_choices.sample : ''
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: healthcare_phony
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Austin Moody
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-15 00:00:00.000000000 Z
+date: 2021-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler