ruby-hl7 1.3.2 → 1.4.0

data/lib/segments/msa.rb

@@ -1,4 +1,5 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 class HL7::Message::Segment::MSA < HL7::Message::Segment
   weight 1 # should occur after the msh segment
   add_field :ack_code
@@ -8,4 +9,3 @@ class HL7::Message::Segment::MSA < HL7::Message::Segment
   add_field :delayed_ack_type
   add_field :error_cond
 end
-

data/lib/segments/msh.rb

@@ -1,6 +1,7 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 class HL7::Message::Segment::MSH < HL7::Message::Segment
-  weight( -1 ) # the msh should always start a message
+  weight(-1) # the msh should always start a message
   add_field :enc_chars
   add_field :sending_app
   add_field :sending_facility

data/lib/segments/nk1.rb

@@ -1,13 +1,53 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 class HL7::Message::Segment::NK1 < HL7::Message::Segment
-  add_field :set_id
-  add_field :name
-  add_field :relationship
-  add_field :address
-  add_field :phone_number
+  add_field :set_id, :idx => 1
+  add_field :name, :idx => 2
+  add_field :relationship, :idx => 3
+  add_field :address, :idx => 4
+  add_field :phone_number, :idx => 5
+  add_field :business_phone_number, :idx => 6
+  add_field :contact_role, :idx => 7
+  add_field :start_date, :idx => 8 do |value|
+    convert_to_ts(value)
+  end
+  add_field :end_date, :idx => 9 do |value|
+    convert_to_ts(value)
+  end
+  add_field :job_title, :idx => 10
+  add_field :job_code, :idx => 11
+  add_field :employee_number, :idx => 12
   add_field :organization_name, :idx => 13
+  add_field :marital_status, :idx => 14
+  add_field :admin_sex, :idx => 15 do |sex|
+    sanitize_admin_sex!(sex)
+  end
+  add_field :date_of_birth, :idx => 16 do |value|
+    convert_to_ts(value)
+  end
+  add_field :living_dependency, :idx => 17
+  add_field :ambulatory_status, :idx => 18
+  add_field :citizenship, :idx => 19
   add_field :primary_language, :idx => 20
+  add_field :living_arrangement, :idx => 21
+  add_field :publicity_code, :idx => 22
+  add_field :protection_indicator, :idx => 23
+  add_field :student_indicator, :idx => 24
+  add_field :religion, :idx => 25
+  add_field :mother_maiden_name, :idx => 26
+  add_field :nationality, :idx => 27
+  add_field :ethnic_group, :idx => 28
+  add_field :contact_reason, :idx => 29
   add_field :contact_persons_name, :idx => 30
-  add_field :contact_persons_telephone_number
-  add_field :contact_persons_address
+  add_field :contact_persons_telephone_number, :idx => 31
+  add_field :contact_persons_address, :idx => 32
+  add_field :identifiers, :idx => 33
+  add_field :job_status, :idx => 34
+  add_field :race, :idx => 35
+  add_field :handicap, :idx => 36
+  add_field :contact_persons_ssn, :idx => 37
+  add_field :birth_place, :idx => 38
+  add_field :vip_indicator, :idx => 39
+  add_field :telecommunication_information, :idx => 40
+  add_field :contact_persons_telecommunication_information, :idx => 41
 end

data/lib/segments/nte.rb

@@ -1,8 +1,9 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 class HL7::Message::Segment::NTE < HL7::Message::Segment
   weight 4
-  add_field :set_id, :idx=>1
-  add_field :source, :idx=>2
-  add_field :comment, :idx=>3
-  add_field :comment_type, :idx=>4
+  add_field :set_id, :idx => 1
+  add_field :source, :idx => 2
+  add_field :comment, :idx => 3
+  add_field :comment_type, :idx => 4
 end

data/lib/segments/obr.rb

@@ -1,7 +1,8 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 class HL7::Message::Segment::OBR < HL7::Message::Segment
   weight 89 # obx.weight-1
-  has_children [:NTE,:OBX,:SPM]
+  has_children %i[NTE OBX SPM]
   add_field :set_id
   add_field :placer_order_number
   add_field :filler_order_number
@@ -61,7 +62,7 @@ class HL7::Message::Segment::OBR < HL7::Message::Segment
   add_field :procedure_code_modifier
   add_field :placer_supplemental_service_info
   add_field :filler_supplemental_service_info
-  add_field :medically_necessary_dup_procedure_reason #longest method name ever. sry.
+  add_field :medically_necessary_dup_procedure_reason # longest method name ever. sry.
   add_field :result_handling
   add_field :parent_universal_service_identifier
 end

data/lib/segments/obx.rb

@@ -1,4 +1,5 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 class HL7::Message::Segment::OBX < HL7::Message::Segment
   weight 90
   has_children [:NTE]

data/lib/segments/orc.rb

@@ -1,4 +1,5 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 class HL7::Message::Segment::ORC < HL7::Message::Segment
   weight 88 # obr.weight-1
   has_children [:OBR]
@@ -32,18 +33,15 @@ class HL7::Message::Segment::ORC < HL7::Message::Segment
   add_field :ordering_provider_address
   add_field :order_status_modifier
   add_field :advanced_beneficiary_notice_override_reason
-  add_field :fillers_expected_availability_date_time 
+  add_field :fillers_expected_availability_date_time
   add_field :confidentiality_code
   add_field :order_type
   add_field :enterer_authorization_mode
   add_field :parent_universal_service_identifier
-  
-  private
-  def self.convert_to_ts(value) #:nodoc:
-    if value.is_a?(Time) or value.is_a?(Date)
-      return value.to_hl7
-    else
-      return value
-    end
+
+  def self.convert_to_ts(value) # :nodoc:
+    return value.to_hl7 if value.is_a?(Time) || value.is_a?(Date)
+
+    value
   end
 end

data/lib/segments/oru.rb

@@ -1,3 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 class HL7::Message::Segment::ORU < HL7::Message::Segment
 end

data/lib/segments/pid.rb

@@ -1,7 +1,8 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 class HL7::Message::Segment::PID < HL7::Message::Segment
   weight 1
-  has_children [:NK1,:NTE,:PV1,:PV2]
+  has_children %i[NK1 NTE PV1 PV2]
   add_field :set_id
   add_field :patient_id
   add_field :patient_id_list
@@ -12,11 +13,7 @@ class HL7::Message::Segment::PID < HL7::Message::Segment
     convert_to_ts(value)
   end
   add_field :admin_sex do |sex|
-    unless /^[FMOUANC]$/.match(sex) || sex == nil || sex == ""
-      raise HL7::InvalidDataError.new( "bad administrative sex value (not F|M|O|U|A|N|C)" )
-    end
-    sex = "" unless sex
-    sex
+    sanitize_admin_sex!(sex)
   end
   add_field :patient_alias
   add_field :race
@@ -43,7 +40,7 @@ class HL7::Message::Segment::PID < HL7::Message::Segment
   end
   add_field :death_indicator
   add_field :id_unknown_indicator
-  add_field :id_readability_code
+  add_field :id_reliability_code
   add_field :last_update_date do |value|
     convert_to_ts(value)
   end
@@ -55,14 +52,26 @@ class HL7::Message::Segment::PID < HL7::Message::Segment
   add_field :tribal_citizenship
 
   def country_code
-    warn "DEPRECATION WARNING: PID-12 is defined as 'county_code'; "+
+    warn "DEPRECATION WARNING: PID-12 is defined as 'county_code'; " \
          "the 'country_code' alias is retained for backwards compatibility only."
     county_code
   end
 
   def country_code=(country_code)
-    warn "DEPRECATION WARNING: PID-12 is defined as 'county_code'; "+
+    warn "DEPRECATION WARNING: PID-12 is defined as 'county_code'; " \
          "the 'country_code' alias is retained for backwards compatibility only."
     self.county_code = country_code
   end
+
+  def id_readability_code
+    warn "DEPRECATION WARNING: PID-32 is defined as 'id_reliability_code'; " \
+         "the 'id_readability_code' alias is retained for backwards compatibility only."
+    id_reliability_code
+  end
+
+  def id_readability_code=(code)
+    warn "DEPRECATION WARNING: PID-32 is defined as 'id_reliability_code'; " \
+         "the 'id_readability_code' alias is retained for backwards compatibility only."
+    self.id_reliability_code = code
+  end
 end

data/lib/segments/prd.rb

@@ -1,4 +1,5 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 class HL7::Message::Segment::PRD < HL7::Message::Segment
   weight 2
   add_field :provider_role

data/lib/segments/prt.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class HL7::Message::Segment::PRT < HL7::Message::Segment
+  add_field :participation_instance_id, :idx => 1
+  add_field :action_code, :idx => 2
+  add_field :action_reason, :idx => 3
+  add_field :participation, :idx => 4
+  add_field :participation_person, :idx => 5
+  add_field :participation_person_provider_type, :idx => 6
+  add_field :participation_organization_unit_type, :idx => 7
+  add_field :participation_organization, :idx => 8
+  add_field :participation_location, :idx => 9
+  add_field :participation_device, :idx => 10
+  add_field :participation_begin_date_time, :idx => 11 do |value|
+    convert_to_ts(value)
+  end
+  add_field :participation_end_date_time, :idx => 12 do |value|
+    convert_to_ts(value)
+  end
+  add_field :participation_qualitative_duration, :idx => 13
+  add_field :participation_address, :idx => 14
+  add_field :participation_telecommunication_address, :idx => 15
+end

data/lib/segments/pv1.rb

@@ -1,4 +1,5 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 class HL7::Message::Segment::PV1 < HL7::Message::Segment
   weight 2
   add_field :set_id

data/lib/segments/pv2.rb

@@ -1,55 +1,68 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 class HL7::Message::Segment::PV2 < HL7::Message::Segment
   weight 3
-  add_field :prior_pending_location
-  add_field :accommodation_code
-  add_field :admit_reason
-  add_field :transfer_reason
-  add_field :patient_valuables
-  add_field :patient_valuables_location
-  add_field :visit_user_code
-  add_field :expected_admit_date
-  add_field :expected_discharge_date
-  add_field :estimated_inpatient_stay_length
-  add_field :actual_inpatient_stay_length
-  add_field :visit_description
-  add_field :referral_source_code
-  add_field :previous_service_date
-  add_field :employment_illness_related_indicator
-  add_field :purge_status_code
-  add_field :purge_status_date
-  add_field :special_program_code
-  add_field :retention_indicator
-  add_field :expected_number_of_insurance_plans
-  add_field :visit_publicity_code
-  add_field :visit_protection_indicator
-  add_field :clinic_organization_name
-  add_field :patient_status_code
-  add_field :visit_priority_code
-  add_field :previous_treatment_date
-  add_field :expected_discharge_disposition
-  add_field :signature_on_file
-  add_field :first_similar_illness_date
-  add_field :patient_charge_adjustment_code
-  add_field :recurring_service_code
-  add_field :billing_media_code
-  add_field :expected_surgery_date
+  add_field :prior_pending_location, :idx => 1
+  add_field :accommodation_code, :idx => 2
+  add_field :admit_reason, :idx => 3
+  add_field :transfer_reason, :idx => 4
+  add_field :patient_valuables, :idx => 5
+  add_field :patient_valuables_location, :idx => 6
+  add_field :visit_user_code, :idx => 7
+  add_field :expected_admit_date, :idx => 8
+  add_field :expected_discharge_date, :idx => 9
+  add_field :estimated_inpatient_stay_length, :idx => 10
+  add_field :actual_inpatient_stay_length, :idx => 11
+  add_field :visit_description, :idx => 12
+  add_field :referral_source_code, :idx => 13
+  add_field :previous_service_date, :idx => 14
+  add_field :employment_illness_related_indicator, :idx => 15
+  add_field :purge_status_code, :idx => 16
+  add_field :purge_status_date, :idx => 17
+  add_field :special_program_code, :idx => 18
+  add_field :retention_indicator, :idx => 19
+  add_field :expected_number_of_insurance_plans, :idx => 20
+  add_field :visit_publicity_code, :idx => 21
+  add_field :visit_protection_indicator, :idx => 22
+  add_field :clinic_organization_name, :idx => 23
+  add_field :patient_status_code, :idx => 24
+  add_field :visit_priority_code, :idx => 25
+  add_field :previous_treatment_date, :idx => 26
+  add_field :expected_discharge_disposition, :idx => 27
+  add_field :signature_on_file, :idx => 28
+  add_field :first_similar_illness_date, :idx => 29
+  add_field :patient_charge_adjustment_code, :idx => 30
+  add_field :recurring_service_code, :idx => 31
+  add_field :billing_media_code, :idx => 32
+  add_field :expected_surgery_date, :idx => 33
+  add_field :military_partnership_code, :idx => 34
+  add_field :military_non_availability_code, :idx => 35
+  add_field :newborn_baby_indicator, :idx => 36
+  add_field :baby_detained_indicator, :idx => 37
+  add_field :mode_of_arrival_code, :idx => 38
+  add_field :recreational_drug_use_code, :idx => 39
+  add_field :admission_level_of_care_code, :idx => 40
+  add_field :precaution_code, :idx => 41
+  add_field :patient_condition_code, :idx => 42
+  add_field :living_will_code, :idx => 43
+  add_field :organ_donor_code, :idx => 44
+  add_field :advance_directive_code, :idx => 45
+  add_field :patient_status_effective_date, :idx => 46
+  add_field :expected_loa_return_date, :idx => 47
+  add_field :expected_preadmission_testing_date, :idx => 48
+  add_field :notify_clergy_code, :idx => 49
+
+  def military_non_availibility_code
+    warn "DEPRECATION WARNING: PV2-35 is defined as 'military_non_availability_code'; " \
+         "the 'military_non_availibility_code' alias is retained for backwards compatibility only."
+
+    military_non_availability_code
+  end
+
+  def military_non_availibility_code=(code)
+    warn "DEPRECATION WARNING: PV2-35 is defined as 'military_non_availability_code'; " \
+         "the 'military_non_availibility_code' alias is retained for backwards compatibility only."
 
-  # Adding military fields
-  [ :military_partnership_code,
-    :military_non_availibility_code,
-    :newborn_baby_indicator,
-    :baby_detained_indicator,
-    :mode_of_arrival_code,
-    :recreational_drug_use_code,
-    :precaution_code,
-    :patient_condition_code,
-    :living_will_code,
-    :organ_donor_code,
-    :advance_directive_code,
-    :patient_status_effective_date,
-    :expected_loa_return_date,
-    :expected_preadmission_testing_date,
-    :notify_clergy_code
-   ].each { |f| add_field f }
+    self.military_non_availability_code = code
+  end
 end

data/lib/segments/qrd.rb

@@ -1,4 +1,5 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 class HL7::Message::Segment::QRD < HL7::Message::Segment
   weight 84
   add_field :query_date

data/lib/segments/qrf.rb

@@ -1,4 +1,5 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 class HL7::Message::Segment::QRF < HL7::Message::Segment
   weight 85
   add_field :where_subject_filter

data/lib/segments/rf1.rb

@@ -1,4 +1,5 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 class HL7::Message::Segment::RF1 < HL7::Message::Segment
   weight 0 # should occur after the MSH segment
   add_field :referral_status

data/lib/segments/rgs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class HL7::Message::Segment::RGS < HL7::Message::Segment
   weight 3
   add_field :set_id

data/lib/segments/rol.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class HL7::Message::Segment::ROL < HL7::Message::Segment
+  add_field :role_instance, :idx => 1
+  add_field :action_code, :idx => 2
+  add_field :role, :idx => 3
+  add_field :role_person, :idx => 4
+  add_field :role_begin_date_time, :idx => 5 do |value|
+    convert_to_ts(value)
+  end
+  add_field :role_end_date_time, :idx => 6 do |value|
+    convert_to_ts(value)
+  end
+  add_field :role_duration, :idx => 7
+  add_field :role_action_reason, :idx => 8
+  add_field :provider_type, :idx => 9
+  add_field :organization_unit_type, :idx => 10
+  add_field :office_home_address_birthplace, :idx => 11
+  add_field :phone_number, :idx => 12
+  add_field :person_location, :idx => 13
+  add_field :organization, :idx => 14
+end

data/lib/segments/sch.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class HL7::Message::Segment::SCH < HL7::Message::Segment
   weight 0
   add_field :placer_appointment_id

data/lib/segments/sft.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class HL7::Message::Segment::SFT < HL7::Message::Segment
   weight 0
   add_field :software_vendor_organization

data/lib/segments/spm.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class HL7::Message::Segment::SPM < HL7::Message::Segment
   # Weight doesn't really matter, since this always occurs as a child
   # of an OBR segment.

data/lib/segments/tq1.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class HL7::Message::Segment::TQ1 < HL7::Message::Segment
   weight 2
   add_field :set_id

data/lib/segments/txa.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class HL7::Message::Segment::TXA < HL7::Message::Segment
+  add_field :set_id
+  add_field :document_type
+  add_field :document_content_presentation
+  add_field :activity_date_time
+  add_field :primary_activity_provider_code
+  add_field :origination_date_time
+  add_field :transcription_date_time
+  add_field :edit_date_time
+  add_field :originator_code
+  add_field :assigned_document_authenticator
+  add_field :transcriptionist_code
+  add_field :unique_document_number
+  add_field :parent_document_number
+  add_field :placer_order_number
+  add_field :filler_order_number
+  add_field :unique_document_file_name
+  add_field :document_completion_status
+  add_field :document_confidentiality_status
+  add_field :document_availability_status
+  add_field :document_storage_status
+  add_field :document_change_reason
+  add_field :authentication_person_time_stamp
+  add_field :distributed_copies_code
+  add_field :folder_assignment
+  add_field :document_title
+  add_field :agreed_due_date_time
+end