cancer_registry_reporting_test_kit 0.9.0

data/lib/cancer_registry_reporting_test_kit/ehr_suite/mcode_data_access_resources/medication_administration/medication_administration_search_test.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative '../../../search_test'
+require_relative '../../../search_test_properties'
+require_relative '../../../hdea_generator/group_metadata'
+
+module CancerRegistryReportingTestKit
+  class MedicationAdministrationSearchTest < Inferno::Test
+    include CancerRegistryReportingTestKit::SearchTest
+
+    title 'Server returns valid results for MedicationAdministration search by patient'
+    description %(
+        A server SHALL support searching by the
+        patient search parameter on the MedicationAdministration resource. This test
+        will pass if resources are returned and match the search criteria. If
+        none are returned, the test is skipped.
+
+        Because this is the first search of the sequence, resources in the
+        response will be used for subsequent tests.
+
+        Additionally, this test will check that GET and POST search methods
+        return the same number of results.
+      )
+
+    id :ccrr_medication_administration_search_test
+    input :patient_ids,
+          title: 'Patient IDs',
+          description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements.'
+
+    def self.properties
+      @properties ||= SearchTestProperties.new(
+        first_search: true,
+        resource_type: 'MedicationAdministration',
+        search_param_names: %w[patient],
+        test_post_search: false
+      )
+    end
+
+    def self.metadata
+      @metadata ||= HdeaGenerator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+    end
+
+    def scratch_resources
+      scratch[:medication_administration_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/cancer_registry_reporting_test_kit/ehr_suite/mcode_data_access_resources/medication_administration/medication_administration_validation_test.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative '../../../validation_test'
+
+module CancerRegistryReportingTestKit
+  class MedicationAdministrationValidationTest < Inferno::Test
+    include CancerRegistryReportingTestKit::ValidationTest
+
+    id :ccrr_medication_administration_validation_test
+    title 'MedicationAdministration resources returned during previous tests conform to the mCODE Cancer-Related Medication Administration Profile'
+    description %(
+        This test verifies resources returned from the first search conform to
+        the [mCODE Cancer-Related Medication Administration Profile](https://hl7.org/fhir/us/mcode/STU3/StructureDefinition-mcode-cancer-related-medication-administration.html).
+        Systems must demonstrate at least one valid example in order to pass this test.
+
+        It verifies the presence of mandatory elements and that elements with
+        required bindings contain appropriate values. CodeableConcept element
+        bindings will fail if none of their codings have a code/system belonging
+        to the bound ValueSet. Quantity, Coding, and code element bindings will
+        fail if their code/system are not found in the valueset.
+
+      )
+
+    verifies_requirements 'hl7.fhir.us.mcode_3.0.0@83'
+
+    def resource_type
+      'MedicationAdministration'
+    end
+
+    def scratch_resources
+      scratch[:medication_administration_resources] ||= {}
+    end
+
+    run do
+      perform_validation_test(scratch_resources[:all] || [],
+                              'http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-related-medication-administration',
+                              '3.0.0',
+                              skip_if_empty: true)
+    end
+  end
+end

data/lib/cancer_registry_reporting_test_kit/ehr_suite/mcode_data_access_resources/medication_administration/metadata.yml

@@ -0,0 +1,72 @@
+---
+:name: mcode_cancer_related_medication_administration
+:class_name: McodeCancerRelatedMedicationAdministrationSequence
+:version: v1.0.0
+:reformatted_version: v100
+:resource: MedicationAdministration
+:profile_url: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-related-medication-administration
+:profile_name: Cancer-Related Medication Administration Profile
+:profile_version: 3.0.0
+:title: Cancer-Related Medication Administration
+:short_description: Verify support for the server capabilities required by the Cancer-Related
+  Medication Administration Profile.
+:must_supports:
+  :extensions:
+  - :id: MedicationAdministration.extension
+    :path: extension
+    :url: 
+  - :id: MedicationAdministration.extension:treatmentIntent
+    :path: extension
+    :url: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-procedure-intent
+  :slices: []
+  :elements:
+  - :path: status
+  - :path: statusReason
+  - :path: medication[x]
+    :types:
+    - Reference
+  - :path: subject
+    :types:
+    - Reference
+    :target_profiles:
+    - http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient
+  - :path: effective[x]
+  - :path: reasonCode
+  - :path: reasonReference
+    :types:
+    - Reference
+    :target_profiles:
+    - http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns
+:mandatory_elements:
+- MedicationAdministration.status
+- MedicationAdministration.medication[x]
+- MedicationAdministration.subject
+- MedicationAdministration.effective[x]
+- MedicationAdministration.performer.actor
+:tests: []
+:id: ccrr_v100_medication_administration
+:file_name: medication_administration_group.rb
+:searches:
+- :expectation: SHALL
+  :names:
+  - patient
+  - effective
+:search_definitions:
+  :patient:
+    :paths:
+    - subject
+    :full_paths:
+    - Condition.subject
+    :comparators: {}
+    :values: []
+    :type: Reference
+    :contains_multiple: false
+    :multiple_or: MAY
+  :effective-time:
+    :paths:
+    - effective
+    :full_paths:
+    - MedicationAdministration.effective[x]
+    :comparators: {}
+    :contains_multiple: false
+    :multiple_or: MAY

data/lib/cancer_registry_reporting_test_kit/ehr_suite/mcode_data_access_resources/medication_administration_group.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative 'medication_administration/medication_administration_search_test'
+require_relative 'medication_administration/medication_administration_must_support_test'
+require_relative 'medication_administration/medication_administration_validation_test'
+
+module CancerRegistryReportingTestKit
+  class EHRMedicationAdministrationTests < Inferno::TestGroup
+    title 'mCODE Cancer-Related Medication Administration'
+    description %(
+      # Background
+      The mCODE Cancer-Related Medication Administration group verifies that the system under test is
+      able to provide correct responses for Cancer-Related MedicationAdministration queries. These queries
+      return resources conforming to the [mCODE Cancer-Related Medication Administration Profile](https://hl7.org/fhir/us/mcode/STU3/StructureDefinition-mcode-cancer-related-medication-administration.html)
+      as specified in the mCODE v3.0.0 Implementation Guide.
+
+      # Testing Methodology
+      ## Searching
+      This test sequence will first perform each required search associated
+      with this resource. This sequence will perform searches with the
+      following parameters:
+
+      * patient
+
+      ### Search Parameters
+      The first search uses values from the **Patient IDs** input as provided by the tester.
+      Any subsequent searches will look for its parameter values
+      from the results of the first search. For example, the `identifier`
+      search in the patient sequence is performed by looking for an existing
+      `Patient.identifier` from any of the resources returned in the first
+      search. If a value cannot be found this way, the search is skipped.
+
+      ### Search Validation
+      Inferno will retrieve up to the first 20 bundle pages of the reply for
+      Medication Administration resources and save them for subsequent tests. Each of
+      these resources is then checked to see if it matches the searched
+      parameters in accordance with [FHIR search
+      guidelines](https://www.hl7.org/fhir/search.html). The test will fail,
+      for example, if a Patient search for `gender=male` returns a `female`
+      patient.
+
+      ## 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 Medication Administration resources found in the first test for these
+      elements.
+
+      ## Profile Validation
+      Each resource returned from the first search is expected to conform to
+      the [mCODE Cancer-Related Medication Administration Profile](http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-related-medication-administration).
+      Each element is checked against terminology 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.
+    )
+
+    id :ccrr_ehr_medication_administration
+    run_as_group
+
+    def self.metadata
+      @metadata ||= HdeaGenerator::GroupMetadata.new(YAML.load_file(
+                                                       File.join(__dir__, 'medication_administration',
+                                                                 'metadata.yml'), aliases: true
+                                                     ))
+    end
+    test from: :ccrr_medication_administration_search_test
+    test from: :ccrr_medication_administration_validation_test
+    test from: :ccrr_medication_administration_must_support_test
+  end
+end

data/lib/cancer_registry_reporting_test_kit/ehr_suite/mcode_data_access_resources/medication_request/medication_request_must_support_test.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative '../../../must_support_test'
+
+module CancerRegistryReportingTestKit
+  class MedicationRequestMustSupportTest < Inferno::Test
+    include CancerRegistryReportingTestKit::MustSupportTest
+
+    title 'All must support elements are provided in the mCODE Cancer-Related MedicationRequest resources returned'
+    description %(
+      CCRR EHRs SHALL be capable of populating all data elements as
+      part of the query results. This test will look through the MedicationRequest resources
+      found previously for the following must support elements:
+
+      * MedicationRequest.authoredOn
+      * MedicationRequest.category
+      * MedicationRequest.dispenseRequest
+      * MedicationRequest.dispenseRequest.numberOfRepeatsAllowed
+      * MedicationRequest.dispenseRequest.quantity
+      * MedicationRequest.dosageInstruction
+      * MedicationRequest.dosageInstruction.doseAndRate
+      * MedicationRequest.dosageInstruction.doseAndRate.dose[x]
+      * MedicationRequest.dosageInstruction.text
+      * MedicationRequest.dosageInstruction.timing
+      * MedicationRequest.encounter
+      * MedicationRequest.extension:treatmentIntent
+      * MedicationRequest.medication[x]
+      * MedicationRequest.reasonCode
+      * MedicationRequest.reasonReference
+      * MedicationRequest.reported[x]
+      * MedicationRequest.requester
+      * MedicationRequest.status
+      * MedicationRequest.statusReason
+      * MedicationRequest.subject
+    )
+
+    id :ccrr_medication_request_must_support_test
+
+    def resource_type
+      'MedicationRequest'
+    end
+
+    def self.metadata
+      @metadata ||= HdeaGenerator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+    end
+
+    def scratch_resources
+      scratch[:medication_request_resources] ||= {}
+    end
+
+    run do
+      perform_must_support_test(all_scratch_resources)
+    end
+  end
+end

data/lib/cancer_registry_reporting_test_kit/ehr_suite/mcode_data_access_resources/medication_request/medication_request_search_test.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative '../../../search_test'
+require_relative '../../../hdea_generator/group_metadata'
+
+module CancerRegistryReportingTestKit
+  class MedicationRequestSearchTest < Inferno::Test
+    include CancerRegistryReportingTestKit::SearchTest
+
+    title 'Server returns valid results for MedicationRequest search by patient + intent (order)'
+    description %(
+        A server SHALL support searching by
+        patient + intent search parameters on on the MedicationRequest resource. This test
+        will pass if resources are returned and match the search criteria. If
+        none are returned, the test is skipped.
+
+        Because this is the first search of the sequence, resources in the
+        response will be used for subsequent tests.
+
+        Additionally, this test will check that GET and POST search methods
+        return the same number of results.
+      )
+
+    id :ccrr_medication_request_search_test
+    input :patient_ids,
+          title: 'Patient IDs',
+          description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements.'
+
+    def self.properties
+      @properties ||= USCoreTestKit::SearchTestProperties.new(
+        first_search: true,
+        fixed_value_search: true,
+        resource_type: 'MedicationRequest',
+        search_param_names: %w[patient intent],
+        possible_status_search: true,
+        test_medication_inclusion: true,
+        test_reference_variants: true,
+        multiple_or_search_params: ['intent'],
+        test_post_search: false
+      )
+    end
+
+    def self.metadata
+      @metadata ||= HdeaGenerator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+    end
+
+    def scratch_resources
+      scratch[:medication_request_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/cancer_registry_reporting_test_kit/ehr_suite/mcode_data_access_resources/medication_request/medication_request_validation_test.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative '../../../validation_test'
+
+module CancerRegistryReportingTestKit
+  class MedicationRequestValidationTest < Inferno::Test
+    include CancerRegistryReportingTestKit::ValidationTest
+
+    id :ccrr_medication_request_validation_test
+    title 'MedicationRequest resources returned during previous tests conform to the mCODE Cancer-Related Medication Request Profile'
+    description %(
+        This test verifies resources returned from the first search conform to
+        the [mCODE Cancer-Related Medication Request Profile](http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-related-medication-request).
+        Systems must demonstrate at least one valid example in order to pass this test.
+
+        It verifies the presence of mandatory elements and that elements with
+        required bindings contain appropriate values. CodeableConcept element
+        bindings will fail if none of their codings have a code/system belonging
+        to the bound ValueSet. Quantity, Coding, and code element bindings will
+        fail if their code/system are not found in the valueset.
+      )
+
+    def resource_type
+      'MedicationRequest'
+    end
+
+    def scratch_resources
+      scratch[:medication_request_resources] ||= {}
+    end
+
+    run do
+      perform_validation_test(scratch_resources[:all] || [],
+                              'http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-related-medication-request',
+                              '3.0.0',
+                              skip_if_empty: true)
+    end
+  end
+end

data/lib/cancer_registry_reporting_test_kit/ehr_suite/mcode_data_access_resources/medication_request/metadata.yml

@@ -0,0 +1,94 @@
+---
+:name: mcode_cancer_related_medication_request
+:class_name: McodeCancerRelatedMedicationRequestSequence
+:version: v1.0.0
+:reformatted_version: v100
+:resource: MedicationRequest
+:profile_url: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-related-medication-request
+:profile_name: Cancer-Related Medication Request Profile
+:profile_version: 3.0.0
+:title: Cancer-Related Medication Request
+:short_description: Verify support for the server capabilities required by the Cancer-Related
+  Medication Request Profile.
+:must_supports:
+  :extensions:
+  - :id: MedicationRequest.extension:treatmentIntent
+    :path: extension
+    :url: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-procedure-intent
+  :slices:
+  - :slice_id: MedicationRequest.category:us-core
+    :slice_name: us-core
+    :path: category
+    :discriminator:
+      :type: requiredBinding
+      :path: ''
+      :values:
+      - :system: http://terminology.hl7.org/CodeSystem/medicationrequest-category
+        :code: inpatient
+      - :system: http://terminology.hl7.org/CodeSystem/medicationrequest-category
+        :code: outpatient
+      - :system: http://terminology.hl7.org/CodeSystem/medicationrequest-category
+        :code: community
+      - :system: http://terminology.hl7.org/CodeSystem/medicationrequest-category
+        :code: discharge
+  :elements:
+  - :path: status
+  - :path: statusReason
+  - :path: intent
+  - :path: category
+  - :path: medication[x]
+    :types:
+    - Reference
+  - :path: subject
+    :types:
+    - Reference
+    :target_profiles:
+    - http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient
+  - :path: requester
+    :types:
+    - Reference
+    :target_profiles:
+    - http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
+  - :path: reasonCode
+  - :path: reasonReference
+    :types:
+    - Reference
+    :target_profiles:
+    - http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns
+:mandatory_elements:
+- MedicationRequest.status
+- MedicationRequest.intent
+- MedicationRequest.medication[x]
+- MedicationRequest.subject
+- MedicationRequest.requester
+- MedicationRequest.substitution.allowed[x]
+:tests: []
+:id: ccrr_v100_medication_request
+:file_name: medication_request_group.rb
+:searches:
+- :expectation: SHALL
+  :names:
+  - patient
+  - intent
+:search_definitions:
+  :patient:
+    :paths:
+    - subject
+    :full_paths:
+    - MedicationRequest.subject
+    :comparators: {}
+    :values: []
+    :type: Reference
+    :contains_multiple: false
+    :multiple_or: MAY
+  :intent:
+    :paths:
+    - intent
+    :full_paths:
+    - MedicationRequest.intent
+    :comparators: {}
+    :values:
+    - order
+    :type: code
+    :contains_multiple: false
+    :multiple_or: SHALL

data/lib/cancer_registry_reporting_test_kit/ehr_suite/mcode_data_access_resources/medication_request_group.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative 'medication_request/medication_request_search_test'
+require_relative 'medication_request/medication_request_must_support_test'
+require_relative 'medication_request/medication_request_validation_test'
+
+module CancerRegistryReportingTestKit
+  class EHRMedicationRequestTests < Inferno::TestGroup
+    title 'mCODE Cancer-Related Medication Request'
+    description %(
+      # Background
+      The mCODE Cancer-Related Medication Request group verifies that the system under test is
+      able to provide correct responses for Cancer-Related MedicationRequest queries. These queries
+      return resources conforming to the [mCODE Cancer-Related Medication Request Profile](https://hl7.org/fhir/us/mcode/STU3/StructureDefinition-mcode-cancer-related-medication-request.html)
+      as specified in the mCODE v3.0.0 Implementation Guide.
+
+      # Testing Methodology
+      ## Searching
+      This test sequence will first perform each required search associated
+      with this resource. This sequence will perform searches with the
+      following parameters:
+
+      * patient + intent (order)
+
+      ### Search Parameters
+      The first search uses values from the **Patient IDs** input
+      and a fixed value of `order` for the intent.
+      Any subsequent searches will look for its parameter values
+      from the results of the first search. For example, the `identifier`
+      search in the patient sequence is performed by looking for an existing
+      `Patient.identifier` from any of the resources returned in the first
+      search. If a value cannot be found this way, the search is skipped.
+
+      ### Search Validation
+      Inferno will retrieve up to the first 20 bundle pages of the reply for
+      Condition resources and save them for subsequent tests. Each of
+      these resources is then checked to see if it matches the searched
+      parameters in accordance with [FHIR search
+      guidelines](https://www.hl7.org/fhir/search.html). The test will fail,
+      for example, if a Patient search for `gender=male` returns a `female`
+      patient.
+
+
+      ## 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 Condition resources found in the first test for these
+      elements.
+
+      ## Profile Validation
+      Each resource returned from the first search is expected to conform to
+      the [mCODE Cancer-Related Medication Request Profile](http://hl7.org/fhir/us/mcode/STU3/StructureDefinition-mcode-cancer-related-medication-request.html).
+      Each element is checked against terminology 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.
+    )
+    id :ccrr_ehr_medication_request
+    run_as_group
+
+    def self.metadata
+      @metadata ||= HdeaGenerator::GroupMetadata.new(YAML.load_file(
+                                                       File.join(__dir__, 'medication_request',
+                                                                 'metadata.yml'), aliases: true
+                                                     ))
+    end
+    test from: :ccrr_medication_request_search_test
+    test from: :ccrr_medication_request_validation_test
+    test from: :ccrr_medication_request_must_support_test
+  end
+end

data/lib/cancer_registry_reporting_test_kit/ehr_suite/mcode_data_access_resources/primary_cancer_condition_group.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative 'primary_condition/primary_cancer_condition_search_test'
+require_relative 'primary_condition/primary_cancer_condition_must_support_test'
+require_relative 'primary_condition/primary_cancer_condition_validation_test'
+
+module CancerRegistryReportingTestKit
+  class EHRPrimaryConditionTests < Inferno::TestGroup
+    title 'mCODE Primary Cancer Condition'
+    description %(
+      # Background
+      The mCODE Primary Cancer Condition group verifies that the system under test is
+      able to provide correct responses for Primary Cancer Condition queries. These queries
+      return resources conforming to the [mCODE Primary Cancer Condition Profile](https://hl7.org/fhir/us/mcode/STU3/StructureDefinition-mcode-primary-cancer-condition.html)
+      as specified in the mCODE v3.0.0 Implementation Guide.
+
+      # Testing Methodology
+      ## Searching
+      This test sequence will first perform each required search associated
+      with this resource. This sequence will perform searches with the
+      following parameters:
+
+      * patient + category
+
+      ### Search Parameters
+      The first search uses values from the **Patient IDs** and
+      **Primary Cancer Condition category** inputs as provided by the tester.
+      Any subsequent searches will look for its parameter values
+      from the results of the first search. For example, the `identifier`
+      search in the patient sequence is performed by looking for an existing
+      `Patient.identifier` from any of the resources returned in the first
+      search. If a value cannot be found this way, the search is skipped.
+
+      ### Search Validation
+      Inferno will retrieve up to the first 20 bundle pages of the reply for
+      Condition resources and save them for subsequent tests. Each of
+      these resources is then checked to see if it matches the searched
+      parameters in accordance with [FHIR search
+      guidelines](https://www.hl7.org/fhir/search.html). The test will fail,
+      for example, if a Patient search for `gender=male` returns a `female`
+      patient.
+
+
+      ## 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 Condition resources found in the first test for these
+      elements.
+
+      ## Profile Validation
+      Each resource returned from the first search is expected to conform to
+      the [mCODE Primary Cancer Condition Profile](http://hl7.org/fhir/us/mcode/STU3/StructureDefinition-mcode-primary-cancer-condition.html).
+      Each element is checked against terminology 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.
+    )
+    id :ccrr_ehr_primary_cancer_condition
+    run_as_group
+
+    def self.metadata
+      @metadata ||= HdeaGenerator::GroupMetadata.new(YAML.load_file(
+                                                       File.join(__dir__, 'primary_condition',
+                                                                 'metadata.yml'), aliases: true
+                                                     ))
+    end
+    test from: :ccrr_primary_cancer_condition_search_test
+    test from: :ccrr_primary_cancer_condition_validation_test
+    test from: :ccrr_primary_cancer_condition_must_support_test
+  end
+end