davinci_crd_test_kit 0.12.2 → 0.14.0

data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/Device.yml

@@ -0,0 +1,5 @@
+---
+:resource: Device
+:profile_url: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-device
+:profile_name: CRD Device
+:profile_version: 2.0.1

data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/DeviceRequest.yml

@@ -0,0 +1,5 @@
+---
+:resource: DeviceRequest
+:profile_url: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-devicerequest
+:profile_name: CRD DeviceRequest
+:profile_version: 2.0.1

data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/Encounter.yml

@@ -0,0 +1,7 @@
+---
+:resource: Encounter
+:profile_url: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-encounter
+:profile_name: CRD Encounter
+:profile_version: 2.0.1
+:include_params:
+- Encounter:location

data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/Location.yml

@@ -0,0 +1,5 @@
+---
+:resource: Location
+:profile_url: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-location
+:profile_name: CRD Location
+:profile_version: 2.0.1

data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/MedicationRequest.yml

@@ -0,0 +1,5 @@
+---
+:resource: MedicationRequest
+:profile_url: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-medicationrequest
+:profile_name: CRD MedicationRequest
+:profile_version: 2.0.1

data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/NutritionOrder.yml

@@ -0,0 +1,5 @@
+---
+:resource: NutritionOrder
+:profile_url: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-nutritionorder
+:profile_name: CRD NutritionOrder
+:profile_version: 2.0.1

data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/Organization.yml

@@ -0,0 +1,5 @@
+---
+:resource: Organization
+:profile_url: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-organization
+:profile_name: CRD Organization
+:profile_version: 2.0.1

data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/Patient.yml

@@ -0,0 +1,5 @@
+---
+:resource: Patient
+:profile_url: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-patient
+:profile_name: CRD Patient
+:profile_version: 2.0.1

data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/Practitioner.yml

@@ -0,0 +1,5 @@
+---
+:resource: Practitioner
+:profile_url: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-practitioner
+:profile_name: CRD Practitioner
+:profile_version: 2.0.1

data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/PractitionerRole.yml

@@ -0,0 +1,40 @@
+---
+:resource: PractitionerRole
+:profile_url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole
+:profile_name: US Core PractitionerRole
+:profile_version: 3.1.1
+:search_definitions:
+  :_id:
+    :paths:
+    - id
+    :full_paths:
+    - PractitionerRole.id
+    :type: http://hl7.org/fhirpath/System.String
+  :specialty:
+    :paths:
+    - specialty
+    :full_paths:
+    - PractitionerRole.specialty
+    :type: CodeableConcept
+  :organization:
+    :paths:
+    - organization
+    :full_paths:
+    - PractitionerRole.organization
+    :type: Reference
+  :practitioner:
+    :paths:
+    - practitioner
+    :full_paths:
+    - PractitionerRole.practitioner
+    :type: Reference
+    :chain:
+    - :chain: identifier
+      :expectation: SHALL
+    - :chain: name
+      :expectation: SHALL
+:include_params:
+- PractitionerRole:endpoint
+- PractitionerRole:practitioner
+:revincludes:
+- Provenance:target

data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/ServiceRequest.yml

@@ -0,0 +1,5 @@
+---
+:resource: ServiceRequest
+:profile_url: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-servicerequest
+:profile_name: CRD ServiceRequest
+:profile_version: 2.0.1

data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/Task.yml

@@ -0,0 +1,5 @@
+---
+:resource: Task
+:profile_url: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-taskquestionnaire
+:profile_name: CRD Questionnaire Task
+:profile_version: 2.0.1

data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/VisionPrescription.yml

@@ -0,0 +1,5 @@
+---
+:resource: VisionPrescription
+:profile_url: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-visionprescription
+:profile_name: CRD VisionPrescription
+:profile_version: 2.0.1

data/lib/davinci_crd_test_kit/server/v2.0.1/crd_server_suite.rb

@@ -0,0 +1,99 @@
+require_relative '../jwt_helper'
+require_relative '../endpoints/jwk_set_endpoint_handler'
+require_relative 'server_discovery_group'
+require_relative 'server_demonstrate_hook_response_group'
+require_relative 'server_hooks_group'
+require_relative 'server_urls'
+require_relative '../endpoints/mock_ehr_endpoints'
+
+module DaVinciCRDTestKit
+  module V201
+    class CRDServerSuite < Inferno::TestSuite
+      include ServerURLs
+
+      id :crd_server
+      title 'Da Vinci CRD Server v2.0.1 Test Suite'
+      description <<~DESCRIPTION
+        The Da Vinci CRD Server Test Suite tests the conformance of server systems
+        to [version 2.0.1 of the Da Vinci Coverage Requirements Discovery (CRD)
+        Implementation Guide](https://hl7.org/fhir/us/davinci-crd/STU2).
+
+        For details on the design and use of these tests, see the wiki including
+        - [Suite Details](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Server-Details)
+          for a high-level description of the test
+          organization, including its components and limitations.
+        - [Testing Instructions](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Server-Instructions)
+          for a step-by-step guide to execution of these
+          tests against a CRD server, including [instructions for a demonstration execution](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Server-Instructions#demonstration-execution)
+          against the [public reference implementation](https://crd.davinci.hl7.org/).
+      DESCRIPTION
+
+      suite_summary <<~SUMMARY
+        The Da Vinci CRD Server Test Suite tests the conformance of server systems
+        to [version 2.0.1 of the Da Vinci Coverage Requirements Discovery (CRD)
+        Implementation Guide](https://hl7.org/fhir/us/davinci-crd/STU2).
+      SUMMARY
+
+      links [
+        {
+          label: 'Report Issue',
+          url: 'https://github.com/inferno-framework/davinci-crd-test-kit/issues'
+        },
+        {
+          label: 'Open Source',
+          url: 'https://github.com/inferno-framework/davinci-crd-test-kit'
+        },
+        {
+          label: 'Download',
+          url: 'https://github.com/inferno-framework/davinci-crd-test-kit/releases'
+        }
+      ]
+
+      requirement_sets(
+        {
+          identifier: 'hl7.fhir.us.davinci-crd_2.0.1',
+          title: 'Da Vinci Coverage Requirements Discovery (CRD) v2.0.1',
+          actor: 'Server'
+        }
+      )
+
+      input :base_url,
+            title: 'CRD server base URL'
+
+      fhir_resource_validator do
+        igs('hl7.fhir.us.davinci-crd#2.0.1')
+
+        validation_context do
+          snomedCT '731000124108' # explicit snomedCT expansion parameter
+        end
+
+        exclude_message do |message|
+          # extension definition issue present in 2.0.1 but corrected in later versions
+          message.message.match?(%r{The extension http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information is not allowed to be used at this point \(allowed = e:QuestionnaireResponse, e:Encounter, e:NutritionOrder, e:CommunicationRequest, e:DeviceRequest, e:ServiceRequest, e:MedicationRequest; this element is \[Appointment\]\)}) # rubocop:disable Layout/LineLength
+        end
+      end
+
+      US_CORE_3_METADATA_PATTERN = File.join(
+        Gem::Specification.find_by_name('us_core_test_kit').gem_dir,
+        'lib', 'us_core_test_kit', 'generated', 'v3.1.1', '*', 'metadata.yml'
+      )
+      CRD_V201_METADATA_PATTERN = File.join(__dir__, 'crd_metadata', '*.yml')
+      include(MockEHREndpoints.with do
+                Dir.glob([US_CORE_3_METADATA_PATTERN, CRD_V201_METADATA_PATTERN])
+              end)
+
+      route :get, '/jwks.json', JWKSetEndpointHandler
+      resume_test_route :get, RESUME_PASS_PATH do |request|
+        request.query_parameters['token']
+      end
+      resume_test_route :get, RESUME_FAIL_PATH, result: 'fail' do |request|
+        request.query_parameters['token']
+      end
+      group from: :crd_v201_server_discovery_group
+
+      group from: :crd_v201_server_demonstrate_hook_response
+
+      group from: :crd_v201_server_hooks
+    end
+  end
+end

data/lib/davinci_crd_test_kit/server/v2.0.1/discovery/discovery_endpoint_test.rb

@@ -0,0 +1,90 @@
+module DaVinciCRDTestKit
+  module V201
+    class DiscoveryEndpointTest < Inferno::Test
+      title 'Server returns a discovery response'
+      id :crd_v201_discovery_endpoint_test
+      description %(
+        A CDS Service provider must expose its discovery endpoint at `{baseURL}/cds-services`
+        as specified in the [CDS Hooks Specification](https://cds-hooks.hl7.org/2.0/#discovery).
+
+        This test checks that the server responds to a GET request at the following endpoint:
+
+        `GET {baseURL}/cds-services`
+
+        It does this by checking that the server responds with an HTTP OK 200 status code
+        and that the body of the response is a valid JSON object. This test does not
+        inspect the structure and content of the response body to see if it contains the required information.
+        It only checks to see if the RESTful interaction is supported and returns a valid JSON object.
+      )
+
+      input_order :base_url, :authentication_required, :encryption_method, :jwks_kid
+      input :base_url
+      input :authentication_required,
+            title: 'Discovery endpoint requires authentication?',
+            type: 'radio',
+            default: 'no',
+            options: {
+              list_options: [
+                {
+                  label: 'No',
+                  value: 'no'
+                },
+                {
+                  label: 'Yes',
+                  value: 'yes'
+                }
+              ]
+            }
+      input :encryption_method,
+            title: 'JWT Signing Algorithm',
+            description: <<~DESCRIPTION,
+              CDS Hooks recommends ES384 and RS384 for JWT signature verification.
+              Select which method to use.
+            DESCRIPTION
+            type: 'radio',
+            default: 'ES384',
+            options: {
+              list_options: [
+                {
+                  label: 'ES384',
+                  value: 'ES384'
+                },
+                {
+                  label: 'RS384',
+                  value: 'RS384'
+                }
+              ]
+            }
+      input :jwks_kid,
+            title: 'CDS Services JWKS kid',
+            description: <<~DESCRIPTION,
+              The key ID of the JWKS private key to use for signing the JWTs when invoking a CDS service endpoint
+              requiring authentication.
+              Defaults to the first JWK in the list if no kid is supplied.
+            DESCRIPTION
+            optional: true
+      output :cds_services
+
+      run do
+        discovery_url = "#{base_url.chomp('/')}/cds-services"
+        headers = { 'Accept' => 'application/json' }
+
+        if authentication_required == 'yes'
+          token = JwtHelper.build(
+            aud: discovery_url,
+            iss: inferno_base_url,
+            jku: "#{inferno_base_url}/jwks.json",
+            kid: jwks_kid,
+            encryption_method:
+          )
+          headers['Authorization'] = "Bearer #{token}"
+        end
+        get(discovery_url, headers:, tags: [DISCOVERY_TAG])
+        assert_response_status(200)
+        assert_valid_json(request.response_body)
+
+        output cds_services: request.response_body
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/server/v2.0.1/discovery/discovery_services_validation_test.rb

@@ -0,0 +1,67 @@
+require_relative '../../server_test_helper'
+
+module DaVinciCRDTestKit
+  module V201
+    class DiscoveryServicesValidationTest < Inferno::Test
+      include DaVinciCRDTestKit::ServerTestHelper
+
+      title 'Discovery response contains valid services'
+      id :crd_v201_discovery_services_validation
+      description %(
+        As per the [CDS Hooks Spec](https://cds-hooks.hl7.org/2.0/#response),
+        the response to the discovery endpoint SHALL be an object containing
+        a list of CDS services. If your CDS server hosts no CDS services,
+        the discovery endpoint should return a 200 HTTP response with
+        an empty array of services.
+
+        Each CDS service must contain the following required fields:
+        `hook`, `description`, and `id`.
+
+        This test checks for the presence of the required fields and
+        validates that they are of the correct type.
+
+        The test will be skipped if the server hosts no CDS services.
+      )
+
+      input :cds_services
+      output :appointment_book_service_ids, :encounter_start_service_ids, :encounter_discharge_service_ids,
+             :order_dispatch_service_ids, :order_select_service_ids, :order_sign_service_ids
+
+      def required_fields
+        {
+          'hook' => String,
+          'description' => String,
+          'id' => String
+        }
+      end
+
+      run do
+        object = parse_json(cds_services)
+        assert object['services'], 'Discovery response did not contain `services`'
+
+        services = object['services']
+        assert services.is_a?(Array), 'Services field of the CDS Discovery response object is not an array.'
+        skip_if services.empty?, 'Server hosts no CDS Services.'
+
+        service_hooks_to_ids = services.each_with_object({}) do |service, hash|
+          hash[service['hook']] ||= []
+          hash[service['hook']] << service['id'] if service['id']
+        end
+
+        output appointment_book_service_ids: service_hooks_to_ids['appointment-book']&.join(', '),
+               encounter_start_service_ids: service_hooks_to_ids['encounter-start']&.join(', '),
+               encounter_discharge_service_ids: service_hooks_to_ids['encounter-discharge']&.join(', '),
+               order_dispatch_service_ids: service_hooks_to_ids['order-dispatch']&.join(', '),
+               order_select_service_ids: service_hooks_to_ids['order-select']&.join(', '),
+               order_sign_service_ids: service_hooks_to_ids['order-sign']&.join(', ')
+
+        services.each do |service|
+          required_fields.each do |field, type|
+            assert(service[field], "Service `#{service}` did not contain required field: `#{field}`")
+            assert(service[field].is_a?(type), "Service `#{service}`: field `#{field}` is not of type #{type}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/server/v2.0.1/interaction/server_invoke_hook_test.rb

@@ -0,0 +1,12 @@
+require_relative '../server_urls'
+require_relative '../../server_abstract_invoke_hook_test'
+
+module DaVinciCRDTestKit
+  module V201
+    class ServerInvokeHookTest < ServerAbstractInvokeHookTest
+      include ServerURLs
+
+      id :crd_v201_server_invoke_hook_test
+    end
+  end
+end

data/lib/davinci_crd_test_kit/server/v2.0.1/must_support/coverage_information_system_action_across_hooks_validation_test.rb

@@ -0,0 +1,34 @@
+require_relative '../../server_test_helper'
+
+module DaVinciCRDTestKit
+  module V201
+    class CoverageInformationSystemActionAcrossHooksValidationTest < Inferno::Test
+      include DaVinciCRDTestKit::ServerTestHelper
+
+      title 'Valid Coverage Information system actions received across all hooks'
+      id :crd_v201_coverage_info_system_action_across_hooks_validation
+      description %(
+        This test verifies the presence of valid [Coverage Information](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#coverage-information)
+        system action returned by CRD services across all hooks invoked. It verifies the following for each action:
+        - The action type is `update`.
+        - The resource within the action conforms its respective FHIR profile.
+
+        Additionally, the test examines the `coverage-info` extensions within the resource to ensure that:
+        - Entries referencing differing coverage have distinct `coverage-assertion-ids` and `satisfied-pa-ids`
+        (if present).
+        - Entries referencing the same coverage have the same `coverage-assertion-ids` and `satisfied-pa-ids`
+        (if present).
+
+        The test will be skipped if no valid Coverage Information system actions are returned across all hooks.
+      )
+
+      run do
+        verify_at_least_one_test_passes(
+          self.class.parent.parent.groups,
+          'crd_v201_coverage_info_system_action_validation',
+          'None of the hooks invoked returned valid Coverage Info system actions.'
+        )
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/server/v2.0.1/must_support/external_reference_card_across_hooks_validation_test.rb

@@ -0,0 +1,30 @@
+require_relative '../../server_test_helper'
+
+module DaVinciCRDTestKit
+  module V201
+    class ExternalReferenceCardAcrossHooksValidationTest < Inferno::Test
+      include DaVinciCRDTestKit::ServerTestHelper
+
+      title 'Valid External Reference cards received across all hooks'
+      id :crd_v201_external_reference_card_across_hooks_validation
+      description %(
+        This test verifies the presence of valid External Reference returned by CRD services across all hooks invoked.
+        As per the [Da Vinci CRD Implementation Guide](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#external-reference),
+        External Reference cards must contain links with the type set to `absolute`.
+        This test checks for the presence of any External Reference cards by verifying:
+        - The presence of a `links` array within each card.
+        - That every link in the `links` array of a card is of type `absolute`.
+
+        The test will be skipped if no valid External Reference cards are returned across all hooks.
+      )
+
+      run do
+        verify_at_least_one_test_passes(
+          self.class.parent.parent.groups,
+          'crd_v201_external_reference_card_validation',
+          'None of the hooks invoked returned an External Reference card.'
+        )
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/server/v2.0.1/must_support/instructions_card_received_across_hooks_test.rb

@@ -0,0 +1,27 @@
+require_relative '../../server_test_helper'
+
+module DaVinciCRDTestKit
+  module V201
+    class InstructionsCardReceivedAcrossHooksTest < Inferno::Test
+      include DaVinciCRDTestKit::ServerTestHelper
+
+      title 'Valid Instructions cards received across all hooks'
+      id :crd_v201_valid_instructions_card_received_across_hooks
+      description %(
+        This test validates that a valid [Instructions card](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#instructions)
+        was received across all hooks responses.
+
+        The test will be skipped if no valid Instructions cards are returned across all hooks.
+      )
+
+      run do
+        verify_at_least_one_test_passes(
+          self.class.parent.parent.groups,
+          'crd_v201_valid_instructions_card_received',
+          'None of the hooks invoked returned a valid Instructions card.',
+          'across_hooks'
+        )
+      end
+    end
+  end
+end