davinci_pas_test_kit 0.9.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35fff0ddc7e7badcd0fe5e9927f9bbafc7be123f908f4eed1f81c8f777189ef4
-  data.tar.gz: 36fa5c2af21fb2ca92ff958a0f96d97aed08dd45c1bdd454cce2f2a4aabe5af1
+  metadata.gz: e45ca8e36bad87d4e457eb2b49c26eb0170c7877e059e9a8cb8e5bda906972b9
+  data.tar.gz: 6dbf634eb8484ea7dc442a7bd9b016392ea70316e3635ae4fe7c2e2bd884772a
 SHA512:
-  metadata.gz: 954d086d05f047336a216d2d72947ca8d8d1ffaf944a3b29174a15ea7fd73fe75d6a9e26552af08b20d7b33917102903ec9e98f90000fd2228697ab9cb25defb
-  data.tar.gz: 8ed7048ddeaad521eda54110707aa8a55e2e151c0f37c2f0a35ba5a57f2823c121e4b5d97796166340afbda10242650a2a83fe6244a6981d74ae5cf9472c4537
+  metadata.gz: 29e35d93edbabe076d85521e36829951c15ae73645c262a334a3abf3a1c1abaf6752ab7e56488c4edc519dfa95a2a228312e467a25f9b78822efa1f2abb96d7c
+  data.tar.gz: af2de00d7c19bc247f8834f185a702b942b939947e4aa2c16323ab044b67ccffcd9cd315fe6ec8d26cc98e410e05ed12548f8796e9d9d01da9da72c3d0b29410

data/lib/davinci_pas_test_kit/client_suite.rb

@@ -41,8 +41,8 @@ module DaVinciPASTestKit
       !test.config.options[:accepts_multiple_requests]
     end
 
-    validator do
-      url ENV.fetch('VALIDATOR_URL')
+    fhir_resource_validator do
+      igs 'hl7.fhir.us.davinci-pas#2.0.1'
 
       exclude_message do |message|
         # Messages expected of the form `<ResourceType>: <FHIRPath>: <message>`

data/lib/davinci_pas_test_kit/custom_groups/v2.0.1/client_tests/pas_client_approval_submit_response_attest.rb

@@ -20,6 +20,7 @@ module DaVinciPASTestKit
             )
 
       run do
+        skip_if request.status.between?(400, 499), 'Bad claim submission request.'
         wait(
           identifier: access_token,
           message: %(

data/lib/davinci_pas_test_kit/docs/client_suite_description_v201.md

@@ -77,6 +77,11 @@ json-encoded FHIR bundle in the "Claim pended response JSON" and "Claim deny res
 clicking the '*Run All Tests*' button. These responses will be echoed back when a request
 is made during the corresponding test.
 
+Selecting the *Example PAS Server Responses* Preset in the dropdown in the upper left will fill in example
+FHIR bundles for the pended and deny responses. It will also fill in a sample value for the Client ID,
+which is only necessary for the *Demonstrate Authorization* test group, which can be skipped in favor of
+manual bearer token input in subsequent tests as described above.
+
 ### Postman-based Demo
 
 If you do not have a PAS client but would like to try the tests out, you can use

data/lib/davinci_pas_test_kit/generated/v2.0.1/server_suite.rb

@@ -33,8 +33,8 @@ module DaVinciPASTestKit
         request.query_parameters['use_case']
       end
 
-      validator do
-        url ENV.fetch('VALIDATOR_URL')
+      fhir_resource_validator do
+        igs 'hl7.fhir.us.davinci-pas#2.0.1'
 
         exclude_message do |message|
           # Messages expected of the form `<ResourceType>: <FHIRPath>: <message>`

data/lib/davinci_pas_test_kit/generator/suite_generator.rb

@@ -48,6 +48,11 @@ module DaVinciPASTestKit
         "Da Vinci PAS Server Suite #{ig_metadata.ig_version}"
       end
 
+      def ig_identifier
+        version = ig_metadata.ig_version[1..] # Remove leading 'v'
+        "hl7.fhir.us.davinci-pas##{version}"
+      end
+
       def ig_link
         case ig_metadata.ig_version
         when 'v2.0.1'

data/lib/davinci_pas_test_kit/igs/README.md

@@ -0,0 +1,21 @@
+# Note on this IGs folder
+
+There are three reasons why it would be necessary to put an IG package.tgz in this folder. If none of these apply, you do not need to put any files here, or can consider removing any existing files to make it clear they are unused.
+
+## 1. Generated Test Suites
+Some test kits use a "generator" to automatically generate the contents of a test suite for an IG. The IG files are required every time the test suites need to be regenerated. Examples of test kits that use this approach are the US Core Test Kit and CARIN IG for Blue Button® Test Kit.
+
+
+## 2. Non-published IG
+If your IG, or the specific version of the IG you want to test against, is not published, then the validator service needs to load the IG from file in order to be able to validate resources with it. The IG must be referenced in the `fhir_resource_validator` block in the test suite definition by filename, ie:
+
+```ruby
+      fhir_resource_validator do
+        igs 'igs/filename.tgz'
+
+        ...
+      end
+```
+
+## 3. Inferno Validator UI
+The Inferno Validator UI is configured to auto-load any IGs present in the igs folder and include them in all validations. The Inferno Validator UI is currently disabled by default, so this is only relevant if you choose to re-enable it. In general, the Inferno team is currently leaving IGs in this folder even if not otherwise necessary to make it easy to re-enable the validator UI.

data/lib/davinci_pas_test_kit/mock_server.rb

@@ -25,9 +25,13 @@ module DaVinciPASTestKit
       operation = request&.url&.split('$')&.last
       req_bundle = FHIR.from_contents(request&.request_body)
       claim_entry = req_bundle&.entry&.find { |e| e&.resource&.resourceType == 'Claim' }
-      root_url = base_url(claim_entry&.fullUrl)
-      return unless ['submit', 'inquire'].include?(operation) && claim_entry.present?
+      claim_full_url = claim_entry&.fullUrl
+      if claim_entry.blank? || claim_full_url.blank?
+        handle_missing_required_elements(claim_entry, request)
+        return
+      end
 
+      root_url = base_url(claim_full_url)
       claim_response = mock_claim_response(claim_entry.resource, req_bundle, operation, root_url)
 
       res_bundle = FHIR::Bundle.new(
@@ -137,11 +141,25 @@ module DaVinciPASTestKit
       request.query_parameters['token']
     end
 
+    def handle_missing_required_elements(claim_entry, request)
+      request.status = 400
+      request.response_headers = { 'Content-Type': 'application/json' }
+      details = if claim_entry.blank?
+                  'Required Claim entry missing from bundle'
+                else
+                  'Required element fullUrl missing from Claim entry'
+                end
+      request.response_body = FHIR::OperationOutcome.new(
+        issue: FHIR::OperationOutcome::Issue.new(severity: 'fatal', code: 'required',
+                                                 details: FHIR::CodeableConcept.new(text: details))
+      ).to_json
+    end
+
     # Drop the last two segments of a URL, i.e. the resource type and ID of a FHIR resource
     # e.g. http://example.org/fhir/Patient/123 -> http://example.org/fhir
     # @private
     def base_url(url)
-      return unless url.start_with?('http://', 'https://')
+      return unless url&.start_with?('http://', 'https://')
 
       # Drop everything after the second to last '/', ignoring a trailing slash
       url.sub(%r{/[^/]*/[^/]*(/)?\z}, '')

data/lib/davinci_pas_test_kit/pas_bundle_validation.rb

@@ -210,9 +210,11 @@ module DaVinciPASTestKit
     # @param version [String] The version of the IG.
     def validate_bundle_entries_against_profiles(version)
       bundle_resources_target_profile_map.each_value do |item|
+        resource = item[:resource]
+        base_profile = FHIR::Definitions.resource_definition(resource.resourceType).url
         success_profile = item[:profile_urls].find do |url|
-          profile_with_version = "#{url}|#{version}"
-          resource_is_valid?(resource: item[:resource], profile_url: profile_with_version)
+          profile_to_validate = url == base_profile ? url : "#{url}|#{version}"
+          resource_is_valid?(resource:, profile_url: profile_to_validate)
         end
 
         validation_error_messages << generate_non_conformance_message(item) unless success_profile
@@ -370,18 +372,20 @@ module DaVinciPASTestKit
 
       logger = Logger.new($stdout)
       begin
-        validator_url = ENV.fetch('VALIDATOR_URL') # 'https://inferno.healthit.gov/validatorapi/'
-        path = "#{validator_url}/evaluate?path=#{expression}"
+        fhirpath_url = ENV.fetch('FHIRPATH_URL')
+        path = "#{fhirpath_url}/evaluate?path=#{expression}"
 
         response = Faraday.post(path, resource.to_json, 'Content-Type' => 'application/json')
         if response.status.to_s.start_with? '2'
           result = JSON.parse(response.body)
           return result.map { |entry| entry.dig('element', 'reference') if entry['type'] == 'Reference' }.compact
         else
-          logger.error "External validator failed: #{response.status}"
+          logger.error "External FHIRPath service failed: #{response.status}"
+          raise 'FHIRPath service not available'
         end
       rescue Faraday::Error => e
         logger.error "HTTP request failed: #{e.message}"
+        raise 'FHIRPath service not available'
       end
 
       []
@@ -465,7 +469,7 @@ module DaVinciPASTestKit
       url_regex = /\A#{URI::DEFAULT_PARSER.make_regexp(%w[http https])}\z/
       urn_uuid_regex = /\Aurn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}\z/i
 
-      string.match?(url_regex) || string.match?(urn_uuid_regex)
+      string&.match?(url_regex) || string&.match?(urn_uuid_regex)
     end
 
     # This method traverses references within a FHIR resource, ensuring that referenced resources

data/lib/davinci_pas_test_kit/validator_suppressions.rb

@@ -133,6 +133,8 @@ module DaVinciPASTestKit
       # no real content
       /Details for (.+) matching against profile/,
       ': All OK',
+      # This was ignored natively in the Inferno validator but needs to be ignored by the test kit with the HL7 validator
+      /URL value '.*' does not resolve/,
       # addition validator clean-up based on Bundle sub-validations where Inferno error supression doesn't
       # work. The test kit validates these instances individually as well, so they are still checked,
       # but in a way that Inferno can supress errors

data/lib/davinci_pas_test_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: truen
 
 module DaVinciPASTestKit
-  VERSION = '0.9.2'.freeze
+  VERSION = '0.10.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: davinci_pas_test_kit
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.0
 platform: ruby
 authors:
 - Inferno Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-29 00:00:00.000000000 Z
+date: 2024-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inferno_core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.34
+        version: 0.4.37
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.34
+        version: 0.4.37
 - !ruby/object:Gem::Dependency
   name: database_cleaner-sequel
   requirement: !ruby/object:Gem::Requirement
@@ -247,6 +247,7 @@ files:
 - lib/davinci_pas_test_kit/generator/terminology_binding_metadata_extractor.rb
 - lib/davinci_pas_test_kit/generator/validation_test_generator.rb
 - lib/davinci_pas_test_kit/generator/value_extractor.rb
+- lib/davinci_pas_test_kit/igs/README.md
 - lib/davinci_pas_test_kit/mock_server.rb
 - lib/davinci_pas_test_kit/must_support_test.rb
 - lib/davinci_pas_test_kit/pas_bundle_validation.rb