davinci_pdex_test_kit 0.10.6 → 0.12.0

data/lib/davinci_pdex_test_kit/pdex_payer_server/medication_dispense/metadata.yml

@@ -0,0 +1,206 @@
+---
+:name: pdex_medicationdispense
+:class_name: PdexMedicationdispenseSequence
+:version: v2.0.0
+:reformatted_version: v200
+:resource: MedicationDispense
+:profile_url: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-medicationdispense
+:profile_name: PDex MedicationDispense
+:profile_version: 2.0.0
+:title: PDex MedicationDispense
+:short_description: Verify support for the server capabilities required by the PDex
+  MedicationDispense.
+:is_delayed: true
+:interactions:
+- :code: search-type
+  :expectation: SHALL
+- :code: read
+  :expectation: SHALL
+- :code: vread
+  :expectation: SHOULD
+- :code: history-instance
+  :expectation: SHOULD
+- :code: history-type
+  :expectation: MAY
+:operations: []
+:searches:
+- :names:
+  - patient
+  :expectation: SHALL
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHOULD
+  :names:
+  - patient
+  - status
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHOULD
+  :names:
+  - patient
+  - status
+  - type
+  :names_not_must_support_or_mandatory:
+  - type
+  :must_support_or_mandatory: false
+:search_definitions:
+  :patient:
+    :paths:
+    - subject
+    :full_paths:
+    - MedicationDispense.subject
+    :comparators: {}
+    :values: []
+    :type: Reference
+    :contains_multiple: false
+    :multiple_or: MAY
+  :status:
+    :paths:
+    - status
+    :full_paths:
+    - MedicationDispense.status
+    :comparators: {}
+    :values:
+    - preparation
+    - in-progress
+    - cancelled
+    - on-hold
+    - completed
+    - entered-in-error
+    - stopped
+    - declined
+    - unknown
+    :type: code
+    :contains_multiple: false
+    :multiple_or: SHALL
+  :type:
+    :paths:
+    - type
+    :full_paths:
+    - MedicationDispense.type
+    :comparators: {}
+    :values:
+    - DF
+    - EM
+    - SO
+    - FF
+    - FFC
+    - FFP
+    - FFSS
+    - TF
+    - FS
+    - MS
+    - RF
+    - UD
+    - RFC
+    - RFCS
+    - RFF
+    - RFFS
+    - RFP
+    - RFPS
+    - RFS
+    - TB
+    - TBS
+    - UDE
+    :type: CodeableConcept
+    :contains_multiple: false
+    :multiple_or: SHALL
+:include_params:
+- MedicationDispense:medication
+:revincludes:
+- Provenance:target
+:required_concepts:
+- category
+- medicationCodeableConcept
+:must_supports:
+  :extensions: []
+  :slices: []
+  :elements:
+  - :path: status
+  - :path: subject
+    :types:
+    - Reference
+    :target_profiles:
+    - http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
+  - :path: substitution
+  - :path: substitution.wasSubstituted
+:mandatory_elements:
+- MedicationDispense.status
+- MedicationDispense.medication[x]
+- MedicationDispense.subject
+- MedicationDispense.performer.actor
+- MedicationDispense.substitution.wasSubstituted
+:bindings:
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/medicationdispense-status
+  :path: status
+- :type: CodeableConcept
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/medicationdispense-category
+  :path: category
+- :type: CodeableConcept
+  :strength: required
+  :system: http://hl7.org/fhir/us/davinci-pdex/ValueSet/FDANationalDrugCode
+  :path: medication
+  :required_binding_slice: true
+:references:
+- :path: MedicationDispense.partOf
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Procedure
+- :path: MedicationDispense.subject
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
+- :path: MedicationDispense.context
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Encounter
+  - http://hl7.org/fhir/StructureDefinition/EpisodeOfCare
+- :path: MedicationDispense.supportingInformation
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Resource
+- :path: MedicationDispense.performer.actor
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization
+- :path: MedicationDispense.location
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-location
+- :path: MedicationDispense.authorizingPrescription
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest
+- :path: MedicationDispense.destination
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Location
+- :path: MedicationDispense.receiver
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Patient
+  - http://hl7.org/fhir/StructureDefinition/Practitioner
+- :path: MedicationDispense.substitution.responsibleParty
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Practitioner
+  - http://hl7.org/fhir/StructureDefinition/PractitionerRole
+- :path: MedicationDispense.detectedIssue
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/DetectedIssue
+- :path: MedicationDispense.eventHistory
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Provenance
+:tests:
+- :id: pdex_medication_dispense_read
+  :file_name: medication_dispense_read_test.rb
+- :id: pdex_medication_dispense_patient_status_search
+  :file_name: medication_dispense_patient_status_search_test.rb
+- :id: pdex_medication_dispense_patient_status_type_search
+  :file_name: medication_dispense_patient_status_type_search_test.rb
+- :id: pdex_medication_dispense_provenance_revinclude_search
+  :file_name: medication_dispense_provenance_revinclude_search_test.rb
+- :id: pdex_medication_dispense_validation
+  :file_name: medication_dispense_validation_test.rb
+- :id: pdex_medication_dispense_must_support
+  :file_name: medication_dispense_must_support_test.rb
+- :id: pdex_medication_dispense_ref_resolution
+  :file_name: medication_dispense_reference_resolution_test.rb
+:id: pdex_medication_dispense
+:file_name: medication_dispense_group.rb
+:delayed_references: []

data/lib/davinci_pdex_test_kit/pdex_payer_server/medication_dispense_group.rb

@@ -0,0 +1,69 @@
+require_relative 'medication_dispense/medication_dispense_patient_search_test'
+require_relative 'medication_dispense/medication_dispense_read_test'
+require_relative 'medication_dispense/medication_dispense_patient_status_search_test'
+require_relative 'medication_dispense/medication_dispense_patient_status_type_search_test'
+require_relative 'medication_dispense/medication_dispense_provenance_revinclude_search_test'
+require_relative 'medication_dispense/medication_dispense_validation_test'
+require_relative 'medication_dispense/medication_dispense_must_support_test'
+require_relative 'medication_dispense/medication_dispense_reference_resolution_test'
+
+module DaVinciPDexTestKit
+  module PDexPayerServer
+    class MedicationDispenseGroup < Inferno::TestGroup
+      title 'PDex MedicationDispense Tests'
+      short_description 'Verify support for the server capabilities required by the PDex MedicationDispense.'
+      description %(
+        # Background
+
+        The PDex MedicationDispense sequence verifies that the system under test is
+        able to provide correct responses for MedicationDispense queries. These queries
+        must contain resources conforming to the PDex MedicationDispense as
+        specified in the PDex v2.0.0 Implementation Guide.
+
+        # Testing Methodology
+
+
+        ## Must Support
+        Each profile contains elements marked as "must support". This test
+        sequence expects to see each of these elements at least once. If at
+        least one cannot be found, the test will fail. The test will look
+        through the MedicationDispense resources found in the first test for these
+        elements.
+
+        ## Profile Validation
+        Each resource returned from the first search is expected to conform to
+        the [PDex MedicationDispense](http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-medicationdispense). Each element is checked against
+        teminology binding and cardinality requirements.
+
+        Elements with a required binding are validated against their bound
+        ValueSet. If the code/system in the element is not part of the ValueSet,
+        then the test will fail.
+
+        ## Reference Validation
+        At least one instance of each external reference in elements marked as
+        "must support" within the resources provided by the system must resolve.
+        The test will attempt to read each reference found and will fail if no
+        read succeeds.
+      )
+
+      id :pdex_medication_dispense
+      run_as_group
+
+      def self.metadata
+        @metadata ||= USCoreTestKit::USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(
+                                                                                   File.join(__dir__, 'medication_dispense',
+                                                                                             'metadata.yml'), aliases: true
+                                                                                 ))
+      end
+
+      test from: :pdex_medication_dispense_patient_search
+      test from: :pdex_medication_dispense_patient_status_search
+      test from: :pdex_medication_dispense_patient_status_type_search
+      test from: :pdex_medication_dispense_read
+      test from: :pdex_medication_dispense_provenance_revinclude_search
+      test from: :pdex_medication_dispense_validation
+      test from: :pdex_medication_dispense_must_support
+      test from: :pdex_medication_dispense_ref_resolution
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/pdex_payer_server/member_match_request_local_references_validation.rb

@@ -27,7 +27,7 @@ module DaVinciPDexTestKit
     # resource. 
     #
     class MemberMatchRequestLocalReferencesValidation < Inferno::Test
-      id :pdex_member_match_request_local_references_validation
+      id :pdex_member_match_local_ref_validation
 
       title '[USER INPUT VALIDATION] Member match request only uses local references'
 

data/lib/davinci_pdex_test_kit/pdex_payer_server/member_match_request_profile_validation.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module DaVinciPDexTestKit
   module PDexPayerServer
 
@@ -29,7 +27,7 @@ module DaVinciPDexTestKit
     # resource. 
     #
     class MemberMatchRequestProfileValidation < Inferno::Test
-      id :pdex_member_match_request_profile_validation
+      id :pdex_member_match_profile_validation
 
       input :member_match_request
 

data/lib/davinci_pdex_test_kit/pdex_payer_server/multiple_member_matches_group.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 require_relative 'member_match_request_profile_validation'
 require_relative 'member_match_request_local_references_validation'
 require_relative 'coverage_to_link_minimal_data_validation'
@@ -7,57 +6,57 @@ require_relative 'coverage_to_link_must_support_validation'
 module DaVinciPDexTestKit
   module PDexPayerServer
     class MultipleMemberMatchesGroup < Inferno::TestGroup
+      id :pdex_multiple_member_matches
+      title '$member-match with multiple matches'
 
-        id :pdex_multiple_member_matches_group
-        title '$member-match with multiple matches'
+      run_as_group
 
-        run_as_group
+      input :multiple_member_match_request,
+            title: 'Member Match Request for multiple matches',
+            description: "A JSON payload for server's $member-match endpoint that has **more than one match**",
+            type: 'textarea',
+            optional: true
 
-        input :multiple_member_match_request,
-          title: 'Member Match Request for multiple matches',
-          description: "A JSON payload for server's $member-match endpoint that has **more than one match**",
-          type: 'textarea',
-          optional: true
+      group_config = { inputs: { member_match_request: { name: :multiple_member_match_request } } }
 
-        group_config = { inputs: { member_match_request: { name: :multiple_member_match_request } } }
-  
-        test from: :pdex_member_match_request_profile_validation do
-          id :multiple_member_match_request_profile_test
-          config(group_config)
-          title '[USER INPUT VALIDATION] Member match request for multiple matches is valid'
-          description %{
+      test from: :pdex_member_match_profile_validation do
+        id :pdex_multiple_match_profile_validation
+        config(group_config)
+        title '[USER INPUT VALIDATION] Member match request for multiple matches is valid'
+        description %{
             This test validates the conformity of the user input to the
             [HRex Member Match Request Profile](https://hl7.org/fhir/us/davinci-hrex/STU1/StructureDefinition-hrex-parameters-member-match-in.html),
             ensuring subsequent tests can accurately simulate content. It also checks conformance to the [Parameters Resource](https://hl7.org/fhir/R4/parameters.html),
             mandatory elements, and terminology. It also checks that the Patient reference with the Consent and CoverageToMatch parameters are local references.
           }
 
-          # Inherits
-        end
+        # Inherits
+      end
+
+      test from: :pdex_member_match_local_ref_validation, config: group_config
 
-        test from: :pdex_member_match_request_local_references_validation, config: group_config
-  
-        test from: :pdex_coverage_to_link_minimal_data_validation, config: group_config
-        test from: :pdex_coverage_to_link_must_support_validation, config: group_config
+      test from: :pdex_coverage_to_link_minimal_validation, config: group_config
+      test from: :pdex_coverage_to_link_ms_validation, config: group_config
 
-        test do
-          id :member_match_has_multiple_matches
-          title 'Server $member-match operation returns 422 Unprocessable Content if multiple matches are found'
-          description %{
+      test do
+        id :pdex_member_match_has_multiple_matches
+        title 'Server $member-match operation returns 422 Unprocessable Content if multiple matches are found'
+        description %{
             See [member matching logic](https://hl7.org/fhir/us/davinci-hrex/STU1/OperationDefinition-member-match.html#member-matching-logic)
             for specification.
-          }
-  
-          run do
-            skip_if !multiple_member_match_request, "No member match request inputted for multiple-match tests."
-
-            member_match_request_resource = FHIR.from_contents(multiple_member_match_request)
-  
-            fhir_operation('/Patient/$member-match', body: member_match_request_resource)
-            assert_response_status(422)
-          end
-        end
+            }
 
+        verifies_requirements 'hl7.fhir.us.davinci-pdex_2.0.0@37'
+
+        run do
+          skip_if !multiple_member_match_request, 'No member match request inputted for multiple-match tests.'
+
+          member_match_request_resource = FHIR.from_contents(multiple_member_match_request)
+
+          fhir_operation('/Patient/$member-match', body: member_match_request_resource)
+          assert_response_status(422)
+        end
+      end
     end
   end
 end

data/lib/davinci_pdex_test_kit/pdex_payer_server/no_member_matches_group.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 require_relative 'member_match_request_profile_validation'
 require_relative 'member_match_request_local_references_validation'
 require_relative 'coverage_to_link_minimal_data_validation'
@@ -7,42 +6,41 @@ require_relative 'coverage_to_link_must_support_validation'
 module DaVinciPDexTestKit
   module PDexPayerServer
     class NoMemberMatchesGroup < Inferno::TestGroup
-        id :pdex_no_member_matches_group
-        title '$member-match with no matches'
+      id :pdex_no_member_matches
+      title '$member-match with no matches'
 
-        run_as_group
+      run_as_group
 
-        input :no_member_match_request,
-          title: 'Member Match Request for no matches',
-          description: "A JSON payload for server's $member-match endpoint that has **no matches**",
-          type: 'textarea',
-          optional: true
+      input :no_member_match_request,
+            title: 'Member Match Request for no matches',
+            description: "A JSON payload for server's $member-match endpoint that has **no matches**",
+            type: 'textarea',
+            optional: true
 
-        group_config = { inputs: { member_match_request: { name: :no_member_match_request } } }
+      group_config = { inputs: { member_match_request: { name: :no_member_match_request } } }
 
-        test from: :pdex_member_match_request_profile_validation do
-          id :no_member_match_request_profile_test
-          config(group_config)
+      test from: :pdex_member_match_profile_validation do
+        id :pdex_no_match_profile_validation
+        config(group_config)
 
-          title '[USER INPUT VALIDATION] Member match request for no matches is valid'
-          description %{
+        title '[USER INPUT VALIDATION] Member match request for no matches is valid'
+        description %{
             Regardless of having no intended matches, this test validates the conformity of the user input to the
             [HRex Member Match Request Profile](https://hl7.org/fhir/us/davinci-hrex/STU1/StructureDefinition-hrex-parameters-member-match-in.html),
             ensuring subsequent tests can accurately simulate content. It also checks conformance to the [Parameters Resource](https://hl7.org/fhir/R4/parameters.html),
             mandatory elements, and terminology. It also checks that the Patient reference with the Consent and CoverageToMatch parameters are local references.
           }
-        end
-
-        test from: :pdex_member_match_request_local_references_validation, config: group_config
+      end
 
-        test from: :pdex_coverage_to_link_minimal_data_validation, config: group_config
-        test from: :pdex_coverage_to_link_must_support_validation, config: group_config
+      test from: :pdex_member_match_local_ref_validation, config: group_config
 
+      test from: :pdex_coverage_to_link_minimal_validation, config: group_config
+      test from: :pdex_coverage_to_link_ms_validation, config: group_config
 
-        test do
-          id :member_match_has_no_matches
-          title 'Server $member-match operation returns 422 Unprocessable Content if no matches are found'
-          description %{
+      test do
+        id :pdex_member_match_has_no_matches
+        title 'Server $member-match operation returns 422 Unprocessable Content if no matches are found'
+        description %{
             See [member matching logic](https://hl7.org/fhir/us/davinci-hrex/STU1/OperationDefinition-member-match.html#member-matching-logic)
             for specification.
 
@@ -50,15 +48,16 @@ module DaVinciPDexTestKit
             is expected to return 422.
           }
 
-          run do
-            skip_if !no_member_match_request, "No member match request inputted for no-match tests."
-            member_match_request_resource = FHIR.from_contents(no_member_match_request)
+        verifies_requirements 'hl7.fhir.us.davinci-pdex_2.0.0@36'
 
-            fhir_operation('/Patient/$member-match', body: member_match_request_resource)
-            assert_response_status(422)
-          end
-        end
+        run do
+          skip_if !no_member_match_request, 'No member match request inputted for no-match tests.'
+          member_match_request_resource = FHIR.from_contents(no_member_match_request)
 
+          fhir_operation('/Patient/$member-match', body: member_match_request_resource)
+          assert_response_status(422)
+        end
+      end
     end
   end
 end

data/lib/davinci_pdex_test_kit/pdex_payer_server/patient_operation_in_capability_statement_validation.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module DaVinciPDexTestKit
   module PDexPayerServer
     # Factorized test for asserting a patient resource opeartion in a Capability Statement
@@ -17,7 +15,7 @@ module DaVinciPDexTestKit
     # options:
     #   operation_name: operation to check for, i.e: 'member-match'
     #   operation_url: operation definition canonical URL
-    #
+    #   client: fhir client name, default: :default
     # ==== Required Scratch
     #
     # (none)
@@ -27,7 +25,7 @@ module DaVinciPDexTestKit
     # Requires an Inferno fhir client configured.
     #
     class PatientOperationInCapabilityStatementValidation < Inferno::Test
-      id :patient_operation_in_capability_statement_validation
+      id :pdex_patient_operation_in_cap_stmt_validation
 
       description %{
         The [CapabilityStatement](https://hl7.org/fhir/R4/capabilitystatement.html) must declare support for the
@@ -38,21 +36,23 @@ module DaVinciPDexTestKit
         The operation shall only be declared in one object in the `rest` array.
       }
 
+      verifies_requirements 'hl7.fhir.us.davinci-pdex_2.0.0@30'
+
       run do
-          fhir_get_capability_statement
+        fhir_get_capability_statement(client: config.options.fetch(:client, :default))
 
-          assert_response_status(200)
-          assert_resource_type(:capability_statement)
+        assert_response_status(200)
+        assert_resource_type(:capability_statement)
 
-          assert(
-            resource.rest&.one? do |rest_metadata|
-              rest_metadata.resource&.find{|resource_metadata| resource_metadata.type == 'Patient'}
-                &.operation&.any? do |operation_metadata|
-                  operation_metadata.name == config.options[:operation_name] &&
-                  operation_metadata.definition == config.options[:operation_url]
-                end
-            end
-          )
+        assert(
+          resource.rest&.one? do |rest_metadata|
+            rest_metadata.resource&.find { |resource_metadata| resource_metadata.type == 'Patient' }
+              &.operation&.any? do |operation_metadata|
+                operation_metadata.name == config.options[:operation_name] &&
+                operation_metadata.definition == config.options[:operation_url]
+              end
+          end
+        )
       end
     end
   end