davinci_crd_test_kit 0.13.0 → 0.14.0

data/lib/davinci_crd_test_kit/client/v2.2.1/cds-services-v221.json

@@ -0,0 +1,202 @@
+
+{
+  "services": [
+    {
+      "hook": "appointment-book",
+      "title": "Appointment Booking CDS Service",
+      "description": "A simulated CDS Service that is invoked when user of a CRD client books a future appointment for a patient",
+      "id": "appointment-book-service",
+      "prefetch" : {
+        "patient": "Patient/{{context.patientId}}",
+        "encounter": "Encounter/{{context.encounterId}}",
+        "coverage": "Coverage?patient={{context.patientId}}&status=active",
+        "deviceRequests" : "DeviceRequest?_id={{context.appointments.entry.resource.basedOn.extension('http://hl7.org/fhir/StructureDefinition/alternate-reference').value.resolve().ofType(DeviceRequest).id}}",
+        "serviceRequests" : "ServiceRequest?_id={{context.appointments.entry.resource.basedOn.resolve().ofType(ServiceRequest).id}}",
+        "medicationRequests" : "MedicationRequest?_id={{context.appointments.entry.resource.basedOn.extension('http://hl7.org/fhir/StructureDefinition/alternate-reference').value.resolve().ofType(MedicationRequest).id}}",
+        "devices": "Device?_id={{%deviceRequests.entry.resource.code.resolve().id}}",
+        "medications": "Medication?_id={{%medicationRequests.entry.resource.medication.resolve().id}}",
+        "practitionerRoles" : "PractitionerRole?_id={{%encounter.participant.individual.resolve().ofType(PractitionerRole).id|context.appointments.entry.resource.participant.actor.resolve().ofType(PractitionerRole).id|%deviceRequests.entry.resource.performer.resolve().ofType(PractitionerRole).id|%deviceRequests.entry.resource.requester.resolve().ofType(PractitionerRole).id|%medicationRequests.entry.resource.performer.resolve().ofType(PractitionerRole).id|%medicationRequests.entry.resource.requester.resolve().ofType(PractitionerRole).id|%serviceRequests.entry.resource.performer.resolve().ofType(PractitionerRole).id|%serviceRequests.entry.resource.requester.resolve().ofType(PractitionerRole).id}}",
+        "practitioners" : "Practitioner?_id={{%practitionerRoles.entry.resource.practitioner.resolve().id|%encounter.participant.individual.resolve().ofType(Practitioner).id|context.appointments.entry.resource.participant.actor.resolve().ofType(Practitioner).id|%deviceRequests.entry.resource.performer.resolve().ofType(Practitioner).id|%deviceRequests.entry.resource.requester.resolve().ofType(Practitioner).id|%medicationRequests.entry.resource.performer.resolve().ofType(Practitioner).id|%medicationRequests.entry.resource.requester.resolve().ofType(Practitioner).id|%serviceRequests.entry.resource.performer.resolve().ofType(Practitioner).id|%serviceRequests.entry.resource.requester.resolve().ofType(Practitioner).id}}",
+        "organizations" : "Organization?_id={{%practitionerRoles.entry.resource.organization.resolve().id|%encounter.serviceProvider.resolve().ofType(Organization).id|%medicationRequests.entry.resource.dispenseRequest.performer.resolve().ofType(Organization).id|%serviceRequests.entry.resource.performer.resolve().ofType(Organization).id}}",
+        "locations" : "Location?_id={{%practitionerRoles.entry.resource.location.resolve().id|%encounter.location.location.resolve().id|context.appointments.entry.resource.participant.actor.resolve().ofType(Location).id|%serviceRequests.entry.resource.locationReference.resolve().ofType(Location).id}}"
+      },
+      "extension" : {
+        "davinci-crd.version" : [
+          "2.2",
+          "2.0"
+        ],
+        "davinci-crd.configuration-options" : [
+          {
+            "code" : "coverage-info",
+            "type" : "boolean",
+            "name" : "Coverage Information",
+            "description" : "Information related to the patient's coverage, including whether a service is covered, requires prior authorization, is approved without seeking prior authorization, and/or requires additional documentation or data collection",
+            "default" : true
+          }
+        ]
+      }
+    },
+    {
+      "hook": "encounter-start",
+      "title": "Encounter Start CDS Service",
+      "description": "A simulated CDS Service that is invoked when the user is initiating a new encounter.",
+      "id": "encounter-start-service",
+      "prefetch" : {
+        "patient": "Patient/{{context.patientId}}",
+        "encounter": "Encounter/{{context.encounterId}}",
+        "coverage": "Coverage?patient={{context.patientId}}&status=active",
+        "practitionerRoles" : "PractitionerRole?_id={{%encounter.participant.individual.resolve().ofType(PractitionerRole).id}}",
+        "practitioners" : "Practitioner?_id={{%practitionerRoles.entry.resource.practitioner.resolve().id|%encounter.participant.individual.resolve().ofType(Practitioner).id}}",
+        "organizations" : "Organization?_id={{%practitionerRoles.entry.resource.organization.resolve().id|%encounter.serviceProvider.resolve().ofType(Organization).id}}",
+        "locations" : "Location?_id={{%practitionerRoles.entry.resource.location.resolve().id|%encounter.location.location.resolve().id}}"
+      },
+      "extension" : {
+        "davinci-crd.version" : [
+          "2.2",
+          "2.0"
+        ],
+        "davinci-crd.configuration-options" : [
+          {
+            "code" : "coverage-info",
+            "type" : "boolean",
+            "name" : "Coverage Information",
+            "description" : "Information related to the patient's coverage, including whether a service is covered, requires prior authorization, is approved without seeking prior authorization, and/or requires additional documentation or data collection",
+            "default" : true
+          }
+        ]
+      }
+    },
+    {
+      "hook": "encounter-discharge",
+      "title": "Encounter Disharge CDS Service Example",
+      "description": "A simulated CDS Service that is invoked when the user is performing the discharge process for an encounter - typically an inpatient encounter.",
+      "id": "encounter-discharge-service",
+      "prefetch" : {
+        "patient": "Patient/{{context.patientId}}",
+        "encounter": "Encounter/{{context.encounterId}}",
+        "coverage": "Coverage?patient={{context.patientId}}&status=active",
+        "practitionerRoles" : "PractitionerRole?_id={{%encounter.participant.individual.resolve().ofType(PractitionerRole).id}}",
+        "practitioners" : "Practitioner?_id={{%practitionerRoles.entry.resource.practitioner.resolve().id|%encounter.participant.individual.resolve().ofType(Practitioner).id}}",
+        "organizations" : "Organization?_id={{%practitionerRoles.entry.resource.organization.resolve().id|%encounter.serviceProvider.resolve().ofType(Organization).id}}",
+        "locations" : "Location?_id={{%practitionerRoles.entry.resource.location.resolve().id|%encounter.location.location.resolve().id}}"
+      },
+      "extension" : {
+        "davinci-crd.version" : [
+          "2.2",
+          "2.0"
+        ],
+        "davinci-crd.configuration-options" : [
+          {
+            "code" : "coverage-info",
+            "type" : "boolean",
+            "name" : "Coverage Information",
+            "description" : "Information related to the patient's coverage, including whether a service is covered, requires prior authorization, is approved without seeking prior authorization, and/or requires additional documentation or data collection",
+            "default" : true
+          }
+        ]
+      }
+    },
+    {
+      "hook": "order-dispatch",
+      "title": "Order Dispatch CDS Service Example",
+      "description": "A simulated CDS Service that fires when a practitioner is selecting a candidate performer for a pre-existing order that was not tied to a specific performer",
+      "id": "order-dispatch-service",
+      "prefetch": {
+        "patient": "Patient/{{context.patientId}}",
+        "encounter": "Encounter/{{context.encounterId}}",
+        "coverage": "Coverage?patient={{context.patientId}}&status=active",
+	      "communicationRequests": "CommunicationRequest?_id={{context.dispatchedOrders.resolve().ofType(CommunicationRequest).id}}",
+	      "deviceRequests": "DeviceRequest?_id={{context.dispatchedOrders.resolve().ofType(DeviceRequest).id}}",
+        "medicationRequests": "MedicationRequest?_id={{context.dispatchedOrders.resolve().ofType(MedicationRequest).id}}",
+        "nutritionOrders": "NutritionOrder?_id={{context.dispatchedOrders.resolve().ofType(NutritionOrder).id}}",
+        "serviceRequests": "ServiceRequest?_id={{context.dispatchedOrders.resolve().ofType(ServiceRequest).id}}",
+	      "visionPrescriptions": "VisionPrescription?_id={{context.dispatchedOrders.resolve().ofType(VisionPrescription).id}}",
+        "devices": "Device?_id={{%deviceRequests.entry.resource.code.resolve().id}}",
+        "medications": "Medication?_id={{%medicationRequests.entry.resource.medication.resolve().id}}",
+        "practitionerRoles": "PractitionerRole?_id={{%encounter.participant.individual.resolve().ofType(PractitionerRole).id|%communicationRequests.entry.resource.sender.resolve().ofType(PractitionerRole).id|%communicationRequests.entry.resource.recipient.resolve().ofType(PractitionerRole).id|%communicationRequests.entry.resource.requester.resolve().ofType(PractitionerRole).id|%deviceRequests.entry.resource.performer.resolve().ofType(PractitionerRole).id|%deviceRequests.entry.resource.requester.resolve().ofType(PractitionerRole).id|%medicationRequests.entry.resource.performer.resolve().ofType(PractitionerRole).id|%medicationRequests.entry.resource.requester.resolve().ofType(PractitionerRole).id|%serviceRequests.entry.resource.performer.resolve().ofType(PractitionerRole).id|%serviceRequests.entry.resource.requester.resolve().ofType(PractitionerRole).id|%nutritionOrders.entry.resource.orderer.resolve().ofType(PractitionerRole).id|%visionPrescriptions.entry.resource.prescriber.resolve().ofType(PractitionerRole).id}}",
+        "practitioners": "Practitioner?_id={{%practitionerRoles.entry.resource.practitioner.resolve().id|%encounter.participant.individual.resolve().ofType(Practitioner).id|%communicationRequests.entry.resource.sender.resolve().ofType(Practitioner).id|%communicationRequests.entry.resource.recipient.resolve().ofType(Practitioner).id|%communicationRequests.entry.resource.requester.resolve().ofType(Practitioner).id|%deviceRequests.entry.resource.performer.resolve().ofType(Practitioner).id|%deviceRequests.entry.resource.requester.resolve().ofType(Practitioner).id|%medicationRequests.entry.resource.performer.resolve().ofType(Practitioner).id|%medicationRequests.entry.resource.requester.resolve().ofType(Practitioner).id|%serviceRequests.entry.resource.performer.resolve().ofType(Practitioner).id|%serviceRequests.entry.resource.requester.resolve().ofType(Practitioner).id|%nutritionOrders.entry.resource.orderer.resolve().ofType(Practitioner).id|%visionPrescriptions.entry.resource.prescriber.resolve().ofType(Practitioner).id}}",
+        "organizations": "Organization?_id={{%practitionerRoles.entry.resource.organization.resolve().id|%encounter.serviceProvider.resolve().ofType(Organization).id|%communicationRequests.entry.resource.recipient.resolve().ofType(Organization).id|%communicationRequests.entry.resource.sender.resolve().ofType(Organization).id|%medicationRequests.entry.resource.dispenseRequest.performer.resolve().id|%serviceRequests.entry.resource.performer.resolve().ofType(Organization).id}}",
+        "locations": "Location?_id={{%practitionerRoles.entry.resource.location.resolve().id|%encounter.location.location.resolve().id|%serviceRequests.entry.resource.locationReference.resolve().id}}"
+      },
+      "extension" : {
+        "davinci-crd.version" : [
+          "2.2",
+          "2.0"
+        ],
+        "davinci-crd.configuration-options" : [
+          {
+            "code" : "coverage-info",
+            "type" : "boolean",
+            "name" : "Coverage Information",
+            "description" : "Information related to the patient's coverage, including whether a service is covered, requires prior authorization, is approved without seeking prior authorization, and/or requires additional documentation or data collection",
+            "default" : true
+          }
+        ]
+      }
+    },
+    {
+      "hook": "order-select",
+      "title": "Order Select CDS Service",
+      "description": "A simulated CDS Service that fires when a clinician selects one or more orders to place for a patient",
+      "id": "order-select-service",
+      "prefetch": {
+        "patient": "Patient/{{context.patientId}}",
+        "encounter": "Encounter/{{context.encounterId}}",
+        "coverage": "Coverage?patient={{context.patientId}}&status=active",        
+        "devices": "Device?_id={{context.draftOrders.entry.resource.ofType(DeviceRequest).code.resolve().id}}",
+        "medications": "Medication?_id={{context.draftOrders.entry.resource.ofType(MedicationRequest).medication.resolve().id}}",
+        "practitionerRoles": "PractitionerRole?_id={{%encounter.participant.individual.resolve().ofType(PractitionerRole).id|context.draftOrders.entry.resource.sender.resolve().ofType(PractitionerRole).id|context.draftOrders.entry.resource.recipient.resolve().ofType(PractitionerRole).id|context.draftOrders.entry.resource.requester.resolve().ofType(PractitionerRole).id|context.draftOrders.entry.resource.performer.resolve().ofType(PractitionerRole).id|context.draftOrders.entry.resource.orderer.resolve().ofType(PractitionerRole).id|context.draftOrders.entry.resource.prescriber.resolve().ofType(PractitionerRole).id}}",
+        "practitioners": "Practitioner?_id={{%practitionerRoles.entry.resource.practitioner.resolve().id|%encounter.participant.individual.resolve().ofType(Practitioner).id|context.draftOrders.entry.resource.sender.resolve().ofType(Practitioner).id|context.draftOrders.entry.resource.recipient.resolve().ofType(Practitioner).id|context.draftOrders.entry.resource.requester.resolve().ofType(Practitioner).id|context.draftOrders.entry.resource.performer.resolve().ofType(Practitioner).id|context.draftOrders.entry.resource.orderer.resolve().ofType(Practitioner).id|context.draftOrders.entry.resource.prescriber.resolve().ofType(Practitioner).id}}",
+        "organizations": "Organization?_id={{%practitionerRoles.entry.resource.organization.resolve().id|%encounter.serviceProvider.resolve().ofType(Organization).id|context.draftOrders.entry.resource.dispenseRequest.performer.resolve().id|context.draftOrders.entry.resource.sender.resolve().ofType(Organization).id|context.draftOrders.entry.resource.recipient.resolve().ofType(Organization).id|context.draftOrders.entry.resource.performer.resolve().ofType(Organization).id}}",
+        "locations": "Location?_id={{%practitionerRoles.entry.resource.location.resolve().id|%encounter.location.location.resolve().id|context.draftOrders.entry.resource.locationReference.resolve().id}}"
+      },
+      "extension" : {
+        "davinci-crd.version" : [
+          "2.2",
+          "2.0"
+        ],
+        "davinci-crd.configuration-options" : [
+          {
+            "code" : "coverage-info",
+            "type" : "boolean",
+            "name" : "Coverage Information",
+            "description" : "Information related to the patient's coverage, including whether a service is covered, requires prior authorization, is approved without seeking prior authorization, and/or requires additional documentation or data collection",
+            "default" : true
+          }
+        ]
+      }
+    },
+    {
+      "hook": "order-sign",
+      "title": "Order Sign CDS Service",
+      "description": "A simulated CDS Service that fires when a clinician is ready to sign one or more orders for a patient",
+      "id": "order-sign-service",
+      "prefetch": {
+        "patient": "Patient/{{context.patientId}}",
+        "encounter": "Encounter/{{context.encounterId}}",
+        "coverage": "Coverage?patient={{context.patientId}}&status=active",        
+        "devices": "Device?_id={{context.draftOrders.entry.resource.ofType(DeviceRequest).code.resolve().id}}",
+        "medications": "Medication?_id={{context.draftOrders.entry.resource.ofType(MedicationRequest).medication.resolve().id}}",
+        "practitionerRoles": "PractitionerRole?_id={{%encounter.participant.individual.resolve().ofType(PractitionerRole).id|context.draftOrders.entry.resource.sender.resolve().ofType(PractitionerRole).id|context.draftOrders.entry.resource.recipient.resolve().ofType(PractitionerRole).id|context.draftOrders.entry.resource.requester.resolve().ofType(PractitionerRole).id|context.draftOrders.entry.resource.performer.resolve().ofType(PractitionerRole).id|context.draftOrders.entry.resource.orderer.resolve().ofType(PractitionerRole).id|context.draftOrders.entry.resource.prescriber.resolve().ofType(PractitionerRole).id}}",
+        "practitioners": "Practitioner?_id={{%practitionerRoles.entry.resource.practitioner.resolve().id|%encounter.participant.individual.resolve().ofType(Practitioner).id|context.draftOrders.entry.resource.sender.resolve().ofType(Practitioner).id|context.draftOrders.entry.resource.recipient.resolve().ofType(Practitioner).id|context.draftOrders.entry.resource.requester.resolve().ofType(Practitioner).id|context.draftOrders.entry.resource.performer.resolve().ofType(Practitioner).id|context.draftOrders.entry.resource.orderer.resolve().ofType(Practitioner).id|context.draftOrders.entry.resource.prescriber.resolve().ofType(Practitioner).id}}",
+        "organizations": "Organization?_id={{%practitionerRoles.entry.resource.organization.resolve().id|%encounter.serviceProvider.resolve().ofType(Organization).id|context.draftOrders.entry.resource.dispenseRequest.performer.resolve().id|context.draftOrders.entry.resource.sender.resolve().ofType(Organization).id|context.draftOrders.entry.resource.recipient.resolve().ofType(Organization).id|context.draftOrders.entry.resource.performer.resolve().ofType(Organization).id}}",
+        "locations": "Location?_id={{%practitionerRoles.entry.resource.location.resolve().id|%encounter.location.location.resolve().id|context.draftOrders.entry.resource.locationReference.resolve().id}}"
+      },
+      "extension" : {
+        "davinci-crd.version" : [
+          "2.2",
+          "2.0"
+        ],
+        "davinci-crd.configuration-options" : [
+          {
+            "code" : "coverage-info",
+            "type" : "boolean",
+            "name" : "Coverage Information",
+            "description" : "Information related to the patient's coverage, including whether a service is covered, requires prior authorization, is approved without seeking prior authorization, and/or requires additional documentation or data collection",
+            "default" : true
+          }
+        ]
+      }
+    }
+  ]
+}

data/lib/davinci_crd_test_kit/client/v2.2.1/client_appointment_book_group.rb

@@ -0,0 +1,102 @@
+require_relative 'invocation/appointment_book_receive_request_test'
+require_relative 'auth/decode_auth_token_test'
+require_relative 'auth/retrieve_jwks_test'
+require_relative 'auth/token_header_test'
+require_relative 'auth/token_payload_test'
+require_relative 'verify_request/hook_request_conformance_test'
+require_relative 'verify_request/hook_request_requested_version_test'
+require_relative 'verify_request/hook_request_prefetch_profiles_test'
+require_relative 'verify_request/hook_request_prefetch_complete_test'
+require_relative 'verify_request/hook_request_granted_scopes_test'
+require_relative 'verify_request/hook_request_secured_transport_test'
+require_relative 'verify_request/hook_request_coverage_verification_test'
+require_relative 'verify_request/hook_request_data_fetch_verification_test'
+require_relative 'verify_response/inferno_response_validation'
+require_relative 'verify_response/client_display_cards_attest'
+require_relative 'verify_response/hook_response_support_coverage_information_test'
+
+module DaVinciCRDTestKit
+  module V221
+    class ClientAppointmentBookGroup < Inferno::TestGroup
+      title 'appointment-book'
+      id :crd_v221_client_appointment_book
+      description <<~DESCRIPTION
+        The [appointment-book](https://cds-hooks.hl7.org/hooks/STU1/appointment-book.html) hook is invoked when
+        the user is scheduling one or more future encounters/visits for the patient.
+        The CRD IG places [additional constraints on the use of the appintment-book hook](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#appointment-book),
+        including the profiles that resources in each request must conform to.
+      DESCRIPTION
+      run_as_group
+
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@hook-2-A'
+
+      input_order :cds_jwt_iss, :cds_jwk_set
+
+      config(
+        inputs: {
+          auth_token_headers_json: { name: :appointment_book_auth_token_headers_json },
+          auth_tokens: { name: :appointment_book_auth_tokens },
+          auth_tokens_jwk_json: { name: :appointment_book_auth_tokens_jwk_json },
+          client_access_token: { name: :appointment_book_client_access_token },
+          client_fhir_server: { name: :appointment_book_client_fhir_server },
+          crd_jwks_keys_json: { name: :appointment_book_crd_jwks_keys_json },
+          custom_response_template: { name: :appointment_book_custom_response_template },
+          selected_response_types: { name: :appointment_book_selected_response_types }
+        },
+        outputs: {
+          auth_token_headers_json: { name: :appointment_book_auth_token_headers_json },
+          auth_token_payloads_json: { name: :appointment_book_auth_token_payloads_json },
+          auth_tokens: { name: :appointment_book_auth_tokens },
+          auth_tokens_jwk_json: { name: :appointment_book_auth_tokens_jwk_json },
+          client_access_token: { name: :appointment_book_client_access_token },
+          client_fhir_server: { name: :appointment_book_client_fhir_server },
+          crd_jwks_keys_json: { name: :appointment_book_crd_jwks_keys_json }
+        },
+        options: {
+          hook_name: 'appointment-book'
+        }
+      )
+
+      group do
+        title 'Interaction'
+        test from: :crd_v221_appointment_book_request
+      end
+
+      group do
+        title 'Authorization'
+        test from: :crd_v221_decode_auth_token
+        test from: :crd_v221_retrieve_jwks
+        test from: :crd_v221_token_header
+        test from: :crd_v221_token_payload
+      end
+
+      group do
+        title 'Requests'
+        test from: :crd_v221_hook_request_conformance do
+          verifies_requirements(*HookRequestConformanceTest.verifies_requirements,
+                                'hl7.fhir.us.davinci-crd_2.2.1@hook-24',
+                                'hl7.fhir.us.davinci-crd_2.2.1@prof-1',
+                                'hl7.fhir.us.davinci-crd_2.2.1@prof-2')
+        end
+        test from: :crd_v221_hook_request_requested_version
+        test from: :crd_v221_hook_request_prefetch_profiles
+        test from: :crd_v221_hook_request_prefetch_complete
+        test from: :crd_v221_hook_request_coverage_verification
+        test from: :crd_v221_hook_data_fetch_verification
+        test from: :crd_v221_hook_request_granted_scopes
+        test from: :crd_v221_hook_request_secured_transport
+      end
+
+      group do
+        title 'Response Handling'
+
+        test from: :crd_v221_inferno_response_validation
+        test from: :crd_v221_card_display_attest_test
+        test from: :crd_v221_client_hook_response_support_coverage_information do
+          title 'Client supports the Coverage Information response type on the appointment-book hook'
+          verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@hook-26'
+        end
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.2.1/client_cross_hook_group.rb

@@ -0,0 +1,28 @@
+require_relative 'cross_hook/client_card_must_support_coverage_information_test'
+require_relative 'cross_hook/client_location_address_propagation_test'
+require_relative 'cross_hook/client_fhirpath_collection_as_comma_delimited_string_test'
+require_relative 'cross_hook/client_hook_instances_unique_test'
+require_relative 'cross_hook/client_prefetch_complete_and_subset_test'
+
+module DaVinciCRDTestKit
+  module V221
+    class ClientCrossHookGroup < Inferno::TestGroup
+      title 'Cross Hook'
+      id :crd_v221_client_cross_hook
+      description <<~DESCRIPTION
+        This group checks CRD requirements that pertain across all hooks
+        rather than a specific one.
+
+        These tests must be run after the tests in the "Hooks" group are run.
+      DESCRIPTION
+
+      run_as_group
+
+      test from: :crd_v221_client_card_must_support_coverage_information
+      test from: :crd_v221_client_location_address_propagation
+      test from: :crd_v221_client_fhir_path_collection_as_comma_delimited_string
+      test from: :crd_v221_client_hook_instances_unique
+      test from: :crd_v221_client_prefetch_complete_and_subset
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.2.1/client_encounter_discharge_group.rb

@@ -0,0 +1,96 @@
+require_relative 'invocation/encounter_discharge_receive_request_test'
+require_relative 'auth/decode_auth_token_test'
+require_relative 'auth/retrieve_jwks_test'
+require_relative 'auth/token_header_test'
+require_relative 'auth/token_payload_test'
+require_relative 'verify_request/hook_request_conformance_test'
+require_relative 'verify_request/hook_request_requested_version_test'
+require_relative 'verify_request/hook_request_prefetch_profiles_test'
+require_relative 'verify_request/hook_request_prefetch_complete_test'
+require_relative 'verify_request/hook_request_granted_scopes_test'
+require_relative 'verify_request/hook_request_secured_transport_test'
+require_relative 'verify_request/hook_request_coverage_verification_test'
+require_relative 'verify_request/hook_request_data_fetch_verification_test'
+require_relative 'verify_response/inferno_response_validation'
+require_relative 'verify_response/client_display_cards_attest'
+
+module DaVinciCRDTestKit
+  module V221
+    class ClientEncounterDischargeGroup < Inferno::TestGroup
+      title 'encounter-discharge'
+      id :crd_v221_client_encounter_discharge
+      description <<~DESCRIPTION
+        The [encounter-discharge](https://cds-hooks.hl7.org/hooks/STU1/encounter-discharge.html) hook is
+        invoked when the user is performing the discharge process for an encounter where
+        the notion of 'discharge' is relevant - typically an inpatient encounter.
+        The CRD IG places [additional constraints on the use of the encounter-discharge hook](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#encounter-discharge),
+        including the profiles that resources in each request must conform to.
+      DESCRIPTION
+      run_as_group
+
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@hook-2-A'
+
+      input_order :cds_jwt_iss, :cds_jwk_set
+
+      config(
+        inputs: {
+          auth_token_headers_json: { name: :encounter_discharge_auth_token_headers_json },
+          auth_tokens: { name: :encounter_discharge_auth_tokens },
+          auth_tokens_jwk_json: { name: :encounter_discharge_auth_tokens_jwk_json },
+          client_access_token: { name: :encounter_discharge_client_access_token },
+          client_fhir_server: { name: :encounter_discharge_client_fhir_server },
+          crd_jwks_keys_json: { name: :encounter_discharge_crd_jwks_keys_json },
+          custom_response_template: { name: :encounter_discharge_custom_response_template },
+          selected_response_types: { name: :encounter_discharge_selected_response_types }
+        },
+        outputs: {
+          auth_token_headers_json: { name: :encounter_discharge_auth_token_headers_json },
+          auth_token_payloads_json: { name: :encounter_discharge_auth_token_payloads_json },
+          auth_tokens: { name: :encounter_discharge_auth_tokens },
+          auth_tokens_jwk_json: { name: :encounter_discharge_auth_tokens_jwk_json },
+          client_access_token: { name: :encounter_discharge_client_access_token },
+          client_fhir_server: { name: :encounter_discharge_client_fhir_server },
+          crd_jwks_keys_json: { name: :encounter_discharge_crd_jwks_keys_json }
+        },
+        options: {
+          hook_name: 'encounter-discharge'
+        }
+      )
+
+      group do
+        title 'Interaction'
+        test from: :crd_v221_encounter_discharge_request
+      end
+
+      group do
+        title 'Authorization'
+        test from: :crd_v221_decode_auth_token
+        test from: :crd_v221_retrieve_jwks
+        test from: :crd_v221_token_header
+        test from: :crd_v221_token_payload
+      end
+
+      group do
+        title 'Requests'
+        test from: :crd_v221_hook_request_conformance do
+          verifies_requirements(*HookRequestConformanceTest.verifies_requirements,
+                                'hl7.fhir.us.davinci-crd_2.2.1@hook-27')
+        end
+        test from: :crd_v221_hook_request_requested_version
+        test from: :crd_v221_hook_request_prefetch_profiles
+        test from: :crd_v221_hook_request_prefetch_complete
+        test from: :crd_v221_hook_request_coverage_verification
+        test from: :crd_v221_hook_data_fetch_verification
+        test from: :crd_v221_hook_request_granted_scopes
+        test from: :crd_v221_hook_request_secured_transport
+      end
+
+      group do
+        title 'Response Handling'
+
+        test from: :crd_v221_inferno_response_validation
+        test from: :crd_v221_card_display_attest_test
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.2.1/client_encounter_start_group.rb

@@ -0,0 +1,95 @@
+require_relative 'invocation/encounter_start_receive_request_test'
+require_relative 'auth/decode_auth_token_test'
+require_relative 'auth/retrieve_jwks_test'
+require_relative 'auth/token_header_test'
+require_relative 'auth/token_payload_test'
+require_relative 'verify_request/hook_request_conformance_test'
+require_relative 'verify_request/hook_request_requested_version_test'
+require_relative 'verify_request/hook_request_prefetch_profiles_test'
+require_relative 'verify_request/hook_request_prefetch_complete_test'
+require_relative 'verify_request/hook_request_granted_scopes_test'
+require_relative 'verify_request/hook_request_secured_transport_test'
+require_relative 'verify_request/hook_request_coverage_verification_test'
+require_relative 'verify_request/hook_request_data_fetch_verification_test'
+require_relative 'verify_response/inferno_response_validation'
+require_relative 'verify_response/client_display_cards_attest'
+
+module DaVinciCRDTestKit
+  module V221
+    class ClientEncounterStartGroup < Inferno::TestGroup
+      title 'encounter-start'
+      id :crd_v221_client_encounter_start
+      description <<~DESCRIPTION
+        The [encounter-start](https://cds-hooks.hl7.org/hooks/STU1/encounter-start.html) hook is invoked
+        when the user is initiating a new encounter. The CRD IG places [additional constraints on the use
+        of the encounter-start hook](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#encounter-start),
+        including the profiles that resources in each request must conform to.
+      DESCRIPTION
+      run_as_group
+
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@hook-2-A'
+
+      input_order :cds_jwt_iss, :cds_jwk_set
+
+      config(
+        inputs: {
+          auth_token_headers_json: { name: :encounter_start_auth_token_headers_json },
+          auth_tokens: { name: :encounter_start_auth_tokens },
+          auth_tokens_jwk_json: { name: :encounter_start_auth_tokens_jwk_json },
+          client_access_token: { name: :encounter_start_client_access_token },
+          client_fhir_server: { name: :encounter_start_client_fhir_server },
+          crd_jwks_keys_json: { name: :encounter_start_crd_jwks_keys_json },
+          custom_response_template: { name: :encounter_start_custom_response_template },
+          selected_response_types: { name: :encounter_start_selected_response_types }
+        },
+        outputs: {
+          auth_token_headers_json: { name: :encounter_start_auth_token_headers_json },
+          auth_token_payloads_json: { name: :encounter_start_auth_token_payloads_json },
+          auth_tokens: { name: :encounter_start_auth_tokens },
+          auth_tokens_jwk_json: { name: :encounter_start_auth_tokens_jwk_json },
+          client_access_token: { name: :encounter_start_client_access_token },
+          client_fhir_server: { name: :encounter_start_client_fhir_server },
+          crd_jwks_keys_json: { name: :encounter_start_crd_jwks_keys_json }
+        },
+        options: {
+          hook_name: 'encounter-start'
+        }
+      )
+
+      group do
+        title 'Interaction'
+        test from: :crd_v221_encounter_start_request
+      end
+
+      group do
+        title 'Authorization'
+        test from: :crd_v221_decode_auth_token
+        test from: :crd_v221_retrieve_jwks
+        test from: :crd_v221_token_header
+        test from: :crd_v221_token_payload
+      end
+
+      group do
+        title 'Requests'
+        test from: :crd_v221_hook_request_conformance do
+          verifies_requirements(*HookRequestConformanceTest.verifies_requirements,
+                                'hl7.fhir.us.davinci-crd_2.2.1@hook-29')
+        end
+        test from: :crd_v221_hook_request_requested_version
+        test from: :crd_v221_hook_request_prefetch_profiles
+        test from: :crd_v221_hook_request_prefetch_complete
+        test from: :crd_v221_hook_request_coverage_verification
+        test from: :crd_v221_hook_data_fetch_verification
+        test from: :crd_v221_hook_request_granted_scopes
+        test from: :crd_v221_hook_request_secured_transport
+      end
+
+      group do
+        title 'Response Handling'
+
+        test from: :crd_v221_inferno_response_validation
+        test from: :crd_v221_card_display_attest_test
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.2.1/client_fhir_api_group.rb

@@ -0,0 +1,88 @@
+require 'us_core_test_kit'
+require_relative '../crd_client_options'
+require_relative 'api/client_crd_update_verification_group'
+
+module DaVinciCRDTestKit
+  module V221
+    class ClientFHIRAPIGroup < Inferno::TestGroup
+      title 'FHIR API'
+      description <<~DESCRIPTION
+        CRD client systems are responsible for returning data requested by the CRD server needed to provide decision support.
+        This group contains tests that verify the required 'server' FHIR API capabilities.
+        These 'server' capabilities are based on the US Core Server Capability Statement for the US Core version chosen
+        when initiating the test session:
+        - [US Core 3.1.1 Server Capability Statement](http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-server.html)
+        - [US Core 6.1.0 Server Capability Statement](http://hl7.org/fhir/us/core/STU6.1/CapabilityStatement-us-core-server.html)
+        - [US Core 7.0.0 Server Capability Statement](http://hl7.org/fhir/us/core/STU7/CapabilityStatement-us-core-server.html)
+      DESCRIPTION
+      id :crd_v221_client_fhir_api
+
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@conf-1'
+
+      input_instructions %(
+        The location of and an access token for the client's FHIR server are expected to come in
+        the CDS Hooks request. The following information will be auto-populated from
+        the body of the latest hook invocation made during this session:
+        - The URL of the CRD client FHIR server from the `fhirServer` field.
+        - The OAuth Access Token from the `fhirAuthorization.access_token` field.
+
+        If that access token will not be long-lived enough to perform
+        a full test of the US Core FHIR API, provide an updated token and/or refresh
+        token with Client ID and token endpoint so that Inferno can perform these tests.
+      )
+
+      input :url,
+            title: 'FHIR Endpoint',
+            description: %(
+              URL of the CRD client FHIR server.
+            ),
+            locked: true
+      input :smart_auth_info,
+            title: 'OAuth Credentials',
+            type: 'auth_info'
+
+      group from: :'us_core_v311-us_core_v311_fhir_api' do
+        description %(
+          This test group verifies that the CRD client can respond to queries as required by the
+          [US Core 3.1.1 Server Capability Statement](http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-server.html).
+
+          Note: these tests do not look for crd-specific data and so only verify conformance against
+          US Core profiles. The hook tests take the CRD-specific profiles into account.
+        )
+        required_suite_options CRDClientOptions::US_CORE_3_REQUIREMENT
+
+        group from: :crd_v221_client_update_verification,
+              id: :crd_v221_us_core_311_client_update_verification
+        reorder :crd_v221_us_core_311_client_update_verification, 1
+      end
+      group from: :'us_core_v610-us_core_v610_fhir_api' do
+        description %(
+          This test group verifies that the CRD client can respond to queries as required by the
+          [US Core 6.1.0 Server Capability Statement](http://hl7.org/fhir/us/core/STU6.1/CapabilityStatement-us-core-server.html).
+
+          Note: these tests do not look for crd-specific data and so only verify conformance against
+          US Core profiles. The hook tests take the CRD-specific profiles into account.
+        )
+        required_suite_options CRDClientOptions::US_CORE_6_REQUIREMENT
+
+        group from: :crd_v221_client_update_verification,
+              id: :crd_v221_us_core_610_client_update_verification
+        reorder :crd_v221_us_core_610_client_update_verification, 1
+      end
+      group from: :'us_core_v700-us_core_v700_fhir_api' do
+        description %(
+          This test group verifies that the CRD client can respond to queries as required by the
+          [US Core 7.0.0 Server Capability Statement](http://hl7.org/fhir/us/core/STU7/CapabilityStatement-us-core-server.html).
+
+          Note: these tests do not look for crd-specific data and so only verify conformance against
+          US Core profiles. The hook tests take the CRD-specific profiles into account.
+        )
+        required_suite_options CRDClientOptions::US_CORE_7_REQUIREMENT
+
+        group from: :crd_v221_client_update_verification,
+              id: :crd_v221_us_core_700_client_update_verification
+        reorder :crd_v221_us_core_700_client_update_verification, 1
+      end
+    end
+  end
+end