us_quality_core_test_kit 0.1.2 → 0.2.1

data/lib/us_quality_core_test_kit/client/generated/v1.0.0-ballot/wait_group.rb

@@ -0,0 +1,523 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+module USQualityCoreTestKit
+  module Client
+    module USQualityCoreClientV100_BALLOT
+      class WaitGroup < Inferno::TestGroup
+        include URLs
+
+        id :us_quality_core_client_access_group_v100_ballot
+        title 'Client Access'
+        description %(
+          During these tests, Inferno will simulate a US Quality Core FHIR Server for the client to
+          use to access data. Inferno will wait while the client submits requests and will
+          both respond with data and collect the requests for later analysis.
+        )
+
+        run_as_group
+
+        def suite_id
+          return config.options[:endpoint_suite_id] if config.options[:endpoint_suite_id].present?
+
+          'us_quality_core_client_v100_ballot'
+        end
+
+        group do
+          id :us_quality_core_client_wait_group_v100_ballot
+          title 'Perform Data Access'
+
+          test do
+            id :us_quality_core_client_wait_test_v100_ballot
+            title 'Wait for Requests'
+            description %(
+              This test will wait for the client under test to submit requests for resources for
+              each of the US Quality Core profiles, and for requests including all of the required search
+              parameters for each resource type.
+            )
+
+            output :access_token
+
+            run do
+              token = SecureRandom.uuid
+              output access_token: token
+
+              wait(
+                identifier: token,
+                message: %(
+  Inferno will now wait for the client under test to make the required requests against the following base URL:
+
+  #{fhir_url}
+
+  Inferno generated this access token for the current run:
+
+  `#{token}`
+
+  Configure the client under test to send the following HTTP header with every request.
+  Clients must send this exact value as the bearer token for this run.
+  If the client system already adds the `Bearer` scheme, enter only the access
+  token value shown above in the client configuration.
+
+  `Authorization: Bearer #{token}`
+
+  All requests will be recorded. When finished, the requests will be inspected to ensure that the client under test is making the required requests.
+  Requests should target the following patient record:
+  - **Resource ID**: `usqualitycore-patient`
+
+  [Click here](#{resume_pass_url}?token=#{token}) when finished.
+
+  The following requirements will be checked:
+
+  * **Patient**
+  * read: any Patient resource (any ID)
+  * searches:
+    * _id
+* **AdverseEvent**
+  * read: any AdverseEvent resource (any ID)
+  * searches:
+    * subject
+    * subject + event
+    * subject + recorded-date
+* **AllergyIntolerance**
+  * read: any AllergyIntolerance resource (any ID)
+  * searches:
+    * patient
+* **CarePlan**
+  * read: any CarePlan resource (any ID)
+  * searches:
+    * patient + category
+* **CareTeam**
+  * read: any CareTeam resource (any ID)
+  * searches:
+    * patient + status
+* **Communication**
+  * read: any Communication resource (any ID)
+  * searches:
+    * subject + status
+    * subject
+    * subject + topic
+* **Communicationdone**
+  * read: any Communication resource (any ID)
+  * searches:
+    * subject + status
+    * subject
+    * subject + topic
+* **Communicationnotdone**
+  * read: any Communication resource (any ID)
+  * searches:
+    * subject + status
+    * subject
+    * subject + topic
+* **ConditionEncounterDiagnosis**
+  * read: any Condition resource (any ID)
+  * searches:
+    * patient + category
+    * patient
+    * patient + code
+* **ConditionProblemsHealthConcerns**
+  * read: any Condition resource (any ID)
+  * searches:
+    * patient + category
+    * patient
+    * patient + code
+* **Coverage**
+  * read: any Coverage resource (any ID)
+  * searches:
+    * patient
+* **Device**
+  * read: any Device resource (any ID)
+  * searches:
+    * patient
+    * patient + type
+* **Devicerequest**
+  * read: any DeviceRequest resource (any ID)
+  * searches:
+    * patient
+    * patient + code
+    * patient + do-not-perform
+* **Devicerequested**
+  * read: any DeviceRequest resource (any ID)
+  * searches:
+    * patient + do-not-perform
+    * patient
+    * patient + code
+* **Deviceprohibited**
+  * read: any DeviceRequest resource (any ID)
+  * searches:
+    * patient + do-not-perform
+    * patient
+    * patient + code
+* **DiagnosticReportNote**
+  * read: any DiagnosticReport resource (any ID)
+  * searches:
+    * patient + category
+    * patient
+    * patient + category + date
+    * patient + code
+* **DiagnosticReportLab**
+  * read: any DiagnosticReport resource (any ID)
+  * searches:
+    * patient + category
+    * patient
+    * patient + category + date
+    * patient + code
+* **UsCoreDocumentreference**
+  * read: any DocumentReference resource (any ID)
+  * searches:
+    * patient + category
+    * patient
+    * _id
+    * patient + type
+    * patient + category + date
+* **UsCoreAdiDocumentreference**
+  * read: any DocumentReference resource (any ID)
+  * searches:
+    * patient + category
+    * patient
+    * _id
+    * patient + type
+    * patient + category + date
+* **FamilyMemberHistory**
+  * read: any FamilyMemberHistory resource (any ID)
+  * searches:
+    * patient
+* **Goal**
+  * read: any Goal resource (any ID)
+  * searches:
+    * patient
+* **ImagingStudy**
+  * read: any ImagingStudy resource (any ID)
+  * searches:
+    * subject
+* **Immunization**
+  * read: any Immunization resource (any ID)
+  * searches:
+    * patient + status
+    * patient
+* **Immunizationnotdone**
+  * read: any Immunization resource (any ID)
+  * searches:
+    * patient + status
+    * patient
+* **Immunizationdone**
+  * read: any Immunization resource (any ID)
+  * searches:
+    * patient + status
+    * patient
+* **Medicationadministration**
+  * read: any MedicationAdministration resource (any ID)
+  * searches:
+    * patient + status
+    * patient
+    * patient + code
+    * patient + effective-time
+* **Medicationadministrationnotdone**
+  * read: any MedicationAdministration resource (any ID)
+  * searches:
+    * patient + status
+    * patient
+    * patient + code
+    * patient + effective-time
+* **Medicationadministrationdone**
+  * read: any MedicationAdministration resource (any ID)
+  * searches:
+    * patient + status
+    * patient
+    * patient + code
+    * patient + effective-time
+* **Medicationdispense**
+  * read: any MedicationDispense resource (any ID)
+  * searches:
+    * patient + status
+    * patient
+* **Medicationdispensedeclined**
+  * read: any MedicationDispense resource (any ID)
+  * searches:
+    * patient + status
+    * patient
+* **Medicationdispensedone**
+  * read: any MedicationDispense resource (any ID)
+  * searches:
+    * patient + status
+    * patient
+* **Medicationrequest**
+  * read: any MedicationRequest resource (any ID)
+  * searches:
+    * patient + intent
+    * patient + intent + do-not-perform
+* **Medicationprohibited**
+  * read: any MedicationRequest resource (any ID)
+  * searches:
+    * patient + intent + do-not-perform
+    * patient + intent
+* **Medicationrequested**
+  * read: any MedicationRequest resource (any ID)
+  * searches:
+    * patient + intent + do-not-perform
+    * patient + intent
+* **NutritionOrder**
+  * read: any NutritionOrder resource (any ID)
+  * searches:
+    * patient
+* **ObservationClinicalResult**
+  * read: any Observation resource (any ID)
+  * searches:
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+    * patient + code
+* **UsCoreObservationAdiDocumentation**
+  * read: any Observation resource (any ID)
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **UsCoreTreatmentInterventionPreference**
+  * read: any Observation resource (any ID)
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **SimpleObservation**
+  * read: any Observation resource (any ID)
+  * searches:
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+    * patient + code
+* **ObservationScreeningAssessment**
+  * read: any Observation resource (any ID)
+  * searches:
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+    * patient + code
+* **UsCoreObservationPregnancystatus**
+  * read: any Observation resource (any ID)
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **UsCoreObservationPregnancyintent**
+  * read: any Observation resource (any ID)
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **UsCoreSmokingstatus**
+  * read: any Observation resource (any ID)
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **ObservationLab**
+  * read: any Observation resource (any ID)
+  * searches:
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+    * patient + code
+* **UsCoreObservationOccupation**
+  * read: any Observation resource (any ID)
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **UsCoreBloodPressure**
+  * read: any Observation resource (any ID)
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **UsCoreBmi**
+  * read: any Observation resource (any ID)
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **PediatricBmiForAge**
+  * read: any Observation resource (any ID)
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **UsCoreBodyHeight**
+  * read: any Observation resource (any ID)
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **UsCoreBodyTemperature**
+  * read: any Observation resource (any ID)
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **UsCoreBodyWeight**
+  * read: any Observation resource (any ID)
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **HeadOccipitalFrontalCircumferencePercentile**
+  * read: any Observation resource (any ID)
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **UsCoreHeartRate**
+  * read: any Observation resource (any ID)
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **UsCorePulseOximetry**
+  * read: any Observation resource (any ID)
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **UsCoreRespiratoryRate**
+  * read: any Observation resource (any ID)
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **PediatricWeightForHeight**
+  * read: any Observation resource (any ID)
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **Procedure**
+  * read: any Procedure resource (any ID)
+  * searches:
+    * patient + status
+    * patient
+    * patient + date
+* **Procedurenotdone**
+  * read: any Procedure resource (any ID)
+  * searches:
+    * patient + status
+    * patient
+    * patient + date
+* **Proceduredone**
+  * read: any Procedure resource (any ID)
+  * searches:
+    * patient + status
+    * patient
+    * patient + date
+* **QuestionnaireResponse**
+  * read: any QuestionnaireResponse resource (any ID)
+  * searches:
+    * patient
+    * patient + questionnaire
+* **RelatedPerson**
+  * read: any RelatedPerson resource (any ID)
+  * searches:
+    * patient
+    * _id
+* **Servicerequest**
+  * read: any ServiceRequest resource (any ID)
+  * searches:
+    * patient
+    * _id
+    * patient + category
+    * patient + category + authored
+    * patient + code
+    * patient + do-not-perform
+* **Serviceprohibited**
+  * read: any ServiceRequest resource (any ID)
+  * searches:
+    * patient + do-not-perform
+    * _id
+    * patient
+    * patient + category
+    * patient + category + authored
+    * patient + code
+* **Servicerequested**
+  * read: any ServiceRequest resource (any ID)
+  * searches:
+    * patient + do-not-perform
+    * _id
+    * patient
+    * patient + category
+    * patient + category + authored
+    * patient + code
+* **Task**
+  * read: any Task resource (any ID)
+  * searches:
+    * patient + status
+    * patient
+    * patient + code
+* **Taskrejected**
+  * read: any Task resource (any ID)
+  * searches:
+    * patient + status
+    * patient
+    * patient + code
+* **Taskdone**
+  * read: any Task resource (any ID)
+  * searches:
+    * patient + status
+    * patient
+    * patient + code
+* **Encounter**
+  * read: any Encounter resource (any ID)
+  * searches:
+    * patient
+    * _id
+    * patient + type
+    * patient + date
+* **Location**
+  * read: any Location resource (any ID)
+  * searches:
+
+* **Organization**
+  * read: any Organization resource (any ID)
+  * searches:
+
+* **Practitioner**
+  * read: any Practitioner resource (any ID)
+  * searches:
+
+* **PractitionerRole**
+  * read: any PractitionerRole resource (any ID)
+  * searches:
+
+* **Provenance**
+  * read: any Provenance resource (any ID)
+  * searches:
+
+* **Specimen**
+  * read: any Specimen resource (any ID)
+  * searches:
+    * _id
+                ),
+                timeout: 900
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/us_quality_core_test_kit/client/generator/capability_statement_generator.rb

@@ -36,7 +36,12 @@ module USQualityCoreTestKit
         end
 
         def template
-          @template ||= File.read(File.join(__dir__, 'templates', 'capability_statement.json.erb'))
+          @template ||=
+            if ig_metadata.ig_version == 'v0.5.0'
+              File.read(File.join(__dir__, 'templates', 'v0.5.0', 'capability_statement.json.erb'))
+            else
+              File.read(File.join(__dir__, 'templates', 'capability_statement.json.erb'))
+            end
         end
 
         def output

data/lib/us_quality_core_test_kit/client/generator/group_generator.rb

@@ -41,40 +41,23 @@ module USQualityCoreTestKit
             ## Data Access Supported
 
             Clients may not be required to support the #{resource_type} FHIR resource type. However, if they
-            do support it, they must support the #{profile_name} and the resource type's search parameters.
+            do support it, they must support the #{profile_name} and use a supported search to access its data.
             The tests in this group will not execute if client makes no attempt to access data for the
             #{resource_type} resource type. In this case, the test will be marked as skip if support
             for the resource type is required, and omitted otherwise.
 
             ## Reading
-            This test will check that the client performed a read of #{expected_resource_id.length > 1 ? 'one of the following ids' : 'the following id'}:
-
-            #{expected_resource_id_string}
+            This test checks that the client performed a read of any #{resource_type} resource, regardless of its ID.
 
             ## Searching
-            These tests will check that the client performed searches against the
-            #{resource_type} resource type with the following required parameters:
+            The client must demonstrate at least one of the following search parameter
+            combinations supported by the server for #{resource_type}:
 
             #{search_param_name_string}
 
-            Inferno will also look for searches using the following optional parameters:
-
-            #{optional_search_param_name_string}
-
           DESCRIPTION
         end
 
-        def optional_searches
-          group_metadata.searches.reject { |search| search[:expectation] == 'SHALL' }
-        end
-
-        def optional_search_param_name_string
-          optional_searches
-            .map { |search| search[:names].join(' + ') }
-            .map { |names| "* #{names}" }
-            .join("\n")
-        end
-
         def conformance_optional?
           group_metadata.resource_conformance_expectation != 'SHALL'
         end
@@ -84,18 +67,6 @@ module USQualityCoreTestKit
           group_metadata.id = group_id
           group_metadata.file_name = base_output_file_name
         end
-
-        def expected_resource_id
-          resource_id = [USQualityCoreTestKit::Generator::Naming.instance_id_for_profile(profile_identifier)]
-
-          resource_id << USQualityCoreTestKit::Generator::Naming.instance_id_for_profile('observation_lab') if profile_identifier == 'observation_clinical_result'
-
-          resource_id
-        end
-
-        def expected_resource_id_string
-          expected_resource_id.map { |id| "* `#{id}`" }.join("\n")
-        end
       end
     end
   end

data/lib/us_quality_core_test_kit/client/generator/read_test_generator.rb

@@ -36,31 +36,16 @@ module USQualityCoreTestKit
           group_metadata.resource
         end
 
-        def expected_resource_id
-          if profile_identifier == 'observation_clinical_result'
-            [USQualityCoreTestKit::Generator::Naming.instance_id_for_profile(profile_identifier),
-             USQualityCoreTestKit::Generator::Naming.instance_id_for_profile('observation_lab')]
-          else
-            USQualityCoreTestKit::Generator::Naming.instance_id_for_profile(profile_identifier)
-          end
-        end
-
-        def expected_resource_id_string
-          Array(expected_resource_id).map { |id| "`#{resource_type}/#{id}`" }.join(', ')
-        end
-
-        def expected_resource_id_literal
-          return expected_resource_id.inspect if expected_resource_id.is_a?(Array)
-
-          "'#{expected_resource_id}'"
+        def optional?
+          resource_type != 'Patient' && !group_metadata.delayed?
         end
 
         def title
-          "#{conformance_expectation} support read of #{profile_identifier.camelize}"
+          "#{conformance_expectation} support read of #{resource_type}"
         end
 
         def description
-          "The client demonstrates #{conformance_expectation} support for reading #{profile_identifier.camelize}."
+          "The client demonstrates #{conformance_expectation} support for reading the #{resource_type} resource type."
         end
       end
     end

data/lib/us_quality_core_test_kit/client/generator/search_test_generator.rb

@@ -12,11 +12,10 @@ module USQualityCoreTestKit
           def generate(ig_metadata, base_output_dir)
             ig_metadata.groups
                        .reject { |group| USQualityCoreTestKit::Generator::SpecialCases.exclude_group? group }
-                       .select { |group| group.searches.present? }
+                       .select { |group| group.searches.any? { |search| search[:expectation] == 'SHALL' } }
                        .each do |group|
-              group.searches.each do |search|
-                new(group, search, base_output_dir).generate
-              end
+              first_required_search = group.searches.find { |search| search[:expectation] == 'SHALL' }
+              new(group, first_required_search, base_output_dir).generate
             end
           end
         end
@@ -30,7 +29,7 @@ module USQualityCoreTestKit
         end
 
         def class_name
-          "#{profile_identifier.camelize}#{search_identifier.camelize}ClientSearchTest"
+          "#{profile_identifier.camelize}ClientSearchTest"
         end
 
         def resource
@@ -46,13 +45,22 @@ module USQualityCoreTestKit
         end
 
         def title
-          "#{conformance_expectation} support #{search_param_name_string} search " \
-            "of #{profile_identifier.camelize}"
+          "Search #{resource_type} using a supported combination"
         end
 
         def description
-          "The client demonstrates #{conformance_expectation} support for searching " \
-            "#{search_param_name_string} on #{profile_identifier.camelize}."
+          "The client demonstrates at least one required server search combination for #{profile_identifier.camelize}."
+        end
+
+        def required_search_combinations
+          group_metadata.searches
+                        .select { |search| search[:expectation] == 'SHALL' }
+                        .map { |search| search[:names] }
+                        .uniq
+        end
+
+        def all_required_search_parameters
+          required_search_combinations.flatten.uniq
         end
       end
     end

data/lib/us_quality_core_test_kit/client/generator/suite_generator.rb

@@ -72,7 +72,7 @@ module USQualityCoreTestKit
             they demonstrate that the client:
 
             * Retrieved a target instance for each profile.
-            * Performed searches using the required search parameters and search
+            * Performed a search using at least one of the required server search
               parameter combinations for the profile's resource type.
 
             # Interpreting the Results
@@ -89,8 +89,8 @@ module USQualityCoreTestKit
               all profiles of that resource type will be evaluated, meaning that
               the group for each profile of that resource type will be executed,
               checking that the client read the target instance for that profile
-              and perform searches with all required search parameters and
-              combinations for the resource type. The executed group will pass or
+              and performed a search with at least one required server search
+              combination for the resource type. The executed group will pass or
               fail and include details of the issues encountered by Inferno.
             - If a client makes no requests for a given resource type, support
               is not evaluated. If support for the resource type is required, the