davinci_dtr_test_kit 0.17.0 → 0.18.0

data/lib/davinci_dtr_test_kit/cross_suite/v2.2.0/questionnaire_helper.rb

@@ -0,0 +1,162 @@
+module DaVinciDTRTestKit
+  module QuestionnaireHelper
+    ###########################################################################
+    # Canonical URLs
+    ###########################################################################
+
+    def questionnaire_canonical_url(questionnaire)
+      if questionnaire.version.present?
+        "#{questionnaire.url}|#{questionnaire.version}"
+      else
+        questionnaire.url
+      end
+    end
+
+    ###########################################################################
+    # Categorizing Questionnaires
+    ###########################################################################
+
+    def adaptive_questionnaire?(questionnaire)
+      questionnaire.extension.find do |extension|
+        extension.valueBoolean != false &&
+          extension.url == 'http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive'
+      end
+    end
+
+    ###########################################################################
+    # Display for Questionnaires
+    ###########################################################################
+
+    def questionnaire_display(questionnaire)
+      canonical_url = questionnaire_canonical_url(questionnaire)
+      title = questionnaire.title.present? ? questionnaire.title : questionnaire.name
+
+      if title.present?
+        "#{title} (#{canonical_url})"
+      else
+        canonical_url
+      end
+    end
+
+    ###########################################################################
+    # Generic Questionnaire Extraction ($questionnaire-package or $next-question)
+    ###########################################################################
+
+    def no_questionnaires_returned?(requests)
+      questionnaires_from_operation_responses(requests).blank?
+    end
+
+    def questionnaires_from_operation_responses(requests, include_standard: true, include_adaptive: true)
+      questionnaires = []
+
+      parsed_operation_responses(requests).each do |request, response|
+        # pull out Questionnaires from requests ($q-p and $n-q)
+        if response.is_a?(FHIR::QuestionnaireResponse)
+          questionnaires << contained_questionnaire_from_questionnaire_response(response) if include_adaptive
+        elsif response.is_a?(FHIR::Parameters)
+          questionnaires.concat(questionnaires_from_operation_response_parameters(response, request, include_standard:,
+                                                                                                     include_adaptive:))
+        end
+      end
+
+      questionnaires.compact
+    end
+
+    def questionnaires_from_operation_response_parameters(parameters, request, include_standard: true,
+                                                          include_adaptive: true)
+      if request.url.include?('$questionnaire-package')
+        questionnaires_from_questionnaire_package_output_parameters(parameters, include_standard:, include_adaptive:)
+      elsif request.url.include?('$next-question')
+        Array.wrap(include_adaptive ? questionnaire_from_next_question_output_parameters(parameters) : nil)
+      end
+    end
+
+    ###########################################################################
+    # $next-question extraction of QuestionnaireResponse and Questionnaire
+    ###########################################################################
+
+    def contained_questionnaire_from_questionnaire_response(questionnaire_response)
+      questionnaire_response&.contained&.find do |contained_resource|
+        contained_resource.is_a?(FHIR::Questionnaire)
+      end
+    end
+
+    def questionnaire_from_next_question_output_parameters(parameters)
+      return_parameter = parameters.parameter.find do |parameter|
+        parameter.name == 'return' && parameter.resource.is_a?(FHIR::QuestionnaireResponse)
+      end
+      return nil unless return_parameter.present?
+
+      contained_questionnaire_from_questionnaire_response(return_parameter.resource)
+    end
+
+    # $next-question has a single "return" out parameter typed as a Resource, so per the FHIR
+    # spec (https://www.hl7.org/fhir/R4/operations.html#response) a conformant response is the
+    # raw QuestionnaireResponse rather than a Parameters wrapper (see
+    # dtr_next_question_response_validation_test); a Parameters-wrapped `return` is tolerated too.
+    # Expects an already-parsed response body (a FHIR resource), not a raw request/JSON string.
+    def questionnaire_response_from_next_question_response(response_body)
+      case response_body
+      when FHIR::QuestionnaireResponse
+        response_body
+      when FHIR::Parameters
+        response_body.parameter.find do |parameter|
+          parameter.name == 'return' && parameter.resource.is_a?(FHIR::QuestionnaireResponse)
+        end&.resource
+      end
+    end
+
+    def questionnaire_response_from_next_question_request(request_body)
+      case request_body
+      when FHIR::QuestionnaireResponse
+        request_body
+      when FHIR::Parameters
+        request_body.parameter.find do |parameter|
+          parameter.name == 'questionnaire-response' && parameter.resource.is_a?(FHIR::QuestionnaireResponse)
+        end&.resource
+      end
+    end
+
+    ###########################################################################
+    # $questionnaire-package extraction of Parameters, Bundle, Questionnaire
+    ###########################################################################
+
+    def questionnaire_package_output_parameters_from_operation_responses(requests)
+      parsed_operation_responses(requests).filter_map do |_request, response|
+        response if response.is_a?(FHIR::Parameters)
+      end
+    end
+
+    def questionnaire_package_bundles(parameters)
+      parameters.parameter.filter_map do |parameter|
+        parameter.resource if parameter.name == 'packagebundle' && parameter.resource.is_a?(FHIR::Bundle)
+      end
+    end
+
+    def questionnaires_from_questionnaire_package_output_parameters(parameters, include_standard: true,
+                                                                    include_adaptive: true)
+      questionnaire_package_bundles(parameters).filter_map do |bundle|
+        questionnaire_from_package_bundle(bundle, include_standard:, include_adaptive:)
+      end
+    end
+
+    def questionnaire_from_package_bundle(bundle, include_standard: true, include_adaptive: true)
+      bundle.entry.find do |entry|
+        entry.resource.is_a?(FHIR::Questionnaire) &&
+          (adaptive_questionnaire?(entry.resource) ? include_adaptive : include_standard)
+      end&.resource
+    end
+
+    private
+
+    def parsed_operation_responses(requests)
+      requests.filter_map do |request|
+        next if request.response_body.blank?
+
+        [request, FHIR.from_contents(request.response_body)]
+      rescue JSON::ParserError
+        nil # errors handled elsewhere
+      end
+    end
+  end
+end

data/lib/davinci_dtr_test_kit/{dtr_client_options.rb → full_ehr/dtr_full_ehr_options.rb}

@@ -4,7 +4,7 @@ require 'smart_app_launch_test_kit'
 require 'udap_security_test_kit'
 
 module DaVinciDTRTestKit
-  module DTRClientOptions
+  module DTRFullEHROptions
     SMART_BACKEND_SERVICES_CONFIDENTIAL_ASYMMETRIC =
       SMARTAppLaunch::SMARTClientOptions::SMART_BACKEND_SERVICES_CONFIDENTIAL_ASYMMETRIC
     UDAP_CLIENT_CREDENTIALS =

data/lib/davinci_dtr_test_kit/{endpoints → full_ehr/endpoints}/mock_payer.rb

@@ -1,9 +1,15 @@
 module DaVinciDTRTestKit
   module MockPayer
-    def parse_fhir_object(str)
-      FHIR.from_contents(str)
+    class ParseError < StandardError; end
+
+    def parse_fhir_object(str, entity: 'Request')
+      FHIR.from_contents(str).tap do |result|
+        raise ParseError, "#{entity} does not contain a valid FHIR resource." if result.nil?
+      end
+    rescue ParseError
+      raise
     rescue StandardError
-      operation_outcome('error', 'invalid', 'No valid input parameters')
+      raise ParseError, "#{entity} does not contain valid JSON."
     end
 
     def find_questionnaire_response(input_parameters)

data/lib/davinci_dtr_test_kit/{endpoints → full_ehr/endpoints}/mock_udap_smart_server/token_endpoint.rb

@@ -2,8 +2,8 @@
 
 require 'udap_security_test_kit'
 require 'smart_app_launch_test_kit'
-require_relative '../../urls'
-require_relative '../../tags'
+require_relative '../../../urls'
+require_relative '../../../tags'
 
 module DaVinciDTRTestKit
   module MockUdapSmartServer

data/lib/davinci_dtr_test_kit/full_ehr/fixture_loader.rb

@@ -0,0 +1,37 @@
+require 'singleton'
+require 'fhir_models'
+
+module DaVinciDTRTestKit
+  class FixtureLoader
+    include Singleton
+
+    def initialize
+      @cache = {}
+    end
+
+    def [](path)
+      return unless path.present?
+
+      return @cache[path] if @cache.key?(path)
+
+      fixture_path = File.join(__dir__, 'fixtures', path)
+      begin
+        fhir_instance = FHIR.from_contents(File.read(fixture_path))
+      rescue Errno::ENOENT
+        raise Inferno::Exceptions::TestSuiteImplementationException.new('FixtureLoader',
+                                                                        "File not found: #{fixture_path}")
+      rescue JSON::ParserError => e
+        raise Inferno::Exceptions::TestSuiteImplementationException.new('FixtureLoader',
+                                                                        "Invalid JSON in #{fixture_path}: #{e.message}")
+      end
+      if fhir_instance.nil?
+        raise Inferno::Exceptions::TestSuiteImplementationException.new(
+          'FixtureLoader',
+          "#{fixture_path} does not contain a valid FHIR resource."
+        )
+      end
+
+      @cache[path] = fhir_instance
+    end
+  end
+end

data/lib/davinci_dtr_test_kit/full_ehr/fixtures/dinner_adaptive/dinner_order_adaptive_next_question_template.json

@@ -0,0 +1,243 @@
+{
+  "resourceType": "Questionnaire",
+  "id": "DinnerOrderAdaptive",
+  "meta": {
+    "profile": [
+      "http://hl7.org/fhir/StructureDefinition/cqf-questionnaire",
+      "http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-questionnaire-adapt",
+      "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-adapt"
+    ]
+  },
+  "text": {
+    "status": "generated",
+    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">This is an adaptive questionnaire used to determine what a patient would like for dinner, including pre-populated patient information.</div>"
+  },
+  "extension": [
+    {
+      "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive",
+      "valueBoolean": true
+    },
+    {
+      "url": "http://hl7.org/fhir/StructureDefinition/cqf-library",
+      "valueCanonical": "https://madie.cms.gov/Library/DTRTest"
+    }
+  ],
+  "derivedFrom": [
+    "urn:inferno:dtr-test-kit:dinner-order-adaptive"
+  ],
+  "name": "DinnerOrderAdaptive",
+  "title": "Dinner Order (Adaptive)",
+  "status": "draft",
+  "subjectType": [
+    "Patient"
+  ],
+  "date": "2024-05-06",
+  "publisher": "Inferno",
+  "item": [
+    {
+      "extension": [
+        {
+          "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl",
+          "valueCodeableConcept": {
+            "coding": [
+              {
+                "system": "http://hl7.org/fhir/questionnaire-item-control",
+                "code": "gtable"
+              }
+            ]
+          }
+        }
+      ],
+      "linkId": "PBD",
+      "text": "Patient Information",
+      "type": "group",
+      "item": [
+        {
+          "extension": [
+            {
+              "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression",
+              "valueExpression": {
+                "language": "text/cql",
+                "expression": "\"DTRTest\".LastName"
+              }
+            }
+          ],
+          "linkId": "PBD.1",
+          "text": "Last Name:",
+          "type": "string",
+          "required": true
+        },
+        {
+          "extension": [
+            {
+              "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression",
+              "valueExpression": {
+                "language": "text/cql",
+                "expression": "\"DTRTest\".FirstName"
+              }
+            }
+          ],
+          "linkId": "PBD.2",
+          "text": "First Name:",
+          "type": "string",
+          "required": true
+        }
+      ]
+    },
+    {
+      "extension": [
+        {
+          "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl",
+          "valueCodeableConcept": {
+            "coding": [
+              {
+                "system": "http://hl7.org/fhir/questionnaire-item-control",
+                "code": "gtable"
+              }
+            ]
+          }
+        }
+      ],
+      "linkId": "LOC",
+      "text": "Patient's Location",
+      "type": "group",
+      "item": [
+        {
+          "extension": [
+            {
+              "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression",
+              "valueExpression": {
+                "language": "text/cql",
+                "expression": "\"DTRTest\".FirstLocationDescription"
+              }
+            }
+          ],
+          "linkId": "LOC.1",
+          "text": "Location",
+          "type": "string",
+          "required": true
+        }
+      ]
+    },
+    {
+      "linkId": "3",
+      "text": "Dinner Order",
+      "type": "group",
+      "extension": [
+        {
+          "url": "urn:inferno:dtr:inclusion-criteria",
+          "valueExpression": {
+            "language": "text/fhirpath",
+            "expression": "item.where(linkId = 'LOC').item.where(linkId = 'LOC.1').answer.value.ofType(string).exists()"
+          }
+        }
+      ],
+      "item": [
+        {
+          "linkId": "3.1",
+          "text": "What would you like for dinner?",
+          "type": "choice",
+          "required": true,
+          "answerOption": [
+            {
+              "valueCoding": {
+                "code": "Hamburger"
+              }
+            },
+            {
+              "valueCoding": {
+                "code": "Bean Burrito"
+              }
+            }
+          ]
+        },
+        {
+          "linkId": "3.2.a",
+          "text": "What would you like on your hamburger?",
+          "type": "choice",
+          "required": false,
+          "repeats": true,
+          "answerOption": [
+            {
+              "valueCoding": {
+                "code": "Ketchup"
+              }
+            },
+            {
+              "valueCoding": {
+                "code": "Mustard"
+              }
+            },
+            {
+              "valueCoding": {
+                "code": "Pickles"
+              }
+            },
+            {
+              "valueCoding": {
+                "code": "Tomato"
+              }
+            }
+          ],
+          "extension": [
+            {
+              "url": "urn:inferno:dtr:inclusion-criteria",
+              "valueExpression": {
+                "language": "text/fhirpath",
+                "expression": "item.where(linkId = '3').item.where(linkId = '3.1').answer.value.ofType(Coding).where(code = 'Hamburger').exists()"
+              }
+            }
+          ]
+        },
+        {
+          "linkId": "3.2.b",
+          "text": "What would you like on your bean burrito?",
+          "type": "choice",
+          "required": false,
+          "repeats": true,
+          "answerOption": [
+            {
+              "valueCoding": {
+                "code": "Cheese"
+              }
+            },
+            {
+              "valueCoding": {
+                "code": "Pico de Gallo"
+              }
+            },
+            {
+              "valueCoding": {
+                "code": "Guacamole"
+              }
+            }
+          ],
+          "extension": [
+            {
+              "url": "urn:inferno:dtr:inclusion-criteria",
+              "valueExpression": {
+                "language": "text/fhirpath",
+                "expression": "item.where(linkId = '3').item.where(linkId = '3.1').answer.value.ofType(Coding).where(code = 'Bean Burrito').exists()"
+              }
+            }
+          ]
+        },
+        {
+          "linkId": "3.3",
+          "text": "Any special requests?",
+          "type": "string",
+          "required": false,
+          "extension": [
+            {
+              "url": "urn:inferno:dtr:inclusion-criteria",
+              "valueExpression": {
+                "language": "text/fhirpath",
+                "expression": "item.where(linkId = '3').item.where(linkId = '3.1').answer.value.ofType(Coding).code.exists()"
+              }
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}