Module: DaVinciUSDrugFormularyTestKit::SearchTest

Extended by:
Forwardable
Includes:
DateSearchValidation, FHIRResourceNavigation
Included in:
DaVinciUSDrugFormularyV201::BasicCodeSearchTest, DaVinciUSDrugFormularyV201::BasicDrugTierSearchTest, DaVinciUSDrugFormularyV201::BasicFormularyIncludeSearchTest, DaVinciUSDrugFormularyV201::BasicFormularySearchTest, DaVinciUSDrugFormularyV201::BasicIdSearchTest, DaVinciUSDrugFormularyV201::BasicLastupdatedSearchTest, DaVinciUSDrugFormularyV201::BasicPeriodSearchTest, DaVinciUSDrugFormularyV201::BasicPharmacyBenefitTypeSearchTest, DaVinciUSDrugFormularyV201::BasicStatusSearchTest, DaVinciUSDrugFormularyV201::BasicSubjectIncludeSearchTest, DaVinciUSDrugFormularyV201::BasicSubjectSearchTest, DaVinciUSDrugFormularyV201::FormularyCoverageAreaSearchTest, DaVinciUSDrugFormularyV201::FormularyCoverageTypeSearchTest, DaVinciUSDrugFormularyV201::FormularyFormularyCoverageSearchTest, DaVinciUSDrugFormularyV201::FormularyIdSearchTest, DaVinciUSDrugFormularyV201::FormularyIdentifierSearchTest, DaVinciUSDrugFormularyV201::FormularyLastupdatedSearchTest, DaVinciUSDrugFormularyV201::FormularyNameSearchTest, DaVinciUSDrugFormularyV201::FormularyPeriodSearchTest, DaVinciUSDrugFormularyV201::FormularyStatusSearchTest, DaVinciUSDrugFormularyV201::FormularyTypeSearchTest, DaVinciUSDrugFormularyV201::LocationAddressCitySearchTest, DaVinciUSDrugFormularyV201::LocationAddressPostalcodeSearchTest, DaVinciUSDrugFormularyV201::LocationAddressSearchTest, DaVinciUSDrugFormularyV201::LocationAddressStateSearchTest, DaVinciUSDrugFormularyV201::LocationIdSearchTest, DaVinciUSDrugFormularyV201::LocationLastupdatedSearchTest, DaVinciUSDrugFormularyV201::MedicationKnowledgeCodeSearchTest, DaVinciUSDrugFormularyV201::MedicationKnowledgeDoseformSearchTest, DaVinciUSDrugFormularyV201::MedicationKnowledgeDrugNameSearchTest, DaVinciUSDrugFormularyV201::MedicationKnowledgeIdSearchTest, DaVinciUSDrugFormularyV201::MedicationKnowledgeLastupdatedSearchTest, DaVinciUSDrugFormularyV201::MedicationKnowledgeStatusSearchTest, DaVinciUSDrugFormularyV201::PayerInsurancePlanCoverageAreaSearchTest, DaVinciUSDrugFormularyV201::PayerInsurancePlanCoverageTypeSearchTest, DaVinciUSDrugFormularyV201::PayerInsurancePlanFormularyCoverageIncludeSearchTest, DaVinciUSDrugFormularyV201::PayerInsurancePlanFormularyCoverageSearchTest, DaVinciUSDrugFormularyV201::PayerInsurancePlanIdSearchTest, DaVinciUSDrugFormularyV201::PayerInsurancePlanIdentifierSearchTest, DaVinciUSDrugFormularyV201::PayerInsurancePlanLastupdatedSearchTest, DaVinciUSDrugFormularyV201::PayerInsurancePlanNameSearchTest, DaVinciUSDrugFormularyV201::PayerInsurancePlanPeriodSearchTest, DaVinciUSDrugFormularyV201::PayerInsurancePlanStatusSearchTest, DaVinciUSDrugFormularyV201::PayerInsurancePlanTypeSearchTest
Defined in:
lib/davinci_us_drug_formulary_test_kit/search_test.rb

Constant Summary

Constants included from FHIRResourceNavigation

FHIRResourceNavigation::DAR_EXTENSION_URL

Instance Method Summary collapse

Methods included from FHIRResourceNavigation

#find_a_value_at, #find_slice_via_discriminator, #get_next_value, #resolve_path, #verify_slice_by_values

Methods included from DateSearchValidation

#fhir_date_comparer, #get_fhir_datetime_range, #get_fhir_period_range, #is_date?, #validate_date_search, #validate_datetime_search, #validate_period_search

Instance Method Details

#all_comparator_searches_tested? ⇒ Boolean

Returns:

  • (Boolean) 


235
236
237
238
239
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 235

def all_comparator_searches_tested?
  return true if params_with_comparators.blank?

  Set.new(params_with_comparators) == search_variant_test_records[:comparator_searches]
end

#all_include_search_params ⇒ Object 



49
50
51
52
53
54
55
56
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 49

def all_include_search_params
  @all_include_search_params ||=
    search_param_names.each_with_object({}) do |value, params|
      params[value] ||= fixed_value_search_param_values.filter_map do |fixed_value|
        fixed_value_search_params(fixed_value, value).merge('_include' => include_param)
      end
    end
end

#all_scratch_resources ⇒ Object 



395
396
397
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 395

def all_scratch_resources
  scratch_resources[:all] ||= []
end

#all_search_params ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 26

def all_search_params
  param_values = if resource_type == 'Location' && first_search?
                   resource_id_list
                 else
                   resource_status
                 end

  @all_search_params ||=
    param_values.each_with_object({}) do |value, params|
      params[value] ||= []
      new_params =
        if fixed_value_search?
          fixed_value_search_param_values.map { |fixed_value| fixed_value_search_params(fixed_value, value) }
        else
          [search_params_with_values(search_param_names, value)]
        end
      new_params.reject! do |params|
        params.any? { |_key, value| value.blank? }
      end
      params[value].concat(new_params)
    end
end

#all_search_params_present?(params) ⇒ Boolean

Returns:

  • (Boolean) 


478
479
480
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 478

def all_search_params_present?(params)
  params.all? { |_name, value| value.present? }
end

#all_search_variants_tested? ⇒ Boolean

Returns:

  • (Boolean) 


230
231
232
233
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 230

def all_search_variants_tested?
  search_variant_test_records.all? { |_variant, tested| tested.present? } &&
    all_comparator_searches_tested?
end

#any_valid_search_params?(search_params) ⇒ Boolean

Returns:

  • (Boolean) 


58
59
60
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 58

def any_valid_search_params?(search_params)
  search_params.any? { |_resource_id, params| params.present? }
end

#array_of_codes(array) ⇒ Object 



482
483
484
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 482

def array_of_codes(array)
  array.map { |name| "`#{name}`" }.join(', ')
end

#cant_resolve_next_bundle_message(link) ⇒ Object 



516
517
518
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 516

def cant_resolve_next_bundle_message(link)
  "Could not resolve next bundle: #{link}"
end

#check_resource_against_params(resource, params) ⇒ Object

RESULT CHECKING ####



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 627

def check_resource_against_params(resource, params)
  params.each do |name, escaped_search_value|
    # unescape search value
    search_value = escaped_search_value&.gsub('\\,', ',')
    paths = search_param_paths(name)
    match_found = false
    values_found = []

    paths.each do |path|
      type = metadata.search_definitions[name.to_sym][:type]
      values_found =
        resolve_path(resource, path)
          .map do |value|
            if value.is_a? FHIR::Reference
              value.reference
            else
              value
            end
          end
      match_found =
        case type
        when 'Period', 'date', 'instant', 'dateTime'
          values_found.any? { |date| validate_date_search(search_value, date) }
        when 'HumanName'
          # When a string search parameter refers to the types HumanName and Address,
          # the search covers the elements of type string, and does not cover elements such as use and period
          # https://www.hl7.org/fhir/search.html#string
          search_value_downcase = search_value.downcase
          values_found.any? do |name|
            name&.text&.downcase&.start_with?(search_value_downcase) ||
              name&.family&.downcase&.start_with?(search_value_downcase) ||
              name&.given&.any? { |given| given.downcase.start_with?(search_value_downcase) } ||
              name&.prefix&.any? { |prefix| prefix.downcase.start_with?(search_value_downcase) } ||
              name&.suffix&.any? { |suffix| suffix.downcase.start_with?(search_value_downcase) }
          end
        when 'Address'
          search_value_downcase = search_value.downcase
          values_found.any? do |address|
            address&.text&.downcase&.start_with?(search_value_downcase) ||
              address&.city&.downcase&.start_with?(search_value_downcase) ||
              address&.state&.downcase&.start_with?(search_value_downcase) ||
              address&.postalCode&.downcase&.start_with?(search_value_downcase) ||
              address&.country&.downcase&.start_with?(search_value_downcase)
          end
        when 'CodeableConcept'
          # FHIR token search (https://www.hl7.org/fhir/search.html#token): "When in doubt, servers SHOULD
          # treat tokens in a case-insensitive manner, on the grounds that including undesired data has
          # less safety implications than excluding desired behavior".
          codings = values_found.flat_map(&:coding)
          if search_value.include? '|'
            system = search_value.split('|').first
            code = search_value.split('|').last
            codings&.any? { |coding| coding.system == system && coding.code&.casecmp?(code) }
          else
            codings&.any? { |coding| coding.code&.casecmp?(search_value) }
          end
        when 'Coding'
          if search_value.include? '|'
            system = search_value.split('|').first
            code = search_value.split('|').last
            values_found.any? { |coding| coding.system == system && coding.code&.casecmp?(code) }
          else
            values_found.any? { |coding| coding.code&.casecmp?(search_value) }
          end
        when 'Identifier'
          if search_value.include? '|'
            values_found.any? { |identifier| "#{identifier.system}|#{identifier.value}" == search_value }
          else
            values_found.any? { |identifier| identifier.value == search_value }
          end
        when 'string'
          searched_values = search_value.downcase.split(/(?<!\\\\),/).map { |string| string.gsub('\\,', ',') }
          values_found.any? do |value_found|
            searched_values.any? { |searched_value| value_found.downcase.starts_with? searched_value }
          end
        else
          # searching by patient requires special case because we are searching by a resource identifier
          # references can also be URLs, so we may need to resolve those URLs
          if ['subject', 'patient'].include? name.to_s
            id = search_value.split('Patient/').last
            possible_values = [id, "Patient/#{id}", "#{url}/Patient/#{id}"]
            values_found.any? do |reference|
              possible_values.include? reference
            end
          else
            search_values = search_value.split(/(?<!\\\\),/).map { |string| string.gsub('\\,', ',') }
            values_found.any? { |value_found| search_values.include? value_found }
          end
        end

      break if match_found
    end

    assert match_found,
           "#{resource_type}/#{resource.id} did not match the search parameters:\n" \
           "* Expected: #{search_value}\n" \
           "* Found: #{values_found.map(&:inspect).join(', ')}"
  end
end

#check_search_response ⇒ Object 



211
212
213
214
215
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 211

def check_search_response
  assert_response_status(200)
  assert_resource_type(:bundle)
  # NOTE: how do we want to handle validating Bundles?
end

#date_comparator_value(comparator, date) ⇒ Object 



241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 241

def date_comparator_value(comparator, date)
  date = date.start || date.end if date.is_a? FHIR::Period
  case comparator
  when 'lt', 'le'
    comparator + (DateTime.xmlschema(date) + 1).xmlschema
  when 'gt', 'ge'
    comparator + (DateTime.xmlschema(date) - 1).xmlschema
  else
    # ''
    raise "Unsupported comparator '#{comparator}'"
  end
end

#default_search_values(param_name) ⇒ Object 



345
346
347
348
349
350
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 345

def default_search_values(param_name)
  definition = metadata.search_definitions[param_name]
  return [] if definition.blank?

  definition[:multiple_or] == 'SHALL' ? [definition[:values].join(',')] : Array.wrap(definition[:values])
end

#drugpol_coding?(coding) ⇒ Boolean

Returns:

  • (Boolean) 


201
202
203
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 201

def drugpol_coding?(coding)
  coding&.code == 'DRUGPOL' && coding&.system == 'http://terminology.hl7.org/CodeSystem/v3-ActCode'
end

#element_has_valid_value?(element, include_system) ⇒ Boolean

Returns:

  • (Boolean) 


578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 578

def element_has_valid_value?(element, include_system)
  case element
  when FHIR::Reference
    element.reference.present?
  when FHIR::CodeableConcept
    if include_system
      coding =
        find_a_value_at(element, 'coding') { |coding| coding.code.present? && coding.system.present? }
      coding.present?
    else
      find_a_value_at(element, 'coding.code').present?
    end
  when FHIR::Identifier
    include_system ? element.value.present? && element.system.present? : element.value.present?
  when FHIR::Coding
    include_system ? element.code.present? && element.system.present? : element.code.present?
  when FHIR::HumanName
    (element.family || element.given&.first || element.text).present?
  when FHIR::Address
    (element.text || element.city || element.state || element.postalCode || element.country).present?
  else
    true
  end
end

#empty_search_params_message(empty_search_params) ⇒ Object 



490
491
492
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 490

def empty_search_params_message(empty_search_params)
  "Could not find values for the search parameters #{array_of_codes(empty_search_params.keys)}"
end

#filter_insurance_plan(resources) ⇒ Object 



183
184
185
186
187
188
189
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 183

def filter_insurance_plan(resources)
  if metadata.profile_name.include?('Formulary')
    resources.select! { |resource| formulary_insurance_plan? resource }
  else
    resources.select! { |resource| payer_insurance_plan? resource }
  end
end

#fixed_value_search_param_name ⇒ Object 



409
410
411
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 409

def fixed_value_search_param_name
  (search_param_names - ['patient']).first
end

#fixed_value_search_param_values ⇒ Object 



413
414
415
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 413

def fixed_value_search_param_values
  metadata.search_definitions[fixed_value_search_param_name.to_sym][:values]
end

#fixed_value_search_params(value, resource_input) ⇒ Object 



417
418
419
420
421
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 417

def fixed_value_search_params(value, resource_input)
  search_param_names.each_with_object({}) do |name, params|
    params[name] = resource_id_param?(name) ? resource_input : value
  end
end

#formulary_insurance_plan?(resource) ⇒ Boolean

Returns:

  • (Boolean) 


191
192
193
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 191

def formulary_insurance_plan?(resource)
  resource&.type&.first&.coding&.any? { |coding| drugpol_coding? coding }
end

#initial_search_variant_test_records ⇒ Object 



221
222
223
224
225
226
227
228
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 221

def initial_search_variant_test_records
  {}.tap do |records|
    records[:post_variant] = false if test_post_search?
    records[:reference_variants] = false if test_reference_variants?
    records[:token_variants] = false if token_search_params.present?
    records[:comparator_searches] = Set.new if params_with_comparators.present?
  end
end

#no_resources_skip_message(resource_type = self.resource_type) ⇒ Object 



494
495
496
497
498
499
500
501
502
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 494

def no_resources_skip_message(resource_type = self.resource_type)
  msg = "No #{resource_type} resources appear to be available"

  if resource_type == 'Device' && implantable_device_codes.present?
    msg.concat(" with the following Device Type Code filter: #{implantable_device_codes}")
  end

  "#{msg}. Please use resources with more information"
end

#payer_insurance_plan?(resource) ⇒ Boolean

Returns:

  • (Boolean) 


195
196
197
198
199
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 195

def payer_insurance_plan?(resource)
  return false if formulary_insurance_plan? resource

  true
end

#perform_comparator_searches(params, _resource_input) ⇒ Object 



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 263

def perform_comparator_searches(params, _resource_input)
  params_with_comparators.each do |name|
    next if search_variant_test_records[:comparator_searches].include? name

    required_comparators(name).each do |comparator|
      paths = search_param_paths(name).first
      date_element = find_a_value_at(scratch_resources_for_group(metadata.profile_url), paths)
      params_with_comparator = params.merge(name => date_comparator_value(comparator, date_element))

      search_and_check_response(params_with_comparator)

      fetch_all_bundled_resources(resource_type:, bundle: resource).each do |resource|
        check_resource_against_params(resource, params_with_comparator) if resource.resourceType == resource_type
      end
    end

    search_variant_test_records[:comparator_searches] << name
  end
end

#perform_multiple_or_search_test ⇒ Object 



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 352

def perform_multiple_or_search_test
  resolved_one = false

  all_search_params.each_value do |params_list|
    next unless params_list.present?

    search_params = params_list.first
    existing_values = {}
    missing_values = {}

    multiple_or_search_params.each do |param_name|
      search_value = default_search_values(param_name.to_sym)
      search_params = search_params.merge(param_name.to_s => search_value)
      existing_values[param_name.to_sym] =
        scratch_resources_for_group(metadata.profile_url).map(&param_name.to_sym).compact.uniq
    end

    # skip patient without multiple-or values
    next if existing_values.values.any?(&:empty?)

    resolved_one = true

    search_and_check_response(search_params)

    resources_returned = select_all_bundled_resources

    multiple_or_search_params.each do |param_name|
      missing_values[param_name.to_sym] =
        existing_values[param_name.to_sym] - resources_returned.map(&param_name.to_sym)
    end

    missing_value_message = missing_values
      .reject { |_param_name, missing_value| missing_value.empty? }
      .map { |param_name, missing_value| "#{missing_value.join(',')} values from #{param_name}" }
      .join(' and ')

    assert missing_value_message.blank?,
           "Could not find #{missing_value_message} in any of the resources returned for #{metadata.profile_name}"

    break if resolved_one
  end
end

#perform_post_search(get_search_resources, params) ⇒ Object 



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 163

def perform_post_search(get_search_resources, params)
  fhir_search resource_type, params:, search_method: :post

  check_search_response

  post_search_resources = select_all_bundled_resources

  filter_insurance_plan(post_search_resources) if resource_type == 'InsurancePlan'

  get_resource_count = get_search_resources.length
  post_resource_count = post_search_resources.length

  search_variant_test_records[:post_variant] = true

  assert get_resource_count == post_resource_count,
         'Expected search by POST to return the same results as search by GET, ' \
         "but GET search returned #{get_resource_count} resources, and POST search " \
         "returned #{post_resource_count} resources."
end

#perform_reference_with_type_search(params, resource_count) ⇒ Object 



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 283

def perform_reference_with_type_search(params, resource_count)
  return if resource_count.zero?
  return if search_variant_test_records[:reference_variants]

  new_search_params = params.each_with_object({}) do |(name, value), new_params|
    definition = metadata.search_definitions[name.to_sym]
    if definition[:type] != 'Reference'
      new_params[name] = value
      next
    end

    target_type = metadata.search_definitions[name.to_sym][:target]
    new_value =
      if value.start_with?("#{target_type}/")
        value.delete_prefix("#{target_type}/")
      else
        "#{target_type}/#{value}"
      end
    new_params[name] = new_value
  end

  search_and_check_response(new_search_params)

  reference_with_type_resources = select_all_bundled_resources

  filter_insurance_plan(reference_with_type_resources) if resource_type == 'InsurancePlan'

  new_resource_count = reference_with_type_resources.count

  assert new_resource_count == resource_count,
         "Expected search by `#{params['patient']}` to to return the same results as searching " \
         "by `#{new_search_params['patient']}`, but found #{resource_count} resources with " \
         "`#{params['patient']}` and #{new_resource_count} with `#{new_search_params['patient']}`"

  search_variant_test_records[:reference_variants] = true
end

#perform_search(params, resource_input) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 127

def perform_search(params, resource_input)
  fhir_search(resource_type, params:)

  check_search_response

  resources_returned =
    select_all_bundled_resources

  return [] if resources_returned.blank?

  perform_comparator_searches(params, resource_input) if params_with_comparators.present?

  filter_insurance_plan(resources_returned) if resource_type == 'InsurancePlan'

  if first_search?
    all_scratch_resources.concat(resources_returned).uniq!
    scratch_resources_for_group(metadata.profile_url).concat(resources_returned).uniq!
    # scratch_resources_for_group(resource_input).concat(resources_returned).uniq!

  end

  resources_returned.each do |resource|
    check_resource_against_params(resource, params)
  end

  save_delayed_references(resources_returned) if saves_delayed_references?

  return resources_returned if all_search_variants_tested?

  perform_post_search(resources_returned, params) if test_post_search?
  perform_reference_with_type_search(params, resources_returned.count) if test_reference_variants?
  perform_search_with_system(params, resource_input) if token_search_params.present?

  resources_returned
end

#perform_search_with_system(params, resource_input) ⇒ Object 



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 320

def perform_search_with_system(params, resource_input)
  return if search_variant_test_records[:token_variants]

  new_search_params = search_params_with_values(token_search_params, resource_input, include_system: true)
  return if new_search_params.any? { |_name, value| value.blank? }

  search_params = params.merge(new_search_params)
  search_and_check_response(search_params)

  resources_returned = select_all_bundled_resources

  assert resources_returned.present?, 'No resources were returned when searching by `system|code`'

  search_variant_test_records[:token_variants] = true
end

#references_to_save(_resource_type = nil) ⇒ Object 



405
406
407
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 405

def references_to_save(_resource_type = nil)
  metadata.delayed_references
end

#required_comparators(name) ⇒ Object 



254
255
256
257
258
259
260
261
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 254

def required_comparators(name)
  metadata
    .search_definitions
    .dig(name.to_sym, :comparators)
    .select { |_comparator, expectation| expectation == 'SHALL' }
    .keys
    .map(&:to_s)
end

#resource_id_list ⇒ Object 



455
456
457
458
459
460
461
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 455

def resource_id_list
  return [] unless respond_to? :input_ids

  input_ids.split(',').map(&:strip)
  # return [] if input_ids.blank? || !respond_to?(input_ids)
  # send(input_ids).split(',').map(&:strip)
end

#resource_id_param?(name) ⇒ Boolean

Returns:

  • (Boolean) 


463
464
465
466
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 463

def resource_id_param?(name)
  name == '_id'
  # name == 'patient' || (name == '_id' && resource_type == 'Patient')
end

#resource_status ⇒ Object 



451
452
453
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 451

def resource_status
  ['active']
end

#run_include_search_test ⇒ Object 



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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 76

def run_include_search_test
  any_include_references = false

  all_include_search_params.each_value do |params_list|
    params_list.each do |params|
      fhir_search(resource_type, params:)
      check_search_response

      page_count = 1
      bundle = resource

      until bundle.nil? || page_count == 20
        matched_resources = bundle&.entry&.filter_map do |entry|
          entry&.resource if entry&.search&.mode == 'match' && entry&.resource&.resourceType == resource_type
        end

        included_resources = bundle&.entry&.filter_map { |entry| entry.resource if entry.search&.mode == 'include' }

        # For resources in the bundle with the relevant reference, check the bundle for the referenced resource
        matched_resources&.each do |match|
          search_param_paths(include_search_look_up_param).each do |include_ref_path|
            include_ref = resolve_path(match, include_ref_path).first
            next unless include_ref.present?

            any_include_references = true
            include_ref_id = include_ref.reference_id
            include_target_present = included_resources.any? { |resource| resource.id == include_ref_id }

            assert(include_target_present,
                   "#{include_ref.type}/#{include_ref_id} referenced by #{resource_type}/#{match.id} " \
                   'was not included in the bundle')
          end
        end

        # Fetch the next bundle page
        next_bundle_link = bundle&.link&.find { |link| link.relation == 'next' }&.url
        break if next_bundle_link.blank?

        reply = fhir_client.raw_read_url(next_bundle_link)
        store_request('outgoing') { reply }

        bundle = fhir_client.parse_reply(FHIR::Bundle, fhir_client.default_format, reply)
        page_count += 1
      end
    end
  end

  skip_if !any_include_references,
          "Could not find any resources with a reference matching the include param #{include_param}"
end

#run_search_test ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 62

def run_search_test
  # TODO: skip if not supported?

  skip_if !any_valid_search_params?(all_search_params), unable_to_resolve_params_message
  resources_returned =
    all_search_params.flat_map do |resource_input, params_list|
      params_list.flat_map { |params| perform_search(params, resource_input) }
    end

  skip_if resources_returned.empty?, no_resources_skip_message

  perform_multiple_or_search_test if multiple_or_search_params.present?
end

#save_delayed_references(resources, containing_resource_type = resource_type) ⇒ Object 



609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 609

def save_delayed_references(resources, containing_resource_type = resource_type)
  resources.each do |resource|
    references_to_save(containing_resource_type).each do |reference_to_save|
      resolve_path(resource, reference_to_save[:path])
        .select { |reference| reference.is_a?(FHIR::Reference) && !reference.contained? }
        .each do |reference|
          resource_type = reference.resource_class.name.demodulize
          need_to_save = reference_to_save[:resources].include?(resource_type)
          next unless need_to_save

          save_resource_reference(resource_type, reference)
        end
    end
  end
end

#save_resource_reference(resource_type, reference) ⇒ Object 



603
604
605
606
607
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 603

def save_resource_reference(resource_type, reference)
  scratch[:references] ||= {}
  scratch[:references][resource_type] ||= Set.new
  scratch[:references][resource_type] << reference
end

#scratch_resources_for_group(resource_value) ⇒ Object 



399
400
401
402
403
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 399

def scratch_resources_for_group(resource_value)
  return all_scratch_resources if resource_value.nil?

  scratch_resources[resource_value] ||= []
end

#search_and_check_response(params, resource_type = self.resource_type) ⇒ Object 



205
206
207
208
209
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 205

def search_and_check_response(params, resource_type = self.resource_type)
  fhir_search(resource_type, params:)

  check_search_response
end

#search_param_paths(name) ⇒ Object 



472
473
474
475
476
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 472

def search_param_paths(name)
  paths = metadata.search_definitions[name.to_sym][:paths]
  paths[0] = 'local_class' if paths.first == 'class'
  paths.map { |path| path.delete_prefix('Resource.') }
end

#search_param_value(name, resource, include_system: false) ⇒ Object 



520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 520

def search_param_value(name, resource, include_system: false)
  paths = search_param_paths(name)
  search_value = nil
  paths.each do |path|
    element = find_a_value_at(resource, path) { |element| element_has_valid_value?(element, include_system) }
    search_value =
      case element
      when FHIR::Period
        if element.start.present?
          "gt#{(DateTime.xmlschema(element.start) - 1).xmlschema}"
        else
          end_datetime = get_fhir_datetime_range(element.end)[:end]
          "lt#{(end_datetime + 1).xmlschema}"
        end
      when FHIR::Reference
        element.reference
      when FHIR::CodeableConcept
        if include_system
          coding =
            find_a_value_at(element, 'coding') { |coding| coding.code.present? && coding.system.present? }
          "#{coding.system}|#{coding.code}"
        else
          find_a_value_at(element, 'coding.code')
        end
      when FHIR::Identifier
        include_system ? "#{element.system}|#{element.value}" : element.value
      when FHIR::Coding
        include_system ? "#{element.system}|#{element.code}" : element.code
      when FHIR::HumanName
        element.family || element.given&.first || element.text
      when FHIR::Address
        element.text || element.city || element.state || element.postalCode || element.country
      else
        if metadata.version != 'v3.1.1' &&
           metadata.search_definitions[name.to_sym][:type] == 'date' &&
           params_with_comparators&.include?(name)
          # convert date search to greath-than comparator search with correct precision
          # For all date search parameters:
          #   Patient.birthDate does not mandate comparators so cannot be converted
          #   Goal.target-date has day precision
          #   All others have second + time offset precision
          if /^\d{4}(-\d{2})?$/.match?(element) || # YYYY or YYYY-MM
             (/^\d{4}-\d{2}-\d{2}$/.match?(element) && resource_type != 'Goal') # YYY-MM-DD AND Resource is NOT Goal
            "gt#{(DateTime.xmlschema(element) - 1).xmlschema}"
          else
            element
          end
        else
          element
        end
      end

    break if search_value.present?
  end

  search_value&.gsub(',', '\\,')
end

#search_params_with_values(search_param_names, input_value, include_system: false) ⇒ Object 



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 423

def search_params_with_values(search_param_names, input_value, include_system: false)
  resources = scratch_resources_for_group(metadata.profile_url)

  if resources.empty?
    return search_param_names.each_with_object({}) do |name, params|
      # if you get an input value, map that to name {{"_id"=>"StateOfCTLocation"}}
      value = (input_value if status_param?(name) || resource_id_param?(name))
      params[name] = value
    end
  end
  resources.each_with_object({}) do |resource, outer_params|
    results_from_one_resource = search_param_names.each_with_object({}) do |name, params|
      value = if status_param?(name)
                input_value
              else
                search_param_value(name, resource,
                                   include_system:)
              end
      params[name] = value
    end

    outer_params.merge!(results_from_one_resource)

    # stop if all parameter values are found
    return outer_params if outer_params.all? { |_key, value| value.present? }
  end
end

#search_variant_test_records ⇒ Object 



217
218
219
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 217

def search_variant_test_records
  @search_variant_test_records ||= initial_search_variant_test_records
end

#select_all_bundled_resources ⇒ Object 



504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 504

def select_all_bundled_resources
  if resource_type == 'MedicationRequest'
    fetch_all_bundled_resources(resource_type:, bundle: resource, additional_resource_types: ['Medication'])
      .select do |resource|
      resource.resourceType == resource_type
    end
  else
    fetch_all_bundled_resources(resource_type:, bundle: resource)
      .select { |resource| resource.resourceType == resource_type }
  end
end

#status_param?(name) ⇒ Boolean

Returns:

  • (Boolean) 


468
469
470
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 468

def status_param?(name)
  name == 'status'
end

#status_search_param_name ⇒ Object 



336
337
338
339
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 336

def status_search_param_name
  @status_search_param_name ||=
    metadata.search_definitions.keys.find { |key| key.to_s.include? 'status' }
end

#status_search_values ⇒ Object 



341
342
343
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 341

def status_search_values
  default_search_values(status_search_param_name)
end

#unable_to_resolve_params_message ⇒ Object 



486
487
488
 
# File 'lib/davinci_us_drug_formulary_test_kit/search_test.rb', line 486

def unable_to_resolve_params_message
  "Could not find values for all search params #{array_of_codes(search_param_names)}"
end