ipa_test_kit 0.2.0 → 0.3.1

data/lib/ipa_test_kit/generated/v1.0.0/vitalsigns/vitalsigns_must_support_test.rb

@@ -0,0 +1,57 @@
+require_relative '../../../must_support_test'
+
+module IpaTestKit
+  module IpaV100
+    class VitalsignsMustSupportTest < Inferno::Test
+      include IpaTestKit::MustSupportTest
+
+      title 'All must support elements are provided in the Observation resources returned'
+      description %(
+        Responders conforming to a profile in IPA SHALL return a Must Support
+        element if that element is available. This test will look through the
+        Observation resources found previously for the following must
+        support elements:
+
+        * Observation.category
+        * Observation.category.coding
+        * Observation.category.coding.code
+        * Observation.category.coding.system
+        * Observation.category:VSCat
+        * Observation.code
+        * Observation.component
+        * Observation.component.code
+        * Observation.component.dataAbsentReason
+        * Observation.component.value[x]
+        * Observation.dataAbsentReason
+        * Observation.effective[x]
+        * Observation.status
+        * Observation.subject
+        * Observation.value[x]
+
+        Note: Responders who cannot store or return a data element tagged as
+        Supported in IPA profiles can still claim conformance to the IPA
+        profiles per the IPA conformance resources.
+      )
+
+      id :ipa_v100_vitalsigns_must_support_test
+
+      optional
+
+      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[:vitalsigns_resources] ||= {}
+      end
+
+      run do
+        perform_must_support_test(all_scratch_resources)
+      end
+    end
+  end
+end

data/lib/ipa_test_kit/generated/v1.0.0/vitalsigns/vitalsigns_patient_category_date_search_test.rb

@@ -0,0 +1,48 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module IpaTestKit
+  module IpaV100
+    class VitalsignsPatientCategoryDateSearchTest < Inferno::Test
+      include IpaTestKit::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.
+
+# TODO: Fix this
+# [US Core Server CapabilityStatement](http://hl7.org/fhir/us/core//CapabilityStatement-us-core-server.html)
+
+
+      )
+
+      id :ipa_v100_vitalsigns_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'],
+        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[:vitalsigns_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/ipa_test_kit/generated/v1.0.0/vitalsigns/vitalsigns_patient_category_search_test.rb

@@ -0,0 +1,65 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module IpaTestKit
+  module IpaV100
+    class VitalsignsPatientCategorySearchTest < Inferno::Test
+      include IpaTestKit::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.
+
+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. IPA
+requires that both forms are supported by IPA 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 IPA v1.0.0.
+
+# TODO: Fix this
+# [US Core Server CapabilityStatement](http://hl7.org/fhir/us/core//CapabilityStatement-us-core-server.html)
+
+
+      )
+
+      id :ipa_v100_vitalsigns_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(
+          first_search: true,
+        fixed_value_search: true,
+        resource_type: 'Observation',
+        search_param_names: ['patient', 'category'],
+        token_search_params: ['category'],
+        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[:vitalsigns_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/ipa_test_kit/generated/v1.0.0/vitalsigns/vitalsigns_patient_category_status_search_test.rb

@@ -0,0 +1,50 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module IpaTestKit
+  module IpaV100
+    class VitalsignsPatientCategoryStatusSearchTest < Inferno::Test
+      include IpaTestKit::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.
+
+# TODO: Fix this
+# [US Core Server CapabilityStatement](http://hl7.org/fhir/us/core//CapabilityStatement-us-core-server.html)
+
+
+      )
+
+      id :ipa_v100_vitalsigns_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']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:vitalsigns_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/ipa_test_kit/generated/v1.0.0/vitalsigns/vitalsigns_patient_code_date_search_test.rb

@@ -0,0 +1,50 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module IpaTestKit
+  module IpaV100
+    class VitalsignsPatientCodeDateSearchTest < Inferno::Test
+      include IpaTestKit::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.
+
+# TODO: Fix this
+# [US Core Server CapabilityStatement](http://hl7.org/fhir/us/core//CapabilityStatement-us-core-server.html)
+
+
+      )
+
+      id :ipa_v100_vitalsigns_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'],
+        token_search_params: ['code']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:vitalsigns_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/ipa_test_kit/generated/v1.0.0/vitalsigns/vitalsigns_patient_code_search_test.rb

@@ -0,0 +1,48 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module IpaTestKit
+  module IpaV100
+    class VitalsignsPatientCodeSearchTest < Inferno::Test
+      include IpaTestKit::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.
+
+# TODO: Fix this
+# [US Core Server CapabilityStatement](http://hl7.org/fhir/us/core//CapabilityStatement-us-core-server.html)
+
+
+      )
+
+      id :ipa_v100_vitalsigns_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(
+          resource_type: 'Observation',
+        search_param_names: ['patient', 'code'],
+        token_search_params: ['code']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:vitalsigns_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/ipa_test_kit/generated/v1.0.0/vitalsigns/vitalsigns_provenance_revinclude_search_test.rb

@@ -0,0 +1,52 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module IpaTestKit
+  module IpaV100
+    class VitalsignsProvenanceRevincludeSearchTest < Inferno::Test
+      include IpaTestKit::SearchTest
+
+      title 'Server returns Provenance resources from Observation search by patient + category + revInclude:Provenance:target'
+      description %(
+        A server SHALL be capable of supporting _revIncludes:Provenance:target.
+
+        This test will perform a search by patient + category + revInclude:Provenance:target and
+        will pass if a Provenance resource is found in the response.
+      %)
+
+      id :ipa_v100_vitalsigns_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', 'category']
+        )
+      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[:vitalsigns_resources] ||= {}
+      end
+
+      def scratch_provenance_resources
+        scratch[:provenance_resources] ||= {}
+      end
+
+      run do
+        run_provenance_revinclude_search_test
+      end
+    end
+  end
+end

data/lib/ipa_test_kit/generated/v1.0.0/vitalsigns/vitalsigns_read_test.rb

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

data/lib/ipa_test_kit/generated/v1.0.0/vitalsigns/vitalsigns_reference_resolution_test.rb

@@ -0,0 +1,42 @@
+require_relative '../../../reference_resolution_test'
+require_relative '../resource_list'
+
+module IpaTestKit
+  module IpaV100
+    class VitalsignsReferenceResolutionTest < Inferno::Test
+      include IpaTestKit::ReferenceResolutionTest
+      include ResourceList
+
+      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 IPA profile.
+
+        Elements which may provide external references include:
+
+        * Observation.subject
+      )
+
+      id :ipa_v100_vitalsigns_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[:vitalsigns_resources] ||= {}
+      end
+
+      run do
+        perform_reference_resolution_test(scratch_resources[:all])
+      end
+    end
+  end
+end

data/lib/ipa_test_kit/generated/v1.0.0/vitalsigns/vitalsigns_validation_test.rb

@@ -0,0 +1,40 @@
+require_relative '../../../validation_test'
+
+module IpaTestKit
+  module IpaV100
+    class VitalsignsValidationTest < Inferno::Test
+      include IpaTestKit::ValidationTest
+
+      id :ipa_v100_vitalsigns_validation_test
+      title 'Observation resources returned during previous tests conform to the Vital Signs Profile'
+      description %(
+This test verifies resources returned from the first search conform to
+the [Vital Signs Profile](http://hl7.org/fhir/StructureDefinition/vitalsigns).
+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[:vitalsigns_resources] ||= {}
+      end
+
+      run do
+        perform_validation_test(scratch_resources[:all] || [],
+                                'http://hl7.org/fhir/StructureDefinition/vitalsigns',
+                                '4.0.1',
+                                skip_if_empty: true)
+      end
+    end
+  end
+end

data/lib/ipa_test_kit/generated/v1.0.0/vitalsigns_group.rb

@@ -0,0 +1,100 @@
+require_relative 'vitalsigns/vitalsigns_patient_category_search_test'
+require_relative 'vitalsigns/vitalsigns_patient_code_search_test'
+require_relative 'vitalsigns/vitalsigns_patient_category_date_search_test'
+require_relative 'vitalsigns/vitalsigns_patient_category_status_search_test'
+require_relative 'vitalsigns/vitalsigns_patient_code_date_search_test'
+require_relative 'vitalsigns/vitalsigns_read_test'
+require_relative 'vitalsigns/vitalsigns_provenance_revinclude_search_test'
+require_relative 'vitalsigns/vitalsigns_validation_test'
+require_relative 'vitalsigns/vitalsigns_must_support_test'
+require_relative 'vitalsigns/vitalsigns_reference_resolution_test'
+
+module IpaTestKit
+  module IpaV100
+    class VitalsignsGroup < Inferno::TestGroup
+      title 'Observation (Vital Signs Profile) Tests'
+      short_description 'Verify support for the server capabilities required by the Vital Signs Profile.'
+      description %(
+  # Background
+
+The IPA Observation (Vital Signs Profile) sequence verifies that the system under test is
+able to provide correct responses for Observation queries. These queries
+must contain resources conforming to the Vital Signs Profile as
+specified in the IPA v1.0.0 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 + category
+* patient + code
+* 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 [Vital Signs Profile](http://hl7.org/fhir/StructureDefinition/vitalsigns). 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 :ipa_v100_vitalsigns
+      run_as_group
+      input :standalone_smart_credentials,
+            title: 'SMART App Launch Credentials',
+            type: 'oauth_credentials',
+            optional: true
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'vitalsigns', 'metadata.yml'), aliases: true))
+      end
+  
+      test from: :ipa_v100_vitalsigns_patient_category_search_test
+      test from: :ipa_v100_vitalsigns_patient_code_search_test
+      test from: :ipa_v100_vitalsigns_patient_category_date_search_test
+      test from: :ipa_v100_vitalsigns_patient_category_status_search_test
+      test from: :ipa_v100_vitalsigns_patient_code_date_search_test
+      test from: :ipa_v100_vitalsigns_read_test
+      test from: :ipa_v100_vitalsigns_provenance_revinclude_search_test
+      test from: :ipa_v100_vitalsigns_validation_test
+      test from: :ipa_v100_vitalsigns_must_support_test
+      test from: :ipa_v100_vitalsigns_reference_resolution_test
+    end
+  end
+end