Class: USCoreTestKit::Generator::GroupMetadataExtractor

Inherits:
Object
  • Object
show all
Defined in:
lib/us_core_test_kit/generator/group_metadata_extractor.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(resource_capabilities, profile_url, ig_metadata, ig_resources) ⇒ GroupMetadataExtractor

Returns a new instance of GroupMetadataExtractor.



12
13
14
15
16
17
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 12

def initialize(resource_capabilities, profile_url, ig_metadata, ig_resources)
  self.resource_capabilities = resource_capabilities
  self.profile_url = profile_url
  self.ig_metadata = ig_metadata
  self.ig_resources = ig_resources
end

Instance Attribute Details

#ig_metadata ⇒ Object

Returns the value of attribute ig_metadata.



10
11
12
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 10

def ig_metadata
  @ig_metadata
end

#ig_resources ⇒ Object

Returns the value of attribute ig_resources.



10
11
12
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 10

def ig_resources
  @ig_resources
end

#profile_url ⇒ Object

Returns the value of attribute profile_url.



10
11
12
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 10

def profile_url
  @profile_url
end

#resource_capabilities ⇒ Object

Returns the value of attribute resource_capabilities.



10
11
12
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 10

def resource_capabilities
  @resource_capabilities
end

Instance Method Details

#base_name ⇒ Object 



139
140
141
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 139

def base_name
  profile_url.split('StructureDefinition/').last
end

#bindings ⇒ Object 



256
257
258
259
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 256

def bindings
  @bindings ||=
    terminology_binding_metadata_extractor.terminology_bindings
end

#category_first_profile? ⇒ Boolean

BEGIN SPECIAL CASES ###

Returns:

  • (Boolean) 


97
98
99
100
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 97

def category_first_profile?
  SpecialCases::ALL_VERSION_CATEGORY_FIRST_PROFILES.include?(profile_url) ||
  SpecialCases::VERSION_SPECIFIC_CATEGORY_FIRST_PROFILES[profile_url]&.include?(reformatted_version)
end

#class_name ⇒ Object 



147
148
149
150
151
152
153
154
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 147

def class_name
  base_name
    .split('-')
    .map(&:capitalize)
    .join
    .gsub('UsCore', "USCore#{ig_metadata.reformatted_version}")
    .concat('Sequence')
end

#first_search_params ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 102

def first_search_params
  @first_search_params ||=
  if category_first_profile?
    ['patient', 'category']
  elsif resource == 'Observation'
    ['patient', 'code']
  elsif resource == 'MedicationRequest'
    ['patient', 'intent']
  elsif resource == 'CareTeam'
    ['patient', 'status']
  else
    ['patient']
  end
end

#group_metadata ⇒ Object 



19
20
21
22
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 19

def group_metadata
  @group_metadata ||=
    GroupMetadata.new(group_metadata_hash)
end

#group_metadata_hash ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 24

def group_metadata_hash
  @group_metadata_hash ||=
    {
      name: name,
      class_name: class_name,
      version: version,
      reformatted_version: reformatted_version,
      # test_id_prefix: test_id_prefix,
      resource: resource,
      profile_url: profile_url,
      profile_name: profile_name,
      profile_version: profile_version,
      title: title,
      short_description: short_description,
      interactions: interactions,
      operations: operations,
      searches: searches,
      search_definitions: search_definitions,
      include_params: include_params,
      revincludes: revincludes,
      required_concepts: required_concepts,
      must_supports: must_supports,
      mandatory_elements: mandatory_elements,
      bindings: bindings,
      references: references
      # tests: []
    }

  mark_mandatory_and_must_support_searches
  handle_special_cases

  @group_metadata_hash
end

#handle_special_cases ⇒ Object 



117
118
119
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 117

def handle_special_cases
  set_first_search
end

#include_params ⇒ Object 



231
232
233
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 231

def include_params
  resource_capabilities.searchInclude || []
end

#interactions ⇒ Object 



190
191
192
193
194
195
196
197
198
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 190

def interactions
  @interactions ||=
    resource_capabilities.interaction.map do |interaction|
      {
        code: interaction.code,
        expectation: interaction.extension.first.valueCode # TODO: fix expectation extension finding
      }
    end
end

#mandatory_elements ⇒ Object 



271
272
273
274
275
276
277
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 271

def mandatory_elements
  @mandatory_elements ||=
    profile_elements
      .select { |element| element.min.positive? }
      .map { |element| element.path }
      .uniq
end

#mark_mandatory_and_must_support_searches ⇒ Object 



58
59
60
61
62
63
64
65
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
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 58

def mark_mandatory_and_must_support_searches
  searches.each do |search|
    search[:names_not_must_support_or_mandatory] = search[:names].reject do |name|
      full_paths = search_definitions[name.to_sym][:full_paths]
      any_must_support_elements = (must_supports[:elements]).any? do |element|
        full_must_support_paths = ["#{resource}.#{element[:original_path]}", "#{resource}.#{element[:path]}"]

        full_paths.any? do |path|
          # allow for non-choice, choice types, and _id
          name == '_id' || full_must_support_paths.include?(path) || full_must_support_paths.include?("#{path}[x]")
        end
      end

      any_must_support_slices = must_supports[:slices].any? do |slice|
        # only handle type slices because that is all we need for now
        # for a slice like Observation.effective[x]:effectiveDateTime, the search parameter's expression could be
        # either Observation.effective or Observation.effectiveDateTime.
        if slice[:discriminator] && slice[:discriminator][:type] == 'type'
          full_must_support_path = "#{resource}.#{slice[:path].sub('[x]', slice[:discriminator][:code])}"
          base_must_support_path = "#{resource}.#{slice[:path].sub('[x]', '')}"

          full_paths.intersection([full_must_support_path,base_must_support_path]).present?
        else
          false
        end
      end

      any_mandatory_elements = mandatory_elements.any? do |element|
        full_paths.include?(element)
      end

      any_must_support_elements || any_must_support_slices || any_mandatory_elements
    end

    search[:must_support_or_mandatory] = search[:names_not_must_support_or_mandatory].empty?
  end
end

#must_support_metadata_extractor ⇒ Object 



261
262
263
264
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 261

def must_support_metadata_extractor
  @must_support_metadata_extractor ||=
    MustSupportMetadataExtractor.new(profile_elements, profile, resource, ig_resources)
end

#must_supports ⇒ Object 



266
267
268
269
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 266

def must_supports
  @must_supports ||=
    must_support_metadata_extractor.must_supports
end

#name ⇒ Object 



143
144
145
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 143

def name
  base_name.tr('-', '_')
end

#operations ⇒ Object 



200
201
202
203
204
205
206
207
208
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 200

def operations
  @operations ||=
    resource_capabilities.operation.map do |operation|
      {
        code: operation.name,
        expectation: operation.extension.first.valueCode # TODO: fix expectation extension finding
      }
    end
end

#profile ⇒ Object

END SPECIAL CASES ###



131
132
133
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 131

def profile
  @profile ||= ig_resources.profile_by_url(profile_url)
end

#profile_elements ⇒ Object 



135
136
137
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 135

def profile_elements
  @profile_elements ||= profile.snapshot.element
end

#profile_name ⇒ Object 



168
169
170
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 168

def profile_name
  profile.title.gsub('  ', ' ')
end

#profile_version ⇒ Object 



172
173
174
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 172

def profile_version
  profile.version
end

#references ⇒ Object 



279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 279

def references
  @references ||=
    profile_elements
      .select { |element| element.type&.first&.code == 'Reference' }
      .map do |reference_definition|
        {
          path: reference_definition.path,
          profiles: reference_definition.type.first.targetProfile
        }
      end
end

#reformatted_version ⇒ Object 



160
161
162
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 160

def reformatted_version
  ig_metadata.reformatted_version
end

#required_concepts ⇒ Object 



239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 239

def required_concepts
  # The base FHIR vital signs profile has a required binding that isn't
  # relevant for any of its child profiles
  return [] if resource == 'Observation'

  profile_elements
    .select { |element| element.type&.any? { |type| type.code == 'CodeableConcept' } }
    .select { |element| element.binding&.strength == 'required' }
    .map { |element| element.path.gsub("#{resource}.", '').gsub('[x]', 'CodeableConcept') }
    .uniq
end

#resource ⇒ Object 



164
165
166
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 164

def resource
  resource_capabilities.type
end

#revincludes ⇒ Object 



235
236
237
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 235

def revincludes
  resource_capabilities.searchRevInclude || []
end

#search_definitions ⇒ Object 



227
228
229
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 227

def search_definitions
  @search_definitions ||= search_metadata_extractor.search_definitions
end

#search_metadata_extractor ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 210

def search_metadata_extractor
  @search_metadata_extractor ||= SearchMetadataExtractor.new(
    resource_capabilities,
    ig_resources,
    profile_elements,
    {
      resource: resource,
      profile_url: profile_url,
      must_supports: must_supports
    }
  )
end

#searches ⇒ Object 



223
224
225
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 223

def searches
  @searches ||= search_metadata_extractor.searches
end

#set_first_search ⇒ Object 



121
122
123
124
125
126
127
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 121

def set_first_search
  search = searches.find { |param| param[:names] == first_search_params }
  return if search.nil?

  searches.delete(search)
  searches.unshift(search)
end

#short_description ⇒ Object 



186
187
188
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 186

def short_description
  "Verify support for the server capabilities required by the #{profile_name}."
end

#terminology_binding_metadata_extractor ⇒ Object 



251
252
253
254
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 251

def terminology_binding_metadata_extractor
  @terminology_binding_metadata_extractor ||=
    TerminologyBindingMetadataExtractor.new(profile_elements, ig_resources, resource)
end

#title ⇒ Object 



176
177
178
179
180
181
182
183
184
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 176

def title
  title = profile.title.gsub(/US\s*Core\s*/, '').gsub(/\s*Profile/, '').strip

  if (Naming.resources_with_multiple_profiles.include?(resource)) && !title.start_with?(resource) && version != 'v3.1.1'
    title = resource + ' ' + title.split(resource).map(&:strip).join(' ')
  end

  title
end

#version ⇒ Object 



156
157
158
 
# File 'lib/us_core_test_kit/generator/group_metadata_extractor.rb', line 156

def version
  ig_metadata.ig_version
end