us_core_test_kit 0.6.2 → 0.6.3

data/lib/us_core_test_kit/generated/v7.0.0-ballot/vital_signs/vital_signs_patient_category_date_search_test.rb

@@ -0,0 +1,48 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV700_BALLOT
+    class VitalSignsPatientCategoryDateSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Observation search by patient + category + date'
+      description %(
+A server SHALL support searching by
+patient + category + date on the Observation resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core//CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v700_ballot_vital_signs_patient_category_date_search_test
+      input :patient_ids,
+        title: 'Patient IDs',
+        description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+  
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'Observation',
+        search_param_names: ['patient', 'category', 'date'],
+        possible_status_search: true,
+        token_search_params: ['category'],
+        params_with_comparators: ['date']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:vital_signs_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0-ballot/vital_signs/vital_signs_patient_category_search_test.rb

@@ -0,0 +1,47 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV700_BALLOT
+    class VitalSignsPatientCategorySearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Observation search by patient + category'
+      description %(
+A server SHALL support searching by
+patient + category on the Observation resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core//CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v700_ballot_vital_signs_patient_category_search_test
+      input :patient_ids,
+        title: 'Patient IDs',
+        description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+  
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'Observation',
+        search_param_names: ['patient', 'category'],
+        possible_status_search: true,
+        token_search_params: ['category']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:vital_signs_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0-ballot/vital_signs/vital_signs_patient_category_status_search_test.rb

@@ -0,0 +1,49 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV700_BALLOT
+    class VitalSignsPatientCategoryStatusSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Observation search by patient + category + status'
+      description %(
+A server SHOULD support searching by
+patient + category + status on the Observation resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core//CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v700_ballot_vital_signs_patient_category_status_search_test
+      optional
+  
+      input :patient_ids,
+        title: 'Patient IDs',
+        description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+  
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'Observation',
+        search_param_names: ['patient', 'category', 'status'],
+        token_search_params: ['category'],
+        multiple_or_search_params: ['status']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:vital_signs_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0-ballot/vital_signs/vital_signs_patient_code_date_search_test.rb

@@ -0,0 +1,50 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV700_BALLOT
+    class VitalSignsPatientCodeDateSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Observation search by patient + code + date'
+      description %(
+A server SHOULD support searching by
+patient + code + date on the Observation resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core//CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v700_ballot_vital_signs_patient_code_date_search_test
+      optional
+  
+      input :patient_ids,
+        title: 'Patient IDs',
+        description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+  
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'Observation',
+        search_param_names: ['patient', 'code', 'date'],
+        possible_status_search: true,
+        token_search_params: ['code'],
+        params_with_comparators: ['date']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:vital_signs_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0-ballot/vital_signs/vital_signs_patient_code_search_test.rb

@@ -0,0 +1,64 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV700_BALLOT
+    class VitalSignsPatientCodeSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Observation search by patient + code'
+      description %(
+A server SHALL support searching by
+patient + code on the Observation resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+This test verifies that the server supports searching by reference using
+the form `patient=[id]` as well as `patient=Patient/[id]`. The two
+different forms are expected to return the same number of results. US
+Core requires that both forms are supported by US Core responders.
+
+Because this is the first search of the sequence, resources in the
+response will be used for subsequent tests.
+
+Additionally, this test will check that GET and POST search methods
+return the same number of results. Search by POST is required by the
+FHIR R4 specification, and these tests interpret search by GET as a
+requirement of US Core v7.0.0-ballot.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core//CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v700_ballot_vital_signs_patient_code_search_test
+      input :patient_ids,
+        title: 'Patient IDs',
+        description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+  
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          first_search: true,
+        fixed_value_search: true,
+        resource_type: 'Observation',
+        search_param_names: ['patient', 'code'],
+        possible_status_search: true,
+        token_search_params: ['code'],
+        test_reference_variants: true,
+        test_post_search: true
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:vital_signs_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0-ballot/vital_signs/vital_signs_provenance_revinclude_search_test.rb

@@ -0,0 +1,53 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV700_BALLOT
+    class VitalSignsProvenanceRevincludeSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns Provenance resources from Observation search by patient + code + revInclude:Provenance:target'
+      description %(
+        A server SHALL be capable of supporting _revIncludes:Provenance:target.
+
+        This test will perform a search by patient + code + revInclude:Provenance:target and
+        will pass if a Provenance resource is found in the response.
+      %)
+
+      id :us_core_v700_ballot_vital_signs_provenance_revinclude_search_test
+  
+      input :patient_ids,
+        title: 'Patient IDs',
+        description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+  
+      def properties
+        @properties ||= SearchTestProperties.new(
+          fixed_value_search: true,
+        resource_type: 'Observation',
+        search_param_names: ['patient', 'code'],
+        possible_status_search: true
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+      end
+
+      def self.provenance_metadata
+        @provenance_metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, '..', 'provenance', 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:vital_signs_resources] ||= {}
+      end
+
+      def scratch_provenance_resources
+        scratch[:provenance_resources] ||= {}
+      end
+
+      run do
+        run_provenance_revinclude_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0-ballot/vital_signs/vital_signs_read_test.rb

@@ -0,0 +1,26 @@
+require_relative '../../../read_test'
+
+module USCoreTestKit
+  module USCoreV700_BALLOT
+    class VitalSignsReadTest < Inferno::Test
+      include USCoreTestKit::ReadTest
+
+      title 'Server returns correct Observation resource from Observation read interaction'
+      description 'A server SHALL support the Observation read interaction.'
+
+      id :us_core_v700_ballot_vital_signs_read_test
+
+      def resource_type
+        'Observation'
+      end
+
+      def scratch_resources
+        scratch[:vital_signs_resources] ||= {}
+      end
+
+      run do
+        perform_read_test(all_scratch_resources)
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0-ballot/vital_signs/vital_signs_reference_resolution_test.rb

@@ -0,0 +1,40 @@
+require_relative '../../../reference_resolution_test'
+
+module USCoreTestKit
+  module USCoreV700_BALLOT
+    class VitalSignsReferenceResolutionTest < Inferno::Test
+      include USCoreTestKit::ReferenceResolutionTest
+
+      title 'MustSupport references within Observation resources are valid'
+      description %(
+        This test will attempt to read external references provided within elements
+        marked as 'MustSupport', if any are available.
+
+        It verifies that at least one external reference for each MustSupport Reference element
+        can be accessed by the test client, and conforms to corresponding US Core profile.
+
+        Elements which may provide external references include:
+
+        * Observation.subject
+      )
+
+      id :us_core_v700_ballot_vital_signs_reference_resolution_test
+
+      def resource_type
+        'Observation'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:vital_signs_resources] ||= {}
+      end
+
+      run do
+        perform_reference_resolution_test(scratch_resources[:all])
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0-ballot/vital_signs/vital_signs_validation_test.rb

@@ -0,0 +1,40 @@
+require_relative '../../../validation_test'
+
+module USCoreTestKit
+  module USCoreV700_BALLOT
+    class VitalSignsValidationTest < Inferno::Test
+      include USCoreTestKit::ValidationTest
+
+      id :us_core_v700_ballot_vital_signs_validation_test
+      title 'Observation resources returned during previous tests conform to the US Core Vital Signs Profile'
+      description %(
+This test verifies resources returned from the first search conform to
+the [US Core Vital Signs Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs).
+Systems must demonstrate at least one valid example in order to pass this test.
+
+It verifies the presence of mandatory elements and that elements with
+required bindings contain appropriate values. CodeableConcept element
+bindings will fail if none of their codings have a code/system belonging
+to the bound ValueSet. Quantity, Coding, and code element bindings will
+fail if their code/system are not found in the valueset.
+
+      )
+      output :dar_code_found, :dar_extension_found
+
+      def resource_type
+        'Observation'
+      end
+
+      def scratch_resources
+        scratch[:vital_signs_resources] ||= {}
+      end
+
+      run do
+        perform_validation_test(scratch_resources[:all] || [],
+                                'http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs',
+                                '7.0.0-ballot',
+                                skip_if_empty: true)
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0-ballot/vital_signs_group.rb

@@ -0,0 +1,96 @@
+require_relative 'vital_signs/vital_signs_patient_code_search_test'
+require_relative 'vital_signs/vital_signs_patient_category_search_test'
+require_relative 'vital_signs/vital_signs_patient_category_date_search_test'
+require_relative 'vital_signs/vital_signs_patient_category_status_search_test'
+require_relative 'vital_signs/vital_signs_patient_code_date_search_test'
+require_relative 'vital_signs/vital_signs_read_test'
+require_relative 'vital_signs/vital_signs_provenance_revinclude_search_test'
+require_relative 'vital_signs/vital_signs_validation_test'
+require_relative 'vital_signs/vital_signs_must_support_test'
+require_relative 'vital_signs/vital_signs_reference_resolution_test'
+
+module USCoreTestKit
+  module USCoreV700_BALLOT
+    class VitalSignsGroup < Inferno::TestGroup
+      title 'Observation Vital Signs Tests'
+      short_description 'Verify support for the server capabilities required by the US Core Vital Signs Profile.'
+      description %(
+  # Background
+
+The US Core Observation Vital Signs sequence verifies that the system under test is
+able to provide correct responses for Observation queries. These queries
+must contain resources conforming to the US Core Vital Signs Profile as
+specified in the US Core v7.0.0-ballot Implementation Guide.
+
+# Testing Methodology
+## Searching
+This test sequence will first perform each required search associated
+with this resource. This sequence will perform searches with the
+following parameters:
+
+* patient + code
+* patient + category
+* patient + category + date
+
+### Search Parameters
+The first search uses the selected patient(s) from the prior launch
+sequence. Any subsequent searches will look for its parameter values
+from the results of the first search. For example, the `identifier`
+search in the patient sequence is performed by looking for an existing
+`Patient.identifier` from any of the resources returned in the `_id`
+search. If a value cannot be found this way, the search is skipped.
+
+### Search Validation
+Inferno will retrieve up to the first 20 bundle pages of the reply for
+Observation resources and save them for subsequent tests. Each of
+these resources is then checked to see if it matches the searched
+parameters in accordance with [FHIR search
+guidelines](https://www.hl7.org/fhir/search.html). The test will fail,
+for example, if a Patient search for `gender=male` returns a `female`
+patient.
+
+
+## Must Support
+Each profile contains elements marked as "must support". This test
+sequence expects to see each of these elements at least once. If at
+least one cannot be found, the test will fail. The test will look
+through the Observation resources found in the first test for these
+elements.
+
+## Profile Validation
+Each resource returned from the first search is expected to conform to
+the [US Core Vital Signs Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs). Each element is checked against
+teminology binding and cardinality requirements.
+
+Elements with a required binding are validated against their bound
+ValueSet. If the code/system in the element is not part of the ValueSet,
+then the test will fail.
+
+## Reference Validation
+At least one instance of each external reference in elements marked as
+"must support" within the resources provided by the system must resolve.
+The test will attempt to read each reference found and will fail if no
+read succeeds.
+
+      )
+
+      id :us_core_v700_ballot_vital_signs
+      run_as_group
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'vital_signs', 'metadata.yml'), aliases: true))
+      end
+  
+      test from: :us_core_v700_ballot_vital_signs_patient_code_search_test
+      test from: :us_core_v700_ballot_vital_signs_patient_category_search_test
+      test from: :us_core_v700_ballot_vital_signs_patient_category_date_search_test
+      test from: :us_core_v700_ballot_vital_signs_patient_category_status_search_test
+      test from: :us_core_v700_ballot_vital_signs_patient_code_date_search_test
+      test from: :us_core_v700_ballot_vital_signs_read_test
+      test from: :us_core_v700_ballot_vital_signs_provenance_revinclude_search_test
+      test from: :us_core_v700_ballot_vital_signs_validation_test
+      test from: :us_core_v700_ballot_vital_signs_must_support_test
+      test from: :us_core_v700_ballot_vital_signs_reference_resolution_test
+    end
+  end
+end

data/lib/us_core_test_kit/generator/granular_scope_group_generator.rb

@@ -0,0 +1,127 @@
+require_relative 'naming'
+require_relative '../custom_groups/smart_scopes_constants'
+
+module USCoreTestKit
+  class Generator
+    class GranularScopeGroupGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir)
+          return unless ['6', '7'].include? ig_metadata.ig_version[1]
+
+          [1, 2].each do |group_number|
+            new(ig_metadata, base_output_dir, group_number).generate
+          end
+        end
+      end
+
+      attr_accessor :ig_metadata, :base_output_dir, :group_number
+
+      def initialize(ig_metadata, base_output_dir, group_number)
+        self.ig_metadata = ig_metadata
+        self.base_output_dir = base_output_dir
+        self.group_number = group_number
+      end
+
+      def template
+        @template ||= File.read(File.join(__dir__, 'templates', 'granular_scope_group.rb.erb'))
+      end
+
+      def output
+        @output ||= ERB.new(template).result(binding)
+      end
+
+      def base_output_file_name
+        "#{class_name.underscore}.rb"
+      end
+
+      def base_metadata_file_name
+        "metadata.yml"
+      end
+
+      def class_name
+        "GranularScopes#{group_number}Group"
+      end
+
+      def module_name
+        "USCore#{ig_metadata.reformatted_version.upcase}"
+      end
+
+      def title
+        "#US Core FHIR API w/Granular Scopes #{group_number}"
+      end
+
+      def short_description
+        # TODO
+      end
+
+      def output_file_name
+        File.join(base_output_dir, base_output_file_name)
+      end
+
+      def group_dir
+        File.join(base_output_dir, 'granular_scope_tests')
+      end
+
+      def group_id
+        "us_core_#{ig_metadata.reformatted_version}_smart_granular_scopes_#{group_number}"
+      end
+
+      def generate
+        FileUtils.mkdir_p(group_dir)
+        File.open(output_file_name, 'w') { |f| f.write(output) }
+        ig_metadata.granular_scope_groups <<
+          {
+            id: group_id,
+            file_name: base_output_file_name
+          }
+      end
+
+      def group_id_list
+        @group_id_list ||=
+          ig_metadata
+            .granular_scope_resource_type_groups
+            .values
+            .flatten
+            .map { |group| group[:id] }
+            .select { |id| id.include? "scope_#{group_number}" }
+      end
+
+      def group_file_list
+        @group_file_list ||=
+          ig_metadata.granular_scope_resource_type_groups
+            .values
+            .flatten
+            .select { |group| group[:file_name].include? "scope#{group_number}" }
+            .map do |group|
+              name_without_suffix = group[:file_name].delete_suffix('.rb')
+              "./#{name_without_suffix}"
+            end
+      end
+
+      def search_param_name_string
+        required_searches
+          .map { |search| search[:names].join(' + ') }
+          .map { |names| "* #{names}" }
+          .join("\n")
+      end
+
+      def scopes_string
+        SmartScopesConstants.const_get("SMART_GRANULAR_SCOPES_GROUP#{group_number}")
+          .dig(ig_metadata.reformatted_version)
+          .map { |scope| scope.delete_prefix 'patient/' }
+          .map { |scope| "* `#{scope}`" }
+          .join("\n")
+      end
+
+      def description
+        <<~DESCRIPTION
+          The tests in this group repeat all of the searches from the US Core
+          FHIR API tests, and verify that the resources returned are filtered
+          based on the following granular scopes:
+
+          #{scopes_string}
+        DESCRIPTION
+      end
+    end
+  end
+end