davinci_pdex_test_kit 0.9.1

data/lib/davinci_pdex_test_kit/pdex_payer_server_suite.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require_relative 'pdex_payer_server/workflow_member_match'
+require_relative 'pdex_payer_server/workflow_clinical_data'
+require_relative 'pdex_payer_server/workflow_everything'
+require_relative 'pdex_payer_server/workflow_export'
+
+require_relative 'pdex_payer_server/no_member_matches_group'
+require_relative 'pdex_payer_server/multiple_member_matches_group'
+
+require_relative 'pdex_payer_server/explanation_of_benefit_group'
+
+module DaVinciPDexTestKit
+    class PDexPayerServerSuite < Inferno::TestSuite
+      id :pdex_payer_server
+      title 'Da Vinci PDex Payer Server Test Suite'
+      description File.read(File.join(__dir__, 'docs', 'payer_server_suite_description_v200.md'))
+  
+      input :url,
+            title: 'FHIR Server Base Url'
+  
+      input :credentials,
+            title: 'OAuth Credentials',
+            type: :oauth_credentials,
+            optional: true
+  
+      fhir_client do
+        url :url
+        oauth_credentials :credentials
+      end
+
+      VALIDATION_MESSAGE_FILTERS = [
+        /Observation\.effective\.ofType\(Period\): .*vs-1:/, # Invalid invariant in FHIR v4.0.1
+        /\A\S+: \S+: URL value '.*' does not resolve/
+      ].freeze
+
+      VERSION_SPECIFIC_MESSAGE_FILTERS = [].freeze
+  
+      validator do
+        url ENV.fetch('VALIDATOR_URL')
+
+        # Copy messages limit from Bulk Data Export tests
+        message_filters = VALIDATION_MESSAGE_FILTERS + VERSION_SPECIFIC_MESSAGE_FILTERS
+
+        $num_messages = 0
+        $capped_message = false
+        $num_errors = 0
+        $capped_errors = false
+
+        exclude_message do |message|
+          matches_filter = message_filters.any? { |filter| filter.match? message.message }
+
+          unless matches_filter
+            if message.type != 'error'
+              $num_messages += 1
+            else
+              $num_errors += 1
+            end
+          end
+
+           matches_filter ||
+            (message.type != 'error' && $num_messages > 50 && !message.message.include?('Inferno is only showing the first')) ||
+            (message.type == 'error' && $num_errors > 20 && !message.message.include?('Inferno is only showing the first'))
+        end
+
+        perform_additional_validation do
+          if $num_messages > 50 && !$capped_message
+            $capped_message = true
+            { type: 'info', message: 'Inferno is only showing the first 50 validation info and warning messages.' }
+          elsif $num_errors > 20 && !$capped_errors
+            $capped_errors = true
+            { type: 'error', message: 'Inferno is only showing the first 20 validation error messages.' }
+          end
+        end
+      end
+
+      group do
+        title 'Payer to Payer Workflow'
+        id :payer_to_payer_workflow
+        description %(
+          # Background
+
+          This Payer to Payer Workflow test sequence is designed to simulate a realistic use case for
+          data access on a Payer's FHIR Server. This workflow conforms to the Da Vinci
+          [Payer Data Exchange (PDex) v2.0.0 Implementation Guide](https://hl7.org/fhir/us/davinci-pdex/STU2/),
+          which itself relies on
+          [Health Record Exchange (HRex) v1.0.0 Implementation Guide](https://hl7.org/fhir/us/davinci-hrex/index.html)
+          and [US Core v3.1.1 Implementation Guide](http://hl7.org/fhir/us/core/STU3.1.1/). The PDex Implementation Guide contains more on
+          the [business use case background](https://hl7.org/fhir/us/davinci-pdex/STU2/index.html#background), and the specific
+          [payer-to-payer workflow](https://hl7.org/fhir/us/davinci-pdex/STU2/payertopayerexchange.html).
+
+          # Testing Methodology
+
+          This workflow is broken into four parts:
+
+          1. Send a `$member-match` request to the Server to identify a Patient based on Payer's coverage plan and Patient consent.
+
+          2. Use the identified Patient to query for specific clinical data.
+
+          3. **Optional.** Send an `$everything` request to the server to query for all relevant clinical data on the Patient.
+
+          4. **Optional.** Send an `$export` request to the server to query for all relevant clinical data on the Patient asynchronously.
+
+          See the corresponding test group's description for the testing methodology of each part.
+        )
+
+        group from: :workflow_member_match
+        group from: :workflow_clinical_data
+        group from: :workflow_everything
+        group from: :workflow_export
+      end
+
+      group do
+        title 'API Capability and Must Support Coverage'
+        id :api_and_must_support_coverage
+        
+        group do
+          title '$member-match failure cases'
+          id :member_match_failure_cases
+          description %{
+            # Background
+            
+            This test sequence is for the negative results specification in
+            [member matching logic](http://hl7.org/fhir/us/davinci-hrex/STU1/OperationDefinition-member-match.html#member-matching-logic)
+            from HRex 1.0.0 Implementation Guide, and is required by the PDex 2.0.0 Implementation Guide.
+
+            # Testing Methodology
+
+            1. If provided, attempt no-match member match operation
+              + validate input
+              + POST request to server and validiate HTTP 422 response status
+            2. If provided, attempt a multiple-match member match operation
+              + validate input
+              + POST request to server and validiate HTTP 422 response status
+          }
+
+          input_order :url, :credentials, :no_member_match_request, :multiple_member_match_request
+
+          group from: :no_member_matches_group
+          group from: :multiple_member_matches_group
+        end
+
+        group do
+          title 'PDEX Search and Read API (US Core plus additional PDex resource types)' 
+          id :search_and_read_api_coverage
+          
+          group from: :pdex_explanation_of_benefit
+          # Import all US Core v3.1.1 groups without the Suite
+          Dir.glob(File.join($LOAD_PATH.find { |x| x.match? "us_core_test_kit" }, 'us_core_test_kit/generated/v3.1.1/*_group.rb')).each do |test_group_path|
+            require_relative test_group_path
+
+            group from: "us_core_v311_#{File.basename(test_group_path).gsub('_group.rb','')}".to_sym
+          end
+        end
+      end
+
+    end
+end

data/lib/davinci_pdex_test_kit/pdex_provider_client_suite.rb

@@ -0,0 +1,36 @@
+module DaVinciPDexTestKit
+    class PDexProviderClientSuite < Inferno::TestSuite
+      id :pdex_provider_client
+      title 'Da Vinci PDex Provider Client Test Suite'
+      description %(
+        # Da Vinci PDex Provider Client Test Suite
+
+        This suite validates that a provider system can act as a client
+        retrieving patient data from a payer system using
+        the APIs described in the PDex implementation
+        guide. Inferno will act as a payer server that the 
+        system under test will connect to and retrieve data from.
+      )
+  
+      # These inputs will be available to all tests in this suite
+      input :url,
+            title: 'FHIR Server Base Url'
+  
+      input :credentials,
+            title: 'OAuth Credentials',
+            type: :oauth_credentials,
+            optional: true
+  
+      # All FHIR requests in this suite will use this FHIR client
+      fhir_client do
+        url :url
+        oauth_credentials :credentials
+      end
+  
+      # All FHIR validation requsets will use this FHIR validator
+      validator do
+        url ENV.fetch('VALIDATOR_URL')
+      end
+    end
+  end
+  

data/lib/davinci_pdex_test_kit/tags.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DaVinciPDexTestKit
+  AUTH_TAG = 'pdex_auth'
+  SUBMIT_TAG = 'pdex_submit'
+  # EXPORT_TAG = 'pdex_export'
+  EVERYTHING_TAG = 'pdex_everything'
+  MEMBER_MATCH_TAG = 'pdex_member_match'
+end

data/lib/davinci_pdex_test_kit/urls.rb

@@ -0,0 +1,67 @@
+module DaVinciPDexTestKit
+  TOKEN_PATH = '/mock_auth/token'
+  PATIENT_PATH = '/fhir/Patient'
+  SUBMIT_PATH = '/fhir/:endpoint'
+  METADATA_PATH = '/fhir/metadata'
+  EVERYTHING_PATH = '/fhir/Patient/:patient/$everything'
+  MEMBER_MATCH_PATH = '/fhir/Patient/$member-match'
+  # EXPORT_PATH = '/fhir/Patient/$export'
+  BASE_FHIR_PATH = '/fhir'
+  RESUME_PASS_PATH = '/resume_pass'
+  RESUME_CLINICAL_DATA_PATH = '/resume_clinical_data'
+  RESUME_FAIL_PATH = '/resume_fail'
+
+  module URLs
+    def base_url
+      @base_url ||= "#{Inferno::Application['base_url']}/custom/#{suite_id}"
+    end
+
+    def token_url
+      @token_url ||= base_url + TOKEN_PATH
+    end
+    
+    def base_fhir_url
+      @base_fhir_url ||= base_url + BASE_FHIR_PATH
+    end
+
+    def patient_url
+      @patient_url ||= base_url + PATIENT_PATH
+    end
+
+    def submit_url
+      @submit_url ||= base_url + SUBMIT_PATH
+    end
+
+    def metadata_url
+      @metadata_url ||= base_url + METADATA_PATH
+    end
+
+    def everything_url
+      @everything_url ||= base_url + EVERYTHING_PATH
+    end
+
+    def member_match_url
+      @member_match_url ||= base_url + MEMBER_MATCH_PATH
+    end
+
+    # def export_url
+    #   @export_url ||= base_url + EXPORT_PATH
+    # end
+
+    def resume_pass_url
+      @resume_pass_url ||= base_url + RESUME_PASS_PATH
+    end
+
+    def resume_clinical_data_url
+      @resume_clinical_data_url ||= base_url + RESUME_CLINICAL_DATA_PATH
+    end
+
+    def resume_fail_url
+      @resume_fail_url ||= base_url + RESUME_FAIL_PATH
+    end
+
+    def suite_id
+      self.class.suite.id
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/user_input_response.rb

@@ -0,0 +1,32 @@
+module DaVinciPDexTestKit
+  module UserInputResponse
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    def self.user_inputted_response(configurable, result)
+      input_key = configurable.config.options[:respond_with]
+      return unless input_key.present?
+
+      JSON.parse(result.input_json)&.find { |i| i['name'] == input_key.to_s }&.dig('value')
+    rescue JSON::ParserError
+      nil
+    end
+
+    def check_user_inputted_response(input_key, message = nil)
+      skip_if send(input_key).blank?,
+              message ||
+              "To run this test a response body must be provided in the '**#{input_title(input_key)}**' input"
+    end
+
+    def input_title(input_key)
+      config.inputs[input_key]&.title || config.inputs[input_key]&.name
+    end
+
+    module ClassMethods
+      def respond_with(key)
+        config options: { respond_with: key }
+      end
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DaVinciPDexTestKit
+  VERSION = '0.9.1'
+end

data/lib/davinci_pdex_test_kit.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'davinci_pdex_test_kit/pdex_payer_server_suite'
+require_relative 'davinci_pdex_test_kit/pdex_payer_client_suite'
+# require_relative 'davinci_pdex_test_kit/pdex_provider_client_suite'
+
+module DaVinciPDexTestKit
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: davinci_pdex_test_kit
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+platform: ruby
+authors:
+- Karl Naden
+- Shaumik Ashraf
+- Diego Griese
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inferno_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.38
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.38
+- !ruby/object:Gem::Dependency
+  name: us_core_test_kit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.5
+- !ruby/object:Gem::Dependency
+  name: bulk_data_test_kit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+description: Test Kit for the Da Vinci Payer Data Exchange (PDex) FHIR Implementation
+  Guide
+email:
+- inferno@groups.mitre.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/davinci_pdex_test_kit.rb
+- lib/davinci_pdex_test_kit/docs/payer_client_suite_description_v200.md
+- lib/davinci_pdex_test_kit/docs/payer_server_suite_description_v200.md
+- lib/davinci_pdex_test_kit/ext/inferno_core/record_response_route.rb
+- lib/davinci_pdex_test_kit/ext/inferno_core/request.rb
+- lib/davinci_pdex_test_kit/ext/inferno_core/runnable.rb
+- lib/davinci_pdex_test_kit/fhir_resource_navigation.rb
+- lib/davinci_pdex_test_kit/group_metadata.rb
+- lib/davinci_pdex_test_kit/metadata/mock_capability_statement.json
+- lib/davinci_pdex_test_kit/metadata/mock_operation_outcome_resource.json
+- lib/davinci_pdex_test_kit/mock_server.rb
+- lib/davinci_pdex_test_kit/must_support_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/client_member_match_tests/client_member_match_submit_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/client_member_match_tests/client_member_match_validation_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/client_must_support_tests/client_member_match_must_support_submit_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/client_must_support_tests/client_member_match_must_support_validation_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/client_validation_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/clinical_data_request_tests/allergyintolerance_clinical_data_request_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/clinical_data_request_tests/careplan_clinical_data_request_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/clinical_data_request_tests/careteam_clinical_data_request_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/clinical_data_request_tests/condition_clinical_data_request_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/clinical_data_request_tests/device_clinical_data_request_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/clinical_data_request_tests/diagnosticreport_clinical_data_request_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/clinical_data_request_tests/documentreference_clinical_data_request_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/clinical_data_request_tests/encounter_clinical_data_request_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/clinical_data_request_tests/explanationofbenefit_clinical_data_request_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/clinical_data_request_tests/goal_clinical_data_request_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/clinical_data_request_tests/immunization_clinical_data_request_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/clinical_data_request_tests/initial_scratch_storing.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/clinical_data_request_tests/initial_wait_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/clinical_data_request_tests/location_clinical_data_request_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/clinical_data_request_tests/medicationdispense_clinical_data_request_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/clinical_data_request_tests/medicationrequest_clinical_data_request_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/clinical_data_request_tests/observation_clinical_data_request_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/clinical_data_request_tests/organization_clinical_data_request_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/clinical_data_request_tests/patient_clinical_data_request_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/clinical_data_request_tests/practitioner_clinical_data_request_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/clinical_data_request_tests/practitionerrole_clinical_data_request_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/clinical_data_request_tests/procedure_clinical_data_request_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client/collection.rb
+- lib/davinci_pdex_test_kit/pdex_payer_client_suite.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/abstract_member_match_request_conformance_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/abstract_member_match_request_local_references_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/coverage_to_link_has_minimal_data_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/coverage_to_link_must_support_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/explanation_of_benefit/explanation_of_benefit_id_search_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/explanation_of_benefit/explanation_of_benefit_identifier_search_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/explanation_of_benefit/explanation_of_benefit_must_support_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/explanation_of_benefit/explanation_of_benefit_patient_last_updated_search_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/explanation_of_benefit/explanation_of_benefit_patient_service_date_search_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/explanation_of_benefit/explanation_of_benefit_patient_type_search_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/explanation_of_benefit/explanation_of_benefit_patient_use_search_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/explanation_of_benefit/explanation_of_benefit_provenance_revinclude_search_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/explanation_of_benefit/explanation_of_benefit_read_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/explanation_of_benefit/explanation_of_benefit_reference_resolution_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/explanation_of_benefit/explanation_of_benefit_validation_test.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/explanation_of_benefit_group.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/export_patient_group.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/export_validation_group.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/multiple_member_matches_group.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/no_member_matches_group.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/workflow_clinical_data.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/workflow_everything.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/workflow_export.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server/workflow_member_match.rb
+- lib/davinci_pdex_test_kit/pdex_payer_server_suite.rb
+- lib/davinci_pdex_test_kit/pdex_provider_client_suite.rb
+- lib/davinci_pdex_test_kit/tags.rb
+- lib/davinci_pdex_test_kit/urls.rb
+- lib/davinci_pdex_test_kit/user_input_response.rb
+- lib/davinci_pdex_test_kit/version.rb
+homepage: https://github.com/inferno-framework/davinci-pdex-test-kit/
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/inferno-framework/davinci-pdex-test-kit/
+  source_code_uri: https://github.com/inferno-framework/davinci-pdex-test-kit/
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Da Vinci PDex Test Kit
+test_files: []