carin_for_blue_button_test_kit 0.12.1 → 0.13.0

data/lib/carin_for_blue_button_test_kit/client/v2.0.0/mock_server.rb

@@ -0,0 +1,190 @@
+require_relative 'user_input_response'
+require_relative 'urls'
+require_relative 'collection'
+require_relative 'client_validation_test'
+# require_relative 'metadata/mock_capability_statement'
+
+module CarinForBlueButtonTestKit
+  # Serve responses to CARIN requests
+  #
+  # Note that there are numerous expected validation issues that can safely be ignored.
+  # See here for full list: https://hl7.org/fhir/us/carin-bb/STU2/qa.html#suppressed
+
+  module MockServer
+    include URLs
+
+    def server_proxy
+      @server_proxy ||= Faraday.new(
+        url: ENV.fetch('FHIR_REFERENCE_SERVER'),
+        params: {},
+        headers: { 'Content-Type' => 'application/json', 'Authorization' => 'Bearer SAMPLE_TOKEN',
+                   'Host' => ENV.fetch('HOST_HEADER') }
+      ) do |proxy|
+        proxy.use FaradayMiddleware::Gzip
+        proxy.options.params_encoder = Faraday::FlatParamsEncoder
+      end
+    end
+
+    def token_response(request, _test = nil, _test_result = nil)
+      # Placeholder for a more complete mock token endpoint
+      response.body = { access_token: SecureRandom.hex, token_type: 'bearer', expires_in: 300 }.to_json
+      response.status = 200
+    end
+
+    def error_response_resource(request)
+      server_response = server_proxy.get('Patient', { _id: 888 })
+      response_resource = FHIR.from_contents(server_response.body)
+      response_resource.entry = [{ fullUrl: 'urn:uuid:2866af9c-137d-4458-a8a9-eeeec0ce5583',
+                                   resource: mock_operation_outcome_resource, search: { mode: 'outcome' } }]
+      response_resource.link.first.url = request.url # specific case for Operation Outcome handling
+      response.status = 403
+      response_resource
+    end
+
+    def get_params(query_string)
+      params = {}
+      query_string.split('&').each do |param|
+        split_param = param.split('=')
+        params[split_param.first] = [] if params[split_param.first].nil?
+        params[split_param.first].append(split_param.last)
+      end
+      params
+    end
+
+    def carin_resource_response(request, test = nil, test_result = nil)
+      endpoint = resource_endpoint(request.url)
+      if endpoint
+        request_parameters = get_params(request.query_string)
+        params = match_request_to_expectation(endpoint, request_parameters)
+        if params.present?
+          server_response = server_proxy.get(endpoint, params)
+          response.status = server_response.status
+          response_resource = if response.status == 200
+                                replace_bundle_urls(FHIR.from_contents(server_response.body))
+                              else
+                                FHIR.from_contents(server_response.body)
+                              end
+          response.headers.merge!(server_response.headers)
+          remove_transfer_encoding_and_content_length_header(response.headers)
+        else
+          response_resource = error_response_resource(request)
+        end
+      else
+        response_resource = error_response_resource(request)
+      end
+      response.body = response_resource.to_json
+    end
+
+    def carin_resource_id_response(request)
+      endpoint = resource_id_endpoint(request.url)
+      if endpoint
+        server_response = server_proxy.get(endpoint)
+        response.status = server_response.status
+        response_resource = FHIR.from_contents(server_response.body)
+        response.headers.merge!(server_response.headers)
+        remove_transfer_encoding_and_content_length_header(response.headers)
+      else
+        response_resource = error_response_resource(request)
+      end
+      response.body = response_resource.to_json
+    end
+
+    def read_next_page(request, test = nil, test_result = nil)
+      server_response = server_proxy.get('', JSON.parse(request.params.to_json))
+      response.status = server_response.status
+      response.response_headers = remove_transfer_encoding_header(server_response.headers)
+      response.response_body = replace_bundle_urls(FHIR.from_contents(server_response.body)).to_json
+    end
+
+    def get_metadata
+      proc {
+        [200, { 'Content-Type' => 'application/fhir+json;charset=utf-8' },
+         [File.read('lib/carin_for_blue_button_test_kit/client/v2.0.0/metadata/mock_capability_statement.json')]]
+      }
+    end
+
+    def remove_transfer_encoding_and_content_length_header(headers)
+      headers.delete('transfer-encoding') if headers['transfer-encoding'].present?
+
+      return unless headers['Content-Length'].present?
+
+      headers.delete('Content-Length')
+    end
+
+    def match_request_to_expectation(resource_type, params)
+      matched_search = SEARCHES_BY_PRIORITY[resource_type.to_sym].select do |expectation|
+        (params.keys.map(&:to_s) & expectation).sort == expectation
+      end.map(&:first)
+
+      if matched_search.present?
+        return params.select do |key, value|
+          matched_search.include?(key.to_s) || key == '_revInclude' || key == '_include'
+        end
+      end
+      nil
+    end
+
+    def extract_client_id(request)
+      URI.decode_www_form(request.body.read).to_h['client_id']
+    end
+
+    # Header expected to be a bearer token of the form "Bearer: <token>"
+    def extract_bearer_token(request)
+      request.headers['authorization']&.delete_prefix('Bearer ')
+    end
+
+    def extract_token_from_query_params(request)
+      request.query_parameters['token']
+    end
+
+    # Pull resource type from url
+    # e.g. http://example.org/fhir/Patient?_id=123 -> Patient
+    # @private
+    def resource_endpoint(url)
+      return unless url.start_with?('http://', 'https://')
+
+      match = %r{custom/c4bb_v200_client/fhir/(.*)\?}.match(url)
+      match[1] if match.present?
+    end
+
+    def resource_id_endpoint(url)
+      return unless url.start_with?('http://', 'https://')
+
+      match = %r{custom/c4bb_v200_client/fhir/(.*)}.match(url)
+      match[1] if match.present?
+    end
+
+    def mock_operation_outcome_resource
+      FHIR.from_contents(File.read(
+                           'lib/carin_for_blue_button_test_kit/client/v2.0.0/metadata/mock_operation_outcome_resource.json'
+                         ))
+    end
+
+    def replace_bundle_urls(bundle)
+      reference_server_base = ENV.fetch('FHIR_REFERENCE_SERVER')
+      bundle&.link&.map! { |link| { relation: link.relation, url: link.url.gsub(reference_server_base, new_link) } }
+      bundle&.entry&.map! do |bundled_resource|
+        { fullUrl: bundled_resource.fullUrl.gsub(reference_server_base, new_link),
+          resource: bundled_resource.resource,
+          search: bundled_resource.search }
+      end
+      bundle
+    end
+
+    def new_link
+      "#{Inferno::Application['base_url']}/custom/c4bb_v200_client/fhir"
+    end
+
+    # @private
+    def find_matching_entry(ref, entries, root_url = '')
+      ref = "#{root_url}/#{ref}" if relative_reference?(ref) && root_url&.present?
+
+      entries&.find { |entry| entry&.fullUrl == ref }
+    end
+
+    # @private
+    def relative_reference?(ref)
+      ref&.count('/') == 1
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/client/v2.0.0/required_searches_tests/coverage_required_searches.rb

@@ -0,0 +1,45 @@
+require_relative '../urls'
+require_relative '../client_validation_test'
+
+module CarinForBlueButtonTestKit
+  class C4BBClientCoverageRequiredSearches < Inferno::Test
+    include URLs
+    include CarinForBlueButtonTestKit::ClientValidationTest
+
+    id :coverage_required_searches
+    title 'Coverage required search parameters'
+    description %(
+      This test will look through all the requests to find a Coverage search request with each of the following
+      required search parameters specified for the Coverage resource in the
+      [CARIN for Blue Button](https://hl7.org/fhir/us/carin-bb/STU2/CapabilityStatement-c4bb.html#coverage)
+      and [US Core Client](https://www.hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-client.html)
+      Capability Statements:
+        * _id
+        * patient
+    )
+    input :access_token
+
+    verifies_requirements 'hl7.fhir.us.carin-bb_2.0.0@14'
+
+    def required_searches
+      [
+        '_id',
+        'patient'
+      ]
+    end
+
+    run do
+      search_params = resource_previous_search_params(:CoverageSearch)
+      skip_if search_params.nil?, 'No search requests made for Coverage resource'
+
+      missing_params = []
+      required_searches.each do |search_param|
+        missing_params.append(search_param) unless search_params.include?(search_param)
+      end
+      assert(missing_params.empty?, %(
+        Did not find any requests made with the following required search parameters:
+        #{missing_params.join(', ')}
+      ))
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/client/v2.0.0/required_searches_tests/eob_required_searches.rb

@@ -0,0 +1,71 @@
+require_relative '../urls'
+require_relative '../client_validation_test'
+
+module CarinForBlueButtonTestKit
+  class C4BBClientEOBRequiredSearches < Inferno::Test
+    include URLs
+    include CarinForBlueButtonTestKit::ClientValidationTest
+
+    id :eob_required_searches
+    title 'Explanation of Benefit required search parameters'
+    description %(
+      This test will look through all the requests to find an ExplanationOfBenefit search request with each of the
+      following required search parameters specified for the ExplanationOfBenefit resource in the
+      [CARIN for Blue Button](https://hl7.org/fhir/us/carin-bb/STU2/CapabilityStatement-c4bb.html#explanationofbenefit)
+      and [US Core Client](https://www.hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-client.html)
+      Capability Statements:
+        * _id
+        * patient
+        * identifier
+        * _lastUpdated
+        * service-date
+        * service-start-date
+        * billable-period-start
+        * type
+        * _include:
+          * ExplanationOfBenefit:patient
+          * ExplanationOfBenefit:provider
+          * ExplanationOfBenefit:care-team
+          * ExplanationOfBenefit:coverage
+          * ExplanationOfBenefit:insurer
+          * ExplanationOfBenefit:payee
+          * ExplanationOfBenefit:*
+    )
+    input :access_token
+
+    verifies_requirements 'hl7.fhir.us.carin-bb_2.0.0@14'
+
+    def required_searches
+      [
+        '_id',
+        'patient',
+        'identifier',
+        '_lastUpdated',
+        'service-date',
+        'service-start-date',
+        'billable-period-start',
+        'type',
+        '_include=ExplanationOfBenefit:patient',
+        '_include=ExplanationOfBenefit:provider',
+        '_include=ExplanationOfBenefit:care-team',
+        '_include=ExplanationOfBenefit:coverage',
+        '_include=ExplanationOfBenefit:insurer',
+        '_include=ExplanationOfBenefit:payee',
+        '_include=ExplanationOfBenefit:*'
+      ]
+    end
+
+    run do
+      search_params = resource_previous_search_params(:ExplanationOfBenefitSearch)
+      skip_if search_params.nil?, 'No search requests made for Explanation of Benefit resource'
+      missing_params = []
+      required_searches.each do |search_param|
+        missing_params.append(search_param) unless search_params.include?(search_param)
+      end
+      assert(missing_params.empty?, %(
+        Did not find any requests made with the following required search parameters:
+        #{missing_params.join(', ')}
+      ))
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/client/v2.0.0/required_searches_tests/organization_required_searches.rb

@@ -0,0 +1,47 @@
+require_relative '../urls'
+require_relative '../client_validation_test'
+
+module CarinForBlueButtonTestKit
+  class C4BBClientOrganizationRequiredSearches < Inferno::Test
+    include URLs
+    include CarinForBlueButtonTestKit::ClientValidationTest
+
+    id :organization_required_searches
+    title 'Organization required search parameters'
+    description %(
+      This test will look through all the requests to find a Organization search request with each of the following
+      required search parameters specified for the Organization resource in the
+      [CARIN for Blue Button](https://hl7.org/fhir/us/carin-bb/STU2/CapabilityStatement-c4bb.html#organization)
+      and [US Core Client](https://www.hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-client.html#organization)
+      Capability Statements:
+        * _id
+        * name
+        * address
+    )
+    input :access_token
+
+    verifies_requirements 'hl7.fhir.us.carin-bb_2.0.0@14'
+
+    def required_searches
+      [
+        '_id',
+        'name',
+        'address'
+      ]
+    end
+
+    run do
+      search_params = resource_previous_search_params(:OrganizationSearch)
+      skip_if search_params.nil?, 'No search requests made for Organization resource'
+
+      missing_params = []
+      required_searches.each do |search_param|
+        missing_params.append(search_param) unless search_params.include?(search_param)
+      end
+      assert(missing_params.empty?, %(
+        Did not find any requests made with the following required search parameters:
+        #{missing_params.join(', ')}
+      ))
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/client/v2.0.0/required_searches_tests/patient_required_searches.rb

@@ -0,0 +1,71 @@
+require_relative '../urls'
+require_relative '../client_validation_test'
+
+module CarinForBlueButtonTestKit
+  class C4BBClientPatientRequiredSearches < Inferno::Test
+    include URLs
+    include CarinForBlueButtonTestKit::ClientValidationTest
+
+    id :patient_required_searches
+    title 'Patient required search parameters'
+    description %(
+      This test will look through all the requests to find a Patient search request with each of the following
+      required search parameters specified for the Patient resource in the
+      [CARIN for Blue Button](https://hl7.org/fhir/us/carin-bb/STU2/CapabilityStatement-c4bb.html#patient)
+      and [US Core Client](https://www.hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-client.html#patient)
+      Capability Statements:
+        * _id
+        * birthdate
+        * family
+        * gender
+        * given
+        * identifier
+        * name
+        * birthdate+family
+        * family+gender
+        * birthdate+name
+        * gender+name
+    )
+    input :access_token
+
+    verifies_requirements 'hl7.fhir.us.carin-bb_2.0.0@14'
+
+    def required_searches
+      [
+        '_id',
+        'birthdate',
+        'family',
+        'gender',
+        'given',
+        'identifier',
+        'name',
+        'birthdate+family',
+        'family+gender',
+        'birthdate+name',
+        'gender+name'
+      ]
+    end
+
+    run do
+      search_params = resource_previous_search_params(:PatientSearch)
+      skip_if search_params.nil?, 'No search requests made for Patient resource'
+
+      missing_params = []
+      required_searches.each do |search_param|
+        if search_param.include?('+')
+          split_param = search_param.split('+')
+          unless search_params.include?(split_param.first) && search_params.include?(split_param.last)
+            missing_params.append(search_param)
+          end
+        else
+          missing_params.append(search_param) unless search_params.include?(search_param)
+        end
+      end
+
+      assert(missing_params.empty?, %(
+        Did not find any requests made with the following required search parameters:
+        #{missing_params.join(', ')}
+      ))
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/client/v2.0.0/required_searches_tests/practitioner_required_searches.rb

@@ -0,0 +1,47 @@
+require_relative '../urls'
+require_relative '../client_validation_test'
+
+module CarinForBlueButtonTestKit
+  class C4BBClientPractitionerRequiredSearches < Inferno::Test
+    include URLs
+    include CarinForBlueButtonTestKit::ClientValidationTest
+
+    id :practitioner_required_searches
+    title 'Practitioner required search parameters'
+    description %(
+      This test will look through all the requests to find a Practitioner search request with each of the following
+      required search parameters specified for the Practitioner resource in the
+      [CARIN for Blue Button](https://hl7.org/fhir/us/carin-bb/STU2/CapabilityStatement-c4bb.html#practitioner)
+      and [US Core Client](https://www.hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-client.html#practitioner)
+      Capability Statements:
+        * _id
+        * name
+        * identifier
+    )
+    input :access_token
+
+    verifies_requirements 'hl7.fhir.us.carin-bb_2.0.0@14'
+
+    def required_searches
+      [
+        '_id',
+        'name',
+        'identifier'
+      ]
+    end
+
+    run do
+      search_params = resource_previous_search_params(:PractitionerSearch)
+      skip_if search_params.nil?, 'No search requests made for Practitioner resource'
+
+      missing_params = []
+      required_searches.each do |search_param|
+        missing_params.append(search_param) unless search_params.include?(search_param)
+      end
+      assert(missing_params.empty?, %(
+        Did not find any requests made with the following required search parameters:
+        #{missing_params.join(', ')}
+      ))
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/client/v2.0.0/required_searches_tests/relatedperson_required_searches.rb

@@ -0,0 +1,43 @@
+require_relative '../urls'
+require_relative '../client_validation_test'
+
+module CarinForBlueButtonTestKit
+  class C4BBClientRelatedPersonRequiredSearches < Inferno::Test
+    include URLs
+    include CarinForBlueButtonTestKit::ClientValidationTest
+
+    id :relatedperson_required_searches
+    title 'RelatedPerson required search parameters'
+    description %(
+      This test will look through all the requests to find a RelatedPerson search request with each of the following
+      required search parameters specified for the RelatedPerson resource in the
+      [CARIN for Blue Button](https://hl7.org/fhir/us/carin-bb/STU2/CapabilityStatement-c4bb.html#relatedperson)
+      and [US Core Client](https://www.hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-client.html#practitioner)
+      Capability Statements:
+        * _id
+    )
+    input :access_token
+
+    verifies_requirements 'hl7.fhir.us.carin-bb_2.0.0@14'
+
+    def required_searches
+      [
+        '_id'
+      ]
+    end
+
+    run do
+      search_params = resource_previous_search_params(:RelatedPersonSearch)
+      skip_if search_params.nil?, 'No search requests made for RelatedPerson resource'
+
+      missing_params = []
+      required_searches.each do |search_param|
+        missing_params.append(search_param) unless search_params.include?(search_param)
+      end
+      assert(missing_params.empty?, %(
+        Did not find any requests made with the following required search parameters:
+        #{missing_params.join(', ')}
+      ))
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/client/v2.0.0/tags.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module CarinForBlueButtonTestKit
+  AUTH_TAG = 'carin_auth'
+  RESOURCE_API_TAG = 'carin_resource_api'
+  RESOURCE_ID_TAG = 'carin_resource_id'
+end

data/lib/carin_for_blue_button_test_kit/client/v2.0.0/urls.rb

@@ -0,0 +1,57 @@
+module CarinForBlueButtonTestKit
+  TOKEN_PATH = '/mock_auth/token'
+  PATIENT_PATH = '/fhir/Patient'
+  RESOURCE_API_PATH = '/fhir/:endpoint'
+  RESOURCE_ID_PATH = '/fhir/:endpoint/:id'
+  METADATA_PATH = '/fhir/metadata'
+  BASE_FHIR_PATH = '/fhir'
+  RESUME_PASS_PATH = '/resume_pass'
+  RESUME_CLAIMS_DATA_PATH = '/resume_claims_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 + RESOURCE_API_PATH
+    end
+
+    def resource_id_url
+      @resource_id_url ||= base_url + RESOURCE_ID_PATH
+    end
+
+    def metadata_url
+      @metadata_url ||= base_url + METADATA_PATH
+    end
+
+    def resume_pass_url
+      @resume_pass_url ||= base_url + RESUME_PASS_PATH
+    end
+
+    def resume_claims_data_url
+      @resume_claims_data_url ||= base_url + RESUME_CLAIMS_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/carin_for_blue_button_test_kit/client/v2.0.0/user_input_response.rb

@@ -0,0 +1,32 @@
+module CarinForBlueButtonTestKit
+  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/carin_for_blue_button_test_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CarinForBlueButtonTestKit
-  VERSION = '0.12.1'
+  VERSION = '0.13.0'
 end

data/lib/carin_for_blue_button_test_kit.rb

@@ -2,3 +2,4 @@ require_relative 'inferno_requirements_tools/ext/inferno_core/runnable'
 require_relative 'carin_for_blue_button_test_kit/generated/v1.1.0/c4bb_test_suite'
 require_relative 'carin_for_blue_button_test_kit/generated/v2.0.0/c4bb_test_suite'
 require_relative 'carin_for_blue_button_test_kit/generated/v2.0.0-dev-nonfinancial/c4bb_test_suite'
+require_relative 'carin_for_blue_button_test_kit/client/v2.0.0/c4bb_client_test_suite'