healthcare_phony 0.3.0

data/lib/healthcare_phony/person_name.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module HealthcarePhony
+  # Public: Randomly generates a patient name.
+  class PersonName
+    attr_accessor :family_name,
+                  :given_name,
+                  :middle_name,
+                  :suffix,
+                  :prefix,
+                  :degree
+
+    # Public: Initializes an Address. Pass in hash of different parameters, currently this includes:
+    # blank - An integer representing the % of times PatientName components should be blank.
+    # gender - A Gender object which will be used to generate a Male or Female name if specified.
+    # degree_data_file - Location of YAML file containing a list of potential degrees to choose from. By default the
+    # gem supplied file will be used.  The default file {degree.yml}[https://github.com/austinmoody/healthcare_phony/blob/main/lib/healthcare_phony/data_files/degree.yml].
+    def initialize(**init_args)
+      @set_blank = !init_args[:blank].nil? && Helper.random_with_blank('X', init_args[:blank]) == ''
+      @gender = init_args[:gender]
+      @degree_data_file = get_degree_data_file(init_args)
+      @given_name = define_given_name
+      @family_name = define_family_name
+      @middle_name = define_middle_name
+      @suffix = define_suffix
+      @prefix = define_prefix
+      @degree = define_degree(init_args)
+    end
+
+    private
+
+    # Private: Boolean set during initialization if Address components should be set to blank.
+    attr_accessor :set_blank
+    attr_accessor :degree_data_file
+
+    def get_degree_data_file(**init_args)
+      if !init_args[:degree_data_file].nil?
+        init_args[:degree_data_file]
+      else
+        "#{::File.expand_path(::File.join("..", "data_files"), __FILE__)}/degree.yml"
+      end
+    end
+
+    def define_given_name
+      if @set_blank
+        ''
+      elsif !@gender.nil? && @gender.code == 'M'
+        Faker::Name.male_first_name
+      elsif !@gender.nil? && @gender.code == 'F'
+        Faker::Name.female_first_name
+      else
+        Faker::Name.first_name
+      end
+    end
+
+    def define_family_name
+      if @set_blank
+        ''
+      else
+        Faker::Name.last_name
+      end
+    end
+
+    def define_middle_name
+      if @set_blank
+        ''
+      else
+        Faker::Name.middle_name
+      end
+    end
+
+    def define_suffix
+      if @set_blank
+        ''
+      else
+        Faker::Name.suffix
+      end
+    end
+
+    def define_prefix
+      if @set_blank
+        ''
+      else
+        Faker::Name.prefix
+      end
+    end
+
+    def define_degree(**init_args)
+      if @set_blank
+        ''
+      elsif !init_args[:degree].nil?
+        degree_choices = Helper.get_array(init_args[:degree])
+        degree_choices.sample unless degree_choices.empty?
+      else
+        degrees_from_file
+      end
+    end
+
+    def degrees_from_file
+      degrees = Psych.load_file(@degree_data_file)
+      degrees.nil? ? '' : degrees.sample
+    end
+  end
+end

data/lib/healthcare_phony/phone_number.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module HealthcarePhony
+  # Public: Generates a fake phone number
+  class PhoneNumber
+    attr_accessor :number,
+                  :country_code,
+                  :area_code,
+                  :exchange_code,
+                  :subscriber_number,
+                  :use_code,
+                  :equipment_type
+
+    def initialize(**init_args)
+      # 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_data_file - YAML file containing use codes to randomly choose from.  If not specified then values from
+      # {tele_use_code.yml}[https://github.com/austinmoody/healthcare_phony/blob/main/lib/healthcare_phony/data_files/tele_use_code.yml] are used.
+      # equipment_type_data_file - YAML file containing equipment type codes to randomly choose from.  If not specified
+      # then values {tele_equipment_type}[https://github.com/austinmoody/healthcare_phony/blob/main/lib/healthcare_phony/data_files/tele_equipment_type.yml] will be used.
+      @set_blank = !init_args[:blank].nil? && Helper.random_with_blank('X', init_args[:blank]) == ''
+      @use_code_data_file = init_args[:use_code_data_file]
+      @equipment_type_data_file = init_args[:equipment_type_data_file]
+      define_country_code
+      define_area_code
+      define_exchange_code
+      define_subscriber_number
+      define_use_code
+      define_equipment_type
+    end
+
+    private
+
+    # Private: Boolean set during initialization if Address components should be set to blank.
+    attr_accessor :set_blank
+
+    # Private: Location of data file of use codes
+    attr_accessor :use_code_data_file
+
+    # Private: Location of data file of equipment types
+    attr_accessor :equipment_type_data_file
+
+    def define_country_code
+      @country_code = Faker::PhoneNumber.country_code
+      @country_code = '' unless @set_blank == false
+    end
+
+    def define_area_code
+      @area_code = Faker::PhoneNumber.area_code
+      @area_code = '' unless @set_blank == false
+    end
+
+    def define_exchange_code
+      @exchange_code = Faker::PhoneNumber.exchange_code
+      @exchange_code = '' unless @set_blank == false
+    end
+
+    def define_subscriber_number
+      @subscriber_number = Faker::PhoneNumber.subscriber_number
+      @subscriber_number = '' unless @set_blank == false
+    end
+
+    def define_use_code
+      data_file = if !@use_code_data_file.nil?
+                    @use_code_data_file
+                  else
+                    "#{::File.expand_path(::File.join("..", "data_files"), __FILE__)}/tele_use_code.yml"
+                  end
+      use_codes = Psych.load_file(data_file)
+      @use_code = use_codes.nil? ? '' : use_codes.sample
+      @use_code = '' unless @set_blank == false
+    end
+
+    def define_equipment_type
+      data_file = if !@equipment_type_data_file.nil?
+                    @equipment_type_data_file
+                  else
+                    "#{::File.expand_path(::File.join("..", "data_files"), __FILE__)}/tele_equipment_type.yml"
+                  end
+      equipment_types = Psych.load_file(data_file)
+      @equipment_type = equipment_types.nil? ? '' : equipment_types.sample
+      @equipment_type = '' unless @set_blank == false
+    end
+  end
+end

data/lib/healthcare_phony/procedure.rb

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

data/lib/healthcare_phony/race.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module HealthcarePhony
+  # Public: Creates a Race by randomly choosing values from a YAML file.
+  class Race
+    attr_accessor :code,
+                  :description,
+                  :coding_system
+    # Public: Initializes an Address. Pass in hash of different parameters, currently this includes:
+    # race_data_file - Location of YAML file containing a list of potential degrees to choose from. By default the
+    # gem supplied file will be used.  The default file {race.yml}[https://github.com/austinmoody/healthcare_phony/blob/main/lib/healthcare_phony/data_files/race.yml].
+    def initialize(**init_args)
+      # TODO: allow a way for caller to pass in % blank
+      # TODO: set coding system
+
+      data_file = if !init_args[:race_data_file].nil?
+                    init_args[:race_data_file]
+                  else
+                    "#{::File.expand_path(::File.join("..", "data_files"), __FILE__)}/race.yml"
+                  end
+      race_array = Psych.load_file(data_file)
+
+      random_race = race_array.nil? ? '' : race_array.sample
+
+      @code = random_race[:code]
+      @description = random_race[:description]
+      @coding_system = ''
+    end
+  end
+end

data/lib/healthcare_phony/religion.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module HealthcarePhony
+  # Public: Creates a Religion object for a Patient by randomly choosing a value from a YAML file.
+  class Religion
+    attr_accessor :code,
+                  :description,
+                  :coding_system
+
+    # Public: Initializes an EthnicGroup. Pass in hash of different parameters, currently this includes:
+    # religion_data_file - YAML file containing religion information to randomly choose from if different options than
+    # those that come with gem are desired.  See {religion.yml}[https://github.com/austinmoody/healthcare_phony/blob/main/lib/healthcare_phony/data_files/religion.yml]
+    # for default values.
+    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[:religion_data_file].nil?
+                    init_args[:religion_data_file]
+                  else
+                    "#{::File.expand_path(::File.join("..", "data_files"), __FILE__)}/religion.yml"
+                  end
+      r_array = Psych.load_file(data_file)
+
+      random_religion = r_array.nil? ? '' : r_array.sample
+
+      @code = random_religion[:code]
+      @description = random_religion[:description]
+      @coding_system = random_religion[:coding_system]
+    end
+  end
+end

data/lib/healthcare_phony/templates/adt_example.erb

@@ -0,0 +1,6 @@
+MSH|^~\&|<%= hl7.sending_application %>|<%= hl7.sending_facility %>|<%= hl7.receiving_application %>|<%= hl7.receiving_facility %>|<%= hl7.message_datetime.to_hl7datetime() %>||<%= hl7.message_type %>^<%= hl7.trigger_event %>|<%= hl7.message_control_id %>|<%= hl7.processing_id %>|<%= hl7.version %>
+EVN|<%= hl7.trigger_event %>|<%= hl7.message_datetime.to_hl7datetime() %>
+PID|||<%= patient.medical_record_number.identifier %>||<%= patient.names[0].family_name %>^<%= patient.names[0].given_name %>^<%= patient.names[0].middle_name%>^||<%= patient.date_of_birth.to_hl7date %>|<%= patient.gender.code %>||<%= patient.races[0].code %>|<%= patient.addresses[0].address_line1 %>^<%= patient.addresses[0].address_line2 %>^<%= patient.addresses[0].city %>^<%= patient.addresses[0].state %>^<%= patient.addresses[0].postal_code %>||(<%= patient.home_phone.area_code %>)<%= patient.home_phone.exchange_code %>-<%= patient.home_phone.subscriber_number %>~(<%= patient.cell_phone.area_code %>)<%= patient.cell_phone.exchange_code %>-<%= patient.cell_phone.subscriber_number %>|(<%= patient.work_phone.area_code %>)<%= patient.work_phone.exchange_code %>-<%= patient.work_phone.subscriber_number %>||||<%= patient.account_number.identifier %>|<%= patient.ssn %>
+PV1||<%= visit.patient_class %>
+
+

data/lib/healthcare_phony/templates/csv_example.erb

@@ -0,0 +1,4 @@
+<% if write_header %>
+MRN,FIRST_NAME,LAST_NAME
+<% end %>
+"<%= patient.medical_record_number.identifier %>","<%= patient.names[0].given_name %>","<%= patient.names[0].family_name %>"

data/lib/healthcare_phony/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module HealthcarePhony
+  VERSION = File.read(File.expand_path('../../VERSION', __dir__)).strip.freeze
+end

data/lib/healthcare_phony/visit_admission.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module HealthcarePhony
+  # Public: Creates admission information for a patient visit.
+  class VisitAdmission
+    attr_accessor :type, :datetime, :source, :reason
+
+    # Public: Initializes an EthnicGroup. Pass in hash of different parameters, currently this includes:
+    # admit_source - Array of Admit Source codes (PV1.14) to randomly choose from.  Specified as comma separated
+    # String or Ruby array. Otherwise default HL7 v2.5.1 Table 0023 values are used.
+    # admission_type - Array of Admission Type (PV1.4) to randomly choose from.  Specified as comma separated String or
+    # Ruby array. Otherwise default HL7 v2.5.1. Table 0007 values are used.
+    # admit_reason - Array of values to use as Admit Reason (PV2.3) to randomly choose from.  Specified as comma
+    # separated String or Ruby array.  Otherwise a string of data is generated with Faker::Lorem.sentence
+    def initialize(**init_args)
+      @source = define_source(init_args)
+      @type = define_type(init_args)
+      @datetime = Faker::Time.backward(days: Faker::Number.number(digits: 1))
+      @reason = define_reason(init_args)
+    end
+
+    private
+
+    def define_source(**init_args)
+      standard_admit_source = '123456789'.split('')
+      as_choices = Helper.get_array(init_args[:admit_source])
+      if !as_choices.empty?
+        as_choices.sample
+      else
+        standard_admit_source.sample
+      end
+    end
+
+    def define_type(**init_args)
+      standard_admission_types = %w[A C E L N R U]
+      at_choices = Helper.get_array(init_args[:admission_type])
+      if !at_choices.empty?
+        at_choices.sample
+      else
+        standard_admission_types.sample
+      end
+    end
+
+    def define_reason(**init_args)
+      ar_choices = Helper.get_array(init_args[:admit_reason])
+      if !ar_choices.empty?
+        ar_choices.sample
+      else
+        Faker::Lorem.sentence
+      end
+    end
+  end
+end

data/lib/healthcare_phony/visit_discharge.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module HealthcarePhony
+  # Public: Creates discharge information for a patient visit.
+  class VisitDischarge
+    attr_accessor :disposition,
+                  :location,
+                  :datetime
+
+    # Public: Initializes an EthnicGroup. Pass in hash of different parameters, currently this includes:
+    # event_type - The HL7 trigger event type that this visit is associated with.
+    # discharge_disposition - Array of discharge disposition codes (PV1.36) to randomly choose from.  Specified as comma
+    # separated String or Ruby array. Otherwise default HL7 v2.5.1 Table 0112 values are used.
+    # 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.
+    def initialize(**init_args)
+      if init_args[:event_type] == 'A03'
+        @disposition = define_discharge_disposition(init_args)
+        @location = define_discharge_location(init_args)
+        @datetime = define_discharge_datetime(init_args)
+      else
+        @disposition = ''
+        @location = ''
+        @datetime = nil
+      end
+    end
+
+    private
+
+    def define_discharge_disposition(**init_args)
+      dd_choices = Helper.get_array(init_args[:discharge_disposition])
+      if init_args[:event_type] != 'A03'
+        ''
+      elsif !dd_choices.empty?
+        dd_choices.sample
+      else
+        data_file = "#{::File.expand_path(::File.join("..", "data_files"), __FILE__)}/discharge_disposition.yml"
+        file_based_choices = Psych.load_file(data_file)
+        file_based_choices.nil? ? '' : file_based_choices.sample
+      end
+    end
+
+    def define_discharge_location(**init_args)
+      dl_choices = Helper.get_array(init_args[:discharge_location])
+      if !dl_choices.empty?
+        dl_choices.sample
+      else
+        Faker::Lorem.sentence
+      end
+    end
+
+    def define_discharge_datetime(**init_args)
+      from_datetime = if init_args[:admit_datetime].nil?
+                        Time.now
+                      else
+                        init_args[:admit_datetime]
+                      end
+      Faker::Time.between(from: from_datetime, to: DateTime.now)
+    end
+  end
+end

data/lib/healthcare_phony/visit_doctors.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module HealthcarePhony
+  # Public: Creates providers associated with visit.  Attending (PV1.7), Referring (PV1.8), Consulting (PV1.9), and
+  # Admitting (PV1.17)
+  class VisitDoctors
+    attr_accessor :attending,
+                  :referring,
+                  :consulting,
+                  :admitting
+
+    def initialize
+      @attending = Doctor.new
+      @referring = Doctor.new
+      @consulting = Doctor.new
+      @admitting = Doctor.new
+    end
+  end
+end

data/lib/healthcare_phony/visit_location.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module HealthcarePhony
+  # Public: Generates various location information associated with a visit.
+  class VisitLocation
+    attr_accessor :point_of_care,
+                  :room,
+                  :bed,
+                  :facility,
+                  :status,
+                  :type,
+                  :building,
+                  :floor,
+                  :description
+
+    # Public: Initializes an Address. Pass in hash of different parameters, currently this includes:
+    # point_of_care - Array of potential points of care (PV1.3.1) to randomly choose from. Specified as comma separated
+    # String or Ruby array. Otherwise random example generated.
+    # room - Array of potential rooms (PV1.3.2) to randomly choose from. Specified as comma separated String or Ruby
+    # array.  Otherwise a random 3 digit number is generated.
+    # bed - Array of potential beds (PV1.3.3) to randomly choose from. Specified as comma separated String or Ruby
+    # array. Otherwise a 3 character sequence is created.
+    # facility - Array of potential facility names (PV1.3.4) to randomly choose from. Specified as comma separated
+    # String or Ruby array. Otherwise a random string is generated.
+    # location_status - Array of potential location statuses (PV1.3.5) to randomly choose from. Specified as comma
+    # separated String or Ruby array. Otherwise a random uppercase letter is generated to use.
+    # person_location_type - Array of potential person location types (PV1.3.6) to randomly choose from.  Specified as
+    # comma separated String or Ruby array. Otherwise values from HL7 v2.5.1 Table 0305 will be used.
+    # building - Array of potential building information (PV1.3.7) to randomly choose from. Specified as a comma
+    # separated String or Ruby array. Otherwise a random digit 1-9 is used.
+    # floor - Array of potential floor information (PV1.3.8) to randomly choose from.  Specified as a comma separated
+    # String or Ruby array. Otherwise a random 2 digit number is used.
+    # location_description - Array of potential location descriptions (PV1.3.9) to randomly choose from.  Specified as
+    # a comma separated String or Ruby array. Otherwise a random string is generated.
+    def initialize(**init_args)
+      @point_of_care = define_point_of_care(init_args)
+      @room = define_room(init_args)
+      @bed = define_bed(init_args)
+      @facility = define_facility(init_args)
+      @status = define_status(init_args)
+      @type = define_type(init_args)
+      @building = define_building(init_args)
+      @floor = define_floor(init_args)
+      @description = define_description(init_args)
+    end
+
+    private
+
+    def define_point_of_care(**init_args)
+      poc_choices = Helper.get_array(init_args[:point_of_care])
+      !poc_choices.empty? ? poc_choices.sample : /[A-Z]{10}/.random_example
+    end
+
+    def define_room(**init_args)
+      room_choices = Helper.get_array(init_args[:room])
+      if !room_choices.empty?
+        room_choices.sample
+      else
+        Faker::Alphanumeric.alphanumeric(number: 3, min_alpha: 0, min_numeric: 3)
+      end
+    end
+
+    def define_bed(**init_args)
+      bed_choices = Helper.get_array(init_args[:bed])
+      if !bed_choices.empty?
+        bed_choices.sample
+      else
+        Faker::Alphanumeric.alphanumeric(number: 3, min_alpha: 1, min_numeric: 2)
+      end
+    end
+
+    def define_facility(**init_args)
+      fac_choices = Helper.get_array(init_args[:facility])
+      !fac_choices.empty? ? fac_choices.sample : Faker::Lorem.sentence
+    end
+
+    def define_status(**init_args)
+      ls_choices = Helper.get_array(init_args[:location_status])
+      !ls_choices.empty? ? ls_choices.sample : /[A-Z]/.random_example
+    end
+
+    def define_type(**init_args)
+      plt_choices = Helper.get_array(init_args[:person_location_type])
+      !plt_choices.empty? ? plt_choices.sample : %w[C D H N O P S].sample
+    end
+
+    def define_building(**init_args)
+      building_choices = Helper.get_array(init_args[:building])
+      !building_choices.empty? ? building_choices.sample : /[1-9]/.random_example
+    end
+
+    def define_floor(**init_args)
+      floor_choices = Helper.get_array(init_args[:floor])
+      !floor_choices.empty? ? floor_choices.sample : /[0-9]{2}/.random_example
+    end
+
+    def define_description(**init_args)
+      ld_choices = Helper.get_array(init_args[:location_description])
+      if !ld_choices.empty?
+        ld_choices.sample
+      else
+        Faker::Lorem.sentence
+      end
+    end
+  end
+end