healthcare_phony 0.3.0

data/lib/healthcare_phony/hl7_message.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module HealthcarePhony
+  # Public: Generates information needed to build an HL7v2 message
+  class Hl7Message
+    attr_accessor  :message_type,
+                   :trigger_event,
+                   :message_control_id,
+                   :version,
+                   :sending_application,
+                   :sending_facility,
+                   :receiving_application,
+                   :receiving_facility,
+                   :message_datetime,
+                   :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
+    # 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
+    # generate a value like: PHONY6850295805
+    # 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
+    # separated String or Ruby Array.
+    # 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
+    # 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]
+      define_sending_facility(init_args)
+      define_sending_application(init_args)
+      define_receiving_application(init_args)
+      define_receiving_facility(init_args)
+
+      # 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]
+    end
+
+    private
+
+    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])
+                          else
+                            Psych.load_file(file_name)
+                          end
+      @message_type = hl7_message_types.nil? ? '' : hl7_message_types.sample
+    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'
+    end
+
+    def define_adt_trigger_event(**init_args)
+      event_types = get_adt_events(init_args)
+      event_types&.sample
+    end
+
+    def define_oru_trigger_event(**init_args)
+      event_types = get_oru_events(init_args)
+      event_types&.sample
+    end
+
+    def define_mdm_trigger_event(**init_args)
+      event_types = get_mdm_events(init_args)
+      event_types&.sample
+    end
+
+    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)
+    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)
+    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)
+    end
+
+    def define_control_id(**init_args)
+      control_id_pattern = init_args[:control_id_pattern].nil? ? 'PHONY\d{10}' : init_args[:control_id_pattern]
+      @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])
+      @sending_facility = !sf_choices.empty? ? sf_choices.sample : ''
+    end
+
+    def define_sending_application(**init_args)
+      sa_choices = Helper.get_array(init_args[: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])
+      @receiving_application = !ra_choices.empty? ? ra_choices.sample : ''
+    end
+
+    def define_receiving_facility(**init_args)
+      rf_choices = Helper.get_array(init_args[:receiving_facility])
+      @receiving_facility = !rf_choices.empty? ? rf_choices.sample : ''
+    end
+  end
+end

data/lib/healthcare_phony/home_phone_number.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require File.expand_path('phone_number', __dir__)
+
+module HealthcarePhony
+  # Public: Generates a fake home phone number
+  class HomePhoneNumber < PhoneNumber
+    # Public: Initializes a home phone number. Pass in hash of different parameters, currently this includes:
+    # blank - An integer representing the % of times phone number components should be blank.
+    # use_code - Allows specification of the phone use code (PID.13.2)
+    # equipment_type - Allows specification of the phone equipment type (PID.13.3)
+    def initialize(**init_args)
+      super(init_args)
+      @use_code = init_args[:use_code].nil? ? 'PRN' : init_args[:use_code]
+      @use_code = '' unless @set_blank == false
+      @equipment_type = init_args[:equipment_type].nil? ? 'PH' : init_args[:equipment_type]
+      @equipment_type = '' unless @set_blank == false
+    end
+  end
+end

data/lib/healthcare_phony/identifier.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'regexp-examples'
+
+module HealthcarePhony
+  # Public: Randomly generates an identifier.
+  class Identifier
+    attr_accessor :identifier,
+                  :identifier_type_code
+
+    # Public: Initializes an Address. Pass in hash of different parameters, currently this includes:
+    # type_code - Identifier Type Code, example PID.3.5.  HL7 Data Table 0203
+    # pattern - Regex pattern used to randomly generate the identifier.  Default is \d{10} which would generate an
+    # identifier like 5992657933.
+    def initialize(**init_args)
+      @identifier_type_code = init_args[:type_code].nil? ? '' : init_args[:type_code]
+
+      identifier_pattern = init_args[:pattern].nil? ? '\d{10}' : init_args[:pattern]
+
+      @identifier = Regexp.new(identifier_pattern).random_example
+    end
+  end
+end

data/lib/healthcare_phony/insurance.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module HealthcarePhony
+  class Insurance
+  end
+end

data/lib/healthcare_phony/language.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module HealthcarePhony
+  # Public: Generate random Language using data from YAML file.
+  class Language
+    attr_accessor :code,
+                  :description,
+                  :coding_system
+
+    # Public: Initializes an Address. Pass in hash of different parameters, currently this includes:
+    # language_data_file - Location of YAML file containing Language data (Code, Description, and Coding System) if a
+    # different set of random values is desired.  Otherwise the default file {language.yml}[https://github.com/austinmoody/healthcare_phony/blob/main/lib/healthcare_phony/data_files/language.yml] will be used.
+    def initialize(**init_args)
+      # TODO: allow a way for caller to pass in a custom set of codes to choose from.
+      # TODO: allow a way for caller to pass in % blank
+
+      data_file = if !init_args[:language_data_file].nil?
+                    init_args[:language_data_file]
+                  else
+                    "#{::File.expand_path(::File.join("..", "data_files"), __FILE__)}/language.yml"
+                  end
+      language_array = Psych.load_file(data_file)
+      random_language = language_array.nil? ? '' : language_array.sample
+
+      @code = random_language[:code]
+      @description = random_language[:description]
+      @coding_system = random_language[:coding_system]
+    end
+  end
+end

data/lib/healthcare_phony/marital_status.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module HealthcarePhony
+  # Public: Generates a random MaritalStatus using data from a YAML file.
+  class MaritalStatus
+    attr_accessor :code,
+                  :description,
+                  :coding_system
+
+    # Public: Initializes an Address. Pass in hash of different parameters, currently this includes:
+    # marital_status_data_file - Location of YAML file containing Language data (Code, Description, and Coding System)
+    # if a different set of random values is desired.  Otherwise the default file {marital_status.yml}[https://github.com/austinmoody/healthcare_phony/blob/main/lib/healthcare_phony/data_files/marital_status.yml] will be used.
+    def initialize(**init_args)
+      # TODO: allow a way for caller to pass in a custom set of codes to choose from
+      # TODO: allow a way for caller to pass in % blank
+
+      data_file = if !init_args[:marital_status_data_file].nil?
+                    init_args[:marital_status_data_file]
+                  else
+                    "#{::File.expand_path(::File.join("..", "data_files"), __FILE__)}/marital_status.yml"
+                  end
+      ms_array = Psych.load_file(data_file)
+
+      random_ms = ms_array.nil? ? '' : ms_array.sample
+
+      @code = random_ms[:code]
+      @description = random_ms[:description]
+      @coding_system = random_ms[:coding_system]
+    end
+  end
+end

data/lib/healthcare_phony/patient.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module HealthcarePhony
+  # Public: Randomly generate a Patient
+  class Patient
+    attr_accessor :names,
+                  :medical_record_number,
+                  :account_number,
+                  :addresses,
+                  :date_of_birth,
+                  :gender,
+                  :races,
+                  :home_phone, # TODO: allow for > 1
+                  :cell_phone, # TODO: allow for > 1
+                  :work_phone, # TODO: allow for > 1
+                  :email,
+                  :language,
+                  :marital_status,
+                  :religion,
+                  :ssn,
+                  :drivers_license,
+                  :ethnic_group,
+                  :multiple_birth_indicator,
+                  :birth_order,
+                  :death_indicator,
+                  :death_datetime
+
+    def initialize(**init_args)
+      define_gender(init_args)
+      define_names(init_args)
+      define_addresses(init_args)
+      define_phones(init_args)
+      define_dob(init_args)
+      define_race(init_args)
+      define_other
+      define_identifiers
+      define_birth_order
+      define_death
+    end
+
+    private
+
+    def define_gender(**init_args)
+      @gender = if !init_args[:gender].nil? && init_args[:gender].is_a?(HealthcarePhony::Gender)
+                  init_args[:gender]
+                else
+                  HealthcarePhony::Gender.new(init_args)
+                end
+    end
+
+    def define_names(**init_args)
+      init_args[:gender] = @gender
+      names_count = init_args[:names_count].nil? || init_args[:names_count] < 1 ? 1 : init_args[:names_count]
+      @names = []
+      while names_count.positive?
+        @names.push(PersonName.new(init_args))
+        names_count -= 1
+      end
+    end
+
+    def define_addresses(**init_args)
+      address_count = init_args[:address_count].nil? || init_args[:address_count] < 1 ? 1 : init_args[:address_count]
+      @addresses = []
+      while address_count.positive?
+        @addresses.push(Address.new)
+        address_count -= 1
+      end
+    end
+
+    def define_phones(**init_args)
+      @home_phone = HomePhoneNumber.new(init_args)
+      @cell_phone = CellPhoneNumber.new(init_args)
+      @work_phone = WorkPhoneNumber.new(init_args)
+    end
+
+    def define_dob(**init_args)
+      min_age = init_args[:min_age].nil? ? 1 : init_args[:min_age]
+      max_age = init_args[:max_age].nil? ? 99 : init_args[:max_age]
+      @date_of_birth = Faker::Date.birthday(min_age: min_age, max_age: max_age)
+    end
+
+    def define_race(**init_args)
+      races_count = init_args[:race_count].nil? || init_args[:race_count] < 1 ? 1 : init_args[:race_count]
+      @races = []
+      while races_count.positive?
+        @races.push(Race.new)
+        races_count -= 1
+      end
+    end
+
+    def define_identifiers
+      @medical_record_number = Identifier.new(type_code: 'MR')
+      @account_number = Identifier.new(type_code: 'AN')
+      @ssn = Faker::IDNumber.ssn_valid
+    end
+
+    def define_death
+      @death_indicator = %w[Y N].sample
+      @death_datetime = @death_indicator == 'Y' ? Faker::Time.between(from: @date_of_birth.to_date, to: Time.now) : ''
+    end
+
+    def define_birth_order
+      @multiple_birth_indicator = %w[Y N].sample
+      @birth_order = @multiple_birth_indicator == 'Y' ? /[1-2]/.random_example : ''
+    end
+
+    def define_other
+      @language = Language.new
+      @marital_status = MaritalStatus.new
+      @religion = Religion.new
+      @ethnic_group = EthnicGroup.new
+    end
+  end
+end

data/lib/healthcare_phony/patient_visit.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module HealthcarePhony
+  # Public: Randomly generates data for a PatientVisit (PV1 segment)
+  class PatientVisit
+    attr_accessor :patient_class,
+                  :admission, :doctors,
+                  :hospital_service, :readmission_indicator,
+                  :ambulatory_status, :vip_indicator, :patient_type,
+                  :visit_number, :bed_status,
+                  :discharge, :location
+
+    # Public: Initializes an Address. Pass in hash of different parameters, currently this includes:
+    # hospital_service - Array of Hospital Service codes (PV1.10) to randomly choose from.  Specified as comma separated
+    # String or Ruby array. Otherwise default HL7 v2.5.1 Table 0069 values are used.
+    # patient_class - Array of Patient Class codes (PV1.2) to randomly choose from.  Specified as comma separated
+    # String or Ruby array. Otherwise default HL7 v2.5.1 Table 0004 values are used.
+    # ambulatory_status - Array of Ambulatory Status codes (PV1.15) to randomly choose from. Specified as comma
+    # separated String or Ruby array. Otherwise default HL7 v2.5.1 Table 0009 values are used.
+    # bed_status - Array of Bed Status codes (PV1.40) to randomly choose from. Specified as comma separated String or
+    # Ruby array.  Otherwise default HL7 v2.5.1 Table 0116 values are used.
+    # patient_type - Array of Patient Type codes (PV1.18) to randomly choose from. Specified as comma separated String
+    # or Ruby array. Otherwise this field is left blank.
+    # vip_indicator - Array of Patient Type codes (PV1.18) to randomly choose from. Specified as comma separated String
+    # or Ruby array. Otherwise this field is left blank.
+    def initialize(**init_args)
+      @doctors = VisitDoctors.new
+      @location = VisitLocation.new(init_args)
+      @admission = VisitAdmission.new(init_args)
+      @bed_status = define_bed_status(init_args)
+      @visit_number = Identifier.new(type_code: 'VN')
+      @readmission_indicator = Helper.random_with_blank('R', 50)
+      @patient_type = define_patient_type(init_args)
+      @vip_indicator = define_vip(init_args)
+      @ambulatory_status = define_ambulatory_status(init_args)
+      @patient_class = define_patient_class(init_args)
+      @hospital_service = define_hospital_service(init_args)
+      @discharge = VisitDischarge.new(init_args.merge({ admit_datetime: @admission.datetime }))
+    end
+
+    private
+
+    def define_hospital_service(**init_args)
+      standard_hospital_service = %w[CAR MED PUL SUR URO]
+      hs_choices = Helper.get_array(init_args[:hospital_service])
+      if !hs_choices.empty?
+        hs_choices.sample
+      else
+        standard_hospital_service.sample
+      end
+    end
+
+    def define_patient_class(**init_args)
+      standard_pc_choices = %w[B C E I N O P R U]
+      pc_choices = Helper.get_array(init_args[:patient_class])
+      !pc_choices.empty? ? pc_choices.sample : standard_pc_choices.sample
+    end
+
+    def define_ambulatory_status(**init_args)
+      standard_ambulatory_status = %w[A0 A1 A2 A3 A4 A5 A6 A7 A8 A9 B1 B2 B3 B4 B5 B6]
+      as_choices = Helper.get_array(init_args[:ambulatory_status])
+      if !as_choices.empty?
+        as_choices.sample
+      else
+        standard_ambulatory_status.sample
+      end
+    end
+
+    def define_bed_status(**init_args)
+      bs_choices = Helper.get_array(init_args[:bed_status])
+      if !bs_choices.empty?
+        bs_choices.sample
+      else
+        %w[C H I K O U].sample
+      end
+    end
+
+    def define_patient_type(**init_args)
+      pt_choices = Helper.get_array(init_args[:patient_type])
+      if !pt_choices.empty?
+        pt_choices.sample
+      else
+        ''
+      end
+    end
+
+    def define_vip(**init_args)
+      vip_choices = Helper.get_array(init_args[:vip_indicator])
+      if !vip_choices.empty?
+        vip_choices.sample
+      else
+        ''
+      end
+    end
+  end
+end