davinci_pdex_test_kit 0.10.6 → 0.12.0

data/lib/davinci_pdex_test_kit/pdex_payer_client_suite.rb

@@ -1,16 +1,15 @@
-require 'inferno/dsl/oauth_credentials'
-require_relative 'ext/inferno_core/record_response_route'
-require_relative 'ext/inferno_core/runnable'
-require_relative 'ext/inferno_core/request'
-require_relative 'urls'
-require_relative 'mock_server'
-require_relative 'tags'
+require_relative 'pdex_payer_client/urls'
+require_relative 'pdex_payer_client/tags'
 require_relative 'pdex_payer_client/collection'
-require_relative 'must_support_test'
-require_relative 'pdex_payer_client/client_validation_test'
+require_relative 'pdex_payer_client/mock_server'
+# require_relative 'must_support_test'
+# require_relative 'pdex_payer_client/client_validation_test'
 
-require_relative 'pdex_payer_client/clinical_data_request_tests/initial_wait_test'
-require_relative 'pdex_payer_client/clinical_data_request_tests/initial_scratch_storing'
+require_relative 'pdex_payer_client/client_workflow_interaction_test'
+require_relative 'pdex_payer_client/client_member_match_tests/client_member_match_validation_test'
+
+require_relative 'pdex_payer_client/clinical_data_request_tests/clinical_data_request_check_test'
+require_relative 'pdex_payer_client/clinical_data_request_tests/patient_id_search_request_check_test'
 require_relative 'pdex_payer_client/clinical_data_request_tests/allergyintolerance_clinical_data_request_test'
 require_relative 'pdex_payer_client/clinical_data_request_tests/careplan_clinical_data_request_test'
 require_relative 'pdex_payer_client/clinical_data_request_tests/careteam_clinical_data_request_test'
@@ -32,155 +31,111 @@ require_relative 'pdex_payer_client/clinical_data_request_tests/practitioner_cli
 require_relative 'pdex_payer_client/clinical_data_request_tests/practitionerrole_clinical_data_request_test'
 require_relative 'pdex_payer_client/clinical_data_request_tests/procedure_clinical_data_request_test'
 
-require_relative 'pdex_payer_client/client_member_match_tests/client_member_match_submit_test'
-require_relative 'pdex_payer_client/client_member_match_tests/client_member_match_validation_test'
-# require_relative 'pdex_payer_client/client_must_support_tests/client_member_match_must_support_submit_test'
-# require_relative 'pdex_payer_client/client_must_support_tests/client_member_match_must_support_validation_test'
-
-
 module DaVinciPDexTestKit
-    class PDexPayerClientSuite < Inferno::TestSuite
-      extend MockServer
-      extend ClientValidationTest
-
-      id :pdex_payer_client
-      title 'Da Vinci PDex Payer Client Test Suite'
-      description File.read(File.join(__dir__, 'docs', 'payer_client_suite_description_v200.md'))
-
-      def self.test_resumes?(test)
-        !test.config.options[:accepts_multiple_requests]
-      end
-      
-      links [
-        {
-          label: 'Report Issue',
-          url: 'https://github.com/inferno-framework/davinci-pdex-test-kit/issues'
-        },
-        {
-          label: 'Open Source',
-          url: 'https://github.com/inferno-framework/davinci-pdex-test-kit'
-        },
-        {
-          label: 'Download',
-          url: 'https://github.com/inferno-framework/davinci-pdex-test-kit/releases'
-        },
-        {
-          label: 'Implementation Guide',
-          url: 'https://hl7.org/fhir/us/davinci-pdex/STU2/'
-        }
-      ]
-
-      # Hl7 Validator Wrapper:
-      fhir_resource_validator do
-        igs 'hl7.fhir.us.davinci-pdex#2.0.0'
-        # hrex 1.0.0 and other dependencies will auto-load
-
-        exclude_message do |message|
-          message.message.match?(/\A\S+: \S+: URL value '.*' does not resolve/)
-        end
+  class PDexPayerClientSuite < Inferno::TestSuite
+    include PDexPayerClient
+    include PDexPayerClient::URLs
+    include PDexPayerClient::MockServer
+
+    id :pdex_payer_client
+    title 'Da Vinci PDex Payer Client Test Suite'
+    description File.read(File.join(__dir__, 'docs', 'payer_client_suite_description_v200.md'))
+
+    links [
+      {
+        label: 'Report Issue',
+        url: 'https://github.com/inferno-framework/davinci-pdex-test-kit/issues'
+      },
+      {
+        label: 'Open Source',
+        url: 'https://github.com/inferno-framework/davinci-pdex-test-kit'
+      },
+      {
+        label: 'Download',
+        url: 'https://github.com/inferno-framework/davinci-pdex-test-kit/releases'
+      },
+      {
+        label: 'Implementation Guide',
+        url: 'https://hl7.org/fhir/us/davinci-pdex/STU2/'
+      }
+    ]
+
+    # Hl7 Validator Wrapper:
+    fhir_resource_validator do
+      igs 'hl7.fhir.us.davinci-pdex#2.0.0'
+      # hrex 1.0.0 and other dependencies will auto-load
+
+      exclude_message do |message|
+        message.message.match?(/\A\S+: \S+: URL value '.*' does not resolve/)
       end
+    end
 
-      record_response_route :post, TOKEN_PATH, AUTH_TAG, method(:token_response) do |request|
-        PDexPayerClientSuite.extract_client_id(request)
-      end
+    resume_test_route :get, RESUME_PASS_PATH do |request|
+      PDexPayerClientSuite.extract_token_from_query_params(request)
+    end
 
-      record_response_route :get, PATIENT_PATH, SUBMIT_TAG, method(:claim_response), # Patient needs a specific definition
-                            resumes: method(:test_resumes?) do |request|
-        PDexPayerClientSuite.extract_bearer_token(request)
-      end
+    resume_test_route :get, RESUME_CLINICAL_DATA_PATH do |request|
+      PDexPayerClientSuite.extract_token_from_query_params(request)
+    end
 
-      record_response_route :get, SUBMIT_PATH, SUBMIT_TAG, method(:claim_response),
-                            resumes: method(:test_resumes?) do |request|
-        PDexPayerClientSuite.extract_bearer_token(request)
-      end
+    resume_test_route :get, RESUME_FAIL_PATH, result: 'fail' do |request|
+      PDexPayerClientSuite.extract_token_from_query_params(request)
+    end
 
-      record_response_route :get, BINARY_PATH, BINARY_TAG, method(:binary_read_response),
-                            resumes: method(:test_resumes?) do |request|
-        PDexPayerClientSuite.extract_bearer_token(request)
-      end
+    group do
+      run_as_group
+      title 'Workflow Tests'
+      id :payer_to_payer_workflow
 
-      record_response_route :get, EVERYTHING_PATH, EVERYTHING_TAG, method(:everything_response),
-                            resumes: method(:test_resumes?) do |request|
-        PDexPayerClientSuite.extract_bearer_token(request)
-      end
+      group do
+        title 'Interaction Tests'
+        id :client_workflow_interaction
 
-      record_response_route :get, EXPORT_PATH, EXPORT_TAG, method(:export_response),
-                            resumes: method(:test_resumes?) do |request|
-        PDexPayerClientSuite.extract_bearer_token(request)
+        test from: :pdex_client_workflow_interaction
       end
 
-      record_response_route :get, EXPORT_STATUS_PATH, EXPORT_STATUS_TAG, method(:export_status_response),
-                            resumes: method(:test_resumes?) do |request|
-        PDexPayerClientSuite.extract_bearer_token(request)
-      end
+      group do
+        title '$member-match validation'
+        id :member_match_validation
 
-      record_response_route :post, MEMBER_MATCH_PATH, MEMBER_MATCH_TAG, method(:member_match_response),
-                            resumes: method(:test_resumes?) do |request|
-        PDexPayerClientSuite.extract_bearer_token(request)
+        test from: :pdex_initial_member_match_validation
       end
 
-      record_response_route :get, BASE_FHIR_PATH, SUBMIT_TAG, method(:read_next_page),
-                            resumes: method(:test_resumes?) do |request|
-        PDexPayerClientSuite.extract_bearer_token(request)
-      end
-  
-      resume_test_route :get, RESUME_PASS_PATH do |request|
-        PDexPayerClientSuite.extract_token_from_query_params(request)
+      group do
+        title 'Clinical data request validation'
+        id :clinical_data_validation
+
+        test from: :pdex_clinical_data_request_check
+        test from: :pdex_patient_id_search_request_check
+        test from: :pdex_allergyintolerance_clinical_data_request
+        test from: :pdex_careplan_clinical_data_request
+        test from: :pdex_careteam_clinical_data_request
+        test from: :pdex_condition_clinical_data_request
+        test from: :pdex_device_clinical_data_request
+        test from: :pdex_diagnosticreport_clinical_data_request
+        test from: :pdex_documentreference_clinical_data_request
+        test from: :pdex_encounter_clinical_data_request
+        test from: :pdex_explanationofbenefit_clinical_data_request
+        test from: :pdex_goal_clinical_data_request
+        test from: :pdex_immunization_clinical_data_request
+        test from: :pdex_location_clinical_data_request
+        test from: :pdex_medicationdispense_clinical_data_request
+        test from: :pdex_medicationrequest_clinical_data_request
+        test from: :pdex_observation_clinical_data_request
+        test from: :pdex_organization_clinical_data_request
+        test from: :pdex_patient_clinical_data_request
+        test from: :pdex_practitioner_clinical_data_request
+        test from: :pdex_practitionerrole_clinical_data_request
+        test from: :pdex_procedure_clinical_data_request
       end
+    end
 
-      resume_test_route :get, RESUME_CLINICAL_DATA_PATH do |request|
-        PDexPayerClientSuite.extract_token_from_query_params(request)
-      end
-  
-      resume_test_route :get, RESUME_FAIL_PATH, result: 'fail' do |request|
-        PDexPayerClientSuite.extract_token_from_query_params(request)
-      end
+    # TODO: must support validation
 
-      route(:get, METADATA_PATH, get_metadata)
+    private
 
-      group do
-        run_as_group
-        title "Workflow Tests"
-        group do
-          title "$member-match validation"
-          test from: :initial_member_match_submit_test
-          test from: :initial_member_match_validation_test
-        end
-        group do
-          title "Clinical data request tests"
-          test from: :initial_wait_test
-          test from: :initial_scratch_storing
-          test from: :allergyintolerance_clinical_data_request_test
-          test from: :careplan_clinical_data_request_test
-          test from: :careteam_clinical_data_request_test
-          test from: :condition_clinical_data_request_test
-          test from: :device_clinical_data_request_test
-          test from: :diagnosticreport_clinical_data_request_test
-          test from: :documentreference_clinical_data_request_test
-          test from: :encounter_clinical_data_request_test
-          test from: :explanationofbenefit_clinical_data_request_test
-          test from: :goal_clinical_data_request_test
-          test from: :immunization_clinical_data_request_test
-          test from: :location_clinical_data_request_test
-          test from: :medicationdispense_clinical_data_request_test
-          test from: :medicationrequest_clinical_data_request_test
-          test from: :observation_clinical_data_request_test
-          test from: :organization_clinical_data_request_test
-          test from: :patient_clinical_data_request_test
-          test from: :practitioner_clinical_data_request_test
-          test from: :practitionerrole_clinical_data_request_test
-          test from: :procedure_clinical_data_request_test
-        end
-      end
-      
-      # group do
-      #   title "Must Support validation"
-      #   group do
-      #     title "$member-match Must Support tests"
-      #     test from: :initial_member_match_must_support_submit_test
-      #     test from: :initial_member_match_must_support_validation_test
-      #   end
-      # end
+    def self.extract_token_from_query_params(request)
+      request.query_parameters['token']
     end
   end
-  
+end

data/lib/davinci_pdex_test_kit/pdex_payer_server/coverage_to_link_minimal_data_validation.rb

@@ -28,7 +28,7 @@ module DaVinciPDexTestKit
     #
     class CoverageToLinkMinimalDataValidation < Inferno::Test
 
-      id :pdex_coverage_to_link_minimal_data_validation
+      id :pdex_coverage_to_link_minimal_validation
       title '[USER INPUT VALIDATION] CoverageToLink parameter should not include any data elements not marked as mustSupport'
       optional
       description %{

data/lib/davinci_pdex_test_kit/pdex_payer_server/coverage_to_link_must_support_validation.rb

@@ -29,7 +29,7 @@ module DaVinciPDexTestKit
     #
     class CoverageToLinkMustSupportValidation < Inferno::Test
 
-      id :pdex_coverage_to_link_must_support_validation
+      id :pdex_coverage_to_link_ms_validation
       title '[USER INPUT VALIDATION] CoverageToLink parameter is optional for generic FHIR clients, but required for Payer systems.'
       description 'See [CoverageToLink parameter documentation](https://hl7.org/fhir/us/davinci-hrex/STU1/OperationDefinition-member-match.html).'
       optional

data/lib/davinci_pdex_test_kit/pdex_payer_server/device/device_must_support_test.rb

@@ -0,0 +1,50 @@
+require 'us_core_test_kit/must_support_test'
+require 'us_core_test_kit/generator/group_metadata'
+
+module DaVinciPDexTestKit
+  module PDexPayerServer
+    class DeviceMustSupportTest < Inferno::Test
+      include USCoreTestKit::MustSupportTest
+
+      title 'All must support elements are provided in the Device resources returned'
+      description %(
+        PDex Responders SHALL be capable of populating all data elements as
+        part of the query results as specified by the PDex Server Capability
+        Statement. This test will look through the Device resources
+        found previously for the following must support elements:
+
+        * Device.distinctIdentifier
+        * Device.expirationDate
+        * Device.lotNumber
+        * Device.patient
+        * Device.serialNumber
+        * Device.status
+        * Device.type
+        * Device.udiCarrier
+        * Device.udiCarrier.carrierAIDC
+        * Device.udiCarrier.carrierHRF
+        * Device.udiCarrier.deviceIdentifier
+        * Device.url
+      )
+
+      id :pdex_device_must_support
+
+      def resource_type
+        'Device'
+      end
+
+      def self.metadata
+        @metadata ||= USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'),
+                                                                                 aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:device_resources] ||= {}
+      end
+
+      run do
+        perform_must_support_test(all_scratch_resources)
+      end
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/pdex_payer_server/device/device_patient_search_test.rb

@@ -0,0 +1,68 @@
+require 'us_core_test_kit/search_test'
+require 'us_core_test_kit/search_test_properties'
+require 'us_core_test_kit/generator/group_metadata'
+
+module DaVinciPDexTestKit
+  module PDexPayerServer
+    class DevicePatientSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Device search by patient'
+      description %(
+        A server SHALL support searching by
+        patient on the Device 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 PDex 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 PDex v2.0.0.
+
+        [PDex Server CapabilityStatement](https://hl7.org/fhir/us/davinci-pdex/STU2/CapabilityStatement-pdex-server.html)
+      )
+
+      id :pdex_device_patient_search
+      input :patient_ids,
+            title: 'Patient IDs',
+            description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+
+      input :implantable_device_codes,
+            title: 'Implantable Device Type Code',
+            description: 'Enter the code for an Implantable Device type, or multiple codes separated by commas. ' \
+                         'If blank, Inferno will validate all Device resources against the Implantable Device profile',
+            optional: true
+
+      def self.properties
+        @properties ||= USCoreTestKit::SearchTestProperties.new(
+          first_search: true,
+          resource_type: 'Device',
+          search_param_names: ['patient'],
+          test_reference_variants: true,
+          test_post_search: true
+        )
+      end
+
+      def self.metadata
+        @metadata ||= USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'),
+                                                                                 aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:device_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/pdex_payer_server/device/device_patient_type_search_test.rb

@@ -0,0 +1,54 @@
+require 'us_core_test_kit/search_test'
+require 'us_core_test_kit/generator/group_metadata'
+
+module DaVinciPDexTestKit
+  module PDexPayerServer
+    class DevicePatientTypeSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Device search by patient + type'
+      description %(
+        A server SHOULD support searching by
+        patient + type on the Device resource. This test
+        will pass if resources are returned and match the search criteria. If
+        none are returned, the test is skipped.
+
+        [PDex Server CapabilityStatement](https://hl7.org/fhir/us/davinci-pdex/STU2/CapabilityStatement-pdex-server.html)
+      )
+
+      id :pdex_device_patient_type_search
+      optional
+
+      input :patient_ids,
+            title: 'Patient IDs',
+            description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+
+      input :implantable_device_codes,
+            title: 'Implantable Device Type Code',
+            description: 'Enter the code for an Implantable Device type, or multiple codes separated by commas. ' \
+                         'If blank, Inferno will validate all Device resources against the Implantable Device profile',
+            optional: true
+
+      def self.properties
+        @properties ||= USCoreTestKit::SearchTestProperties.new(
+          resource_type: 'Device',
+          search_param_names: ['patient', 'type'],
+          token_search_params: ['type']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'),
+                                                                                 aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:device_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/pdex_payer_server/{explanation_of_benefit/explanation_of_benefit_provenance_revinclude_search_test.rb → device/device_provenance_revinclude_search_test.rb}

@@ -2,12 +2,12 @@ require 'us_core_test_kit/search_test'
 require 'us_core_test_kit/search_test_properties'
 require 'us_core_test_kit/generator/group_metadata'
 
-module USCoreTestKit
-  module USCoreV311
-    class ExplanationOfBenefitProvenanceRevincludeSearchTest < Inferno::Test
+module DaVinciPDexTestKit
+  module PDexPayerServer
+    class DeviceProvenanceRevincludeSearchTest < Inferno::Test
       include USCoreTestKit::SearchTest
 
-      title 'Server returns Provenance resources from ExplanationOfBenefit search by patient + revInclude:Provenance:target'
+      title 'Server returns Provenance resources from Device search by patient + revInclude:Provenance:target'
       description %(
         A server SHALL be capable of supporting _revIncludes:Provenance:target.
 
@@ -15,16 +15,16 @@ module USCoreTestKit
         will pass if a Provenance resource is found in the response.
       %)
 
-      id :pdex_explanation_of_benefit_provenance_revinclude_search_test
-  
+      id :pdex_device_provenance_revinclude_search
+
       input :patient_ids,
-        title: 'Patient IDs',
-        description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
-  
+            title: 'Patient IDs',
+            description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+
       def properties
         @properties ||= USCoreTestKit::SearchTestProperties.new(
-          resource_type: 'ExplanationOfBenefit',
-        search_param_names: ['patient']
+          resource_type: 'Device',
+          search_param_names: ['patient']
         )
       end
 
@@ -33,11 +33,14 @@ module USCoreTestKit
       end
 
       def self.provenance_metadata
-        @provenance_metadata ||= USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, '..', 'provenance', 'metadata.yml'), aliases: true))
+        @provenance_metadata ||= USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(
+                                                                               File.join(__dir__, '..', 'provenance',
+                                                                                         'metadata.yml'), aliases: true
+                                                                             ))
       end
 
       def scratch_resources
-        scratch[:explanation_of_benefit_resources] ||= {}
+        scratch[:device_resources] ||= {}
       end
 
       def scratch_provenance_resources

data/lib/davinci_pdex_test_kit/pdex_payer_server/device/device_read_test.rb

@@ -0,0 +1,26 @@
+require 'us_core_test_kit/read_test'
+
+module DaVinciPDexTestKit
+  module PDexPayerServer
+    class DeviceReadTest < Inferno::Test
+      include USCoreTestKit::ReadTest
+
+      title 'Server returns correct Device resource from Device read interaction'
+      description 'A server SHALL support the Device read interaction.'
+
+      id :pdex_device_read
+
+      def resource_type
+        'Device'
+      end
+
+      def scratch_resources
+        scratch[:device_resources] ||= {}
+      end
+
+      run do
+        perform_read_test(all_scratch_resources)
+      end
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/pdex_payer_server/device/device_reference_resolution_test.rb

@@ -0,0 +1,42 @@
+require 'us_core_test_kit/reference_resolution_test'
+require 'us_core_test_kit/generator/group_metadata'
+
+module DaVinciPDexTestKit
+  module PDexPayerServer
+    class DeviceReferenceResolutionTest < Inferno::Test
+      include USCoreTestKit::ReferenceResolutionTest
+
+      title 'MustSupport references within Device 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 PDex profile.
+
+        Elements which may provide external references include:
+
+        * Device.patient
+      )
+
+      id :pdex_device_ref_resolution
+
+      def resource_type
+        'Device'
+      end
+
+      def self.metadata
+        @metadata ||= USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'),
+                                                                                 aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:device_resources] ||= {}
+      end
+
+      run do
+        perform_reference_resolution_test(scratch_resources[:all])
+      end
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/pdex_payer_server/device/device_validation_test.rb

@@ -0,0 +1,39 @@
+require 'us_core_test_kit/validation_test'
+
+module DaVinciPDexTestKit
+  module PDexPayerServer
+    class DeviceValidationTest < Inferno::Test
+      include USCoreTestKit::ValidationTest
+
+      id :pdex_device_validation
+      title 'Device resources returned during previous tests conform to the PDex Device'
+      description %(
+        This test verifies resources returned from the first search conform to
+        the [PDex Device](http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-device).
+        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
+        'Device'
+      end
+
+      def scratch_resources
+        scratch[:device_resources] ||= {}
+      end
+
+      run do
+        perform_validation_test(scratch_resources[:all] || [],
+                                'http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-device',
+                                '2.0.0',
+                                skip_if_empty: true)
+      end
+    end
+  end
+end