davinci_crd_test_kit 0.13.0 → 0.14.0

data/lib/davinci_crd_test_kit/server_encounter_discharge_group.rb

@@ -1,170 +0,0 @@
-require_relative 'server_tests/service_call_test'
-require_relative 'server_tests/service_request_required_fields_validation_test'
-require_relative 'server_tests/service_request_context_validation_test'
-require_relative 'server_tests/service_request_optional_fields_validation_test'
-require_relative 'server_tests/service_response_validation_test'
-require_relative 'server_tests/card_optional_fields_validation_test'
-require_relative 'server_tests/external_reference_card_validation_test'
-require_relative 'server_tests/launch_smart_app_card_validation_test'
-require_relative 'server_tests/instructions_card_received_test'
-require_relative 'server_tests/form_completion_response_validation_test'
-require_relative 'server_tests/create_or_update_coverage_info_response_validation_test'
-require_relative 'tags'
-
-module DaVinciCRDTestKit
-  class ServerEncounterDischargeGroup < Inferno::TestGroup
-    title 'encounter-discharge'
-    id :crd_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
-
-    test from: :crd_service_call_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'
-             }
-           }
-         }
-    test from: :crd_service_request_required_fields_validation,
-         config: {
-           outputs: {
-             contexts: {
-               name: :encounter_discharge_contexts
-             }
-           }
-         }
-    test from: :crd_service_request_context_validation,
-         config: {
-           inputs: {
-             contexts: {
-               name: :encounter_discharge_contexts
-             }
-           }
-         }
-    test from: :crd_service_request_optional_fields_validation
-    test from: :crd_service_response_validation,
-         config: {
-           outputs: {
-             valid_cards: {
-               name: :encounter_discharge_valid_cards
-             },
-             valid_system_actions: {
-               name: :encounter_discharge_valid_system_actions
-             }
-           }
-         }
-    test from: :crd_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_external_reference_card_validation,
-         config: {
-           inputs: {
-             valid_cards_with_links: {
-               name: :encounter_discharge_valid_cards_with_links
-             }
-           }
-         }
-    test from: :crd_launch_smart_app_card_validation,
-         config: {
-           inputs: {
-             valid_cards_with_links: {
-               name: :encounter_discharge_valid_cards_with_links
-             }
-           }
-         }
-    test from: :crd_valid_instructions_card_received,
-         config: {
-           inputs: {
-             valid_cards: {
-               name: :encounter_discharge_valid_cards
-             }
-           }
-         }
-    test from: :crd_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_coverage_info_system_action_validation,
-         optional: true,
-         config: {
-           inputs: {
-             coverage_info: {
-               name: :encounter_discharge_coverage_info
-             }
-           }
-         }
-    test from: :crd_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_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

data/lib/davinci_crd_test_kit/server_encounter_start_group.rb

@@ -1,170 +0,0 @@
-require_relative 'server_tests/service_call_test'
-require_relative 'server_tests/service_request_required_fields_validation_test'
-require_relative 'server_tests/service_request_context_validation_test'
-require_relative 'server_tests/service_request_optional_fields_validation_test'
-require_relative 'server_tests/service_response_validation_test'
-require_relative 'server_tests/card_optional_fields_validation_test'
-require_relative 'server_tests/external_reference_card_validation_test'
-require_relative 'server_tests/launch_smart_app_card_validation_test'
-require_relative 'server_tests/instructions_card_received_test'
-require_relative 'server_tests/form_completion_response_validation_test'
-require_relative 'server_tests/create_or_update_coverage_info_response_validation_test'
-require_relative 'tags'
-
-module DaVinciCRDTestKit
-  class ServerEncounterStartGroup < Inferno::TestGroup
-    title 'encounter-start'
-    id :crd_server_encounter_start
-    description %(
-      This group of tests invokes the encounter-start hook and ensures that
-      the user-provided requests are valid as per the requirements described
-      in the [CRD IG section on encounter-start hook](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-start)
-      and the [CDS Hooks specification section on encounter-start context](https://cds-hooks.hl7.org/hooks/encounter-start/2023SepSTU1Ballot/encounter-start/).
-      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-start hook](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-start)
-      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@185'
-
-    config options: { hook_name: ENCOUNTER_START_TAG }
-    run_as_group
-
-    test from: :crd_service_call_test,
-         config: {
-           inputs: {
-             service_ids: {
-               name: :encounter_start_service_ids,
-               title: 'Service id for the service that implements the `encounter-start` hook'
-             },
-             service_request_bodies: {
-               name: :encounter_start_request_bodies,
-               title: 'Request body or bodies for invoking the `encounter-start` hook'
-             }
-           }
-         }
-    test from: :crd_service_request_required_fields_validation,
-         config: {
-           outputs: {
-             contexts: {
-               name: :encounter_start_contexts
-             }
-           }
-         }
-    test from: :crd_service_request_context_validation,
-         config: {
-           inputs: {
-             contexts: {
-               name: :encounter_start_contexts
-             }
-           }
-         }
-    test from: :crd_service_request_optional_fields_validation
-    test from: :crd_service_response_validation,
-         config: {
-           outputs: {
-             valid_cards: {
-               name: :encounter_start_valid_cards
-             },
-             valid_system_actions: {
-               name: :encounter_start_valid_system_actions
-             }
-           }
-         }
-    test from: :crd_card_optional_fields_validation,
-         config: {
-           inputs: {
-             valid_cards: {
-               name: :encounter_start_valid_cards
-             }
-           },
-           outputs: {
-             valid_cards_with_links: {
-               name: :encounter_start_valid_cards_with_links
-             },
-             valid_cards_with_suggestions: {
-               name: :encounter_start_valid_cards_with_suggestions
-             }
-           }
-         }
-    test from: :crd_external_reference_card_validation,
-         config: {
-           inputs: {
-             valid_cards_with_links: {
-               name: :encounter_start_valid_cards_with_links
-             }
-           }
-         }
-    test from: :crd_launch_smart_app_card_validation,
-         config: {
-           inputs: {
-             valid_cards_with_links: {
-               name: :encounter_start_valid_cards_with_links
-             }
-           }
-         }
-    test from: :crd_valid_instructions_card_received,
-         config: {
-           inputs: {
-             valid_cards: {
-               name: :encounter_start_valid_cards
-             }
-           }
-         }
-    test from: :crd_coverage_info_system_action_received,
-         optional: true,
-         config: {
-           inputs: {
-             valid_system_actions: {
-               name: :encounter_start_valid_system_actions
-             }
-           },
-           outputs: {
-             coverage_info: {
-               name: :encounter_start_coverage_info
-             }
-           }
-         }
-    test from: :crd_coverage_info_system_action_validation,
-         optional: true,
-         config: {
-           inputs: {
-             coverage_info: {
-               name: :encounter_start_coverage_info
-             }
-           }
-         }
-    test from: :crd_request_form_completion_response_validation,
-         config: {
-           inputs: {
-             valid_system_actions: {
-               name: :encounter_start_valid_system_actions
-             },
-             valid_cards_with_suggestions: {
-               name: :encounter_start_valid_cards_with_suggestions
-             }
-           }
-         }
-    test from: :crd_create_or_update_coverage_info_response_validation,
-         config: {
-           inputs: {
-             valid_system_actions: {
-               name: :encounter_start_valid_system_actions
-             },
-             valid_cards_with_suggestions: {
-               name: :encounter_start_valid_cards_with_suggestions
-             }
-           }
-         }
-  end
-end

data/lib/davinci_crd_test_kit/server_hooks_group.rb

@@ -1,71 +0,0 @@
-require_relative 'server_appointment_book_group'
-require_relative 'server_encounter_start_group'
-require_relative 'server_encounter_discharge_group'
-require_relative 'server_order_select_group'
-require_relative 'server_order_dispatch_group'
-require_relative 'server_order_sign_group'
-require_relative 'server_required_card_response_validation_group'
-
-module DaVinciCRDTestKit
-  class ServerHooksGroup < Inferno::TestGroup
-    title 'Hook Tests'
-    id :crd_server_hooks
-    description %(
-      # Background
-
-      The #{title} Group verifies that a [CRD Server](https://hl7.org/fhir/us/davinci-crd/STU2/CapabilityStatement-crd-server.html)
-      supports at least one of the hooks supported by the [CRD IG](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#supported-hooks).
-      The supported hooks include:
-      - [appointment-book](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book)
-      - [encounter-start](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-start)
-      - [encounter-discharge](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge)
-      - [order-select](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-select)
-      - [order-dispatch](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-dispatch)
-      - [order-sign](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-sign)
-
-      The [CRD STU2 IG section on Supported Hooks](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#supported-hooks)
-      states that "CRD Servers conforming to this implementation guide
-      SHALL provide a service for all hooks and order resource types required of
-      CRD clients by this implementation guide unless the server has determined that
-      the hook will not be reasonably useful in determining coverage or documentation
-      expectations for the types of coverage provided."
-
-      # Test Methodology
-
-      In these tests, Inferno acts as a [CRD Client](https://hl7.org/fhir/us/davinci-crd/STU2/CapabilityStatement-crd-client.html)
-      that initiates CDS Hooks calls. This test sequence is broken up into groups,
-      each group corresponding to a supported hook and defining a set of tests verifying
-      the ability of the server to respond to the given hook invocation. Additionally, an additional
-      group checks the required [response types](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types)
-      across all hooks invoked.
-
-      Each hook group test verifies that:
-      - The hook can be invoked.
-      - The user-provided request payload contains the required fields as specified
-        in the [CDS Hooks section on HTTP request requirements](https://cds-hooks.hl7.org/2.0/#http-request_1).
-      - The user-provided request payload contains the optional fields as specified
-        in the [CDS Hooks section on HTTP request requirements](https://cds-hooks.hl7.org/2.0/#http-request_1) -
-        optional.
-      - Each card and system action returned by the server is valid as described in the
-        [CDS Hooks section on CDS Service Response](https://cds-hooks.hl7.org/2.0/#cds-service-response).
-      - Each [CRD response type](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types)
-        returned is valid - optional for some response types. See the individual test groups for more details.
-    )
-    verifies_requirements 'hl7.fhir.us.davinci-crd_2.0.1@4', 'hl7.fhir.us.davinci-crd_2.0.1@152',
-                          'hl7.fhir.us.davinci-crd_2.0.1@153'
-
-    group from: :crd_server_appointment_book,
-          optional: true
-    group from: :crd_server_encounter_start,
-          optional: true
-    group from: :crd_server_encounter_discharge,
-          optional: true
-    group from: :crd_server_order_select,
-          optional: true
-    group from: :crd_server_order_dispatch,
-          optional: true
-    group from: :crd_server_order_sign,
-          optional: true
-    group from: :crd_server_required_card_response_validation
-  end
-end

data/lib/davinci_crd_test_kit/server_order_dispatch_group.rb

@@ -1,176 +0,0 @@
-require_relative 'server_tests/service_call_test'
-require_relative 'server_tests/service_request_required_fields_validation_test'
-require_relative 'server_tests/service_request_context_validation_test'
-require_relative 'server_tests/service_request_optional_fields_validation_test'
-require_relative 'server_tests/service_response_validation_test'
-require_relative 'server_tests/card_optional_fields_validation_test'
-require_relative 'server_tests/external_reference_card_validation_test'
-require_relative 'server_tests/launch_smart_app_card_validation_test'
-require_relative 'server_tests/instructions_card_received_test'
-require_relative 'server_tests/coverage_information_system_action_received_test'
-require_relative 'server_tests/coverage_information_system_action_validation_test'
-require_relative 'server_tests/form_completion_response_validation_test'
-require_relative 'server_tests/create_or_update_coverage_info_response_validation_test'
-require_relative 'tags'
-
-module DaVinciCRDTestKit
-  class ServerOrderDispatchGroup < Inferno::TestGroup
-    title 'order-dispatch'
-    id :crd_server_order_dispatch
-    description %(
-      This group of tests invokes the order-dispatch hook and ensures that
-      the user-provided requests are valid as per the requirements described
-      in the [CRD IG section on order-dispatch hook](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-dispatch)
-      and the [CDS Hooks specification section on order-dispatch context](https://cds-hooks.hl7.org/hooks/order-dispatch/2023SepSTU1Ballot/order-dispatch/).
-      It also ensures that the contents of the server's response are valid as per the requirements described in
-      the [CRD IG section on order-dispatch hook](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-dispatch)
-      and the [CDS Hooks section on CDS Service Response](https://cds-hooks.hl7.org/2.0/#cds-service-response).
-
-      The [CRD IG section on order-dispatch hook](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-dispatch)
-      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@204', 'hl7.fhir.us.davinci-crd_2.0.1@207'
-
-    config options: { hook_name: ORDER_DISPATCH_TAG }
-    run_as_group
-
-    test from: :crd_service_call_test,
-         config: {
-           inputs: {
-             service_ids: {
-               name: :order_dispatch_service_ids,
-               title: 'Service id for the service that implements the `order-dispatch` hook'
-             },
-             service_request_bodies: {
-               name: :order_dispatch_request_bodies,
-               title: 'Request body or bodies for invoking the `order-dispatch` hook'
-             }
-           }
-         }
-
-    test from: :crd_service_request_required_fields_validation,
-         config: {
-           outputs: {
-             contexts: {
-               name: :order_dispatch_contexts
-             }
-           }
-         }
-    test from: :crd_service_request_context_validation,
-         config: {
-           inputs: {
-             contexts: {
-               name: :order_dispatch_contexts
-             }
-           }
-         }
-    test from: :crd_service_request_optional_fields_validation
-    test from: :crd_service_response_validation,
-         config: {
-           outputs: {
-             valid_cards: {
-               name: :order_dispatch_valid_cards
-             },
-             valid_system_actions: {
-               name: :order_dispatch_valid_system_actions
-             }
-           }
-         }
-    test from: :crd_card_optional_fields_validation,
-         config: {
-           inputs: {
-             valid_cards: {
-               name: :order_dispatch_valid_cards
-             }
-           },
-           outputs: {
-             valid_cards_with_links: {
-               name: :order_dispatch_valid_cards_with_links
-             },
-             valid_cards_with_suggestions: {
-               name: :order_dispatch_valid_cards_with_suggestions
-             }
-           }
-         }
-    test from: :crd_external_reference_card_validation,
-         config: {
-           inputs: {
-             valid_cards_with_links: {
-               name: :order_dispatch_valid_cards_with_links
-             }
-           }
-         }
-    test from: :crd_launch_smart_app_card_validation,
-         config: {
-           inputs: {
-             valid_cards_with_links: {
-               name: :order_dispatch_valid_cards_with_links
-             }
-           }
-         }
-    test from: :crd_valid_instructions_card_received,
-         config: {
-           inputs: {
-             valid_cards: {
-               name: :order_dispatch_valid_cards
-             }
-           }
-         }
-    test from: :crd_coverage_info_system_action_received,
-         config: {
-           inputs: {
-             valid_system_actions: {
-               name: :order_dispatch_valid_system_actions
-             }
-           },
-           outputs: {
-             coverage_info: {
-               name: :order_dispatch_coverage_info
-             }
-           }
-         }
-    test from: :crd_coverage_info_system_action_validation,
-         config: {
-           inputs: {
-             coverage_info: {
-               name: :order_dispatch_coverage_info
-             }
-           }
-         }
-    test from: :crd_request_form_completion_response_validation,
-         config: {
-           inputs: {
-             valid_system_actions: {
-               name: :order_dispatch_valid_system_actions
-             },
-             valid_cards_with_suggestions: {
-               name: :order_dispatch_valid_cards_with_suggestions
-             }
-           }
-         }
-    test from: :crd_create_or_update_coverage_info_response_validation,
-         config: {
-           inputs: {
-             valid_system_actions: {
-               name: :order_dispatch_valid_system_actions
-             },
-             valid_cards_with_suggestions: {
-               name: :order_dispatch_valid_cards_with_suggestions
-             }
-           }
-         }
-  end
-end