Class: DaVinciCRDTestKit::MockEHR::FHIRSearchEndpoint

Inherits:
Inferno::DSL::SuiteEndpoint
  • Object
show all
Includes:
FHIRRequestHandler, Inferno::DSL::FHIRResourceNavigation
Defined in:
lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods included from FHIRRequestHandler

#add_provided_resource_to_mock_ehr_bundle, #assign_id_to_provided_resource, #error_body, #interaction_type, #mock_ehr_bundle, #mock_ehr_bundle_input_name, #mock_ehr_bundle_present?, #prepare_response, #provided_resource, #provided_resource_valid?, #remove_target_resource_from_bundle, #resource_id, #resource_id_present?, #resource_type, #resource_type_present?, #return_provided_resource, #return_target_resource, #return_unhandled_error, #save_mock_ehr_bundle_to_input, session_id_to_token, #target_resource, #target_resource_entry, #target_resource_entry_index, #target_resource_present?, #test_run_identifier, #token_to_session_id, #update_target_resource_in_mock_ehr_bundle

Class Method Details

.metadata_by_resource_typeObject



57
58
59
60
61
62
63
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 57

def self.
  @metadata_by_resource_type ||=
    &.each_with_object(Hash.new { |h, k| h[k] = [] }) do |path, by_type|
       = USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(path, aliases: true))
      by_type[.resource] << 
    end
end

.metadata_filesObject


Search Metadata




53
54
55
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 53

def self.
  nil
end

Instance Method Details

#all_include_paramsObject



91
92
93
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 91

def all_include_params
  @all_include_params ||= .flat_map { |m| m.include_params || [] }.uniq
end

#all_must_support_elementsObject



99
100
101
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 99

def all_must_support_elements
  @all_must_support_elements ||= .flat_map { |m| m.must_supports&.dig(:elements) || [] }.uniq
end

#all_referencesObject



95
96
97
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 95

def all_references
  @all_references ||= .flat_map { |m| m.references || [] }.uniq
end

#build_revincluded_entry_listObject



522
523
524
525
526
527
528
529
530
531
532
533
534
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 522

def build_revincluded_entry_list
  entries = []
  revincluded_set = Set.new
  mock_ehr_bundle.entry.each do |entry|
    next unless candidate_provenance_for_revinclude?(entry, revincluded_set)

    resolve_path(entry.resource, 'target').each do |reference|
      evaluate_revincluded_reference(entry, reference, entries, revincluded_set)
    end
  end
  @revincluded_entry_set = revincluded_set
  entries
end

#bundle_entry_indexObject



498
499
500
501
502
503
504
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 498

def bundle_entry_index
  @bundle_entry_index ||= mock_ehr_bundle.entry.each_with_object({}) do |entry, index|
    next unless entry.resource.present?

    index[[entry.resource.resourceType, entry.resource.id]] = entry
  end
end

#calculate_supported_includesObject



133
134
135
136
137
138
139
140
141
142
143
144
145
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 133

def calculate_supported_includes
  request_params.keys.each_with_object({}) do |name, includes|
    next unless name == '_include'

    target = request_params[name]
    next unless target.present? && all_include_params.include?(target)

    paths = paths_to_include(target)
    next unless paths.present?

    includes[name] = paths
  end
end

#candidate_provenance_for_revinclude?(entry, revincluded_set) ⇒ Boolean

Returns:

  • (Boolean)


536
537
538
539
540
541
542
543
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 536

def candidate_provenance_for_revinclude?(entry, revincluded_set)
  return false unless entry.resource.present?
  return false unless entry.resource.resourceType == 'Provenance'

  key = [entry.resource.resourceType, entry.resource.id]
  !revincluded_set.include?(key) && !included_entry_set.include?(key) &&
    !matching_entry_set.include?(key)
end

#date?(value) ⇒ Boolean

Returns:

  • (Boolean)


437
438
439
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 437

def date?(value)
  /^\d{4}(-\d{2})?(-\d{2})?$/.match?(value) # YYYY or YYYY-MM or YYYY-MM-DD
end

#element_matches_reference_target?(element, target_element) ⇒ Boolean

Returns:

  • (Boolean)


176
177
178
179
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 176

def element_matches_reference_target?(element, target_element)
  element[:types]&.include?('Reference') &&
    [target_element, "#{target_element}[x]"].include?(element[:path])
end

#evaluate_included_reference(reference, included_entries, included_set) ⇒ Object



469
470
471
472
473
474
475
476
477
478
479
480
481
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 469

def evaluate_included_reference(reference, included_entries, included_set)
  return unless local_reference?(reference)

  resource_type, resource_id = reference.reference.split('/')
  key = [resource_type, resource_id]
  return if included_set.include?(key) || matching_entry_set.include?(key)

  included_entry = resolve_reference_to_entry_in_bundle(resource_type, resource_id)
  return unless included_entry.present?

  included_entries << included_entry
  included_set << key
end

#evaluate_revincluded_reference(referencing_entry, reference, revincluded_entries, revincluded_set) ⇒ Object



545
546
547
548
549
550
551
552
553
554
555
556
557
558
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 545

def evaluate_revincluded_reference(referencing_entry, reference, revincluded_entries, revincluded_set)
  return unless local_reference?(reference)

  resource_type, resource_id = reference.reference.split('/')
  return unless matching_entry_set.include?([resource_type, resource_id]) ||
                included_entry_set.include?([resource_type, resource_id])

  provenance_key = [referencing_entry.resource.resourceType, referencing_entry.resource.id]
  return if revincluded_set.include?(provenance_key)

  # referenced instance is matched or included — add the referencing Provenance
  revincluded_entries << referencing_entry
  revincluded_set << provenance_key
end

#fhir_date_comparer(search_range, target_range, comparator, extend_start: false, extend_end: false) ⇒ Object

NOTE: this is different from the US Core implementation for le and ge See jira.hl7.org/browse/FHIR-51068



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
394
395
396
397
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 360

def fhir_date_comparer(search_range, target_range, comparator, extend_start: false, extend_end: false) # rubocop:disable Metrics/CyclomaticComplexity
  # Implicitly, a missing lower boundary is "less than" any actual date.
  # A missing upper boundary is "greater than" any actual date.
  case comparator
  when 'eq' # the range of the search value fully contains the range of the target value
    !target_range[:start].nil? && !target_range[:end].nil? && search_range[:start] <= target_range[:start] &&
      search_range[:end] >= target_range[:end]
  when 'ne' # the range of the search value does not fully contain the range of the target value
    target_range[:start].nil? ||
      target_range[:end].nil? ||
      search_range[:start] > target_range[:start] ||
      search_range[:end] < target_range[:end]
  when 'gt' #  the range above the search value intersects (i.e. overlaps) with the range of the target value
    target_range[:end].nil? ||
      search_range[:end] < target_range[:end] ||
      (search_range[:end] < (target_range[:end] + 1) && extend_end)
  when 'lt' # the range below the search value intersects (i.e. overlaps) with the range of the target value
    target_range[:start].nil? ||
      search_range[:start] > target_range[:start] ||
      (search_range[:start] > (target_range[:start] - 1) && extend_start)
  when 'ge' # the target end is at or after the search range start
    target_range[:end].nil? || target_range[:end] >= search_range[:start]
  when 'le' # the target start is at or before the search range end
    target_range[:start].nil? || target_range[:start] <= search_range[:end]
  when 'sa' # the range above the search value contains the range of the target value
    !target_range[:start].nil? && search_range[:end] < target_range[:start]
  when 'eb' # the range below the search value contains the range of the target value
    !target_range[:end].nil? && search_range[:start] > target_range[:end]
  when 'ap' # the range of the search value overlaps with the range of the target value
    if target_range[:start].nil? || target_range[:end].nil?
      (target_range[:start].nil? && search_range[:start] < target_range[:end]) ||
        (target_range[:end].nil? && search_range[:end] > target_range[:start])
    else
      search_range[:start].between?(target_range[:start], target_range[:end]) ||
        search_range[:end].between?(target_range[:start], target_range[:end])
    end
  end
end

#get_fhir_datetime_range(datetime) ⇒ Object



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 322

def get_fhir_datetime_range(datetime)
  range = { start: DateTime.xmlschema(datetime), end: nil }
  range[:end] =
    case datetime
    when /^\d{4}$/ # YYYY
      range[:start].next_year - 1.seconds
    when /^\d{4}-\d{2}$/ # YYYY-MM
      range[:start].next_month - 1.seconds
    when /^\d{4}-\d{2}-\d{2}$/ # YYYY-MM-DD
      range[:start].next_day - 1.seconds
    else # YYYY-MM-DDThh:mm:ss+zz:zz
      range[:start]
    end
  range
end

#get_fhir_period_range(period) ⇒ Object



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 338

def get_fhir_period_range(period)
  range = { start: nil, end: nil }
  range[:start] = DateTime.xmlschema(period.start) unless period.start.nil?
  return range if period.end.nil?

  period_end_beginning = DateTime.xmlschema(period.end)
  range[:end] =
    case period.end
    when /^\d{4}$/ # YYYY
      period_end_beginning.next_year - 1.seconds
    when /^\d{4}-\d{2}$/ # YYYY-MM
      period_end_beginning.next_month - 1.seconds
    when /^\d{4}-\d{2}-\d{2}$/ # YYYY-MM-DD
      period_end_beginning.next_day - 1.seconds
    else # YYYY-MM-DDThh:mm:ss+zz:zz
      period_end_beginning
    end
  range
end

#include_paths_by_resource_typeObject



483
484
485
486
487
488
489
490
491
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 483

def include_paths_by_resource_type
  @include_paths_by_resource_type ||=
    supported_include_param_paths.values.each_with_object({}) do |include_paths, by_resource_type|
      include_paths.each do |path_with_resource_type|
        resource_type, path = path_with_resource_type.split('.', 2)
        (by_resource_type[resource_type] ||= []) << path
      end
    end
end

#include_resource_in_search_results?(resource) ⇒ Boolean

Returns:

  • (Boolean)


203
204
205
206
207
208
209
210
211
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 203

def include_resource_in_search_results?(resource)
  supported_search_param_names.reduce(true) do |matches_so_far, name|
    return false unless matches_so_far

    escaped_search_value = request_params[name]
    values_found = []
    resource_matches_param?(resource, name, escaped_search_value, values_found)
  end
end

#included_entry_listObject


_include logic




445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 445

def included_entry_list
  @included_entry_list ||= begin
    entries = []
    included_set = Set.new
    matching_entry_list.each do |entry|
      resource = entry.resource
      next unless include_paths_by_resource_type.key?(resource.resourceType)

      include_paths_by_resource_type[resource.resourceType].each do |target_include_path|
        resolve_path(resource, target_include_path).each do |reference|
          evaluate_included_reference(reference, entries, included_set)
        end
      end
    end
    @included_entry_set = included_set
    entries
  end
end

#included_entry_setObject



464
465
466
467
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 464

def included_entry_set
  included_entry_list # ensure built, which populates @included_entry_set
  @included_entry_set ||= Set.new
end

#load_metadata_listObject



74
75
76
77
78
79
80
81
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 74

def 
  return self.class.&.dig(resource_type) || [] if self.class.

  Dir.glob(File.join(, "#{resource_type.underscore}*", 'metadata.yml')).filter_map do |path|
    m = USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(path, aliases: true))
    m if m.resource == resource_type
  end
end

#local_reference?(reference) ⇒ Boolean

Returns:

  • (Boolean)


493
494
495
496
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 493

def local_reference?(reference)
  reference.is_a?(FHIR::Reference) &&
    reference.reference.split('/').length == 2 # local reference
end

#make_responseObject



10
11
12
13
14
15
16
17
18
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 10

def make_response
  prepare_response
  return unless mock_ehr_bundle_present?
  return unless resource_type_present?

  return_response_bundle
rescue StandardError => e
  return_unhandled_error(e)
end

#matching_entry_listObject


Search Logic




185
186
187
188
189
190
191
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 185

def matching_entry_list
  @matching_entry_list ||= mock_ehr_bundle.entry&.select do |entry|
    entry.resource.present? &&
      entry.resource.resourceType == resource_type &&
      include_resource_in_search_results?(entry.resource)
  end
end

#matching_entry_setObject



193
194
195
196
197
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 193

def matching_entry_set
  @matching_entry_set ||= matching_entry_list.each_with_object(Set.new) do |entry, set|
    set << [entry.resource.resourceType, entry.resource.id]
  end
end

#merged_search_definitionsObject



83
84
85
86
87
88
89
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 83

def merged_search_definitions
  @merged_search_definitions ||= .each_with_object({}) do |m, defs|
    m.search_definitions&.each do |name, definition|
      defs[name] ||= definition
    end
  end
end

#metadata_directoryObject



65
66
67
68
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 65

def 
  File.join(Gem::Specification.find_by_name('us_core_test_kit').gem_dir,
            'lib', 'us_core_test_kit', 'generated', 'v6.1.0')
end

#metadata_listObject



70
71
72
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 70

def 
  @metadata_list ||= 
end

#paths_from_must_support_element(target) ⇒ Object



169
170
171
172
173
174
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 169

def paths_from_must_support_element(target)
  target_element = target.split(':').last
  return unless all_must_support_elements.any? { |elt| element_matches_reference_target?(elt, target_element) }

  [target.gsub(':', '.')]
end

#paths_from_reference_list(target) ⇒ Object



162
163
164
165
166
167
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 162

def paths_from_reference_list(target)
  path_with_resource_type = target.gsub(':', '.')
  return unless all_references.any? { |ref| ref[:path] == path_with_resource_type }

  [path_with_resource_type]
end

#paths_from_search_definition(target) ⇒ Object



154
155
156
157
158
159
160
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 154

def paths_from_search_definition(target)
  search_parameter = target.split(':').last
  definition = merged_search_definitions[search_parameter.to_sym]
  return unless definition.present? && definition[:type] == 'Reference'

  definition[:full_paths]
end

#paths_to_include(target) ⇒ Object



147
148
149
150
151
152
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 147

def paths_to_include(target)
  paths = paths_from_search_definition(target)
  paths = paths_from_reference_list(target) unless paths.present?
  paths = paths_from_must_support_element(target) unless paths.present?
  paths
end

#request_paramsObject



199
200
201
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 199

def request_params
  @request_params ||= request.params.to_h.except(:resource_type).stringify_keys
end

#resolve_reference_to_entry_in_bundle(resource_type, resource_id) ⇒ Object



506
507
508
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 506

def resolve_reference_to_entry_in_bundle(resource_type, resource_id)
  bundle_entry_index[[resource_type, resource_id]]
end

#resource_matches_param?(resource, search_param_name, escaped_search_value, values_found = []) ⇒ Boolean

rubocop:disable Metrics/CyclomaticComplexity

Returns:

  • (Boolean)


224
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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
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
319
320
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 224

def resource_matches_param?(resource, search_param_name, escaped_search_value, values_found = []) # rubocop:disable Metrics/CyclomaticComplexity
  search_value = unescape_search_value(escaped_search_value)
  paths = search_param_paths(search_param_name)

  match_found = false

  paths.each do |path|
    type = merged_search_definitions.dig(search_param_name.to_sym, :type)

    resolve_path(resource, path).each do |value|
      values_found <<
        if value.is_a? FHIR::Reference
          value.reference
        elsif value.is_a? Inferno::DSL::PrimitiveType
          value.value
        else
          value
        end
    end

    values_found.compact!
    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? search_param_name.to_s
          id = search_value.split('Patient/').last
          possible_values = [id, "Patient/#{id}"] # TODO: "#{url}/Patient/#{id}"] - allow absolute references?
          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

  match_found
end

#response_bundleObject



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 29

def response_bundle
  bundle = FHIR::Bundle.new({ type: 'searchset' })
  bundle.link << FHIR::Bundle::Link.new({ relation: 'self', url: self_link })

  matching_entry_list.each do |entry|
    bundle.entry << FHIR::Bundle::Entry.new({ resource: entry.resource,
                                              search: FHIR::Bundle::Entry::Search.new({ mode: 'match' }) })
  end
  included_entry_list.each do |entry|
    bundle.entry << FHIR::Bundle::Entry.new({ resource: entry.resource,
                                              search: FHIR::Bundle::Entry::Search.new({ mode: 'include' }) })
  end
  revincluded_entry_list.each do |entry|
    bundle.entry << FHIR::Bundle::Entry.new({ resource: entry.resource,
                                              search: FHIR::Bundle::Entry::Search.new({ mode: 'include' }) })
  end

  bundle
end

#return_response_bundleObject


Search Response




24
25
26
27
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 24

def return_response_bundle
  response.status = 200
  response.body = response_bundle.to_json
end

#revinclude_provenance_target?Boolean

Returns:

  • (Boolean)


124
125
126
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 124

def revinclude_provenance_target?
  request_params.any? { |key, value| key == '_revinclude' && value == 'Provenance:target' }
end

#revincluded_entry_listObject


_revinclude logic




513
514
515
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 513

def revincluded_entry_list
  @revincluded_entry_list ||= revinclude_provenance_target? ? build_revincluded_entry_list : []
end

#revincluded_entry_setObject



517
518
519
520
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 517

def revincluded_entry_set
  revincluded_entry_list # ensure built, which populates @revincluded_entry_set
  @revincluded_entry_set ||= Set.new
end

#search_param_paths(name) ⇒ Object



217
218
219
220
221
222
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 217

def search_param_paths(name)
  paths = merged_search_definitions.dig(name.to_sym, :paths)
  paths[0] = 'local_class' if paths.first == 'class'

  paths
end

Self Link search parameters identification




107
108
109
110
111
112
113
114
115
116
117
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 107

def self_link
  host_and_path = request.url.split('?').first
  param_list =
    (supported_search_param_names + supported_include_param_paths.keys).map do |name|
      "#{name}=#{request_params[name]}"
    end
  param_list << '_revinclude=Provenance:target' if revinclude_provenance_target?
  query_string = param_list.present? ? "?#{param_list.join('&')}" : ''

  "#{host_and_path}#{query_string}"
end

#supported_include_param_pathsObject

map from include name to a list of paths at which to find references to include



129
130
131
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 129

def supported_include_param_paths
  @supported_include_param_paths ||= calculate_supported_includes
end

#supported_search_param_namesObject



119
120
121
122
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 119

def supported_search_param_names
  @supported_search_param_names ||=
    request_params.keys.select { |name| merged_search_definitions.key?(name.to_sym) }
end

#unescape_search_value(value) ⇒ Object



213
214
215
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 213

def unescape_search_value(value)
  value&.gsub('\\,', ',')
end

#validate_date_search(search_value, target_value) ⇒ Object



399
400
401
402
403
404
405
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 399

def validate_date_search(search_value, target_value)
  if target_value.instance_of? FHIR::Period
    validate_period_search(search_value, target_value)
  else
    validate_datetime_search(search_value, target_value)
  end
end

#validate_datetime_search(search_value, target_value) ⇒ Object



407
408
409
410
411
412
413
414
415
416
417
418
419
420
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 407

def validate_datetime_search(search_value, target_value)
  comparator = search_value[0..1]
  if ['eq', 'ge', 'gt', 'le', 'lt', 'ne', 'sa', 'eb', 'ap'].include? comparator
    search_value = search_value[2..]
  else
    comparator = 'eq'
  end
  search_is_date = date?(search_value)
  target_is_date = date?(target_value)
  search_range = get_fhir_datetime_range(search_value)
  target_range = get_fhir_datetime_range(target_value)
  fhir_date_comparer(search_range, target_range, comparator, extend_start: !search_is_date && target_is_date,
                                                             extend_end: !search_is_date && target_is_date)
end

#validate_period_search(search_value, target_value) ⇒ Object



422
423
424
425
426
427
428
429
430
431
432
433
434
435
# File 'lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb', line 422

def validate_period_search(search_value, target_value)
  comparator = search_value[0..1]
  if ['eq', 'ge', 'gt', 'le', 'lt', 'ne', 'sa', 'eb', 'ap'].include? comparator
    search_value = search_value[2..]
  else
    comparator = 'eq'
  end
  search_is_date = date?(search_value)
  search_range = get_fhir_datetime_range(search_value)
  target_range = get_fhir_period_range(target_value)
  fhir_date_comparer(search_range, target_range, comparator,
                     extend_start: !search_is_date && date?(target_value.start),
                     extend_end: !search_is_date && date?(target_value.end))
end