davinci_crd_test_kit 0.12.2 → 0.14.0

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

@@ -0,0 +1,191 @@
+require_relative '../../cross_suite/tags'
+require_relative 'interaction/server_invoke_hook_test'
+require_relative 'verify_request/service_request_required_fields_validation_test'
+require_relative 'verify_request/service_request_optional_fields_validation_test'
+require_relative 'verify_request/service_request_context_validation_test'
+require_relative 'verify_response/service_response_validation_test'
+require_relative 'verify_response/card_optional_fields_validation_test'
+require_relative 'verify_response/external_reference_card_validation_test'
+require_relative 'verify_response/coverage_information_system_action_received_test'
+require_relative 'verify_response/coverage_information_system_action_validation_test'
+require_relative 'verify_response/instructions_card_received_test'
+require_relative 'verify_response/form_completion_response_validation_test'
+require_relative 'verify_response/launch_smart_app_card_validation_test'
+require_relative 'verify_response/create_or_update_coverage_info_response_validation_test'
+
+module DaVinciCRDTestKit
+  module V201
+    class ServerAppointmentBookGroup < Inferno::TestGroup
+      title 'appointment-book'
+      id :crd_v201_server_appointment_book
+      description %(
+        This group of tests invokes the appointment-book hook and ensures that
+        the user-provided requests are valid as per the requirements described
+        in the [CRD IG section on appointment-book hook](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book)
+        and the [CDS Hooks specification section on appointment-book context](https://cds-hooks.hl7.org/hooks/appointment-book/2023SepSTU1Ballot/appointment-book/).
+        It also ensures that the contents of the server's response are valid as per the requirements described in
+        the [CRD IG section on appointment-book hook](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book)
+        and the [CDS Hooks section on CDS Service Response](https://cds-hooks.hl7.org/2.0/#cds-service-response).
+
+        The [CRD IG section on appointment-book hook](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book)
+        states that "servers SHALL, at minimum, support returning and processing the Coverage Information
+        system action for all invocations of this hook."
+
+        This group includes tests to validate the following CRD response types:
+        - [Coverage Information](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#coverage-information)
+        - [Create or update coverage information](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#create-or-update-coverage-information)\
+        - optional
+        - [External Reference](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#external-reference) - optional
+        - [Instructions](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#instructions) - optional
+        - [Launch SMART application](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#launch-smart-application) -
+        optional
+        - [Request form completion](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#request-form-completion) -
+        optional
+      )
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.0.1@164', 'hl7.fhir.us.davinci-crd_2.0.1@168',
+                            'hl7.fhir.us.davinci-crd_2.0.1@170', 'hl7.fhir.us.davinci-crd_2.0.1@184'
+
+      config options: { hook_name: APPOINTMENT_BOOK_TAG }
+      run_as_group
+
+      group do
+        title 'Make Hook Requests'
+
+        test from: :crd_v201_server_invoke_hook_test,
+             config: {
+               inputs: {
+                 service_ids: {
+                   name: :appointment_book_service_ids,
+                   title: 'Service id for the service that implements the `appointment-book` hook'
+                 },
+                 service_request_bodies: {
+                   name: :appointment_book_request_bodies,
+                   title: 'Request body or bodies for invoking the `appointment-book` hook'
+                 }
+               }
+             }
+      end
+
+      group do
+        title 'Verify Requests'
+
+        test from: :crd_v201_service_request_required_fields_validation,
+             config: {
+               outputs: {
+                 contexts: {
+                   name: :appointment_book_contexts
+                 }
+               }
+             }
+        test from: :crd_v201_service_request_context_validation,
+             config: {
+               inputs: {
+                 contexts: {
+                   name: :appointment_book_contexts
+                 }
+               }
+             }
+        test from: :crd_v201_service_request_optional_fields_validation
+      end
+
+      group do
+        title 'Verify Responses'
+
+        test from: :crd_v201_service_response_validation,
+             config: {
+               outputs: {
+                 valid_cards: {
+                   name: :appointment_book_valid_cards
+                 },
+                 valid_system_actions: {
+                   name: :appointment_book_valid_system_actions
+                 }
+               }
+             }
+        test from: :crd_v201_card_optional_fields_validation,
+             config: {
+               inputs: {
+                 valid_cards: {
+                   name: :appointment_book_valid_cards
+                 }
+               },
+               outputs: {
+                 valid_cards_with_links: {
+                   name: :appointment_book_valid_cards_with_links
+                 },
+                 valid_cards_with_suggestions: {
+                   name: :appointment_book_valid_cards_with_suggestions
+                 }
+               }
+             }
+        test from: :crd_v201_external_reference_card_validation,
+             config: {
+               inputs: {
+                 valid_cards_with_links: {
+                   name: :appointment_book_valid_cards_with_links
+                 }
+               }
+             }
+        test from: :crd_v201_launch_smart_app_card_validation,
+             config: {
+               inputs: {
+                 valid_cards_with_links: {
+                   name: :appointment_book_valid_cards_with_links
+                 }
+               }
+             }
+        test from: :crd_v201_valid_instructions_card_received,
+             config: {
+               inputs: {
+                 valid_cards: {
+                   name: :appointment_book_valid_cards
+                 }
+               }
+             }
+        test from: :crd_v201_coverage_info_system_action_received,
+             config: {
+               inputs: {
+                 valid_system_actions: {
+                   name: :appointment_book_valid_system_actions
+                 }
+               },
+               outputs: {
+                 coverage_info: {
+                   name: :appointment_book_coverage_info
+                 }
+               }
+             }
+        test from: :crd_v201_coverage_info_system_action_validation,
+             config: {
+               inputs: {
+                 coverage_info: {
+                   name: :appointment_book_coverage_info
+                 }
+               }
+             }
+        test from: :crd_v201_request_form_completion_response_validation,
+             config: {
+               inputs: {
+                 valid_system_actions: {
+                   name: :appointment_book_valid_system_actions
+                 },
+                 valid_cards_with_suggestions: {
+                   name: :appointment_book_valid_cards_with_suggestions
+                 }
+               }
+             }
+        test from: :crd_v201_create_or_update_coverage_info_response_validation,
+             config: {
+               inputs: {
+                 valid_system_actions: {
+                   name: :appointment_book_valid_system_actions
+                 },
+                 valid_cards_with_suggestions: {
+                   name: :appointment_book_valid_cards_with_suggestions
+                 }
+               }
+             }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+require_relative '../../cross_suite/tags'
+require_relative 'interaction/server_invoke_hook_test'
+require_relative 'verify_request/service_request_required_fields_validation_test'
+require_relative 'verify_request/service_request_optional_fields_validation_test'
+require_relative 'verify_request/service_request_context_validation_test'
+require_relative 'verify_response/service_response_validation_test'
+
+module DaVinciCRDTestKit
+  module V201
+    class ServerDemonstrateHookResponseGroup < Inferno::TestGroup
+      title 'Demonstrate A Hook Response'
+      id :crd_v201_server_demonstrate_hook_response
+      description %(
+        This group of tests allows the system to demonstrate its ability to respond to a CRD Hook invocation
+        and return a valid response. Inferno will use the provided request body and will either use the provided service
+        id or infer one from the hook indicated in the request and the server's discovery response.
+        It ensures that the user-provided request and the server's response are both
+        valid as per the requirements described in the [CRD IG section](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html)
+        and the [CDS Hooks](https://cds-hooks.hl7.org/) hook specification for the corresponding hook.
+      )
+
+      config options: { hook_name: ANY_HOOK_TAG }
+      run_as_group
+
+      group do
+        title 'Make Hook Requests'
+
+        test from: :crd_v201_server_invoke_hook_test,
+             config: {
+               inputs: {
+                 service_ids: {
+                   name: :any_hook_service_ids,
+                   title: 'Service id to use for the "Demonstrate a Hook Response" test',
+                   description: %(
+                If blank, Inferno will attempt to infer the service id to use by finding a service entry in the
+                Discovery response for the hook indicated in the provided request body. If it cannot be inferred,
+                the tests will be skipped.
+               )
+                 },
+                 service_request_bodies: {
+                   name: :any_hook_request_body,
+                   title: 'Request body to use for the "Demonstrate a Hook Response" test',
+                   description: %(
+                Provide a single JSON request body to submit for the hook invocation. The type of hook invoked
+                will be inferred based on the `hook` element in the request.
+              )
+                 }
+               }
+             }
+      end
+
+      group do
+        title 'Verify Requests'
+
+        test from: :crd_v201_service_request_required_fields_validation,
+             config: {
+               outputs: {
+                 contexts: {
+                   name: :any_hook_contexts
+                 }
+               }
+             }
+        test from: :crd_v201_service_request_context_validation,
+             config: {
+               inputs: {
+                 contexts: {
+                   name: :any_hook_contexts
+                 },
+                 request_body: {
+                   name: :any_hook_request_body
+                 }
+               }
+             }
+      end
+
+      group do
+        title 'Verify Responses'
+
+        test from: :crd_v201_service_response_validation,
+             config: {
+               outputs: {
+                 valid_cards: {
+                   name: :any_hook_valid_cards
+                 },
+                 valid_system_actions: {
+                   name: :any_hook_valid_system_actions
+                 }
+               }
+             }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+require 'tls_test_kit'
+require_relative 'discovery/discovery_endpoint_test'
+require_relative 'discovery/discovery_services_validation_test'
+
+module DaVinciCRDTestKit
+  module V201
+    class ServerDiscoveryGroup < Inferno::TestGroup
+      title 'Discovery'
+      id :crd_v201_server_discovery_group
+      description %(
+        # Background
+
+        The #{title} Group checks for a CDS Service's Discovery endpoint as described by the
+        [CDS Hooks Specification](https://cds-hooks.hl7.org/2.0/#discovery).
+        A CDS Service is discoverable via a stable endpoint by CDS Clients. The Discovery endpoint
+        includes information such as a description of the CDS Service, when it should be invoked,
+        and any data that is requested to be prefetched.
+        The Discovery endpoint SHALL always be available at `{baseUrl}/cds-services`.
+
+        # Test Methodology
+
+        This test sequence accesses the CRD server Discovery endpoint at /cds-services using a GET request.
+        It parses the response and verifies that:
+        - The Discovery endpoint is TLS secured.
+        - The Discovery endpoint is available at `{baseURL}/cds-services`.
+        - Each CDS Service in the response contains the required fields as specified in the [CDS Hooks Spec](https://cds-hooks.hl7.org/2.0/#response).
+
+        It collects the following information that is saved in the testing session for use by later tests:
+        - List of supported CDS Services/Hooks
+        - List of service IDs for each supported Hook.
+      )
+
+      run_as_group
+
+      test from: :tls_version_test do
+        title 'CRD Server is secured by transport layer security'
+        description <<~DESCRIPTION
+          Under [Privacy, Security, and Safety](https://hl7.org/fhir/us/davinci-crd/STU2/security.html),
+          the CRD Implementation Guide imposes the following rule about TLS:
+
+          As per the [CDS Hook specification](https://cds-hooks.hl7.org/2.0/#security-and-safety),
+          communications between CRD Clients and CRD Servers SHALL
+          use TLS. Mutual TLS is not required by this specification but is permitted. CRD Servers and
+          CRD Clients SHOULD enforce a minimum version and other TLS configuration requirements based
+          on HRex rules for PHI exchange.
+
+          This test verifies that the CRD server is using TLS 1.2 or higher.
+        DESCRIPTION
+        verifies_requirements 'hl7.fhir.us.davinci-crd_2.0.1@89'
+        id :crd_v201_server_tls_version_stu2
+
+        config(
+          options: { minimum_allowed_version: OpenSSL::SSL::TLS1_2_VERSION },
+          inputs: { url: { name: :base_url } }
+        )
+      end
+
+      test from: :crd_v201_discovery_endpoint_test
+      test from: :crd_v201_discovery_services_validation
+    end
+  end
+end

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

@@ -0,0 +1,186 @@
+require_relative '../../cross_suite/tags'
+require_relative 'interaction/server_invoke_hook_test'
+require_relative 'verify_request/service_request_required_fields_validation_test'
+require_relative 'verify_request/service_request_optional_fields_validation_test'
+require_relative 'verify_request/service_request_context_validation_test'
+require_relative 'verify_response/service_response_validation_test'
+require_relative 'verify_response/card_optional_fields_validation_test'
+require_relative 'verify_response/external_reference_card_validation_test'
+require_relative 'verify_response/launch_smart_app_card_validation_test'
+require_relative 'verify_response/instructions_card_received_test'
+require_relative 'verify_response/form_completion_response_validation_test'
+require_relative 'verify_response/create_or_update_coverage_info_response_validation_test'
+
+module DaVinciCRDTestKit
+  module V201
+    class ServerEncounterDischargeGroup < Inferno::TestGroup
+      title 'encounter-discharge'
+      id :crd_v201_server_encounter_discharge
+      description %(
+        This group of tests invokes the encounter-discharge hook and ensures that
+        the user-provided requests are valid as per the requirements described
+        in the [CRD IG section on encounter-discharge hook](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge)
+        and the [CDS Hooks specification section on encounter-discharge context](https://cds-hooks.hl7.org/hooks/encounter-discharge/2023SepSTU1Ballot/encounter-discharge/).
+        It also ensures that the contents of the server's response are valid as per the requirements described in
+        the [CRD IG section on encounter-discharge hook](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge)
+        and the [CDS Hooks section on CDS Service Response](https://cds-hooks.hl7.org/2.0/#cds-service-response).
+
+        This group includes tests to validate the following CRD response types:
+        - [Coverage Information](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#coverage-information) - optional
+        - [Create or update coverage information](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#create-or-update-coverage-information)\
+        - optional
+        - [External Reference](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#external-reference) - optional
+        - [Instructions](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#instructions) - optional
+        - [Launch SMART application](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#launch-smart-application) -
+        optional
+        - [Request form completion](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#request-form-completion) -
+        optional
+      )
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.0.1@168', 'hl7.fhir.us.davinci-crd_2.0.1@196'
+
+      config options: { hook_name: ENCOUNTER_DISCHARGE_TAG }
+      run_as_group
+
+      group do
+        title 'Make Hook Requests'
+
+        test from: :crd_v201_server_invoke_hook_test,
+             config: {
+               inputs: {
+                 service_ids: {
+                   name: :encounter_discharge_service_ids,
+                   title: 'Service id for the service that implements the `encounter-discharge` hook'
+                 },
+                 service_request_bodies: {
+                   name: :encounter_discharge_request_bodies,
+                   title: 'Request body or bodies for invoking the `encounter-discharge` hook'
+                 }
+               }
+             }
+      end
+
+      group do
+        title 'Verify Requests'
+
+        test from: :crd_v201_service_request_required_fields_validation,
+             config: {
+               outputs: {
+                 contexts: {
+                   name: :encounter_discharge_contexts
+                 }
+               }
+             }
+        test from: :crd_v201_service_request_context_validation,
+             config: {
+               inputs: {
+                 contexts: {
+                   name: :encounter_discharge_contexts
+                 }
+               }
+             }
+        test from: :crd_v201_service_request_optional_fields_validation
+      end
+
+      group do
+        title 'Verify Responses'
+
+        test from: :crd_v201_service_response_validation,
+             config: {
+               outputs: {
+                 valid_cards: {
+                   name: :encounter_discharge_valid_cards
+                 },
+                 valid_system_actions: {
+                   name: :encounter_discharge_valid_system_actions
+                 }
+               }
+             }
+        test from: :crd_v201_card_optional_fields_validation,
+             config: {
+               inputs: {
+                 valid_cards: {
+                   name: :encounter_discharge_valid_cards
+                 }
+               },
+               outputs: {
+                 valid_cards_with_links: {
+                   name: :encounter_discharge_valid_cards_with_links
+                 },
+                 valid_cards_with_suggestions: {
+                   name: :encounter_discharge_valid_cards_with_suggestions
+                 }
+               }
+             }
+        test from: :crd_v201_external_reference_card_validation,
+             config: {
+               inputs: {
+                 valid_cards_with_links: {
+                   name: :encounter_discharge_valid_cards_with_links
+                 }
+               }
+             }
+        test from: :crd_v201_launch_smart_app_card_validation,
+             config: {
+               inputs: {
+                 valid_cards_with_links: {
+                   name: :encounter_discharge_valid_cards_with_links
+                 }
+               }
+             }
+        test from: :crd_v201_valid_instructions_card_received,
+             config: {
+               inputs: {
+                 valid_cards: {
+                   name: :encounter_discharge_valid_cards
+                 }
+               }
+             }
+        test from: :crd_v201_coverage_info_system_action_received,
+             optional: true,
+             config: {
+               inputs: {
+                 valid_system_actions: {
+                   name: :encounter_discharge_valid_system_actions
+                 }
+               },
+               outputs: {
+                 coverage_info: {
+                   name: :encounter_discharge_coverage_info
+                 }
+               }
+             }
+        test from: :crd_v201_coverage_info_system_action_validation,
+             optional: true,
+             config: {
+               inputs: {
+                 coverage_info: {
+                   name: :encounter_discharge_coverage_info
+                 }
+               }
+             }
+        test from: :crd_v201_request_form_completion_response_validation,
+             config: {
+               inputs: {
+                 valid_system_actions: {
+                   name: :encounter_discharge_valid_system_actions
+                 },
+                 valid_cards_with_suggestions: {
+                   name: :encounter_discharge_valid_cards_with_suggestions
+                 }
+               }
+             }
+        test from: :crd_v201_create_or_update_coverage_info_response_validation,
+             config: {
+               inputs: {
+                 valid_system_actions: {
+                   name: :encounter_discharge_valid_system_actions
+                 },
+                 valid_cards_with_suggestions: {
+                   name: :encounter_discharge_valid_cards_with_suggestions
+                 }
+               }
+             }
+      end
+    end
+  end
+end