davinci_crd_test_kit 0.12.2 → 0.14.0

data/lib/davinci_crd_test_kit/{mock_service_response.rb → client/endpoints/mock_service_response.rb}

@@ -1,6 +1,21 @@
 module DaVinciCRDTestKit
   # Serve responses to CRD hook invocations
   module MockServiceResponse
+    def build_mock_hook_response
+      hook_card_response = create_cards_and_system_actions
+      update_specific_hook_card_info(hook_card_response)
+      create_warning_messages(hook_card_response)
+
+      hook_card_response
+    end
+
+    def selected_response_types
+      @selected_response_types ||=
+        JSON.parse(result.input_json)
+          .find { |input| input['name'].include?('selected_response_types') }
+          &.dig('value') || []
+    end
+
     def current_time
       Time.now.utc
     end
@@ -10,7 +25,10 @@ module DaVinciCRDTestKit
     end
 
     def load_json_file(filename)
-      json = JSON.parse(File.read(File.join(__dir__, 'card_responses', filename)))
+      json = JSON.parse(File.read(File.join(__dir__, 'mocked_card_responses', filename)))
+      if ig_version == 'v221'
+        json['source']['topic']['system'] = 'http://terminology.hl7.org/CodeSystem/cdshooks-card-type'
+      end
       return json unless filename == 'launch_smart_app.json'
 
       json['links'].first['url'] = "#{Inferno::Application['base_url']}/custom/smart/launch"
@@ -18,11 +36,6 @@ module DaVinciCRDTestKit
       json
     end
 
-    def request_body
-      @request_body ||=
-        JSON.parse(request.params.to_json)
-    end
-
     def context
       request_body['context']
     end
@@ -54,13 +67,17 @@ module DaVinciCRDTestKit
     end
 
     def coverage_information_required?
-      coverage_information_required_hooks.include? hook_name
+      coverage_information_required_hooks.include? requested_hook
     end
 
     def get_missing_response_types(hook_card_response)
-      selected_response_types.append('coverage_information').uniq! if coverage_information_required?
+      expected_types = if coverage_information_required?
+                         selected_response_types | ['coverage_information']
+                       else
+                         selected_response_types
+                       end
 
-      selected_response_types
+      expected_types
         .select do |response_type|
           response_type = response_type
             .split('_')
@@ -72,8 +89,6 @@ module DaVinciCRDTestKit
     end
 
     def create_warning_messages(hook_card_response)
-      return if custom_response.present?
-
       missing_response_types =
         if hook_card_response.nil?
           selected_response_types
@@ -88,7 +103,7 @@ module DaVinciCRDTestKit
         Inferno::Repositories::Messages.new.create(
           result_id: result.id,
           type: 'warning',
-          message: %(Unable to return response type: `#{missing_response_type}` for #{hook_name} hook)
+          message: %(Unable to return response type `#{missing_response_type}` for #{requested_hook} hook)
         )
       end
     end
@@ -109,14 +124,20 @@ module DaVinciCRDTestKit
     def update_specific_hook_card_info(card_response)
       return if card_response.nil?
 
-      hook_display = hook_name.split('-').map(&:capitalize).join(' ')
-      card_response['cards'].map do |card|
-        card['summary'].prepend("#{hook_display} ")
-        card['uuid'] = SecureRandom.uuid
+      hook_display = requested_hook.split('-').map(&:capitalize).join(' ')
+      card_response['cards']&.tap(&:compact!)&.each do |card|
+        update_one_card_info(card, hook_display)
       end
+      card_response['systemActions']&.compact!
       card_response
     end
 
+    def update_one_card_info(card, hook_display)
+      card['summary'].prepend("#{hook_display} ")
+      card['uuid'] = SecureRandom.uuid
+      card['suggestions']&.each { |suggestion| suggestion['uuid'] = SecureRandom.uuid if suggestion['uuid'].present? }
+    end
+
     def resource_to_update_field_name
       {
         'appointment-book' => 'appointments',
@@ -125,27 +146,14 @@ module DaVinciCRDTestKit
         'order-dispatch' => 'order',
         'order-select' => 'draftOrders',
         'order-sign' => 'draftOrders'
-      }[hook_name]
+      }[requested_hook]
     end
 
     def resource_type_to_update
       {
         'encounter-start' => 'Encounter',
         'encounter-discharge' => 'Encounter'
-      }[hook_name]
-    end
-
-    def hook_response
-      hook_card_response =
-        if custom_response.present?
-          JSON.parse(custom_response)
-        else
-          cards_response = create_cards_and_system_actions
-          update_specific_hook_card_info(cards_response)
-        end
-
-      create_warning_messages(hook_card_response)
-      create_card_response(hook_card_response)
+      }[requested_hook]
     end
 
     def make_resource_request(uri, access_token)
@@ -159,10 +167,15 @@ module DaVinciCRDTestKit
       resource.entry.first.resource
     end
 
+    def patient_coverage
+      @patient_coverage ||= get_patient_coverage
+    end
+
     def get_patient_coverage # rubocop:disable Naming/AccessorMethodName
-      prefetch = request_body['prefetch']
-      if prefetch.present? && prefetch['coverage']
-        FHIR.from_contents(prefetch['coverage'].to_json)
+      prefetched_coverage =  extract_prefetched_coverage(request_body['prefetch'])
+      if prefetched_coverage.present?
+        coverage_or_bundle = FHIR.from_contents(prefetched_coverage.to_json)
+        coverage_or_bundle.is_a?(FHIR::Bundle) ? coverage_or_bundle.entry.first&.resource : coverage_or_bundle
       else
         fhir_server = request_body['fhirServer']
         if fhir_server.present?
@@ -177,7 +190,17 @@ module DaVinciCRDTestKit
       end
     end
 
+    def extract_prefetched_coverage(prefetch)
+      return nil unless prefetch.present?
+      return prefetch['coverage'] if prefetch['coverage'].present?
+      return prefetch['cov'] if prefetch['cov'].present?
+
+      nil
+    end
+
     def get_context_resource(update_resource_id)
+      return unless update_resource_id.present?
+
       update_resource_id = "#{resource_type_to_update}/#{update_resource_id}" unless update_resource_id.include? '/'
       fhir_server = request_body['fhirServer']
       return if fhir_server.blank?
@@ -190,7 +213,7 @@ module DaVinciCRDTestKit
     end
 
     def add_coverage_cards?
-      (['coverage_information', 'create_update_coverage_info'].any? { |x| selected_response_types.include?(x) }) ||
+      ['coverage_information', 'create_update_coverage_info'].any? { |x| selected_response_types.include?(x) } ||
         coverage_information_required?
     end
 
@@ -200,7 +223,6 @@ module DaVinciCRDTestKit
       cards = []
 
       add_basic_cards(cards)
-
       add_order_hook_cards(cards)
 
       system_actions = add_coverage_cards(cards)
@@ -210,7 +232,9 @@ module DaVinciCRDTestKit
       cards_response = { 'cards' => cards }
       cards_response['systemActions'] = system_actions if system_actions.present?
       cards_response
-    rescue StandardError
+    rescue StandardError => e
+      Inferno::Application['logger'].error(e.full_message)
+      # TODO: - make sure this gets logged
       nil
     end
 
@@ -231,31 +255,26 @@ module DaVinciCRDTestKit
     def add_coverage_cards(cards)
       return unless add_coverage_cards?
 
-      coverage = get_patient_coverage
-      if coverage.present?
+      system_actions = []
+      if patient_coverage.present?
         if selected_response_types.include?('coverage_information') || coverage_information_required?
-          system_actions =
-            create_coverage_extension_system_actions(coverage.id)
+          system_actions = create_coverage_extension_system_actions(patient_coverage.id)
         end
 
         if selected_response_types.include?('create_update_coverage_info')
-          cards.append(create_or_update_coverage(coverage))
+          coverage_card = create_or_update_coverage(patient_coverage)
+          cards.append(coverage_card) if coverage_card.present?
         end
       end
       system_actions
     end
 
     def create_coverage_extension_system_actions(coverage_id)
-      update_resource = context[resource_to_update_field_name]
-      prefetch_id = resource_to_update_field_name.split(/(?=[A-Z])/).first
-
       fhir_resource =
-        if update_resource.is_a? Hash
-          FHIR.from_contents(update_resource.to_json)
-        elsif request_body['prefetch'] && request_body['prefetch'][prefetch_id]
-          FHIR.from_contents(request_body['prefetch'][prefetch_id].to_json)
+        if requested_hook == 'order-dispatch' && ig_version == 'v221'
+          find_prefetched_order_dispatch_orders
         else
-          get_context_resource(update_resource)
+          identify_resources_for_system_actions
         end
 
       create_system_actions(fhir_resource, coverage_id)
@@ -263,6 +282,65 @@ module DaVinciCRDTestKit
       nil
     end
 
+    def identify_resources_for_system_actions
+      update_resource = context[resource_to_update_field_name]
+      prefetch_id = prefetch_key_for_system_actions
+
+      if update_resource.is_a? Hash
+        FHIR.from_contents(update_resource.to_json)
+      elsif prefetch_id.present? && request_body['prefetch'] && request_body['prefetch'][prefetch_id]
+        FHIR.from_contents(request_body['prefetch'][prefetch_id].to_json)
+      elsif update_resource.present?
+        get_context_resource(update_resource)
+      end
+    end
+
+    def prefetch_key_for_system_actions
+      if requested_hook.starts_with?('encounter')
+        'encounter'
+      elsif requested_hook == 'order-dispatch'
+        'order'
+      end
+    end
+
+    def find_prefetched_order_dispatch_orders
+      orders_bundle = FHIR::Bundle.new
+
+      context['dispatchedOrders']&.each do |order_reference|
+        prefetched_entry = find_one_prefetched_order_dispatch_order(order_reference)
+        if prefetched_entry.present?
+          orders_bundle.entry << prefetched_entry
+          next
+        end
+
+        read_resource = get_context_resource(order_reference)
+        orders_bundle.entry << FHIR::Bundle::Entry.new({ resource: read_resource }) if read_resource.present?
+      end
+
+      orders_bundle if orders_bundle.entry.present?
+    end
+
+    def find_one_prefetched_order_dispatch_order(order_reference)
+      resource_type, id = order_reference.split('/')
+      return unless request_body['prefetch'].present?
+
+      request_body['prefetch'].each_value do |prefetch_value|
+        entry = find_entry_in_prefetch_bundle(prefetch_value, resource_type, id)
+        return entry if entry.present?
+      end
+
+      nil
+    end
+
+    def find_entry_in_prefetch_bundle(prefetch_value, resource_type, id)
+      return unless prefetch_value.is_a?(Hash)
+
+      bundle = FHIR.from_contents(prefetch_value.to_json)
+      return unless bundle.is_a?(FHIR::Bundle)
+
+      bundle.entry.find { |e| e.resource.present? && e.resource.resourceType == resource_type && e.resource.id == id }
+    end
+
     def create_system_actions(resource, coverage_id)
       return if resource.nil?
 
@@ -373,20 +451,40 @@ module DaVinciCRDTestKit
       return if context.nil?
 
       request_form_completion_card = load_json_file('request_form_completion.json')
+      form_completion_questionnaire_action = request_form_completion_card['suggestions'][0]['actions'].find do |action|
+        action['resource']['resourceType'] == 'Questionnaire'
+      end
+      target_fhir_server = request_body['fhirServer'].present? ? request_body['fhirServer'].chomp('/') : ''
+      form_completion_questionnaire_action['extension']['davinci-crd.if-none-exist']
+        .gsub!('<target_fhir_server>', target_fhir_server)
+
       form_completion_task = request_form_completion_card['suggestions'][0]['actions'].find do |action|
         action['resource']['resourceType'] == 'Task'
       end['resource']
 
       form_completion_task['for']['reference'] = "Patient/#{context['patientId']}"
       form_completion_task['authoredOn'] = current_time.strftime('%Y-%m-%d')
+      form_completion_task['input'].delete_at(1) if ig_version == 'v221'
+      form_completion_task['id'] = SecureRandom.uuid
+      payer_reference = payer_reference_from_coverage
+      if payer_reference.present?
+        form_completion_task['requester']['reference'] = payer_reference
+      else
+        form_completion_task.delete('requester')
+      end
       request_form_completion_card
     end
 
+    def payer_reference_from_coverage
+      patient_coverage&.payor&.first&.reference
+    end
+
     def update_service_request(service_request)
       return if context.nil?
 
       service_request['subject']['reference'] = "Patient/#{context['patientId']}"
-      service_request['requester']['reference'] = context['userId']
+      service_request['requester']['reference'] =
+        requested_hook == 'order-dispatch' && ig_version == 'v221' ? context['performer'] : context['userId']
       service_request['authoredOn'] = current_time.strftime('%Y-%m-%d')
     end
 
@@ -404,13 +502,7 @@ module DaVinciCRDTestKit
 
       propose_alternate_request_card = load_json_file('propose_alternate_request.json')
 
-      if hook_name == 'order-dispatch'
-        order_resource = get_context_resource(context['order'])
-      else
-        draft_orders = context['draftOrders']['entry']
-        draft_order_resource = draft_orders[0]['resource']
-        order_resource = FHIR.from_contents(draft_order_resource.to_json)
-      end
+      order_resource = identify_alternate_order_resource
       return if order_resource.nil?
 
       order_resource_type = order_resource.resourceType
@@ -421,7 +513,7 @@ module DaVinciCRDTestKit
         {
           'type' => 'delete',
           'description' => 'Remove current order until health assessment has been done',
-          'resourceId' => ["#{order_resource_type}/#{order_resource_id}"]
+          'resourceId' => "#{order_resource_type}/#{order_resource_id}"
         },
         {
           'type' => 'create',
@@ -431,5 +523,19 @@ module DaVinciCRDTestKit
       )
       propose_alternate_request_card
     end
+
+    def identify_alternate_order_resource
+      if requested_hook == 'order-dispatch'
+        if ig_version == 'v221'
+          find_prefetched_order_dispatch_orders&.entry&.first&.resource
+        elsif context['order'].present?
+          get_context_resource(context['order'])
+        end
+      else
+        draft_orders = context['draftOrders']['entry']
+        draft_order_resource = draft_orders[0]['resource']
+        FHIR.from_contents(draft_order_resource.to_json)
+      end
+    end
   end
 end

data/lib/davinci_crd_test_kit/{card_responses → client/endpoints/mocked_card_responses}/companions_prerequisites.json

@@ -15,6 +15,7 @@
   "suggestions": [
     {
       "label": "Add monthly physical assessment for the first 3 months",
+      "uuid": "5abc166b-c50f-4df4-bdb1-2b0b62cb9e55",
       "actions": [
         {
           "type": "create",

data/lib/davinci_crd_test_kit/{card_responses → client/endpoints/mocked_card_responses}/create_update_coverage_information.json

@@ -1,6 +1,6 @@
 {
   "summary": "Create/Update Coverage Information Card",
-  "detail": "This is a Create/Update Coverage Information Card which is sent when the CRD server is aware of additional coverage that is relevant to the current/proposed activity or has updates/corrections to make to the information held by the CRD Client",
+  "detail": "This is a Create/Update Coverage Information Card which is sent when the CRD server is aware of additional coverage that is relevant to the current/proposed activity or has updates/corrections to make to the information held by the CRD client",
   "indicator": "info",
   "source": {
     "label": "Inferno",
@@ -14,7 +14,8 @@
   "selectionBehavior": "any",
   "suggestions": [
     {
-      "label": "Create/Update coverage information"
+      "label": "Create/Update coverage information",
+      "uuid": "5abc166b-c50f-4df4-bdb2-2b0b62cb9e55"
     }
   ]
 }

data/lib/davinci_crd_test_kit/{card_responses → client/endpoints/mocked_card_responses}/launch_smart_app.json

@@ -11,6 +11,13 @@
       "display": "Coverage Information"
     }
   },
+  "suggestions": [
+    {
+      "label": "Inferno placeholder suggestion",
+      "uuid": "5abc166b-c50f-4df4-bdb1-2b0b62cb8e55"
+    }
+  ],
+  "selectionBehavior": "any",
   "links": [
     {
       "label": "Inferno",
@@ -18,4 +25,4 @@
       "type": "smart"
     }
   ]
-}
+}

data/lib/davinci_crd_test_kit/{card_responses → client/endpoints/mocked_card_responses}/propose_alternate_request.json

@@ -15,6 +15,7 @@
   "suggestions": [
     {
       "label": "Replace order with a health assessment first",
+      "uuid": "5abc166b-c50f-4df4-b5b1-2b0b62cb9e55",
       "actions": []
     }
   ]

data/lib/davinci_crd_test_kit/{card_responses → client/endpoints/mocked_card_responses}/request_form_completion.json

@@ -15,6 +15,7 @@
   "suggestions": [
     {
       "label": "Add 'completion of the ABC form' to your task list (possibly for reassignment)",
+      "uuid": "5abc166b-c50f-4df4-bdc1-2b0b62cb9e55",
       "actions": [
         {
           "type": "create",
@@ -22,9 +23,9 @@
           "resource": {
             "resourceType": "Questionnaire",
             "id": "XYZ",
-            "url": "http://example.org/Questionnaire/XYZ",
+            "url": "http://inferno.healthit.gov/davinci-crd-test-kit/forms/XYZ",
             "title": "Cancer Quality Forum Questionnaire XYZ",
-            "version": 2,
+            "version": "2",
             "status": "active",
             "subjectType": [
               "Patient"
@@ -35,7 +36,7 @@
                 "linkId": "1",
                 "code": [
                   {
-                    "system": "http://example.org/system/code/sections",
+                    "system": "http://inferno.healthit.gov/davinci-crd-test-kit/code/sections",
                     "code": "COMORBIDITY"
                   }
                 ],
@@ -45,7 +46,7 @@
                     "linkId": "1.1",
                     "code": [
                       {
-                        "system": "http://example.org/system/code/questions",
+                        "system": "http://inferno.healthit.gov/davinci-crd-test-kit/code/questions",
                         "code": "COMORB"
                       }
                     ],
@@ -57,7 +58,7 @@
                         "linkId": "1.1.1",
                         "code": [
                           {
-                            "system": "http://example.org/system/code/sections",
+                            "system": "http://inferno.healthit.gov/davinci-crd-test-kit/code/sections",
                             "code": "CARDIAL"
                           }
                         ],
@@ -77,7 +78,7 @@
                             "linkId": "1.1.1.1",
                             "code": [
                               {
-                                "system": "http://example.org/system/code/questions",
+                                "system": "http://inferno.healthit.gov/davinci-crd-test-kit/code/questions",
                                 "code": "COMORBCAR"
                               }
                             ],
@@ -89,7 +90,7 @@
                                 "linkId": "1.1.1.1.1",
                                 "code": [
                                   {
-                                    "system": "http://example.org/system/code/questions",
+                                    "system": "http://inferno.healthit.gov/davinci-crd-test-kit/code/questions",
                                     "code": "COMCAR00",
                                     "display": "Angina Pectoris"
                                   },
@@ -122,7 +123,7 @@
                             "linkId": "1.1.1.2",
                             "code": [
                               {
-                                "system": "http://example.org/system/code/questions",
+                                "system": "http://inferno.healthit.gov/davinci-crd-test-kit/code/questions",
                                 "code": "COMORBVAS"
                               }
                             ],
@@ -140,7 +141,7 @@
                 "linkId": "2",
                 "code": [
                   {
-                    "system": "http://example.org/system/code/sections",
+                    "system": "http://inferno.healthit.gov/davinci-crd-test-kit/code/sections",
                     "code": "HISTOPATHOLOGY"
                   }
                 ],
@@ -150,7 +151,7 @@
                     "linkId": "2.1",
                     "code": [
                       {
-                        "system": "http://example.org/system/code/sections",
+                        "system": "http://inferno.healthit.gov/davinci-crd-test-kit/code/sections",
                         "code": "ABDOMINAL"
                       }
                     ],
@@ -160,7 +161,7 @@
                         "linkId": "2.1.2",
                         "code": [
                           {
-                            "system": "http://example.org/system/code/questions",
+                            "system": "http://inferno.healthit.gov/davinci-crd-test-kit/code/questions",
                             "code": "STADPT",
                             "display": "pT category"
                           }
@@ -174,7 +175,7 @@
             ]
           },
           "extension": {
-            "davinci-crd.if-none-exist": "url=http://example.org/Questionnaire/XYZ&version=2"
+            "davinci-crd.if-none-exist": "url=<target_fhir_server>/Questionnaire?url=http://inferno.healthit.gov/davinci-crd-test-kit/forms/XYZ&version=2"
           }
         },
         {
@@ -194,11 +195,11 @@
             },
             "description": "Complete XYZ form for local retention",
             "for": {
-              "reference": "http://example.org/fhir/Patient/123"
+              "reference": "Patient/<patient-id>"
             },
             "authoredOn": "2018-08-09",
             "requester": {
-              "reference": "http://example.org/fhir/Organization/payer"
+              "reference": "Organization/<payer-id>"
             },
             "input": [
               {
@@ -211,7 +212,7 @@
                     }
                   ]
                 },
-                "valueCanonical": "http://example.org/Questionnaire/XYZ"
+                "valueCanonical": "http://inferno.healthit.gov/davinci-crd-test-kit/forms/XYZ"
               },
               {
                 "type": {
@@ -239,4 +240,4 @@
       ]
     }
   ]
-}
+}

data/lib/davinci_crd_test_kit/client/multi_request_message_helper.rb

@@ -0,0 +1,35 @@
+module DaVinciCRDTestKit
+  module MultiRequestMessageHelper
+    def request_prefix(request_index)
+      "(Request #{request_index + 1}) "
+    end
+
+    def add_request_message(type, message, request_index)
+      add_message(type, "#{request_prefix(request_index)}#{message}")
+    end
+
+    def parse_json_request_entity(body, entity, request_index)
+      JSON.parse(body)
+    rescue JSON::ParserError
+      add_request_message('error', "#{entity} contains invalid JSON.", request_index)
+      nil
+    end
+
+    def requests_with_errors_prefix
+      request_numbers = error_request_numbers
+      return '' if request_numbers.empty?
+
+      noun = request_numbers.size == 1 ? 'Request' : 'Requests'
+      "#{noun} #{request_numbers.to_sentence}: "
+    end
+
+    private
+
+    def error_request_numbers
+      messages
+        .select { |m| m[:type] == 'error' }
+        .filter_map { |m| m[:message].match(/\A\(Request (\d+)\)/)&.captures&.first&.to_i }
+        .sort.uniq
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/tagged_request_load_helper.rb

@@ -0,0 +1,38 @@
+module DaVinciCRDTestKit
+  module TaggedRequestLoadHelper
+    ALL_HOOKS = [
+      APPOINTMENT_BOOK_TAG,
+      ENCOUNTER_START_TAG,
+      ENCOUNTER_DISCHARGE_TAG,
+      ORDER_DISPATCH_TAG,
+      ORDER_SELECT_TAG,
+      ORDER_SIGN_TAG
+    ].freeze
+
+    def hook_name
+      config.options[:hook_name]
+    end
+
+    def crd_test_group
+      config.options[:crd_test_group]
+    end
+
+    def tags_to_load(hook = hook_name)
+      crd_test_group.present? ? [crd_test_group] : [hook]
+    end
+
+    def load_hook_requests
+      load_tagged_requests(*tags_to_load)
+    end
+
+    def requests_to_analyze
+      if hook_name.present?
+        load_tagged_requests(*tags_to_load)
+      else
+        ALL_HOOKS.each_with_object([]) do |hook, request_list|
+          request_list.concat(load_tagged_requests(*tags_to_load(hook)))
+        end
+      end
+    end
+  end
+end