Module: CancerRegistryReportingTestKit::MustSupportTest

Extended by:
Forwardable
Includes:
FHIRResourceNavigation, HDEABundleParse
Included in:
HDEAV100::AllergyIntoleranceMustSupportTest, HDEAV100::CarePlanMustSupportTest, HDEAV100::CcrrContentBundleMustSupportTest, HDEAV100::CentralCancerRegistryPrimaryCancerConditionMustSupportTest, HDEAV100::CompositionMustSupportTest, HDEAV100::ConditionMustSupportTest, HDEAV100::DiagnosticReportLabMustSupportTest, HDEAV100::DiagnosticReportNoteMustSupportTest, HDEAV100::DocumentReferenceMustSupportTest, HDEAV100::EncounterMustSupportTest, HDEAV100::McodeRadiotherapyCourseSummaryMustSupportTest, HDEAV100::McodeSecondaryCancerConditionMustSupportTest, HDEAV100::McodeTnmStageGroupMustSupportTest, HDEAV100::MedicationAdministrationMustSupportTest, HDEAV100::MedicationMustSupportTest, HDEAV100::MedicationRequestMustSupportTest, HDEAV100::MedicationStatementMustSupportTest, HDEAV100::ObservationLabMustSupportTest, HDEAV100::ObservationMustSupportTest, HDEAV100::OdhUsualWorkMustSupportTest, HDEAV100::OrganizationMustSupportTest, HDEAV100::PatientMustSupportTest, HDEAV100::PractitionerMustSupportTest, HDEAV100::PractitionerRoleMustSupportTest, HDEAV100::ProcedureMustSupportTest, HDEAV100::ServiceRequestMustSupportTest, HDEAV100::SmokingstatusMustSupportTest, MedicationRequestMustSupportTest, PrimaryCancerConditionMustSupportTest, RadiotherapyProcedureMustSupportTest, SecondaryCancerConditionMustSupportTest, TNMDistantMetastasesCategoryMustSupportTest, TNMPrimaryTumorCategoryMustSupportTest, TNMRegionalNodesCategoryMustSupportTest, TNMStageGroupMustSupportTest
Defined in:
lib/cancer_registry_reporting_test_kit/must_support_test.rb

Constant Summary

Constants included from HDEABundleParse

HDEABundleParse::CODE_TO_MULTIPLE_ENTRY_RESOURCE_MAP, HDEABundleParse::CODE_TO_URL_MAP, HDEABundleParse::FIELD_TO_URL_MAP

Constants included from FHIRResourceNavigation

FHIRResourceNavigation::DAR_EXTENSION_URL, FHIRResourceNavigation::PRIMITIVE_DATA_TYPES

Instance Method Summary collapse

Methods included from HDEABundleParse

#clear_unresolved_references, #find_resource_in_bundle, #look_for_references_in_resource, #multiple_reference_types?, #parse_bundle, #parse_sections, #profile_from_resource_type, #unresolved_references

Methods included from FHIRResourceNavigation

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

Instance Method Details

#all_scratch_resources ⇒ Object 



14
15
16
 
# File 'lib/cancer_registry_reporting_test_kit/must_support_test.rb', line 14

def all_scratch_resources
  scratch_resources[:all]
end

#exclude_uscdi_only_test? ⇒ Boolean

Returns:

  • (Boolean) 


76
77
78
 
# File 'lib/cancer_registry_reporting_test_kit/must_support_test.rb', line 76

def exclude_uscdi_only_test?
  config.options[:exclude_uscdi_only_test] == true
end

#find_missing_elements(resources, must_support_elements) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/cancer_registry_reporting_test_kit/must_support_test.rb', line 120

def find_missing_elements(resources, must_support_elements)
  must_support_elements.select do |element_definition|
    resources.none? do |resource|
      path = element_definition[:path]
      ms_extension_urls = must_support_extensions.select { |ex| ex[:path] == "#{path}.extension" }
        .map { |ex| ex[:url] }

      value_found = find_a_value_at(resource, path) do |value|
        if value.instance_of?(CancerRegistryReportingTestKit::PrimitiveType) && ms_extension_urls.present?
          urls = value.extension&.map(&:url)
          has_ms_extension = (urls & ms_extension_urls).present?
        end

        unless has_ms_extension
          value = value.value if value.instance_of?(CancerRegistryReportingTestKit::PrimitiveType)
          value_without_extensions =
            value.respond_to?(:to_hash) ? value.to_hash.except('extension') : value
        end

        (has_ms_extension || value_without_extensions.present? || value_without_extensions == false) &&
          (element_definition[:fixed_value].blank? || value == element_definition[:fixed_value])
      end
      # Note that false.present? => false, which is why we need to add this extra check
      value_found.present? || value_found == false
    end
  end
end

#find_slice(resource, path, discriminator) ⇒ Object 



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/cancer_registry_reporting_test_kit/must_support_test.rb', line 166

def find_slice(resource, path, discriminator)
  find_a_value_at(resource, path) do |element|
    case discriminator[:type]
    when 'patternCodeableConcept'
      coding_path = discriminator[:path].present? ? "#{discriminator[:path]}.coding" : 'coding'
      find_a_value_at(element, coding_path) do |coding|
        coding.code == discriminator[:code] && coding.system == discriminator[:system]
      end
    when 'patternCoding'
      coding_path = discriminator[:path].present? ? discriminator[:path] : ''
      find_a_value_at(element, coding_path) do |coding|
        coding.code == discriminator[:code] && coding.system == discriminator[:system]
      end
    when 'patternIdentifier'
      find_a_value_at(element, discriminator[:path]) { |identifier| identifier.system == discriminator[:system] }
    when 'value'
      values = discriminator[:values].map { |value| value.merge(path: value[:path].split('.')) }
      find_slice_by_values(element, values)
    when 'type'
      case discriminator[:code]
      when 'Date'
        begin
          Date.parse(element)
        rescue ArgumentError
          false
        end
      when 'DateTime'
        begin
          DateTime.parse(element)
        rescue ArgumentError
          false
        end
      when 'String'
        element.is_a? String
      else
        if element.is_a? FHIR::Bundle::Entry
          element.resource.is_a? FHIR.const_get(discriminator[:code])
        else
          element.is_a? FHIR.const_get(discriminator[:code])
        end
      end
    when 'requiredBinding'
      coding_path = discriminator[:path].present? ? "#{discriminator[:path]}.coding" : 'coding'

      ## SPECIAL CASE ##
      # only checking ODH MS slices for codesystem, not codes, given large number of codes
      if metadata.profile_url == 'http://hl7.org/fhir/us/odh/StructureDefinition/odh-UsualWork'
        get_slice_by_codesystem(element, discriminator)
      else
        find_a_value_at(element, coding_path) do |coding|
          discriminator[:values].any? { |value| value[:system] == coding.system && value[:code] == coding.code }
        end
      end
    end
  end
end

#find_slice_by_values(element, value_definitions) ⇒ Object

end special case ##



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
 
# File 'lib/cancer_registry_reporting_test_kit/must_support_test.rb', line 233

def find_slice_by_values(element, value_definitions)
  path_prefixes = value_definitions.map { |value_definition| value_definition[:path].first }.uniq
  Array.wrap(element).find do |el|
    path_prefixes.all? do |path_prefix|
      value_definitions_for_path =
        value_definitions
          .select { |value_definition| value_definition[:path].first == path_prefix }
          .each { |value_definition| value_definition[:path].shift }

      find_a_value_at(el, path_prefix) do |el_found|
        child_element_value_definitions, current_element_value_definitions =
          value_definitions_for_path.partition { |value_definition| value_definition[:path].present? }

        current_element_values_match =
          current_element_value_definitions
            .all? { |value_definition| value_definition[:value].to_s == el_found.to_s }

        child_element_values_match =
          if child_element_value_definitions.present?
            find_slice_by_values(el_found, child_element_value_definitions)
          else
            true
          end

        current_element_values_match && child_element_values_match
      end
    end
  end
end

#get_slice_by_codesystem(element, discriminator) ⇒ Object

special case ##



225
226
227
228
229
 
# File 'lib/cancer_registry_reporting_test_kit/must_support_test.rb', line 225

def get_slice_by_codesystem(element, discriminator)
  find_a_value_at(element, '') do |coding|
    discriminator[:values].any? { |value| coding.system.include? value[:system] }
  end
end

#handle_must_support_choices ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/cancer_registry_reporting_test_kit/must_support_test.rb', line 32

def handle_must_support_choices
  missing_elements.delete_if do |element|
    choices = metadata.must_supports[:choices].find { |choice| choice[:paths]&.include?(element[:path]) }
    is_any_choice_supported?(choices)
  end

  missing_extensions.delete_if do |extension|
    choices = metadata.must_supports[:choices].find { |choice| choice[:extension_ids]&.include?(extension[:id]) }
    is_any_choice_supported?(choices)
  end

  missing_slices.delete_if do |slice|
    choices = metadata.must_supports[:choices].find { |choice| choice[:slice_names]&.include?(slice[:name]) }
    is_any_choice_supported?(choices)
  end
end

#is_any_choice_supported?(choices) ⇒ Boolean

Returns:

  • (Boolean) 


49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/cancer_registry_reporting_test_kit/must_support_test.rb', line 49

def is_any_choice_supported?(choices)
  choices.present? &&
    (
      choices[:paths]&.any? { |path| missing_elements.none? { |element| element[:path] == path } } ||
      choices[:extension_ids]&.any? do |extension_id|
        missing_extensions.none? do |extension|
          extension[:id] == extension_id
        end
      end ||
      choices[:slice_names]&.any? { |slice_name| missing_slices.none? { |slice| slice[:name] == slice_name } }
    )
end

#missing_element_string(element_definition) ⇒ Object 



68
69
70
71
72
73
74
 
# File 'lib/cancer_registry_reporting_test_kit/must_support_test.rb', line 68

def missing_element_string(element_definition)
  if element_definition[:fixed_value].present?
    "#{element_definition[:path]}:#{element_definition[:fixed_value]}"
  else
    element_definition[:path]
  end
end

#missing_elements(resources = []) ⇒ Object 



115
116
117
118
 
# File 'lib/cancer_registry_reporting_test_kit/must_support_test.rb', line 115

def missing_elements(resources = [])
  @missing_elements ||= find_missing_elements(resources, must_support_elements)
  @missing_elements
end

#missing_extensions(resources = []) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/cancer_registry_reporting_test_kit/must_support_test.rb', line 88

def missing_extensions(resources = [])
  @missing_extensions ||=
    must_support_extensions.select do |extension_definition|
      resources.none? do |resource|
        path = extension_definition[:path]

        if path == 'extension'
          resource.extension.any? { |extension| extension.url == extension_definition[:url] }
        else
          extension = find_a_value_at(resource, path) do |el|
            el.url == extension_definition[:url]
          end

          extension.present?
        end
      end
    end
end

#missing_must_support_strings ⇒ Object 



62
63
64
65
66
 
# File 'lib/cancer_registry_reporting_test_kit/must_support_test.rb', line 62

def missing_must_support_strings
  missing_elements.map { |element_definition| missing_element_string(element_definition) } +
    missing_slices.map { |slice_definition| slice_definition[:slice_id] } +
    missing_extensions.map { |extension_definition| extension_definition[:id] }
end

#missing_slices(resources = []) ⇒ Object 



156
157
158
159
160
161
162
163
164
 
# File 'lib/cancer_registry_reporting_test_kit/must_support_test.rb', line 156

def missing_slices(resources = [])
  @missing_slices ||=
    must_support_slices.select do |slice|
      resources.none? do |resource|
        path = slice[:path] # .delete_suffix('[x]')
        find_slice(resource, path, slice[:discriminator]).present?
      end
    end
end

#must_support_elements ⇒ Object 



107
108
109
110
111
112
113
 
# File 'lib/cancer_registry_reporting_test_kit/must_support_test.rb', line 107

def must_support_elements
  if exclude_uscdi_only_test?
    metadata.must_supports[:elements].reject { |element| element[:uscdi_only] }
  else
    metadata.must_supports[:elements]
  end
end

#must_support_extensions ⇒ Object 



80
81
82
83
84
85
86
 
# File 'lib/cancer_registry_reporting_test_kit/must_support_test.rb', line 80

def must_support_extensions
  if exclude_uscdi_only_test?
    metadata.must_supports[:extensions].reject { |extension| extension[:uscdi_only] }
  else
    metadata.must_supports[:extensions]
  end
end

#must_support_slices ⇒ Object 



148
149
150
151
152
153
154
 
# File 'lib/cancer_registry_reporting_test_kit/must_support_test.rb', line 148

def must_support_slices
  if exclude_uscdi_only_test?
    metadata.must_supports[:slices].reject { |slice| slice[:uscdi_only] }
  else
    metadata.must_supports[:slices]
  end
end

#perform_must_support_test(resources) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/cancer_registry_reporting_test_kit/must_support_test.rb', line 18

def perform_must_support_test(resources)
  skip_if resources.blank?, "No #{resource_type} resources were found"

  missing_elements(resources)
  missing_slices(resources)
  missing_extensions(resources)

  handle_must_support_choices if metadata.must_supports[:choices].present?

  skip_if (missing_elements + missing_slices + missing_extensions).present?, 
    "Could not find #{missing_must_support_strings.join(', ')} in the #{resources.length} " \
    "provided #{resource_type} resource(s)"
end