Module: USCoreTestKit::ReferenceResolutionTest

Extended by:
Forwardable
Includes:
Inferno::DSL::FHIRResourceNavigation
Included in:
PractitionerAddressTest, USCoreV311::AllergyIntoleranceReferenceResolutionTest, USCoreV311::BodyheightReferenceResolutionTest, USCoreV311::BodytempReferenceResolutionTest, USCoreV311::BodyweightReferenceResolutionTest, USCoreV311::BpReferenceResolutionTest, USCoreV311::CarePlanReferenceResolutionTest, USCoreV311::CareTeamReferenceResolutionTest, USCoreV311::ConditionReferenceResolutionTest, USCoreV311::DeviceReferenceResolutionTest, USCoreV311::DiagnosticReportLabReferenceResolutionTest, USCoreV311::DiagnosticReportNoteReferenceResolutionTest, USCoreV311::DocumentReferenceReferenceResolutionTest, USCoreV311::EncounterReferenceResolutionTest, USCoreV311::GoalReferenceResolutionTest, USCoreV311::HeadCircumferenceReferenceResolutionTest, USCoreV311::HeartrateReferenceResolutionTest, USCoreV311::ImmunizationReferenceResolutionTest, USCoreV311::MedicationRequestReferenceResolutionTest, USCoreV311::ObservationLabReferenceResolutionTest, USCoreV311::PediatricBmiForAgeReferenceResolutionTest, USCoreV311::PediatricWeightForHeightReferenceResolutionTest, USCoreV311::ProcedureReferenceResolutionTest, USCoreV311::ProvenanceReferenceResolutionTest, USCoreV311::PulseOximetryReferenceResolutionTest, USCoreV311::ResprateReferenceResolutionTest, USCoreV311::SmokingstatusReferenceResolutionTest, USCoreV400::AllergyIntoleranceReferenceResolutionTest, USCoreV400::BloodPressureReferenceResolutionTest, USCoreV400::BmiReferenceResolutionTest, USCoreV400::BodyHeightReferenceResolutionTest, USCoreV400::BodyTemperatureReferenceResolutionTest, USCoreV400::BodyWeightReferenceResolutionTest, USCoreV400::CarePlanReferenceResolutionTest, USCoreV400::CareTeamReferenceResolutionTest, USCoreV400::ConditionReferenceResolutionTest, USCoreV400::DeviceReferenceResolutionTest, USCoreV400::DiagnosticReportLabReferenceResolutionTest, USCoreV400::DiagnosticReportNoteReferenceResolutionTest, USCoreV400::DocumentReferenceReferenceResolutionTest, USCoreV400::EncounterReferenceResolutionTest, USCoreV400::GoalReferenceResolutionTest, USCoreV400::HeadCircumferencePercentileReferenceResolutionTest, USCoreV400::HeadCircumferenceReferenceResolutionTest, USCoreV400::HeartRateReferenceResolutionTest, USCoreV400::ImmunizationReferenceResolutionTest, USCoreV400::MedicationRequestReferenceResolutionTest, USCoreV400::ObservationLabReferenceResolutionTest, USCoreV400::PediatricBmiForAgeReferenceResolutionTest, USCoreV400::PediatricWeightForHeightReferenceResolutionTest, USCoreV400::ProcedureReferenceResolutionTest, USCoreV400::ProvenanceReferenceResolutionTest, USCoreV400::PulseOximetryReferenceResolutionTest, USCoreV400::RespiratoryRateReferenceResolutionTest, USCoreV400::SmokingstatusReferenceResolutionTest, USCoreV501::AllergyIntoleranceReferenceResolutionTest, USCoreV501::BloodPressureReferenceResolutionTest, USCoreV501::BmiReferenceResolutionTest, USCoreV501::BodyHeightReferenceResolutionTest, USCoreV501::BodyTemperatureReferenceResolutionTest, USCoreV501::BodyWeightReferenceResolutionTest, USCoreV501::CarePlanReferenceResolutionTest, USCoreV501::CareTeamReferenceResolutionTest, USCoreV501::ConditionEncounterDiagnosisReferenceResolutionTest, USCoreV501::ConditionProblemsHealthConcernsReferenceResolutionTest, USCoreV501::DeviceReferenceResolutionTest, USCoreV501::DiagnosticReportLabReferenceResolutionTest, USCoreV501::DiagnosticReportNoteReferenceResolutionTest, USCoreV501::DocumentReferenceReferenceResolutionTest, USCoreV501::EncounterReferenceResolutionTest, USCoreV501::GoalReferenceResolutionTest, USCoreV501::HeadCircumferencePercentileReferenceResolutionTest, USCoreV501::HeadCircumferenceReferenceResolutionTest, USCoreV501::HeartRateReferenceResolutionTest, USCoreV501::ImmunizationReferenceResolutionTest, USCoreV501::MedicationRequestReferenceResolutionTest, USCoreV501::ObservationClinicalTestReferenceResolutionTest, USCoreV501::ObservationImagingReferenceResolutionTest, USCoreV501::ObservationLabReferenceResolutionTest, USCoreV501::ObservationSdohAssessmentReferenceResolutionTest, USCoreV501::ObservationSexualOrientationReferenceResolutionTest, USCoreV501::ObservationSocialHistoryReferenceResolutionTest, USCoreV501::PediatricBmiForAgeReferenceResolutionTest, USCoreV501::PediatricWeightForHeightReferenceResolutionTest, USCoreV501::PractitionerRoleReferenceResolutionTest, USCoreV501::ProcedureReferenceResolutionTest, USCoreV501::ProvenanceReferenceResolutionTest, USCoreV501::PulseOximetryReferenceResolutionTest, USCoreV501::QuestionnaireResponseReferenceResolutionTest, USCoreV501::RelatedPersonReferenceResolutionTest, USCoreV501::RespiratoryRateReferenceResolutionTest, USCoreV501::ServiceRequestReferenceResolutionTest, USCoreV501::SmokingstatusReferenceResolutionTest, USCoreV610::AllergyIntoleranceReferenceResolutionTest, USCoreV610::BloodPressureReferenceResolutionTest, USCoreV610::BmiReferenceResolutionTest, USCoreV610::BodyHeightReferenceResolutionTest, USCoreV610::BodyTemperatureReferenceResolutionTest, USCoreV610::BodyWeightReferenceResolutionTest, USCoreV610::CarePlanReferenceResolutionTest, USCoreV610::CareTeamReferenceResolutionTest, USCoreV610::ConditionEncounterDiagnosisReferenceResolutionTest, USCoreV610::ConditionProblemsHealthConcernsReferenceResolutionTest, USCoreV610::CoverageReferenceResolutionTest, USCoreV610::DeviceReferenceResolutionTest, USCoreV610::DiagnosticReportLabReferenceResolutionTest, USCoreV610::DiagnosticReportNoteReferenceResolutionTest, USCoreV610::DocumentReferenceReferenceResolutionTest, USCoreV610::EncounterReferenceResolutionTest, USCoreV610::GoalReferenceResolutionTest, USCoreV610::HeadCircumferencePercentileReferenceResolutionTest, USCoreV610::HeadCircumferenceReferenceResolutionTest, USCoreV610::HeartRateReferenceResolutionTest, USCoreV610::ImmunizationReferenceResolutionTest, USCoreV610::MedicationDispenseReferenceResolutionTest, USCoreV610::MedicationRequestReferenceResolutionTest, USCoreV610::ObservationClinicalResultReferenceResolutionTest, USCoreV610::ObservationLabReferenceResolutionTest, USCoreV610::ObservationOccupationReferenceResolutionTest, USCoreV610::ObservationPregnancyintentReferenceResolutionTest, USCoreV610::ObservationPregnancystatusReferenceResolutionTest, USCoreV610::ObservationScreeningAssessmentReferenceResolutionTest, USCoreV610::ObservationSexualOrientationReferenceResolutionTest, USCoreV610::PediatricBmiForAgeReferenceResolutionTest, USCoreV610::PediatricWeightForHeightReferenceResolutionTest, USCoreV610::PractitionerRoleReferenceResolutionTest, USCoreV610::ProcedureReferenceResolutionTest, USCoreV610::ProvenanceReferenceResolutionTest, USCoreV610::PulseOximetryReferenceResolutionTest, USCoreV610::QuestionnaireResponseReferenceResolutionTest, USCoreV610::RelatedPersonReferenceResolutionTest, USCoreV610::RespiratoryRateReferenceResolutionTest, USCoreV610::ServiceRequestReferenceResolutionTest, USCoreV610::SimpleObservationReferenceResolutionTest, USCoreV610::SmokingstatusReferenceResolutionTest, USCoreV610::SpecimenReferenceResolutionTest, USCoreV700::AllergyIntoleranceReferenceResolutionTest, USCoreV700::AverageBloodPressureReferenceResolutionTest, USCoreV700::BloodPressureReferenceResolutionTest, USCoreV700::BmiReferenceResolutionTest, USCoreV700::BodyHeightReferenceResolutionTest, USCoreV700::BodyTemperatureReferenceResolutionTest, USCoreV700::BodyWeightReferenceResolutionTest, USCoreV700::CareExperiencePreferenceReferenceResolutionTest, USCoreV700::CarePlanReferenceResolutionTest, USCoreV700::CareTeamReferenceResolutionTest, USCoreV700::ConditionEncounterDiagnosisReferenceResolutionTest, USCoreV700::ConditionProblemsHealthConcernsReferenceResolutionTest, USCoreV700::CoverageReferenceResolutionTest, USCoreV700::DeviceReferenceResolutionTest, USCoreV700::DiagnosticReportLabReferenceResolutionTest, USCoreV700::DiagnosticReportNoteReferenceResolutionTest, USCoreV700::DocumentReferenceReferenceResolutionTest, USCoreV700::EncounterReferenceResolutionTest, USCoreV700::GoalReferenceResolutionTest, USCoreV700::HeadCircumferencePercentileReferenceResolutionTest, USCoreV700::HeadCircumferenceReferenceResolutionTest, USCoreV700::HeartRateReferenceResolutionTest, USCoreV700::ImmunizationReferenceResolutionTest, USCoreV700::LocationReferenceResolutionTest, USCoreV700::MedicationDispenseReferenceResolutionTest, USCoreV700::MedicationRequestReferenceResolutionTest, USCoreV700::ObservationClinicalResultReferenceResolutionTest, USCoreV700::ObservationLabReferenceResolutionTest, USCoreV700::ObservationOccupationReferenceResolutionTest, USCoreV700::ObservationPregnancyintentReferenceResolutionTest, USCoreV700::ObservationPregnancystatusReferenceResolutionTest, USCoreV700::ObservationScreeningAssessmentReferenceResolutionTest, USCoreV700::ObservationSexualOrientationReferenceResolutionTest, USCoreV700::PediatricBmiForAgeReferenceResolutionTest, USCoreV700::PediatricWeightForHeightReferenceResolutionTest, USCoreV700::PractitionerRoleReferenceResolutionTest, USCoreV700::ProcedureReferenceResolutionTest, USCoreV700::ProvenanceReferenceResolutionTest, USCoreV700::PulseOximetryReferenceResolutionTest, USCoreV700::QuestionnaireResponseReferenceResolutionTest, USCoreV700::RelatedPersonReferenceResolutionTest, USCoreV700::RespiratoryRateReferenceResolutionTest, USCoreV700::ServiceRequestReferenceResolutionTest, USCoreV700::SimpleObservationReferenceResolutionTest, USCoreV700::SmokingstatusReferenceResolutionTest, USCoreV700::SpecimenReferenceResolutionTest, USCoreV700::TreatmentInterventionPreferenceReferenceResolutionTest, USCoreV800::AdiDocumentReferenceReferenceResolutionTest, USCoreV800::AllergyIntoleranceReferenceResolutionTest, USCoreV800::AverageBloodPressureReferenceResolutionTest, USCoreV800::BloodPressureReferenceResolutionTest, USCoreV800::BmiReferenceResolutionTest, USCoreV800::BodyHeightReferenceResolutionTest, USCoreV800::BodyTemperatureReferenceResolutionTest, USCoreV800::BodyWeightReferenceResolutionTest, USCoreV800::CareExperiencePreferenceReferenceResolutionTest, USCoreV800::CarePlanReferenceResolutionTest, USCoreV800::CareTeamReferenceResolutionTest, USCoreV800::ConditionEncounterDiagnosisReferenceResolutionTest, USCoreV800::ConditionProblemsHealthConcernsReferenceResolutionTest, USCoreV800::CoverageReferenceResolutionTest, USCoreV800::DeviceReferenceResolutionTest, USCoreV800::DiagnosticReportLabReferenceResolutionTest, USCoreV800::DiagnosticReportNoteReferenceResolutionTest, USCoreV800::DocumentReferenceReferenceResolutionTest, USCoreV800::EncounterReferenceResolutionTest, USCoreV800::GoalReferenceResolutionTest, USCoreV800::HeadCircumferencePercentileReferenceResolutionTest, USCoreV800::HeadCircumferenceReferenceResolutionTest, USCoreV800::HeartRateReferenceResolutionTest, USCoreV800::ImmunizationReferenceResolutionTest, USCoreV800::LocationReferenceResolutionTest, USCoreV800::MedicationDispenseReferenceResolutionTest, USCoreV800::MedicationRequestReferenceResolutionTest, USCoreV800::ObservationAdiDocumentationReferenceResolutionTest, USCoreV800::ObservationClinicalResultReferenceResolutionTest, USCoreV800::ObservationLabReferenceResolutionTest, USCoreV800::ObservationOccupationReferenceResolutionTest, USCoreV800::ObservationPregnancyintentReferenceResolutionTest, USCoreV800::ObservationPregnancystatusReferenceResolutionTest, USCoreV800::ObservationScreeningAssessmentReferenceResolutionTest, USCoreV800::ObservationSexualOrientationReferenceResolutionTest, USCoreV800::PediatricBmiForAgeReferenceResolutionTest, USCoreV800::PediatricWeightForHeightReferenceResolutionTest, USCoreV800::PractitionerRoleReferenceResolutionTest, USCoreV800::ProcedureReferenceResolutionTest, USCoreV800::ProvenanceReferenceResolutionTest, USCoreV800::PulseOximetryReferenceResolutionTest, USCoreV800::QuestionnaireResponseReferenceResolutionTest, USCoreV800::RelatedPersonReferenceResolutionTest, USCoreV800::RespiratoryRateReferenceResolutionTest, USCoreV800::ServiceRequestReferenceResolutionTest, USCoreV800::SimpleObservationReferenceResolutionTest, USCoreV800::SmokingstatusReferenceResolutionTest, USCoreV800::SpecimenReferenceResolutionTest, USCoreV800::TreatmentInterventionPreferenceReferenceResolutionTest
Defined in:
lib/us_core_test_kit/reference_resolution_test.rb

Instance Method Summary collapse

Instance Method Details

#is_reference_resolved?(reference, target_profile) ⇒ Boolean

Returns:

  • (Boolean) 


44
45
46
47
48
49
50
51
 
# File 'lib/us_core_test_kit/reference_resolution_test.rb', line 44

def is_reference_resolved?(reference, target_profile)
  resolved_references.any? do |item|
    item[:reference] == reference.reference &&
    (
      target_profile.blank? || item[:profiles].include?(target_profile)
    )
  end
end

#must_support_references ⇒ Object 



62
63
64
 
# File 'lib/us_core_test_kit/reference_resolution_test.rb', line 62

def must_support_references
  metadata.must_supports[:elements].select { |element_definition| element_definition[:types]&.include?('Reference') }
end

#must_support_references_with_target_profile ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/us_core_test_kit/reference_resolution_test.rb', line 66

def must_support_references_with_target_profile
  # mapping array of target_profiles to array of {path, target_profile} pair
  must_support_references.map do |element_definition|
    (element_definition[:target_profiles] || ['']).map do |target_profile|
      {
        path: element_definition[:path],
        target_profile: target_profile
      }
    end
  end.flatten
end

#no_resources_skip_message ⇒ Object 



57
58
59
60
 
# File 'lib/us_core_test_kit/reference_resolution_test.rb', line 57

def no_resources_skip_message
  "No #{resource_type} resources appear to be available. " \
  'Please use patients with more information.'
end

#perform_reference_resolution_test(resources) ⇒ Object 



10
11
12
13
14
15
16
 
# File 'lib/us_core_test_kit/reference_resolution_test.rb', line 10

def perform_reference_resolution_test(resources)
  skip_if resources.blank?, no_resources_skip_message

  pass if unresolved_references(resources).length.zero?

  skip "Could not resolve and validate any Must Support references for #{unresolved_references_strings.join(', ')}"
end

#record_resolved_reference(reference, target_profile) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/us_core_test_kit/reference_resolution_test.rb', line 26

def record_resolved_reference(reference, target_profile)
  saved_reference = resolved_references.find { |item| item[:reference] == reference.reference }

  if saved_reference.present?
    if target_profile.present? && !saved_reference[:profiles].include?(target_profile)
      saved_reference[:profiles] << target_profile
    end
  else
    saved_reference = {
      reference: reference.reference,
      profiles: []
    }

    saved_reference[:profiles] << target_profile if target_profile.present?
    resolved_references.add(saved_reference)
  end
end

#resolve_reference(reference) ⇒ Object 



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/us_core_test_kit/reference_resolution_test.rb', line 140

def resolve_reference(reference)
  reference_type = reference.resource_type
  reference_id = reference.reference_id

  begin
    if reference.relative?
      begin
        reference.resource_class
      rescue NameError
        return nil
      end

      fhir_read(reference_type, reference_id)&.resource
    else
      if reference.base_uri.chomp('/') == fhir_client.instance_variable_get(:@base_service_url).chomp('/')
        fhir_read(reference_type, reference_id)&.resource
      else
        get(reference.reference)&.resource
      end
    end
  rescue StandardError => e
    Inferno::Application['logger'].error("Unable to resolve reference #{reference.reference}")
    Inferno::Application['logger'].error(e.full_message)
    return nil
  end
end

#resolved_references ⇒ Object 



53
54
55
 
# File 'lib/us_core_test_kit/reference_resolution_test.rb', line 53

def resolved_references
  scratch[:resolved_references] ||= Set.new
end

#resource_is_valid_with_target_profile?(resource, target_profile) ⇒ Boolean

Returns:

  • (Boolean) 


167
168
169
170
171
 
# File 'lib/us_core_test_kit/reference_resolution_test.rb', line 167

def resource_is_valid_with_target_profile?(resource, target_profile)
  return true if target_profile.blank?

  resource_is_valid?(resource:, profile_url: target_profile, add_messages_to_runnable: false)
end

#unresolved_references(resources = []) ⇒ Object 



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
 
# File 'lib/us_core_test_kit/reference_resolution_test.rb', line 78

def unresolved_references(resources = [])
  @unresolved_references ||=
    must_support_references_with_target_profile.select do |reference_path_profile_pair|
      path = reference_path_profile_pair[:path]
      target_profile = reference_path_profile_pair[:target_profile]

      found_one_reference = false

      resolve_one_reference = resources.any? do |resource|
        value_found = resolve_path(resource, path)
        next if value_found.empty?

        found_one_reference = true

        value_found.any? do |reference|
          validate_reference_resolution(resource, reference, target_profile)
        end
      end

      found_one_reference && !resolve_one_reference
    end

  if metadata.must_supports[:choices].present?
    @unresolved_references.delete_if do |reference|
      choice_profiles = metadata.must_supports[:choices].find { |choice| choice[:target_profiles]&.include?(reference[:target_profile]) }

      choice_profiles.present? &&
      choice_profiles[:target_profiles]&.any? { |profile| @unresolved_references.none? { |element| element[:target_profile] == profile } }
    end
  end

  @unresolved_references
end

#unresolved_references_strings ⇒ Object 



18
19
20
21
22
23
24
 
# File 'lib/us_core_test_kit/reference_resolution_test.rb', line 18

def unresolved_references_strings
  unresolved_reference_hash =
    unresolved_references.each_with_object(Hash.new { |hash, key| hash[key] = [] }) do |missing, hash|
      hash[missing[:path]] << missing[:target_profile]
    end
  unresolved_reference_hash.map { |path, profiles| "#{path} element: Reference#{"(#{profiles.join('|')})" unless profiles.first.empty?}" }
end

#validate_reference_resolution(resource, reference, target_profile) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/us_core_test_kit/reference_resolution_test.rb', line 112

def validate_reference_resolution(resource, reference, target_profile)
  return true if is_reference_resolved?(reference, target_profile)

  if reference.contained?
    # if reference_id is blank it is referring to itself, so we know it exists
    return true if reference.reference_id.blank?

    return resource.contained.any? do |contained_resource|
        contained_resource&.id == reference.reference_id &&
          resource_is_valid_with_target_profile?(contained_resource, target_profile)
    end
  end

  reference_type = reference.resource_type
  reference_id = reference.reference_id

  resolved_resource = resolve_reference(reference)

  return false if resolved_resource.nil?

  return false unless resolved_resource.resourceType == reference_type && resolved_resource.id == reference_id

  return false unless resource_is_valid_with_target_profile?(resolved_resource, target_profile)

  record_resolved_reference(reference, target_profile)
  true
end