davinci_pas_test_kit 0.12.0 → 0.12.1

data/lib/davinci_pas_test_kit/endpoints/subscription_create_endpoint.rb

@@ -0,0 +1,96 @@
+require_relative '../tags'
+require_relative '../jobs/send_subscription_handshake'
+require 'subscriptions_test_kit'
+
+module DaVinciPASTestKit
+  class SubscriptionCreateEndpoint < Inferno::DSL::SuiteEndpoint
+    include SubscriptionsTestKit::SubscriptionsR5BackportR4Client::SubscriptionSimulationUtils
+
+    def test_run_identifier
+      request.headers['authorization']&.delete_prefix('Bearer ')
+    end
+
+    def make_response
+      response.format = :json
+      response.status = 400
+
+      begin
+        subscription = FHIR.from_contents(request.body.string)
+      rescue StandardError
+        response.body = operation_outcome('error', 'invalid', 'No recognized R4 Subscription in request body').to_json
+        return
+      end
+
+      verification_outcome = verify_subscription(subscription)
+      if verification_outcome.present?
+        response.body = verification_outcome.to_json
+        return
+      end
+
+      # Deny subscription if one already created
+      requests = requests_repo.tagged_requests(test_run.test_session_id, tags)
+      existing_subscription_request = requests.find { |r| r.status == 201 }
+      if existing_subscription_request.present?
+        subscription_hash = JSON.parse(existing_subscription_request.response_body)
+        error_text = 'Inferno only supports one subscription per test run. Subscription already created with ' \
+                     "ID #{subscription_hash['id']}"
+        response.body = operation_outcome('error', 'business-rule', error_text).to_json
+        return
+      end
+
+      # Form response
+      notification_json = nil # no notification
+      subscription_id = SecureRandom.uuid
+      # We have to manipulate the raw hash so that we don't lose the _payload primitive extension
+      subscription_hash = JSON.parse(request.body.string).merge('id' => subscription_id, 'status' => 'requested')
+      subscription_hash['channel']['payload'] = actual_mime_type(subscription)
+      response.status = 201
+      response.body = subscription_hash.to_json
+
+      # Kick off handshake job
+      subscription_url = "#{request.url}/#{subscription_id}"
+      client_endpoint = subscription.channel.endpoint
+      bearer_token = client_access_token_input(result)
+      test_suite_base_url = request.url.chomp('/').chomp(FHIR_SUBSCRIPTION_PATH)
+      Inferno::Jobs.perform(Jobs::SendSubscriptionHandshake, test_run.id, test_run.test_session_id, result.id,
+                            subscription_id, subscription_url, client_endpoint, bearer_token, notification_json,
+                            test_run_identifier, test_suite_base_url)
+    end
+
+    def tags
+      [SUBSCRIPTION_CREATE_TAG]
+    end
+
+    def verify_subscription(subscription)
+      unless subscription.is_a? FHIR::Subscription
+        return operation_outcome('error', 'invalid', 'No recognized R4 Subscription in request body')
+      end
+
+      unless subscription.channel&.type == 'rest-hook'
+        return operation_outcome('error', 'business-rule', 'channel.type must be rest-hook')
+      end
+
+      unless valid_url?(subscription.channel&.endpoint)
+        return operation_outcome('error', 'value', 'channel.endpoint is not recognized as a conformant URL')
+      end
+
+      heartbeat_period = find_heartbeat_period(subscription)
+      operation_outcome('error', 'not-supported', 'heartbeatPeriod is not supported') unless heartbeat_period.nil?
+    end
+
+    def find_heartbeat_period(subscription)
+      return unless subscription.present?
+
+      subscription.channel&.extension&.find do |e|
+        e.url == 'http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period'
+      end
+    end
+
+    def valid_url?(url)
+      uri = URI.parse(url)
+      %w[http https].include?(uri.scheme)
+    rescue URI::InvalidURIError
+      false
+    end
+  end
+end

data/lib/davinci_pas_test_kit/endpoints/subscription_status_endpoint.rb

@@ -0,0 +1,90 @@
+require_relative '../tags'
+require 'subscriptions_test_kit'
+
+module DaVinciPASTestKit
+  class SubscriptionStatusEndpoint < Inferno::DSL::SuiteEndpoint
+    include SubscriptionsTestKit::SubscriptionsR5BackportR4Client::SubscriptionSimulationUtils
+    include ResponseGenerator
+
+    def test_run_identifier
+      request.headers['authorization']&.delete_prefix('Bearer ')
+    end
+
+    def make_response
+      response.format = :json
+      subscription = find_subscription(test_run.test_session_id)
+
+      unless subscription.present?
+        not_found
+        return
+      end
+
+      subscription_id = request.params[:id]
+
+      # Handle resource-level status params
+      unless subscription_id.present?
+        begin
+          params = FHIR.from_contents(request.body.string)
+        rescue StandardError
+          response.status = 400
+          response.body = operation_outcome('error', 'invalid', 'Invalid Parameters in request body').to_json
+          return
+        end
+
+        unless subscription_params_match?(params, subscription)
+          not_found
+          return
+        end
+      end
+
+      subscription_url = "#{base_subscription_url}/#{subscription.id}"
+      subscription_topic = subscription.criteria
+      status_code = determine_subscription_status_code(subscription_id)
+      event_count = determine_event_count(test_run.test_session_id)
+
+      notification_json = notification_bundle_input(result)
+      if notification_json.blank?
+        notification_timestamp = Time.now.utc
+        mock_status_bundle = FHIR::Bundle.new(
+          id: SecureRandom.uuid,
+          timestamp: notification_timestamp.iso8601,
+          type: 'history'
+        )
+        mock_notification_status = build_mock_notification_status(notification_timestamp, subscription_url,
+                                                                  subscription_topic, nil, nil)
+        mock_status_bundle.entry << build_mock_notification_status_entry(mock_notification_status, subscription_url)
+        notification_json = mock_status_bundle.to_json
+      end
+      response.body = derive_status_bundle(notification_json, subscription_url, subscription_topic, status_code,
+                                           event_count, request.url).to_json
+      response.status = 200
+    end
+
+    def subscription_params_match?(params, subscription)
+      id_params = find_params(params, 'id')
+
+      return false if id_params&.any? && id_params&.none? { |p| p.valueString == subscription.id }
+
+      status_params = find_params(params, 'status')
+      subscription_status = determine_subscription_status_code(subscription.id)
+      status_params.blank? || status_params.any? { |p| p.valueString == subscription_status }
+    end
+
+    def tags
+      [SUBSCRIPTION_STATUS_TAG]
+    end
+
+    def not_found
+      response.status = 404
+      response.body = operation_outcome('error', 'not-found').to_json
+    end
+
+    def find_params(params, name)
+      params&.parameter&.filter { |p| p.name == name }
+    end
+
+    def base_subscription_url
+      request.url.sub(/(#{Regexp.escape(FHIR_SUBSCRIPTION_PATH)}).*/, '\1')
+    end
+  end
+end

data/lib/davinci_pas_test_kit/generated/v2.0.1/pas_inquiry_request_bundle/metadata.yml

@@ -68,8 +68,6 @@
 :tests:
 - :id: pas_server_v201_pas_inquiry_request_bundle_validation_test
   :file_name: server_pas_inquiry_request_bundle_validation_test.rb
-- :id: pas_client_v201_pended_pas_inquiry_request_bundle_validation_test
-  :file_name: client_pended_pas_inquiry_request_bundle_validation_test.rb
 - :id: pas_server_inquire_request_v201_pas_inquiry_request_bundle_must_support_test
   :file_name: server_inquire_request_pas_inquiry_request_bundle_must_support_test.rb
 - :id: pas_client_inquire_request_v201_pas_inquiry_request_bundle_must_support_test

data/lib/davinci_pas_test_kit/generated/v2.0.1/pas_inquiry_request_bundle/server_pas_inquiry_request_bundle_validation_test.rb

@@ -11,9 +11,11 @@ module DaVinciPASTestKit
         **USER INPUT VALIDATION**: This test validates input provided by the user instead of the system under test.
         Errors encountered will be treated as a skip instead of a failure.
         
+        
         This test validates the conformity of the
         user input to the
-        [PAS Inquiry Request Bundle](http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-pas-inquiry-request-bundle) structure, ensuring subsequent tests can accurately simulate content.
+        [PAS Inquiry Request Bundle](http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-pas-inquiry-request-bundle) 
+        structure, ensuring subsequent tests can accurately simulate content.
         
         It also checks that other conformance requirements defined in the [PAS Formal
         Specification](https://hl7.org/fhir/us/davinci-pas/STU2/specification.html),

data/lib/davinci_pas_test_kit/generated/v2.0.1/pas_inquiry_response_bundle/server_pas_inquiry_response_bundle_validation_test.rb

@@ -10,7 +10,8 @@ module DaVinciPASTestKit
       description %(
         This test validates the conformity of the
         server's response to the
-        [PAS Inquiry Response Bundle](http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-pas-inquiry-response-bundle) structure.
+        [PAS Inquiry Response Bundle](http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-pas-inquiry-response-bundle) 
+        structure.
         
         It also checks that other conformance requirements defined in the [PAS Formal
         Specification](https://hl7.org/fhir/us/davinci-pas/STU2/specification.html),

data/lib/davinci_pas_test_kit/generated/v2.0.1/pas_request_bundle/metadata.yml

@@ -68,8 +68,6 @@
 :tests:
 - :id: pas_server_v201_pas_request_bundle_validation_test
   :file_name: server_pas_request_bundle_validation_test.rb
-- :id: pas_client_v201_pas_request_bundle_validation_test
-  :file_name: client_pas_request_bundle_validation_test.rb
 - :id: pas_server_submit_request_v201_pas_request_bundle_must_support_test
   :file_name: server_submit_request_pas_request_bundle_must_support_test.rb
 - :id: pas_client_submit_request_v201_pas_request_bundle_must_support_test

data/lib/davinci_pas_test_kit/generated/v2.0.1/pas_request_bundle/server_pas_request_bundle_validation_test.rb

@@ -11,9 +11,11 @@ module DaVinciPASTestKit
         **USER INPUT VALIDATION**: This test validates input provided by the user instead of the system under test.
         Errors encountered will be treated as a skip instead of a failure.
         
+        
         This test validates the conformity of the
         user input to the
-        [PAS Request Bundle](http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-pas-request-bundle) structure, ensuring subsequent tests can accurately simulate content.
+        [PAS Request Bundle](http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-pas-request-bundle) 
+        structure, ensuring subsequent tests can accurately simulate content.
         
         It also checks that other conformance requirements defined in the [PAS Formal
         Specification](https://hl7.org/fhir/us/davinci-pas/STU2/specification.html),

data/lib/davinci_pas_test_kit/generated/v2.0.1/pas_response_bundle/metadata.yml

@@ -62,10 +62,6 @@
 :tests:
 - :id: pas_server_v201_pas_response_bundle_validation_test
   :file_name: server_pas_response_bundle_validation_test.rb
-- :id: pas_client_v201_denial_pas_response_bundle_validation_test
-  :file_name: client_denial_pas_response_bundle_validation_test.rb
-- :id: pas_client_v201_pended_pas_response_bundle_validation_test
-  :file_name: client_pended_pas_response_bundle_validation_test.rb
 - :id: pas_server_submit_response_v201_pas_response_bundle_must_support_test
   :file_name: server_submit_response_pas_response_bundle_must_support_test.rb
 :delayed_references: []

data/lib/davinci_pas_test_kit/generated/v2.0.1/pas_response_bundle/server_pas_response_bundle_validation_test.rb

@@ -10,7 +10,8 @@ module DaVinciPASTestKit
       description %(
         This test validates the conformity of the
         server's response to the
-        [PAS Response Bundle](http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-pas-response-bundle) structure.
+        [PAS Response Bundle](http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-pas-response-bundle) 
+        structure.
         
         It also checks that other conformance requirements defined in the [PAS Formal
         Specification](https://hl7.org/fhir/us/davinci-pas/STU2/specification.html),

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

@@ -9,7 +9,7 @@ module DaVinciPASTestKit
       title 'Successful Denial Workflow'
       description %(
         Demonstrate the ability of the server to respond to a prior
-        authorization request with an `denied` decision.
+        authorization request with a `denied` decision.
         
       )
 

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

@@ -13,12 +13,13 @@ module DaVinciPASTestKit
       title 'Successful Pended Workflow'
       description %(
         Demonstrate a complete prior authorization workflow including a period
-        during which the final decision is pending. This includes
+        during which the final decision is pending. This includes demonstrating
+        the ability of the server to
         
-        - Demonstrating the ability of the server to respond to a prior
-          authorization request with an `pended` status.
-        - Demonstrating the ability of the server to respond to a subsequent
-          inquiry request with a final decision for the request
+        - Respond to a prior authorization request with a `pended` status.
+        - Accept a Subscription creation request and send a notification when
+          the pended claim has been finalized.
+        - Respond to a subsequent inquiry request with a final decision for the request.
         
       )
 

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

@@ -1,3 +1,4 @@
+require 'subscriptions_test_kit'
 require_relative '../../validator_suppressions'
 require_relative '../../custom_groups/v2.0.1/pas_error_group'
 require_relative 'pas_server_approval_use_case_group'

data/lib/davinci_pas_test_kit/generator/group_generator.rb

@@ -276,7 +276,7 @@ module DaVinciPASTestKit
                             else
                               client_inquiry_request_must_support_test_ids
                             end
-                          elsif use_case == 'approval' || use_case == 'denial'
+                          elsif ['approval', 'denial'].include?(use_case)
                             grouped_approval_denial_test_ids
                           elsif use_case == 'pended'
                             grouped_pended_test_ids
@@ -292,7 +292,7 @@ module DaVinciPASTestKit
                               else
                                 client_inquiry_request_must_support_test_file_list
                               end
-                            elsif use_case == 'approval' || use_case == 'denial'
+                            elsif ['approval', 'denial'].include?(use_case)
                               approval_denial_test_file_list
                             elsif use_case == 'pended'
                               pended_test_file_list
@@ -375,17 +375,18 @@ module DaVinciPASTestKit
           when 'denial'
             <<~DESCRIPTION
               Demonstrate the ability of the server to respond to a prior
-              authorization request with an `denied` decision.
+              authorization request with a `denied` decision.
             DESCRIPTION
           when 'pended'
             <<~DESCRIPTION
               Demonstrate a complete prior authorization workflow including a period
-              during which the final decision is pending. This includes
+              during which the final decision is pending. This includes demonstrating
+              the ability of the server to
 
-              - Demonstrating the ability of the server to respond to a prior
-                authorization request with an `pended` status.
-              - Demonstrating the ability of the server to respond to a subsequent
-                inquiry request with a final decision for the request
+              - Respond to a prior authorization request with a `pended` status.
+              - Accept a Subscription creation request and send a notification when
+                the pended claim has been finalized.
+              - Respond to a subsequent inquiry request with a final decision for the request.
             DESCRIPTION
           else # must_support
             <<~DESCRIPTION

data/lib/davinci_pas_test_kit/generator/group_metadata_extractor.rb

@@ -130,7 +130,9 @@ module DaVinciPASTestKit
       end
 
       def conformance_expectation
-        resource_capabilities&.extension&.first&.valueCode
+        return unless resource_capabilities.present?
+
+        resource_capabilities.extension&.first&.valueCode
       end
 
       def profile_name
@@ -155,7 +157,8 @@ module DaVinciPASTestKit
           resource_capabilities.interaction.map do |interaction|
             {
               code: interaction.code,
-              expectation: interaction&.extension&.first&.valueCode # TODO: fix expectation extension finding
+              # TODO: fix expectation extension finding
+              expectation: interaction.present? ? interaction.extension&.first&.valueCode : nil
             }
           end
       end
@@ -165,7 +168,8 @@ module DaVinciPASTestKit
           resource_capabilities.operation.map do |operation|
             {
               code: operation.name,
-              expectation: operation&.extension&.first&.valueCode # TODO: fix expectation extension finding
+              # TODO: fix expectation extension finding
+              expectation: operation.present? ? operation.extension&.first&.valueCode : nil
             }
           end
       end

data/lib/davinci_pas_test_kit/generator/templates/suite.rb.erb

@@ -1,3 +1,4 @@
+require 'subscriptions_test_kit'
 require_relative '../../validator_suppressions'
 require_relative '<%= error_group_file_name %>'
 <% group_file_list.each do |file_name| %>require_relative '<%= file_name %>'

data/lib/davinci_pas_test_kit/generator/validation_test_generator.rb

@@ -6,42 +6,23 @@ module DaVinciPASTestKit
     class ValidationTestGenerator
       class << self
         def generate(ig_metadata, base_output_dir)
-          ['server', 'client'].each do |system|
-            if system == 'server'
-              ig_metadata.bundle_groups.each do |group|
-                new(group, system, base_output_dir:).generate
-              end
-            else
-              ig_metadata.bundle_groups.each do |group|
-                case group.profile_name
-                when 'PAS Request Bundle'
-                  new(group, system, base_output_dir:).generate
-                when 'PAS Inquiry Request Bundle'
-                  new(group, system, 'pended_inquiry', base_output_dir:).generate
-                when 'PAS Response Bundle'
-                  ['denial', 'pended'].each do |workflow|
-                    new(group, system, workflow, base_output_dir:).generate
-                  end
-                end
-              end
-            end
+          ig_metadata.bundle_groups.each do |group|
+            new(group, base_output_dir:).generate
           end
         end
       end
 
-      attr_accessor :group_metadata, :medication_request_metadata, :base_output_dir, :system, :workflow
+      attr_accessor :group_metadata, :medication_request_metadata, :base_output_dir, :workflow
 
-      def initialize(group_metadata, system, workflow = nil, medication_request_metadata = nil, base_output_dir:)
+      def initialize(group_metadata, workflow = nil, medication_request_metadata = nil, base_output_dir:)
         self.group_metadata = group_metadata
-        self.system = system
         self.workflow = workflow
         self.medication_request_metadata = medication_request_metadata
         self.base_output_dir = base_output_dir
       end
 
       def template
-        temp = system == 'server' ? 'validation.rb.erb' : 'validation_client.rb.erb'
-        @template ||= File.read(File.join(__dir__, 'templates', temp))
+        @template ||= File.read(File.join(__dir__, 'templates', 'validation.rb.erb'))
       end
 
       def output
@@ -61,8 +42,6 @@ module DaVinciPASTestKit
       end
 
       def directory_name
-        return 'client_tests' if system == 'client'
-
         Naming.snake_case_for_profile(medication_request_metadata || group_metadata)
       end
 
@@ -87,12 +66,12 @@ module DaVinciPASTestKit
       end
 
       def test_id
-        pref = "pas_#{system}_#{group_metadata.reformatted_version}_#{formatted_workflow}".delete_suffix('_')
+        pref = "pas_server_#{group_metadata.reformatted_version}_#{formatted_workflow}".delete_suffix('_')
         "#{pref}_#{profile_identifier}_validation_test"
       end
 
       def class_name
-        pref = "#{system.capitalize}#{formatted_workflow.camelize}"
+        pref = "Server#{formatted_workflow.camelize}"
         "#{pref}#{Naming.upper_camel_case_for_profile(group_metadata)}ValidationTest"
       end
 
@@ -135,14 +114,23 @@ module DaVinciPASTestKit
       end
 
       def user_input?
-        (system == 'server' && request_type.include?('request')) ||
-          (system == 'client' && request_type.include?('response'))
+        request_type.include?('request')
       end
 
       def description
         <<~DESCRIPTION
           #{description_user_input_validation if user_input?}
-          #{system == 'server' ? description_intro_server : description_intro_client}
+
+          This test validates the conformity of the
+          #{request_type.include?('request') ? 'user input' : "server's response"} to the
+          [#{profile_name}](#{profile_url})#{' '}
+          structure#{request_type.include?('request') ? ', ensuring subsequent tests can accurately simulate content.' : '.'}
+
+          It also checks that other conformance requirements defined in the [PAS Formal
+          Specification](https://hl7.org/fhir/us/davinci-pas/STU2/specification.html),
+          such as the presence of all referenced instances within the bundle and the
+          conformance of those instances to the appropriate profiles, are met.
+
           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
@@ -162,31 +150,6 @@ module DaVinciPASTestKit
         DESCRIPTION
       end
 
-      def description_intro_server
-        <<~GENERIC_INTRO
-          This test validates the conformity of the
-          #{request_type.include?('request') ? 'user input' : "server's response"} to the
-          [#{profile_name}](#{profile_url}) structure#{request_type.include?('request') ? ', ensuring subsequent tests can accurately simulate content.' : '.'}
-
-          It also checks that other conformance requirements defined in the [PAS Formal
-          Specification](https://hl7.org/fhir/us/davinci-pas/STU2/specification.html),
-          such as the presence of all referenced instances within the bundle and the
-          conformance of those instances to the appropriate profiles, are met.
-        GENERIC_INTRO
-      end
-
-      def description_intro_client
-        <<~GENERIC_INTRO
-          This test validates the conformity of the
-          #{request_type.include?('response') ? 'user input' : "client's request"} to the
-          [#{profile_name}](#{profile_url}) structure.
-          It also checks that other conformance requirements defined in the [PAS Formal
-          Specification](https://hl7.org/fhir/us/davinci-pas/STU2/specification.html),
-          such as the presence of all referenced instances within the bundle and the
-          conformance of those instances to the appropriate profiles, are met.
-        GENERIC_INTRO
-      end
-
       def description_user_input_validation
         <<~USER_INPUT_INTRO
           **USER INPUT VALIDATION**: This test validates input provided by the user instead of the system under test.

data/lib/davinci_pas_test_kit/generator/value_extractor.rb

@@ -17,7 +17,10 @@ module DaVinciPASTestKit
       end
 
       def bound_systems(the_element)
-        value_set(the_element)&.compose&.include&.reject { |code| code.concept.nil? }
+        vs = value_set(the_element)
+        return unless vs.present?
+
+        vs.compose&.include&.reject { |code| code.concept.nil? }
       end
 
       def values_from_value_set_binding(the_element)

data/lib/davinci_pas_test_kit/generator.rb

@@ -38,7 +38,7 @@ module DaVinciPASTestKit
     end
 
     def load_ig_package
-      FHIR.logger = Logger.new('/dev/null')
+      FHIR.logger = Logger.new(File::NULL)
       self.ig_resources = IGLoader.new(ig_file_name).load
     end