Class: BaseFieldGenerator

Inherits:
Object
  • Object
show all
Includes:
Utils
Defined in:
lib/ez7gen/service/base_field_generator.rb

Direct Known Subclasses

DynamicFieldGenerator, FieldGenerator

Constant Summary collapse

@@REQ_LEN_3_DGTS =

@@UP_TO_3_DGTS = 1000 # up to 3 digits

3
@@RANGE_INDICATOR =

up to 3 digits

'...'
@@HAT =

Component separator, aka hat

'^'
@@SUB =

Subcomponent separator

'&'
@@MONEY_FORMAT_REGEX =

@@MONEY_FORMAT_INDICATORS = [‘Money’, ‘Balance’, ‘Charge’, ‘Adjustment’, ‘Income’, ‘Amount’, ‘Payment’,‘Cost’]

/\bMoney\b|\bBalance\b|\bCharge|\bAdjustment\b|\bIncome\b|\bAmount\b|\bPayment\b|\bCost\b|\bPercentage\b/
@@INITIALS = 
('A'..'Z').to_a
@@GENERAL_TEXT = 
'Notes'
@@random = 
Random.new

Constants included from Utils

Utils::BASE, Utils::BASE_INDICATOR, Utils::DATA_LOOKUP_MIS, Utils::PRIMARY

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Utils

#blank?, #get_name_without_base, #get_segment_name, #get_type_by_name, #has_html_encoded_ch?, #is_number?, #num_to_nil, #safe_len, #sample_index

Constructor Details

#initialize(parser, helper_parser = nil) ⇒ BaseFieldGenerator

constructor



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 23

def initialize(parser, helper_parser=nil)
  @pp = parser
  # Coded table value lookup profiler. Only set for custom schemas.
  # Custom schema has types which coming from the base schema but using coded tables from primary schema.
  # Also primary schemas use base type coded tables.
  @hp = helper_parser

  # dirname =  File.join(File.dirname(File.expand_path(__FILE__)),'../../resources/properties.yml')
  propertiesFile = File.expand_path('../../resources/properties.yml', __FILE__)
  @yml = YAML.load_file propertiesFile
end

Instance Attribute Details

#pp ⇒ Object

Returns the value of attribute pp.



8
9
10
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 8

def pp
  @pp
end

#yml ⇒ Object

Returns the value of attribute yml.



8
9
10
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 8

def yml
  @yml
end

Instance Method Details

#AD(map, force = false) ⇒ Object

base_dt = [“AD”, “DT”, “DTM”, “FT”, “GTS”, “ID”, “IS”, “NM”, “SI”, “ST”, “TM”, “TX”] Generate HL7 AD (address) data type.



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 37

def AD(map, force=false)
  #check if the field is optional and randomly generate it of skip
  return '' if(!generate?(map, force))

  # match cities, states and zips
  sample  = @yml['address.states'].sample
  idx = @yml['address.states'].index(sample) #index of random element

  val=[]
  #street address (ST) (ST)
  val << @yml['address.streetNames'].sample
  #other designation (ST)
  val <<''
  #city (ST)
  val << @yml['address.cities'].at(idx)
  #state or province (ST)
  val << @yml['address.states'].at(idx)
  #zip or postal code (ST)
  val << @yml['address.zips'].at(idx)
  #country (ID)
  val << @yml['address.countries'].at(idx)
  # address type (ID)
  # ot5 her geographic designation (ST)

  val.join(@@HAT)
end

#apply_rules(codes, attributes) ⇒ Object

Handle range values specified by ‘…’ sequence, including empty range TODO refactor candidate



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 391

def apply_rules(codes, attributes)
  #safety check, no codes returns an empty map
  return {} if blank?(codes)

  #index of random element
  idx = sample_index(codes.size)
  code = codes[idx][:value]
  description = codes[idx][:description]

  if (code.include?(@@RANGE_INDICATOR))
    code = handle_ranges(code)
  end

  if (code.size > (maxlen = (attributes[:max_length]) ? attributes[:max_length].to_i : code.size))
    #remove all codes wich values violate
    #codes.select! {|it| it[:value].size <= maxlen }
    code, description = handle_length(codes, maxlen)
  end

  # got to have code, get an id, most basic - TODO: verify this.
  # if(Utils.blank?(code))
  #   code, description = ID({},true), ''
  # end
  # return code, description

  # puts code + ', ' + description
  return {:value => code, :description => description}
end

#CE(map, force = false) ⇒ Object

Generate HL7 CE (coded element) data type



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 66

def CE(map, force=false)
  #check if the field is optional and randomly generate it of skip
  return '' if(!generate?(map, force))

  if(map[:max_length] && map[:max_length].to_i <3)
    # if CE Element has lenght of 2 or less use only value
    return ID(map, true)
  end

  #TODO: Refactor this method
  if (map[:description] == 'Role Action Reason' || map[:description] == 'Species Code' || map[:description] == 'Breed Code' || map[:description] == 'Production Class Code')
    return '' #Per requirement, PID.35 – PID.38
  end

  val = []
  # CE ce = (CE) map?.fld
  codes = get_coded_map(map)
  if(blank?(codes))
    case map[:description]
      when 'Allergen Code/Mnemonic/Description'
        pair = yml['codes.allergens.icd10'].to_a.sample(1).to_h.first # randomly pick a pair
        val<<pair.first
        val<<pair.last

      else
        # TODO: only for elements that don't have look up table set the id randomly
        # if codetable is empty
        val << ((blank?(map[:codetable])) ? ID(map, true) : '')
    end
  else
    #identifier (ST) (ST)
    val<<codes[:value]
    #text (ST)
    val<<codes[:description]
    #name of coding system (IS)
    #alternate identifier (ST) (ST)
    #alternate text (ST)
    #name of alternate coding system (IS)
  end
  return val.join(@@HAT)
end

#DT(map, force = false) ⇒ Object

Generates an HL7 DT (date) datatype.



119
120
121
122
123
124
125
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 119

def DT(map, force=false)
  #check if the field is optional and randomly generate it of skip
  return '' if(!generate?(map, force))

  # #time of an event (TSComponentOne)
  to_datetime(map).strftime('%Y%m%d') #format('YYYYMMdd.SSS')Date.iso8601
end

#DTM(map, force = false) ⇒ Object

Generates an HL7 DT (date) datatype.



109
110
111
112
113
114
115
116
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 109

def DTM(map, force=false)
  #check if the field is optional and randomly generate it of skip
  return '' if(!generate?(map, force))

  is_year_only = (map[:max_length]) ? map[:max_length].to_i == 4 : false
  # #time of an event (TSComponentOne)
  (is_year_only)?  to_datetime(map).strftime('%Y') : to_datetime(map).strftime('%Y%m%d') #format('YYYYMMdd.SSS')Date.iso8601
end

#FN(map, force = false) ⇒ Object

Generates an HL7 FN (familiy name) data type.



128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 128

def FN(map, force=false)
  #check if the field is optional and randomly generate it of skip
  return '' if(!generate?(map, force))

  #surname (ST)
  @yml['person.names.last'].sample
  #own surname prefix (ST)
  #own surname (ST)
  #surname prefix from partner/spouse (ST)
  #surname from partner/spouse (ST)
end

#FT(map, force = false) ⇒ Object

Formatted text data. The FT field is of arbitrary length (up to 64k) and may contain formatting commands enclosed in escape characters.



142
143
144
145
146
147
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 142

def FT(map, force=false)
  #check if the field is optional and randomly generate it of skip
  return '' if(!generate?(map, force))

  ID(map, true)
end

#generate?(map, force = false) ⇒ Boolean

If field are X,W,B (Not Supported, Withdrawn Fields or Backward Compatible) returns false. Conditional © ? For Optional field (O) makes random choice R - Required returns true def autoGenerate?(map, force=false)

Returns:

  • (Boolean) 


326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 326

def generate?(map, force=false)
  # return true
  return true if (force) #forced generation, ignore mappings

  #look up in the mapping
  case map[:required]
    when 'X', 'W', 'B' then
      false;
    when 'R' then
      true;
    when 'O' then
      [true, false].sample();
    else
      false;
  end
  # if(['X','W','B'].include?(map[:required]))then return false end
  # if(map[:required] =='R') then return true end
  # if(map[:required] == 'O') then return true end #random boolean
end

#generate_length_bound_id(maxlen, str = @@random.rand(100000000).to_s) ⇒ Object

Returns randomly generated Id of required length, of single digit id



347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 347

def generate_length_bound_id(maxlen, str=@@random.rand(100000000).to_s)
  idx = maxlen
  if (maxlen > str.size)
    str = str.ljust(maxlen, '0')
    idx = str.size
  end
  #safe fail
  #this handles case when maxlen is less then 1
  idx = [0, idx-1].max
  return str[0..idx]
end

#get_code_table(attributes) ⇒ Object 



420
421
422
423
424
425
426
427
428
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 420

def get_code_table(attributes)
  codes = @pp.get_code_table(attributes[:codetable])
  # Case when we are looking for code values defined in base schema for types
  # which are in custom/primary schema, or the other way around
  if (@hp && (codes.first == Utils::DATA_LOOKUP_MIS))
    codes = @hp.get_code_table(attributes[:codetable])
  end
  return codes
end

#get_coded_map(attributes) ⇒ Object

Values and Description from code table returned as a pair.



431
432
433
434
435
436
437
438
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 431

def get_coded_map(attributes)
  codes = get_code_table(attributes)

  # puts codes
  #Apply rules to find a value and description
  #Returns map with code and description
  apply_rules(codes, attributes)
end

#get_coded_value(attributes) ⇒ Object

Value of coded table returned as as single value



441
442
443
444
445
446
447
448
449
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 441

def get_coded_value(attributes)
  # codes = get_code_table(attributes)
  # puts codes
  #Apply rules to find a value and description
  # map = apply_rules(codes, attributes)
  #Return value only
  # return map[:value]
  get_coded_map(attributes)[:value]
end

#GTS(map, force = false) ⇒ Object

Generates an HL7 General Timing Specification.



150
151
152
153
154
155
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 150

def GTS(map, force=false)
  #check if the field is optional and randomly generate it of skip
  return '' if(!generate?(map, force))

  DT(map, true)
end

#handle_length(codes, maxlen) ⇒ Object 



376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 376

def handle_length(codes, maxlen)
  idx = codes.find_index { |it| it[:value].size <= maxlen }

  if (!idx)
    code, description = '', ''
  else
    # puts codes
    code = codes[idx][:value]
    description = codes[idx][:description]
  end
  return code, description
end

#handle_ranges(code) ⇒ Object 



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 359

def handle_ranges(code)
  # if (code.include?(@@RANGE_INDICATOR))
  ends = code.delete(' ').split('...').map { |it| it }
  if (ends.empty?) # This is indication that codetable does not have any values
    code = ''
  else #Handle range values, build range and pick random value
    # range = ends.first..ends.last
    # code = range.to_a.sample

    # per Galina: Invalid value 'Q8' appears in segment 4:PD1, field 20, repetition 1, component 1, subcomponent 1,
    # but does not appear in code table 2.4:141.
    # I think you had to fix this one before to pull only the first and the last values from each row.
    code = ends.sample
  end
  return code
end

#ID(map, force = false) ⇒ Object

Generate HL7 ID, usually using value from code table



158
159
160
161
162
163
164
165
166
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 158

def ID(map, force=false)
  #check if the field is optional and randomly generate it of skip
  return '' if(!generate?(map, force))

  #value only
  #Case when max_len overrides requirements
  len = safe_len(map[:max_length], @@REQ_LEN_3_DGTS)
  (!blank?(map[:codetable]))? get_coded_value(map): generate_length_bound_id(len)
end

#IS(map, force = false) ⇒ Object

Generates HL7 IS (namespace id) data type



169
170
171
172
173
174
175
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 169

def IS(map, force=false)
  #check if the field is optional and randomly generate it of skip
  return '' if(!generate?(map, force))

  #TODO: same as ID?
  ID(map,true)
end

#NM(map, force = false) ⇒ Object

Generates an HL7 NM (numeric) data type. A NM contains a single String value.



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 178

def NM(map, force=false)
  #check if the field is optional and randomly generate it of skip
  return '' if(!generate?(map, force))
  val = 0
  case map[:description]
    when'Guarantor Household Size','Birth Order'
      val = generate_length_bound_id(1)
    when 'Guarantor Household Annual Income'
      val = '%.2f' % generate_length_bound_id(5)
    when @@MONEY_FORMAT_REGEX
      val = '%.2f' % ID(map,true)
    when /Date\/Time/
      val = to_datetime(map)
    else
      val = ID(map,true) # general rule for a number
      if (map[:datatype] == 'CP' || map[:datatype] == 'MO') # money
        val = '%.2f' % val
      end
  end

  return val
end

#reset_map_attr(map, key, value) ⇒ Object

convention method to modify values of attirbutes



300
301
302
303
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 300

def reset_map_attr(map, key, value)
  map[key.to_sym]=value
  return map
end

#SAD(map, force = false) ⇒ Object

Street address Appears in the XAD data type, and found in templates



203
204
205
206
207
208
209
210
211
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 203

def SAD(map, force=false)
  #check if the field is optional and randomly generate it of skip
  return '' if(!generate?(map, force))

  # <street or mailing address (ST)>
  @yml['address.streetNames'].sample
  # <street name (ST)>
  # <dwelling number (ST)>
end

#SI(map, force = false) ⇒ Object

Generate HL7 SI (sequence ID) data type. A SI contains a single String value.



214
215
216
217
218
219
220
221
222
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 214

def SI(map, force=false)
  #check if the field is optional and randomly generate it of skip
  return '' if(!generate?(map, force))

  #SI pt = (SI) map.fld
  #pt.setValue(generate_length_bound_id((map.max_length)?map.max_length.toInteger():1))
  len = (!blank?(map[:max_length]))?map[:max_length].to_i : 1
  generate_length_bound_id(len)
end

#ST(map, force = false) ⇒ Object

Generate HL7 ST (string data) data type. A ST contains a single String value.



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 225

def ST(map, force=false)
  #check if the field is optional and randomly generate it of skip
  return '' if(!generate?(map, force))

  # TODO add provider type ln 840 ROL
  case map[:description]
    when 'Guarantor SSN','Insured’s Social Security Number','Medicare health ins Card Number','Military ID Number', 'Contact Person Social Security Number'
      generate_length_bound_id(9)
    when 'Allergy Reaction Code'
      yml['codes.allergens'].keys.sample()
    when 'Strain'
      #PID.35 – PID.38 should be always blank, as they deal with animals, not humans.
    when 'AGENT ORANGE EXPOSURE LOCATION'
      #ZEL.29 should be 1 digit integer.
      generate_length_bound_id(1)
    when /family name|surname/i
      @yml['person.names.last'].sample
    when /given name/i
      @yml['person.names.first'].sample
    when /suffix/i
      @yml['person.suffix'].sample
    when /prefix/i
      @yml['person.prefix'].sample
    else
      #Case when max_len overrides requirements
      len = safe_len(map[:max_length], @@REQ_LEN_3_DGTS)
      (!blank?(map[:codetable]))? get_coded_value(map): generate_length_bound_id(len)
  end

end

#TM(map, force = false) ⇒ Object

An Elementary Data Type Format: HH[MM[SS[.S[S[S]]]]][+/-ZZZZ] EX: 160140.761



257
258
259
260
261
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 257

def TM(map, force=false)
  #check if the field is optional and randomly generate it of skip
  return '' if(!generate?(map, force))
  to_datetime(map).strftime('%H%M%S.%L')
end

#TN(map, force = false) ⇒ Object

Generate an HL7 TN (telephone number) data type. A TN contains a single String value.



264
265
266
267
268
269
270
271
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 264

def TN(map, force=false)
  #check if the field is optional and randomly generate it of skip
  return '' if(!generate?(map, force))

  # TN tn = (TN) map.fld
  # tn.setValue(phones.getAt(Math.abs(random.nextInt()%phones.size())))
  @yml['address.phones'].sample # pick a phone
end

#to_datetime(map) ⇒ Object

Returns DateTime generated with consideration of description string for dates in the future.

Returns:

  • DateTime generated with consideration of description string for dates in the future



306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 306

def to_datetime(map)
  #for Time Stamp one way to figure out if event is in the future of in the past to look for key words in description
  isFutureEvent = !blank?(map[:description])&& map[:description].include?('End') #so 'Role End Date/Time'
  seed = 365 #seed bounds duration of time to a year
  days = @@random.rand(seed)

  if (map[:description]=='Date/Time Of Birth')
    isFutureEvent = false
    years = rand(30..50)
    days = days + 365*years # make a person 30 years old
  end

  (isFutureEvent) ? DateTime.now().next_day(days) : DateTime.now().prev_day(days)
end

#TS(map, force = false) ⇒ Object

Generate HL7 TS (time stamp), within number of weeks in the future or past



274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 274

def TS(map, force=false)
  #check if the field is optional and randomly generate it of skip
  return '' if(!generate?(map, force))

  #time of an event (TSComponentOne)
  ts = to_datetime(map).strftime('%Y%m%d%H%M%S.%L') #format('YYYYMMDDHHSS.SSS')Date.iso8601
  # TS is lenght sensetive, check max_len and trim appropriate
  if (ts.size > (maxlen = (map[:max_length]) ? map[:max_length].to_i : ts.size))
    # puts ts
    # ts = ts[0,maxlen]
    ts = ts.slice(0...maxlen)
  end
  return ts
end

#TX(map, force = false) ⇒ Object

Generate HL7 TX (text data) data type. A TX contains a single String value.



290
291
292
293
294
295
 
# File 'lib/ez7gen/service/base_field_generator.rb', line 290

def TX(map, force=false)
  #check if the field is optional and randomly generate it of skip
  return '' if(!generate?(map, force))
  # @@GENERAL_TEXT
  ID(map,true)
end