Module: DaVinciDTRTestKit::QuestionnaireOperationValidation

Included in:
DTRPayerServerV220::AdaptiveQuestionnaireEndpointTest, DTRPayerServerV220::AdaptiveQuestionnaireResponseContainedQuestionnaireTest, DTRPayerServerV220::AdaptiveQuestionnaireResponseValidationTest, DTRPayerServerV220::CQLLibraryValidationTest, DTRPayerServerV220::InitialQuestionnaireResponseTest, DTRPayerServerV220::QuestionnaireReferencesVersionTest, DTRPayerServerV220::QuestionnaireResponseQuestionnaireCanonicalTest, DTRPayerServerV220::QuestionnaireResponseValidationTest, DTRPayerServerV220::SmallValueSetExpansionTest, DTRPayerServerV220::ValueSetValidationTest
Defined in:
lib/davinci_dtr_test_kit/server/v2.2.0/questionnaire_operation_validation.rb

Constant Summary collapse

QUESTIONNAIRE_PACKAGE_BUNDLE_PROFILE = 
'http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/DTR-QPackageBundle|2.2.0'.freeze
QUESTIONNAIRE_PACKAGE_PARAMETER_PROFILE = 
'http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-qpackage-output-parameters|2.2.0'.freeze

Instance Method Summary collapse

Instance Method Details

#check_libraries(parameters, request_index) ⇒ Object

misformatted_expressions.compact.to_set.each do |idx| messages << { type: 'info', message: format_markdown("[item #+ 1] in [questionnaire #+ 1] contains expression that does not begin with a reference to an included library name.") } end assert misformatted_expressions.compact.to_set.empty?, 'Expression in questionnaire misformatted.' end



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/davinci_dtr_test_kit/server/v2.2.0/questionnaire_operation_validation.rb', line 201

def check_libraries(parameters, request_index)
  questionnaire_bundles = extract_questionnaire_bundles(parameters)

  questionnaire_bundles.each do |bundle|
    reset_library_tracking

    libraries = extract_libraries_from_bundles([bundle])

    questionnaires = extract_questionnaires_from_bundles([bundle])

    referenced_libraries =
      Set.new(
        questionnaires
          .flat_map { |questionnaire| referenced_library_canonicals(questionnaire) }
      )

    libraries.each do |library|
      library_canonicals.add(library_canonical(library)) unless library.url.nil?

      referenced_libraries.merge(depends_on_library_canonicals(library))

      evaluate_library(library, request_index)

      next if library_names.add?(library.name)

      add_message(
        'error',
        "Request #{request_index}: Bundle contains multiple libraries named '#{library.name}'"
      )
    end

    check_referenced_libraries(referenced_libraries, library_canonicals, request_index)
  end
end

#check_referenced_libraries(referenced_libraries, found_libraries, request_index) ⇒ 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
 
# File 'lib/davinci_dtr_test_kit/server/v2.2.0/questionnaire_operation_validation.rb', line 283

def check_referenced_libraries(referenced_libraries, found_libraries, request_index)
  unversioned_library_references = referenced_libraries.select { |library| library.exclude? '|' }

  if unversioned_library_references.present?
    unversioned_library_string =
      unversioned_library_references
        .map { |reference| "`#{reference}`" }
        .join(', ')

    add_message(
      'error',
      "The Bundle included the following unversioned library references: #{unversioned_library_string}"
    )
  end

  referenced_libraries.reject! { |library| library.exclude? '|' }

  missing_libraries = referenced_libraries - found_libraries

  return if missing_libraries.blank?

  missing_library_string = missing_libraries.map { |url| "`#{url}`" }.join(', ')

  add_message(
    'error',
    "Request #{request_index}: The following libraries are referenced but not included in the Bundle: " \
    "#{missing_library_string}"
  )
end

#depends_on_library_canonicals(library) ⇒ Object 



277
278
279
280
281
 
# File 'lib/davinci_dtr_test_kit/server/v2.2.0/questionnaire_operation_validation.rb', line 277

def depends_on_library_canonicals(library)
  library.relatedArtifact.filter_map do |related_artifact|
    related_artifact.resource if related_artifact.type == 'depends-on'
  end
end

#evaluate_library(library, request_index) ⇒ Object 



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/davinci_dtr_test_kit/server/v2.2.0/questionnaire_operation_validation.rb', line 242

def evaluate_library(library, request_index)
  unless library_contains_cql?(library)
    add_message(
      'error',
      "Request #{request_index}: Library `#{library.url}` does not include CQL."
    )
  end

  unless library_contains_elm?(library) # rubocop:disable Style/GuardClause
    add_message(
      'error',
      "Request #{request_index}: Library `#{library.url}` does not include ELM."
    )
  end
end

#extension_presence ⇒ Object 



7
8
9
10
11
12
 
# File 'lib/davinci_dtr_test_kit/server/v2.2.0/questionnaire_operation_validation.rb', line 7

def extension_presence
  @extension_presence ||= { 'found_min_launch_context' => false, 'found_min_variable' => false,
                            'found_min_pop_context' => false, 'found_min_init_expression' => false,
                            'found_min_candidate_expression' => false, 'found_min_context_expression' => false,
                            'found_min_cqf_lib' => false }
end

#extract_bundles_from_parameter(parameter) ⇒ Object 



418
419
420
421
422
423
424
 
# File 'lib/davinci_dtr_test_kit/server/v2.2.0/questionnaire_operation_validation.rb', line 418

def extract_bundles_from_parameter(parameter)
  return [] if parameter.blank?

  parameter.parameter&.filter_map do |param|
    param.resource if param.resource&.resourceType == 'Bundle'
  end
end

#extract_libraries_from_bundles(questionnaire_bundles) ⇒ Object

questionnaires.find { |q| q.url == questionnaire_url } end



434
435
436
437
438
 
# File 'lib/davinci_dtr_test_kit/server/v2.2.0/questionnaire_operation_validation.rb', line 434

def extract_libraries_from_bundles(questionnaire_bundles)
  questionnaire_bundles.filter_map do |qb|
    qb.entry.filter_map { |entry| entry.resource if entry&.resource.is_a?(FHIR::Library) }
  end&.flatten&.compact
end

#extract_questionnaire_bundles(resource) ⇒ Object 



407
408
409
410
411
412
413
414
415
416
 
# File 'lib/davinci_dtr_test_kit/server/v2.2.0/questionnaire_operation_validation.rb', line 407

def extract_questionnaire_bundles(resource)
  case resource&.resourceType
  when 'Bundle'
    [resource]
  when 'Parameters'
    extract_bundles_from_parameter(resource)
  else
    []
  end
end

#extract_questionnaires_from_bundles(questionnaire_bundles) ⇒ Object

def extract_contained_questionnaires(questionnaire_responses) questionnaire_responses&.filter_map do |qr| qr.contained&.grep(FHIR::Questionnaire) end&.flatten&.compact end



384
385
386
387
388
 
# File 'lib/davinci_dtr_test_kit/server/v2.2.0/questionnaire_operation_validation.rb', line 384

def extract_questionnaires_from_bundles(questionnaire_bundles)
  questionnaire_bundles.filter_map do |qb|
    qb.entry.filter_map { |entry| entry.resource if entry.resource.is_a?(FHIR::Questionnaire) }
  end&.flatten&.compact
end

#library_canonical(library) ⇒ Object 



236
237
238
239
240
 
# File 'lib/davinci_dtr_test_kit/server/v2.2.0/questionnaire_operation_validation.rb', line 236

def library_canonical(library)
  library_version_string = library.version.present? ? "|#{library.version}" : ''

  "#{library.url}#{library_version_string}"
end

#library_canonicals ⇒ Object

def cqf_reference_libraries scratch ||= Set.new end



24
25
26
 
# File 'lib/davinci_dtr_test_kit/server/v2.2.0/questionnaire_operation_validation.rb', line 24

def library_canonicals
  @library_canonicals ||= Set.new
end

#library_contains_cql?(library) ⇒ Boolean

Returns:

  • (Boolean) 


258
259
260
261
262
 
# File 'lib/davinci_dtr_test_kit/server/v2.2.0/questionnaire_operation_validation.rb', line 258

def library_contains_cql?(library)
  library
    .content
    .any? { |content| content.data.present? && content.contentType == 'text/cql' }
end

#library_contains_elm?(library) ⇒ Boolean

Returns:

  • (Boolean) 


264
265
266
267
268
 
# File 'lib/davinci_dtr_test_kit/server/v2.2.0/questionnaire_operation_validation.rb', line 264

def library_contains_elm?(library)
  library
    .content
    .any? { |content| content.data.present? && content.contentType == 'application/elm+json' }
end

#library_names ⇒ Object 



28
29
30
 
# File 'lib/davinci_dtr_test_kit/server/v2.2.0/questionnaire_operation_validation.rb', line 28

def library_names
  @library_names ||= Set.new
end

#perform_questionnaire_package_response_validation(resource, index) ⇒ Object 



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/davinci_dtr_test_kit/server/v2.2.0/questionnaire_operation_validation.rb', line 390

def perform_questionnaire_package_response_validation(resource, index)
  bundles = extract_questionnaire_bundles(resource)

  resource_is_valid?(
    resource:,
    profile_url: QUESTIONNAIRE_PACKAGE_PARAMETER_PROFILE,
    message_prefix: "Request #{index}: "
  )

  return if bundles.present?

  add_message(
    'error',
    "No Questionnaire Bundle found in response #{index}"
  )
end

#referenced_library_canonicals(questionnaire) ⇒ Object 



270
271
272
273
274
275
 
# File 'lib/davinci_dtr_test_kit/server/v2.2.0/questionnaire_operation_validation.rb', line 270

def referenced_library_canonicals(questionnaire)
  questionnaire
    .extension
    .select { |extension| extension.url == 'http://hl7.org/fhir/StructureDefinition/cqf-library' }
    .map(&:valueCanonical)
end

#reset_library_tracking ⇒ Object 



32
33
34
35
 
# File 'lib/davinci_dtr_test_kit/server/v2.2.0/questionnaire_operation_validation.rb', line 32

def reset_library_tracking
  @library_canonicals = Set.new
  @library_names = Set.new
end