davinci_crd_test_kit 0.9.0

data/lib/davinci_crd_test_kit/server_order_dispatch_group.rb

@@ -0,0 +1,173 @@
+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'
+
+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
+    )
+
+    config options: { hook_name: 'order-dispatch' }
+    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 invokes `order-dispatch` hook'
+             },
+             service_request_bodies: {
+               name: :order_dispatch_request_bodies,
+               title: 'Request bodies collection to use to invoke 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

data/lib/davinci_crd_test_kit/server_order_select_group.rb

@@ -0,0 +1,169 @@
+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/propose_alternate_request_card_validation_test'
+require_relative 'server_tests/additional_orders_validation_test'
+require_relative 'server_tests/form_completion_response_validation_test'
+require_relative 'server_tests/create_or_update_coverage_info_response_validation_test'
+
+module DaVinciCRDTestKit
+  class ServerOrderSelectGroup < Inferno::TestGroup
+    title 'order-select'
+    id :crd_server_order_select
+    description %(
+      This group of tests invokes the order-select hook and ensures that
+      the user-provided requests are valid as per the requirements described
+      in the [CRD IG section on order-select hook](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-select)
+      and the [CDS Hooks specification section on order-select context](https://cds-hooks.hl7.org/hooks/order-select/2023SepSTU1Ballot/order-select/).
+      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-select hook](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-select)
+      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:
+      - [additional orders as companions/prerequisites](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#identify-additional-orders-as-companionsprerequisites-for-current-order)\
+      - 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
+      - [Propose alternate request](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request) -
+      optional
+      - [Request form completion](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#request-form-completion) -
+      optional
+    )
+
+    config options: { hook_name: 'order-select' }
+    run_as_group
+
+    test from: :crd_service_call_test,
+         config: {
+           inputs: {
+             service_ids: {
+               name: :order_select_service_ids,
+               title: 'Service id for the service that invokes `order-select` hook'
+             },
+             service_request_bodies: {
+               name: :order_select_request_bodies,
+               title: 'Request bodies collection to use to invoke the `order-select` hook'
+             }
+           }
+         }
+    test from: :crd_service_request_required_fields_validation,
+         config: {
+           outputs: {
+             contexts: {
+               name: :order_select_contexts
+             }
+           }
+         }
+    test from: :crd_service_request_context_validation,
+         config: {
+           inputs: {
+             contexts: {
+               name: :order_select_contexts
+             }
+           }
+         }
+    test from: :crd_service_request_optional_fields_validation
+    test from: :crd_service_response_validation,
+         config: {
+           outputs: {
+             valid_cards: {
+               name: :order_select_valid_cards
+             },
+             valid_system_actions: {
+               name: :order_select_valid_system_actions
+             }
+           }
+         }
+    test from: :crd_card_optional_fields_validation,
+         config: {
+           inputs: {
+             valid_cards: {
+               name: :order_select_valid_cards
+             }
+           },
+           outputs: {
+             valid_cards_with_links: {
+               name: :order_select_valid_cards_with_links
+             },
+             valid_cards_with_suggestions: {
+               name: :order_select_valid_cards_with_suggestions
+             }
+           }
+         }
+    test from: :crd_external_reference_card_validation,
+         config: {
+           inputs: {
+             valid_cards_with_links: {
+               name: :order_select_valid_cards_with_links
+             }
+           }
+         }
+    test from: :crd_launch_smart_app_card_validation,
+         config: {
+           inputs: {
+             valid_cards_with_links: {
+               name: :order_select_valid_cards_with_links
+             }
+           }
+         }
+    test from: :crd_valid_instructions_card_received,
+         config: {
+           inputs: {
+             valid_cards: {
+               name: :order_select_valid_cards
+             }
+           }
+         }
+    test from: :crd_propose_alternate_request_card_validation,
+         config: {
+           inputs: {
+             valid_cards_with_suggestions: {
+               name: :order_select_valid_cards_with_suggestions
+             },
+             contexts: {
+               name: :order_select_contexts
+             }
+           }
+         }
+    test from: :crd_additional_orders_card_validation,
+         config: {
+           inputs: {
+             valid_cards_with_suggestions: {
+               name: :order_select_valid_cards_with_suggestions
+             }
+           }
+         }
+    test from: :crd_request_form_completion_response_validation,
+         config: {
+           inputs: {
+             valid_system_actions: {
+               name: :order_select_valid_system_actions
+             },
+             valid_cards_with_suggestions: {
+               name: :order_select_valid_cards_with_suggestions
+             }
+           }
+         }
+    test from: :crd_create_or_update_coverage_info_response_validation,
+         config: {
+           inputs: {
+             valid_system_actions: {
+               name: :order_select_valid_system_actions
+             },
+             valid_cards_with_suggestions: {
+               name: :order_select_valid_cards_with_suggestions
+             }
+           }
+         }
+  end
+end

data/lib/davinci_crd_test_kit/server_order_sign_group.rb

@@ -0,0 +1,198 @@
+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/propose_alternate_request_card_validation_test'
+require_relative 'server_tests/additional_orders_validation_test'
+require_relative 'server_tests/form_completion_response_validation_test'
+require_relative 'server_tests/create_or_update_coverage_info_response_validation_test'
+
+module DaVinciCRDTestKit
+  class ServerOrderSignGroup < Inferno::TestGroup
+    title 'order-sign'
+    id :crd_server_order_sign
+    description %(
+      This group of tests invokes the order-sign hook and ensures that
+      the user-provided requests are valid as per the requirements described
+      in the [CRD IG section on order-sign hook](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-sign)
+      and the [CDS Hooks specification section on order-sign context](https://cds-hooks.hl7.org/hooks/order-sign/2023SepSTU1Ballot/order-sign/).
+      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-sign hook](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-sign)
+      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-sign hook](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-sign)
+      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:
+      - [additional orders as companions/prerequisites](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#identify-additional-orders-as-companionsprerequisites-for-current-order)\
+      - optional
+      - [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
+      - [Propose alternate request](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request) -
+      optional
+      - [Request form completion](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#request-form-completion) -
+      optional
+    )
+
+    config options: { hook_name: 'order-sign' }
+    run_as_group
+
+    test from: :crd_service_call_test,
+         config: {
+           inputs: {
+             service_ids: {
+               name: :order_sign_service_ids,
+               title: 'Service id for the service that invokes `order-sign` hook'
+             },
+             service_request_bodies: {
+               name: :order_sign_request_bodies,
+               title: 'Request bodies collection to use to invoke the `order-sign` hook'
+             }
+           }
+         }
+
+    test from: :crd_service_request_required_fields_validation,
+         config: {
+           outputs: {
+             contexts: {
+               name: :order_sign_contexts
+             }
+           }
+         }
+    test from: :crd_service_request_context_validation,
+         config: {
+           inputs: {
+             contexts: {
+               name: :order_sign_contexts
+             }
+           }
+         }
+    test from: :crd_service_request_optional_fields_validation
+    test from: :crd_service_response_validation,
+         config: {
+           outputs: {
+             valid_cards: {
+               name: :order_sign_valid_cards
+             },
+             valid_system_actions: {
+               name: :order_sign_valid_system_actions
+             }
+           }
+         }
+    test from: :crd_card_optional_fields_validation,
+         config: {
+           inputs: {
+             valid_cards: {
+               name: :order_sign_valid_cards
+             }
+           },
+           outputs: {
+             valid_cards_with_links: {
+               name: :order_sign_valid_cards_with_links
+             },
+             valid_cards_with_suggestions: {
+               name: :order_sign_valid_cards_with_suggestions
+             }
+           }
+         }
+    test from: :crd_external_reference_card_validation,
+         config: {
+           inputs: {
+             valid_cards_with_links: {
+               name: :order_sign_valid_cards_with_links
+             }
+           }
+         }
+    test from: :crd_launch_smart_app_card_validation,
+         config: {
+           inputs: {
+             valid_cards_with_links: {
+               name: :order_sign_valid_cards_with_links
+             }
+           }
+         }
+    test from: :crd_valid_instructions_card_received,
+         config: {
+           inputs: {
+             valid_cards: {
+               name: :order_sign_valid_cards
+             }
+           }
+         }
+    test from: :crd_coverage_info_system_action_received,
+         config: {
+           inputs: {
+             valid_system_actions: {
+               name: :order_sign_valid_system_actions
+             }
+           },
+           outputs: {
+             coverage_info: {
+               name: :order_sign_coverage_info
+             }
+           }
+         }
+    test from: :crd_coverage_info_system_action_validation,
+         config: {
+           inputs: {
+             coverage_info: {
+               name: :order_sign_coverage_info
+             }
+           }
+         }
+    test from: :crd_propose_alternate_request_card_validation,
+         config: {
+           inputs: {
+             valid_cards_with_suggestions: {
+               name: :order_sign_valid_cards_with_suggestions
+             },
+             contexts: {
+               name: :order_sign_contexts
+             }
+           }
+         }
+    test from: :crd_additional_orders_card_validation,
+         config: {
+           inputs: {
+             valid_cards_with_suggestions: {
+               name: :order_sign_valid_cards_with_suggestions
+             }
+           }
+         }
+    test from: :crd_request_form_completion_response_validation,
+         config: {
+           inputs: {
+             valid_system_actions: {
+               name: :order_sign_valid_system_actions
+             },
+             valid_cards_with_suggestions: {
+               name: :order_sign_valid_cards_with_suggestions
+             }
+           }
+         }
+    test from: :crd_create_or_update_coverage_info_response_validation,
+         config: {
+           inputs: {
+             valid_system_actions: {
+               name: :order_sign_valid_system_actions
+             },
+             valid_cards_with_suggestions: {
+               name: :order_sign_valid_cards_with_suggestions
+             }
+           }
+         }
+  end
+end

data/lib/davinci_crd_test_kit/server_required_card_response_validation_group.rb

@@ -0,0 +1,23 @@
+require_relative 'server_tests/external_reference_card_across_hooks_validation_test'
+require_relative 'server_tests/instructions_card_received_across_hooks_test'
+require_relative 'server_tests/coverage_information_system_action_across_hooks_validation_test'
+
+module DaVinciCRDTestKit
+  class ServerRequiredCardResponseValidationGroup < Inferno::TestGroup
+    title 'Required Card Response Validation'
+    description %(
+      This group contains tests to verify the presence and validity of required response types
+      across all hooks invoked. As per the [Da Vinci CRD Implementation Guide](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types),
+      CRD Servers SHALL, at minimum, demonstrate an ability to return the following response types:
+      - Coverage Information System Action
+      - External Reference Card
+      - Instructions Card
+    )
+    id :crd_server_required_card_response_validation
+    run_as_group
+
+    test from: :crd_external_reference_card_across_hooks_validation
+    test from: :crd_valid_instructions_card_received_across_hooks
+    test from: :crd_coverage_info_system_action_across_hooks_validation
+  end
+end

data/lib/davinci_crd_test_kit/server_tests/additional_orders_validation_test.rb

@@ -0,0 +1,70 @@
+require_relative '../test_helper'
+require_relative '../suggestion_actions_validation'
+
+module DaVinciCRDTestKit
+  class AdditionalOrdersValidationTest < Inferno::Test
+    include DaVinciCRDTestKit::TestHelper
+    include DaVinciCRDTestKit::SuggestionActionsValidation
+
+    title 'Valid Additional Orders as companions/prerequisites cards received'
+    id :crd_additional_orders_card_validation
+    description %(
+      This test validates that an [Additional Orders as companions/prerequisites](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#identify-additional-orders-as-companionsprerequisites-for-current-order)
+      card was received. It does so by:
+      - Filtering cards with the following criteria:
+        - For each suggestion in the card's suggestions array, all actions have a type of 'create'
+          and the action's resource type is one of the expected types: CommunicationRequest, Device,
+          DeviceRequest, Medication, MedicationRequest, NutritionOrder, ServiceRequest, or VisionPrescription.
+      - Then, for each valid Additional Orders card retrieved, verifying that each action within the
+      card's suggestions complies with their respective profiles as specified in the
+      [CRD IG section on Additional Orders as companions/prerequisites](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#identify-additional-orders-as-companionsprerequisites-for-current-order):
+        - [crd-profile-communicationrequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-communicationrequest.html)
+        - [crd-profile-device](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-device.html)
+        - [crd-profile-deviceRequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-devicerequest.html)
+        - [us-core-medication](http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-medication.html)
+        - [crd-profile-medicationRequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-medicationrequest.html)
+        - [crd-profile-nutritionOrder](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-nutritionorder.html)
+        - [crd-profile-serviceRequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-servicerequest.html)
+        - [crd-profile-visionPrescription](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-visionprescription.html).
+
+      The test will skip if no Additional Orders cards are found.
+    )
+
+    optional
+    input :valid_cards_with_suggestions
+
+    EXPECTED_RESOURCE_TYPES = %w[
+      CommunicationRequest Device DeviceRequest Medication
+      MedicationRequest NutritionOrder ServiceRequest
+      VisionPrescription
+    ].freeze
+
+    def hook_name
+      config.options[:hook_name]
+    end
+
+    def additional_orders_card?(card)
+      card['suggestions'].all? do |suggestion|
+        actions = suggestion['actions']
+        actions&.all? do |action|
+          action['type'] == 'create' && action_resource_type_check(action, EXPECTED_RESOURCE_TYPES)
+        end
+      end
+    end
+
+    run do
+      parsed_cards = parse_json(valid_cards_with_suggestions)
+      additional_orders_cards = parsed_cards.filter { |card| additional_orders_card?(card) }
+      skip_if additional_orders_cards.blank?,
+              "#{hook_name} hook response does not contain an Additional Orders as companions/prerequisites card."
+
+      additional_orders_cards.each do |card|
+        card['suggestions'].each do |suggestion|
+          actions_check(suggestion['actions'])
+        end
+      end
+
+      no_error_validation('Some Additional Orders as companions/prerequisites cards are not valid.')
+    end
+  end
+end

data/lib/davinci_crd_test_kit/server_tests/card_optional_fields_validation_test.rb

@@ -0,0 +1,47 @@
+require_relative '../test_helper'
+require_relative '../cards_validation'
+
+module DaVinciCRDTestKit
+  class CardOptionalFieldsValidationTest < Inferno::Test
+    include DaVinciCRDTestKit::TestHelper
+    include DaVinciCRDTestKit::CardsValidation
+
+    title 'Cards contain valid optional fields'
+    id :crd_card_optional_fields_validation
+    description %(
+      This test checks for the presence and validity of optional fields in a card,
+      but only if the card's required fields are valid. As specified in the
+      [CDS Hooks specification section on Card Attributes](https://cds-hooks.hl7.org/2.0/#card-attributes),
+      the optional fields include `uuid`, `detail`, `suggestions`, `overrideReasons`, and `links`.
+
+      Additionally, the test validates the presence of the conditional field `selectionBehavior`
+      only if the `suggestions` field is present.
+    )
+    optional
+    input :valid_cards
+    output :valid_cards_with_links, :valid_cards_with_suggestions
+
+    def cards_with_suggestions
+      @cards_with_suggestions ||= []
+    end
+
+    def cards_with_links
+      @cards_with_links ||= []
+    end
+
+    run do
+      parsed_cards = parse_json(valid_cards)
+      parsed_cards.each do |card|
+        if valid_card_with_optionals?(card)
+          cards_with_links << card if card['links']
+          cards_with_suggestions << card if card['suggestions']
+        end
+      end
+
+      output valid_cards_with_links: cards_with_links.to_json
+      output valid_cards_with_suggestions: cards_with_suggestions.to_json
+
+      no_error_validation('Some cards with valid required fields have invalid optional fields.')
+    end
+  end
+end