us_quality_core_test_kit 0.1.2 → 0.2.0

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

@@ -0,0 +1,598 @@
+# 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 id:
+    * usqualitycore-patient
+  * searches:
+    * _id
+* **AdverseEvent**
+  * read id:
+    * usqualitycore-adverse-event
+  * searches:
+    * subject
+    * subject + event
+    * subject + recorded-date
+* **AllergyIntolerance**
+  * read id:
+    * usqualitycore-allergy-intolerance
+  * searches:
+    * patient
+* **CarePlan**
+  * read id:
+    * usqualitycore-care-plan
+  * searches:
+    * patient + category
+* **CareTeam**
+  * read id:
+    * usqualitycore-care-team
+  * searches:
+    * patient + status
+* **Communication**
+  * read id:
+    * usqualitycore-communication
+  * searches:
+    * subject + status
+    * subject
+    * subject + topic
+* **Communicationdone**
+  * read id:
+    * usqualitycore-communication
+  * searches:
+    * subject + status
+    * subject
+    * subject + topic
+* **Communicationnotdone**
+  * read id:
+    * usqualitycore-communicationnotdone
+  * searches:
+    * subject + status
+    * subject
+    * subject + topic
+* **ConditionEncounterDiagnosis**
+  * read id:
+    * usqualitycore-condition-encounter-diagnosis
+  * searches:
+    * patient + category
+    * patient
+    * patient + code
+* **ConditionProblemsHealthConcerns**
+  * read id:
+    * usqualitycore-condition-problems-health-concerns
+  * searches:
+    * patient + category
+    * patient
+    * patient + code
+* **Coverage**
+  * read id:
+    * usqualitycore-coverage
+  * searches:
+    * patient
+* **Device**
+  * read id:
+    * usqualitycore-device
+  * searches:
+    * patient
+    * patient + type
+* **Devicerequest**
+  * read id:
+    * usqualitycore-devicerequest
+  * searches:
+    * patient
+    * patient + code
+    * patient + do-not-perform
+* **Devicerequested**
+  * read id:
+    * usqualitycore-devicerequest
+  * searches:
+    * patient + do-not-perform
+    * patient
+    * patient + code
+* **Deviceprohibited**
+  * read id:
+    * usqualitycore-deviceprohibited
+  * searches:
+    * patient + do-not-perform
+    * patient
+    * patient + code
+* **DiagnosticReportNote**
+  * read id:
+    * usqualitycore-diagnostic-report-note
+  * searches:
+    * patient + category
+    * patient
+    * patient + category + date
+    * patient + code
+* **DiagnosticReportLab**
+  * read id:
+    * usqualitycore-diagnostic-report-lab
+  * searches:
+    * patient + category
+    * patient
+    * patient + category + date
+    * patient + code
+* **UsCoreDocumentreference**
+  * read id:
+    * usqualitycore-us-core-documentreference
+  * searches:
+    * patient + category
+    * patient
+    * _id
+    * patient + type
+    * patient + category + date
+* **UsCoreAdiDocumentreference**
+  * read id:
+    * usqualitycore-us-core-adi-documentreference
+  * searches:
+    * patient + category
+    * patient
+    * _id
+    * patient + type
+    * patient + category + date
+* **FamilyMemberHistory**
+  * read id:
+    * usqualitycore-family-member-history
+  * searches:
+    * patient
+* **Goal**
+  * read id:
+    * usqualitycore-goal
+  * searches:
+    * patient
+* **ImagingStudy**
+  * read id:
+    * usqualitycore-imaging-study
+  * searches:
+    * subject
+* **Immunization**
+  * read id:
+    * usqualitycore-immunization
+  * searches:
+    * patient + status
+    * patient
+* **Immunizationnotdone**
+  * read id:
+    * usqualitycore-immunizationnotdone
+  * searches:
+    * patient + status
+    * patient
+* **Immunizationdone**
+  * read id:
+    * usqualitycore-immunization
+  * searches:
+    * patient + status
+    * patient
+* **Medicationadministration**
+  * read id:
+    * usqualitycore-medicationadministration
+  * searches:
+    * patient + status
+    * patient
+    * patient + code
+    * patient + effective-time
+* **Medicationadministrationnotdone**
+  * read id:
+    * usqualitycore-medicationadministrationnotdone
+  * searches:
+    * patient + status
+    * patient
+    * patient + code
+    * patient + effective-time
+* **Medicationadministrationdone**
+  * read id:
+    * usqualitycore-medicationadministration
+  * searches:
+    * patient + status
+    * patient
+    * patient + code
+    * patient + effective-time
+* **Medicationdispense**
+  * read id:
+    * usqualitycore-medicationdispense
+  * searches:
+    * patient + status
+    * patient
+* **Medicationdispensedeclined**
+  * read id:
+    * usqualitycore-medicationdispensedeclined
+  * searches:
+    * patient + status
+    * patient
+* **Medicationdispensedone**
+  * read id:
+    * usqualitycore-medicationdispense
+  * searches:
+    * patient + status
+    * patient
+* **Medicationrequest**
+  * read id:
+    * usqualitycore-medicationrequest
+  * searches:
+    * patient + intent
+    * patient + intent + do-not-perform
+* **Medicationprohibited**
+  * read id:
+    * usqualitycore-medicationprohibited
+  * searches:
+    * patient + intent + do-not-perform
+    * patient + intent
+* **Medicationrequested**
+  * read id:
+    * usqualitycore-medicationrequest
+  * searches:
+    * patient + intent + do-not-perform
+    * patient + intent
+* **NutritionOrder**
+  * read id:
+    * usqualitycore-nutrition-order
+  * searches:
+    * patient
+* **ObservationClinicalResult**
+  * read id:
+    * usqualitycore-observation-clinical-result
+    * usqualitycore-observation-lab
+  * searches:
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+    * patient + code
+* **UsCoreObservationAdiDocumentation**
+  * read id:
+    * usqualitycore-us-core-observation-adi-documentation
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **UsCoreTreatmentInterventionPreference**
+  * read id:
+    * usqualitycore-us-core-treatment-intervention-preference
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **SimpleObservation**
+  * read id:
+    * usqualitycore-simple-observation
+  * searches:
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+    * patient + code
+* **ObservationScreeningAssessment**
+  * read id:
+    * usqualitycore-observation-screening-assessment
+  * searches:
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+    * patient + code
+* **UsCoreObservationPregnancystatus**
+  * read id:
+    * usqualitycore-us-core-observation-pregnancystatus
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **UsCoreObservationPregnancyintent**
+  * read id:
+    * usqualitycore-us-core-observation-pregnancyintent
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **UsCoreSmokingstatus**
+  * read id:
+    * usqualitycore-us-core-smokingstatus
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **ObservationLab**
+  * read id:
+    * usqualitycore-observation-lab
+  * searches:
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+    * patient + code
+* **UsCoreObservationOccupation**
+  * read id:
+    * usqualitycore-us-core-observation-occupation
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **UsCoreBloodPressure**
+  * read id:
+    * usqualitycore-us-core-blood-pressure
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **UsCoreBmi**
+  * read id:
+    * usqualitycore-us-core-bmi
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **PediatricBmiForAge**
+  * read id:
+    * usqualitycore-pediatric-bmi-for-age
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **UsCoreBodyHeight**
+  * read id:
+    * usqualitycore-us-core-body-height
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **UsCoreBodyTemperature**
+  * read id:
+    * usqualitycore-us-core-body-temperature
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **UsCoreBodyWeight**
+  * read id:
+    * usqualitycore-us-core-body-weight
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **HeadOccipitalFrontalCircumferencePercentile**
+  * read id:
+    * usqualitycore-head-circumference-percentile
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **UsCoreHeartRate**
+  * read id:
+    * usqualitycore-us-core-heart-rate
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **UsCorePulseOximetry**
+  * read id:
+    * usqualitycore-us-core-pulse-oximetry
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **UsCoreRespiratoryRate**
+  * read id:
+    * usqualitycore-us-core-respiratory-rate
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **PediatricWeightForHeight**
+  * read id:
+    * usqualitycore-pediatric-weight-for-height
+  * searches:
+    * patient + code
+    * patient + category + status
+    * patient + category
+    * patient + category + date
+* **Procedure**
+  * read id:
+    * usqualitycore-procedure
+  * searches:
+    * patient + status
+    * patient
+    * patient + date
+* **Procedurenotdone**
+  * read id:
+    * usqualitycore-procedurenotdone
+  * searches:
+    * patient + status
+    * patient
+    * patient + date
+* **Proceduredone**
+  * read id:
+    * usqualitycore-procedure
+  * searches:
+    * patient + status
+    * patient
+    * patient + date
+* **QuestionnaireResponse**
+  * read id:
+    * usqualitycore-questionnaire-response
+  * searches:
+    * patient
+    * patient + questionnaire
+* **RelatedPerson**
+  * read id:
+    * usqualitycore-related-person
+  * searches:
+    * patient
+    * _id
+* **Servicerequest**
+  * read id:
+    * usqualitycore-servicerequest
+  * searches:
+    * patient
+    * _id
+    * patient + category
+    * patient + category + authored
+    * patient + code
+    * patient + do-not-perform
+* **Serviceprohibited**
+  * read id:
+    * usqualitycore-serviceprohibited
+  * searches:
+    * patient + do-not-perform
+    * _id
+    * patient
+    * patient + category
+    * patient + category + authored
+    * patient + code
+* **Servicerequested**
+  * read id:
+    * usqualitycore-servicerequest
+  * searches:
+    * patient + do-not-perform
+    * _id
+    * patient
+    * patient + category
+    * patient + category + authored
+    * patient + code
+* **Task**
+  * read id:
+    * usqualitycore-task
+  * searches:
+    * patient + status
+    * patient
+    * patient + code
+* **Taskrejected**
+  * read id:
+    * usqualitycore-taskrejected
+  * searches:
+    * patient + status
+    * patient
+    * patient + code
+* **Taskdone**
+  * read id:
+    * usqualitycore-task
+  * searches:
+    * patient + status
+    * patient
+    * patient + code
+* **Encounter**
+  * read id:
+    * usqualitycore-encounter
+  * searches:
+    * patient
+    * _id
+    * patient + type
+    * patient + date
+* **Location**
+  * read id:
+    * usqualitycore-location
+  * searches:
+
+* **Organization**
+  * read id:
+    * usqualitycore-organization
+  * searches:
+
+* **Practitioner**
+  * read id:
+    * usqualitycore-practitioner
+  * searches:
+
+* **PractitionerRole**
+  * read id:
+    * usqualitycore-practitioner-role
+  * searches:
+
+* **Provenance**
+  * read id:
+    * usqualitycore-provenance
+  * searches:
+
+* **Specimen**
+  * read id:
+    * usqualitycore-specimen
+  * 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/search_test_generator.rb

@@ -54,6 +54,13 @@ module USQualityCoreTestKit
           "The client demonstrates #{conformance_expectation} support for searching " \
             "#{search_param_name_string} on #{profile_identifier.camelize}."
         end
+
+        def all_required_search_parameters
+          group_metadata.searches
+                        .select { |search| search[:expectation] == 'SHALL' }
+                        .flat_map { |search| search[:names] }
+                        .uniq
+        end
       end
     end
   end

data/lib/us_quality_core_test_kit/client/generator/templates/capability_statement.json.erb

@@ -8,7 +8,7 @@ capability_statement = {
   publisher: 'MITRE',
   kind: 'instance',
   instantiates: [
-    'http://fhir.org/guides/onc/us-quality-core/CapabilityStatement/us-quality-core-server'
+    'http://hl7.org/fhir/us/quality-core/CapabilityStatement/us-quality-core-server'
   ],
   implementation: {
     description: 'Inferno US Quality Core Testing Simulation Server',
@@ -19,7 +19,7 @@ capability_statement = {
     'application/fhir+json'
   ],
   implementationGuide: [
-    'http://fhir.org/guides/onc/us-quality-core/CapabilityStatement/us-quality-core-server'
+    'http://hl7.org/fhir/us/quality-core/CapabilityStatement/us-quality-core-server'
   ],
   rest: [
     {

data/lib/us_quality_core_test_kit/client/generator/templates/search_endpoint.rb.erb

@@ -20,7 +20,7 @@ module USQualityCoreTestKit
         end
 
         def tags
-          [SEARCH_REQUEST_TAG, resource_to_tag(resource_type)]
+          [SEARCH_REQUEST_TAG, resource_to_tag(resource_type)].compact
         end
 
         def resource_to_tag(resource)

data/lib/us_quality_core_test_kit/client/generator/templates/search_test.rb.erb

@@ -28,12 +28,25 @@ module USQualityCoreTestKit
           "Inferno did not receive the expected search made for the `<%= resource_type %>` resource type with required search parameters: `#{required_params.join(' + ')}`."
         end
 
+        <%- unless optional? -%>
+        def all_required_search_parameters
+          <%= all_required_search_parameters.inspect %>
+        end
+
+        <%- end -%>
         run do
           requests = load_tagged_requests(SEARCH_<%= resource.underscore.upcase %>_TAG)
           skip_if requests.blank?, skip_message
 
           requests_with_params = filter_requests_by_search_parameters(requests, required_params)
           assert requests_with_params.any?, failure_message
+          <%- unless optional? -%>
+
+          non_required_search_parameters(requests_with_params, all_required_search_parameters).each do |parameter|
+            warning "The client used the non-required search parameter `#{parameter}` for `<%= resource_type %>`. " \
+                    'The server may not accept search parameters other than those required by the IG CapabilityStatement.'
+          end
+          <%- end -%>
         end
       end
     end

data/lib/us_quality_core_test_kit/client/generator/templates/suite.rb.erb

@@ -8,6 +8,7 @@ require_relative 'read_endpoint'
 require_relative 'search_endpoint'
 require_relative '../../test_helper'
 require_relative 'wait_group'
+require_relative '../../custom_groups/pagination_group'
 
 <%- group_file_list.each do |group| -%>
 require_relative '<%= group %>'
@@ -55,6 +56,7 @@ module USQualityCoreTestKit
         ))
 
         suite_endpoint :post, SEARCH_POST_ROUTE, SearchEndpoint
+        suite_endpoint :get, FHIR_ROUTE, SearchEndpoint
         suite_endpoint :get, SEARCH_ROUTE, SearchEndpoint
         suite_endpoint :get, READ_ROUTE, ReadEndpoint
 
@@ -77,9 +79,13 @@ module USQualityCoreTestKit
           group from: :<%= group %>
           <%- end -%>
 
+          group from: :us_quality_core_client_pagination_group
+
           run do
             profile_groups = groups.reject do |group|
-              group.id == '<%= access_group_id %>' || group.id.end_with?('-<%= access_group_id %>')
+              group.id == '<%= access_group_id %>' ||
+                group.id.end_with?('-<%= access_group_id %>') ||
+                group.id == 'us_quality_core_client_pagination_group'
             end
 
             passing_profile_group = profile_groups.any? do |group|