davinci_us_drug_formulary_test_kit 0.9.0

data/lib/davinci_us_drug_formulary_test_kit/generated/v2.0.1/payer_insurance_plan/payer_insurance_plan_must_support_test.rb

@@ -0,0 +1,66 @@
+require_relative '../../../must_support_test'
+
+module DaVinciUSDrugFormularyTestKit
+  module DaVinciUSDrugFormularyV201
+    class PayerInsurancePlanMustSupportTest < Inferno::Test
+      include DaVinciUSDrugFormularyTestKit::MustSupportTest
+
+      title 'All must support elements are provided in the InsurancePlan resources returned'
+      description %(
+        US Drug Formulary Responders SHALL be capable of populating all data elements as
+        part of the query results as specified by the US Drug Formulary Capability
+        Statement. This test will look through the InsurancePlan resources
+        found previously for the following must support elements:
+
+        * InsurancePlan.contact.name
+        * InsurancePlan.contact.name.text
+        * InsurancePlan.contact.telecom
+        * InsurancePlan.contact.telecom.system
+        * InsurancePlan.contact.telecom.value
+        * InsurancePlan.coverage
+        * InsurancePlan.coverage.type
+        * InsurancePlan.coverage:drug-coverage
+        * InsurancePlan.coverage:drug-coverage.benefit:drug-plan
+        * InsurancePlan.coverage:drug-coverage.extension
+        * InsurancePlan.coverage:drug-coverage.extension:usdf-FormularyReference-extension
+        * InsurancePlan.coverageArea
+        * InsurancePlan.identifier
+        * InsurancePlan.meta.lastUpdated
+        * InsurancePlan.name
+        * InsurancePlan.period
+        * InsurancePlan.plan
+        * InsurancePlan.plan:drug-plan
+        * InsurancePlan.plan:drug-plan.specificCost
+        * InsurancePlan.plan:drug-plan.specificCost.benefit
+        * InsurancePlan.plan:drug-plan.specificCost.benefit.cost
+        * InsurancePlan.plan:drug-plan.specificCost.benefit.cost.qualifiers
+        * InsurancePlan.plan:drug-plan.specificCost.benefit.cost.value
+        * InsurancePlan.plan:drug-plan.specificCost.benefit.cost:coinsurance
+        * InsurancePlan.plan:drug-plan.specificCost.benefit.cost:copay
+        * InsurancePlan.plan:drug-plan.specificCost.benefit.cost:copay.value.value
+        * InsurancePlan.plan:drug-plan.specificCost.benefit.type
+        * InsurancePlan.plan:drug-plan.specificCost.category
+        * InsurancePlan.status
+        * InsurancePlan.type
+      )
+
+      id :usdf_v201_payer_insurance_plan_must_support_test
+
+      def resource_type
+        'InsurancePlan'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:payer_insurance_plan_resources] ||= {}
+      end
+
+      run do
+        perform_must_support_test(all_scratch_resources)
+      end
+    end
+  end
+end

data/lib/davinci_us_drug_formulary_test_kit/generated/v2.0.1/payer_insurance_plan/payer_insurance_plan_name_search_test.rb

@@ -0,0 +1,42 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module DaVinciUSDrugFormularyTestKit
+  module DaVinciUSDrugFormularyV201
+    class PayerInsurancePlanNameSearchTest < Inferno::Test
+      include DaVinciUSDrugFormularyTestKit::SearchTest
+
+      title 'Server returns valid results for InsurancePlan search by name'
+      description %(
+A server SHALL support searching by
+name on the InsurancePlan resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+[US Drug Formulary](http://hl7.org/fhir/us/davinci-drug-formulary/STU2/CapabilityStatement-usdf-server.html)
+
+      )
+
+      id :usdf_v201_payer_insurance_plan_name_search_test
+  
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'InsurancePlan',
+          search_param_names: ['name']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:payer_insurance_plan_resources] ||= {}
+      end
+
+      run do
+        run_search_test 
+      end
+    end
+  end
+end

data/lib/davinci_us_drug_formulary_test_kit/generated/v2.0.1/payer_insurance_plan/payer_insurance_plan_period_search_test.rb

@@ -0,0 +1,42 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module DaVinciUSDrugFormularyTestKit
+  module DaVinciUSDrugFormularyV201
+    class PayerInsurancePlanPeriodSearchTest < Inferno::Test
+      include DaVinciUSDrugFormularyTestKit::SearchTest
+
+      title 'Server returns valid results for InsurancePlan search by period'
+      description %(
+A server SHALL support searching by
+period on the InsurancePlan resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+[US Drug Formulary](http://hl7.org/fhir/us/davinci-drug-formulary/STU2/CapabilityStatement-usdf-server.html)
+
+      )
+
+      id :usdf_v201_payer_insurance_plan_period_search_test
+  
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'InsurancePlan',
+          search_param_names: ['period']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:payer_insurance_plan_resources] ||= {}
+      end
+
+      run do
+        run_search_test 
+      end
+    end
+  end
+end

data/lib/davinci_us_drug_formulary_test_kit/generated/v2.0.1/payer_insurance_plan/payer_insurance_plan_read_test.rb

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

data/lib/davinci_us_drug_formulary_test_kit/generated/v2.0.1/payer_insurance_plan/payer_insurance_plan_reference_resolution_test.rb

@@ -0,0 +1,40 @@
+require_relative '../../../reference_resolution_test'
+
+module DaVinciUSDrugFormularyTestKit
+  module DaVinciUSDrugFormularyV201
+    class PayerInsurancePlanReferenceResolutionTest < Inferno::Test
+      include DaVinciUSDrugFormularyTestKit::ReferenceResolutionTest
+
+      title 'MustSupport references within InsurancePlan 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:
+
+        * InsurancePlan.coverageArea
+      )
+
+      id :usdf_v201_payer_insurance_plan_reference_resolution_test
+
+      def resource_type
+        'InsurancePlan'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:payer_insurance_plan_resources] ||= {}
+      end
+
+      run do
+        perform_reference_resolution_test(scratch_resources[:all])
+      end
+    end
+  end
+end

data/lib/davinci_us_drug_formulary_test_kit/generated/v2.0.1/payer_insurance_plan/payer_insurance_plan_status_search_test.rb

@@ -0,0 +1,53 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module DaVinciUSDrugFormularyTestKit
+  module DaVinciUSDrugFormularyV201
+    class PayerInsurancePlanStatusSearchTest < Inferno::Test
+      include DaVinciUSDrugFormularyTestKit::SearchTest
+
+      title 'Server returns valid results for InsurancePlan search by status'
+      description %(
+A server SHALL support searching by
+status on the InsurancePlan resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+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 v2.0.1.
+
+[US Drug Formulary](http://hl7.org/fhir/us/davinci-drug-formulary/STU2/CapabilityStatement-usdf-server.html)
+
+      )
+
+      id :usdf_v201_payer_insurance_plan_status_search_test
+  
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          first_search: true,
+          fixed_value_search: true,
+          resource_type: 'InsurancePlan',
+          search_param_names: ['status'],
+          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[:payer_insurance_plan_resources] ||= {}
+      end
+
+      run do
+        run_search_test 
+      end
+    end
+  end
+end

data/lib/davinci_us_drug_formulary_test_kit/generated/v2.0.1/payer_insurance_plan/payer_insurance_plan_type_search_test.rb

@@ -0,0 +1,43 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module DaVinciUSDrugFormularyTestKit
+  module DaVinciUSDrugFormularyV201
+    class PayerInsurancePlanTypeSearchTest < Inferno::Test
+      include DaVinciUSDrugFormularyTestKit::SearchTest
+
+      title 'Server returns valid results for InsurancePlan search by type'
+      description %(
+A server SHALL support searching by
+type on the InsurancePlan resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+[US Drug Formulary](http://hl7.org/fhir/us/davinci-drug-formulary/STU2/CapabilityStatement-usdf-server.html)
+
+      )
+
+      id :usdf_v201_payer_insurance_plan_type_search_test
+  
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'InsurancePlan',
+          search_param_names: ['type'],
+          token_search_params: ['type']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:payer_insurance_plan_resources] ||= {}
+      end
+
+      run do
+        run_search_test 
+      end
+    end
+  end
+end

data/lib/davinci_us_drug_formulary_test_kit/generated/v2.0.1/payer_insurance_plan/payer_insurance_plan_validation_test.rb

@@ -0,0 +1,39 @@
+require_relative '../../../validation_test'
+
+module DaVinciUSDrugFormularyTestKit
+  module DaVinciUSDrugFormularyV201
+    class PayerInsurancePlanValidationTest < Inferno::Test
+      include DaVinciUSDrugFormularyTestKit::ValidationTest
+
+      id :usdf_v201_payer_insurance_plan_validation_test
+      title 'InsurancePlan resources returned during previous tests conform to the Payer Insurance Plan profile'
+      description %(
+This test verifies resources returned from the first search conform to
+the [Payer Insurance Plan profile](http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PayerInsurancePlan).
+
+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
+        'InsurancePlan'
+      end
+
+      def scratch_resources
+        scratch[:payer_insurance_plan_resources] ||= {}
+      end
+
+      run do
+        perform_validation_test(scratch_resources[:all] || [],
+                                'http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PayerInsurancePlan',
+                                '2.0.1')
+      end
+    end
+  end
+end

data/lib/davinci_us_drug_formulary_test_kit/generated/v2.0.1/payer_insurance_plan_group.rb

@@ -0,0 +1,108 @@
+require_relative 'payer_insurance_plan/payer_insurance_plan_status_search_test'
+require_relative 'payer_insurance_plan/payer_insurance_plan_id_search_test'
+require_relative 'payer_insurance_plan/payer_insurance_plan_lastupdated_search_test'
+require_relative 'payer_insurance_plan/payer_insurance_plan_identifier_search_test'
+require_relative 'payer_insurance_plan/payer_insurance_plan_period_search_test'
+require_relative 'payer_insurance_plan/payer_insurance_plan_type_search_test'
+require_relative 'payer_insurance_plan/payer_insurance_plan_name_search_test'
+require_relative 'payer_insurance_plan/payer_insurance_plan_coverage_type_search_test'
+require_relative 'payer_insurance_plan/payer_insurance_plan_formulary_coverage_search_test'
+require_relative 'payer_insurance_plan/payer_insurance_plan_coverage_area_search_test'
+require_relative 'payer_insurance_plan/payer_insurance_plan_read_test'
+require_relative 'payer_insurance_plan/payer_insurance_plan_formulary_coverage_include_search_test'
+require_relative 'payer_insurance_plan/payer_insurance_plan_validation_test'
+require_relative 'payer_insurance_plan/payer_insurance_plan_must_support_test'
+require_relative 'payer_insurance_plan/payer_insurance_plan_reference_resolution_test'
+
+module DaVinciUSDrugFormularyTestKit
+  module USDFV201
+    class PayerInsurancePlanGroup < Inferno::TestGroup
+      title 'Payer Insurance Plan Tests'
+      short_description 'Verify support for the server capabilities required by the Payer Insurance Plan.'
+      description %(
+# Background
+
+The USDF Payer Insurance Plan sequence verifies that the system under test is
+able to provide correct responses for InsurancePlan queries. These queries
+must contain resources conforming to the Payer Insurance Plan as
+specified in the USDF v2.0.1 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:
+
+* status
+* _id
+* _lastUpdated
+* identifier
+* period
+* type
+* name
+* coverage-type
+* formulary-coverage
+* coverage-area
+
+### Search Parameters
+The first search uses the selected resources from the prior launch
+sequence. Any subsequent searches will look for its parameter values
+from the results of the first 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
+InsurancePlan 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).
+
+
+## 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 InsurancePlan resources found in the first test for these
+elements.
+
+## Profile Validation
+Each resource returned from the first search is expected to conform to
+the [Payer Insurance Plan](http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PayerInsurancePlan). 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 :usdf_v201_payer_insurance_plan
+      run_as_group
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'payer_insurance_plan', 'metadata.yml'), aliases: true))
+      end
+  
+      test from: :usdf_v201_payer_insurance_plan_status_search_test
+      test from: :usdf_v201_payer_insurance_plan__id_search_test
+      test from: :usdf_v201_payer_insurance_plan__lastUpdated_search_test
+      test from: :usdf_v201_payer_insurance_plan_identifier_search_test
+      test from: :usdf_v201_payer_insurance_plan_period_search_test
+      test from: :usdf_v201_payer_insurance_plan_type_search_test
+      test from: :usdf_v201_payer_insurance_plan_name_search_test
+      test from: :usdf_v201_payer_insurance_plan_coverage_type_search_test
+      test from: :usdf_v201_payer_insurance_plan_formulary_coverage_search_test
+      test from: :usdf_v201_payer_insurance_plan_coverage_area_search_test
+      test from: :usdf_v201_payer_insurance_plan_read_test
+      test from: :usdf_v201_payer_insurance_plan_formulary_coverage_include_search_test
+      test from: :usdf_v201_payer_insurance_plan_validation_test
+      test from: :usdf_v201_payer_insurance_plan_must_support_test
+      test from: :usdf_v201_payer_insurance_plan_reference_resolution_test
+    end
+  end
+end

data/lib/davinci_us_drug_formulary_test_kit/generated/v2.0.1/usdf_test_suite.rb

@@ -0,0 +1,114 @@
+require 'inferno/dsl/oauth_credentials'
+require_relative '../../version'
+require_relative '../../custom_groups/v2.0.1/capability_statement_group'
+require_relative 'payer_insurance_plan_group'
+require_relative 'formulary_group'
+require_relative 'basic_group'
+require_relative 'medication_knowledge_group'
+require_relative 'location_group'
+
+module DaVinciUSDrugFormularyTestKit
+  module USDFV201
+    class USDFTestSuite < Inferno::TestSuite
+      title 'Da Vinci US Drug Formulary v2.0.1'
+      short_title 'US Drug Formulary v2.0.1'
+      description %(
+        The Da Vinci US Drug Formulary Test Kit tests systems for their
+        conformance to the [US Drug Formulary Implementation Guide](https://hl7.org/fhir/us/davinci-drug-formulary/STU2.0.1/).
+
+        ## Instructions
+        In order to run the tests, provide the base URL of the FHIR server to
+        test, along with the IDs of Insurance Plan Location resources.
+        Credentials may optionally be provided if testing against a system which
+        requires authorization.
+
+        ## Scope
+        These tests check the following behaviors as defined in the IG:
+        - FHIR Interactions
+          - Conformance
+          - Read
+          - Search
+            - Individual search parameters
+            - _include searches
+        - FHIR Data
+          - Validation against IG profiles
+          - Presence of all Must Support fields
+            - Resolution of Must Support references
+
+        **Known Issues**
+        - Must Support checks are not performed for all elements of Formulary
+          Drug resources due to the use of an intensional value set for slicing
+          `MedicationKnowledge.code.coding` elements.
+        - The following search features are not tested:
+          - Combination searches
+          - Multiple Or
+          - Multiple And
+          - Comparators
+      )
+      version VERSION
+
+      VALIDATION_MESSAGE_FILTERS = [
+        %r{Sub-extension url 'introspect' is not defined by the Extension http://fhir-registry\.smarthealthit\.org/StructureDefinition/oauth-uris},
+        %r{Sub-extension url 'revoke' is not defined by the Extension http://fhir-registry\.smarthealthit\.org/StructureDefinition/oauth-uris},
+        /Observation\.effective\.ofType\(Period\): .*vs-1:/ # Invalid invariant in FHIR v4.0.1
+      ].freeze
+
+      VERSION_SPECIFIC_MESSAGE_FILTERS = [].freeze
+
+      def self.metadata
+        @metadata ||= YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true)[:groups].map do |raw_metadata|
+            Generator::GroupMetadata.new(raw_metadata)
+          end
+      end
+
+      validator do
+        url ENV.fetch('V201_VALIDATOR_URL', 'http://validator_service:4567')
+        message_filters = VALIDATION_MESSAGE_FILTERS + VERSION_SPECIFIC_MESSAGE_FILTERS
+
+        exclude_message do |message|
+
+          message_filters.any? { |filter| filter.match? message.message }
+        end
+
+        perform_additional_validation do |resource, profile_url|
+          ProvenanceValidator.validate(resource) if resource.instance_of?(FHIR::Provenance)
+        end
+      end
+
+      links [
+        {
+          label: 'Report Issue',
+          url: 'https://github.com/inferno-framework/davinci-us-drug-formulary-test-kit/issues'
+        },
+        {
+          label: 'Source Code',
+          url: 'https://github.com/inferno-framework/davinci-us-drug-formulary-test-kit'
+        }
+      ]
+
+
+      id :davinci_us_drug_formulary_v201
+
+      input :url,
+        title: 'FHIR Endpoint',
+        description: 'URL of the FHIR endpoint'
+      input :smart_credentials,
+        title: 'OAuth Credentials',
+        type: :oauth_credentials,
+        optional: true
+
+      fhir_client do
+        url :url
+        oauth_credentials :smart_credentials
+      end
+
+      group from: :usdf_v201_capability_statement
+  
+      group from: :usdf_v201_payer_insurance_plan
+      group from: :usdf_v201_formulary
+      group from: :usdf_v201_basic
+      group from: :usdf_v201_medication_knowledge
+      group from: :usdf_v201_location
+    end
+  end
+end