cancer_registry_reporting_test_kit 0.9.0

data/lib/cancer_registry_reporting_test_kit/ehr_suite/mcode_data_access_resources/tnm_primary_tumor_category/tnm_primary_tumor_category_search_test.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative '../../../search_test'
+require_relative '../../../hdea_generator/group_metadata'
+
+module CancerRegistryReportingTestKit
+  class TNMPrimaryTumorCategorySearchTest < Inferno::Test
+    include CancerRegistryReportingTestKit::SearchTest
+
+    title 'Server returns valid results for Observation search by patient + code'
+    description %(
+        A server SHALL support searching by
+        patient + code on the Observation 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_tnm_primary_tumor_category_search_test
+    input :patient_ids,
+          title: 'Patient IDs',
+          description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+
+    input :tnm_primary_tumor_category_code,
+          title: 'TNM Primary Tumor Category code',
+          description: %(
+            `Observation.code` value that distinguishes TNM Primary Tumor Category instances from other
+            Observations. Used as a search parameter value when searching for Observation instances to
+            check for conformance to the TNM Primary Tumor Category Observation profile.
+          ),
+          optional: true
+
+    def self.properties
+      @properties ||= CancerRegistryReportingTestKit::SearchTestProperties.new(
+        first_search: true,
+        fixed_value_search: false,
+        resource_type: 'Observation',
+        search_param_names: %w[patient code],
+        possible_status_search: true,
+        token_search_params: ['code'],
+        test_reference_variants: true,
+        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[:tnm_primary_tumor_category_resources] ||= {}
+    end
+
+    run do
+      skip_if tnm_primary_tumor_category_code.blank?,
+              'Provide a code search value for TNM Primary Tumor Categories in the ' \
+              '**TNM Primary Tumor Category code** input to run these tests.'
+
+      # manual params must be in the same order as the param names
+      @manual_search_params = [tnm_primary_tumor_category_code]
+      run_search_test
+    end
+  end
+end

data/lib/cancer_registry_reporting_test_kit/ehr_suite/mcode_data_access_resources/tnm_primary_tumor_category/tnm_primary_tumor_category_validation_test.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../../../validation_test'
+
+module CancerRegistryReportingTestKit
+  class TNMPrimaryTumorCategoryValidationTest < Inferno::Test
+    include CancerRegistryReportingTestKit::ValidationTest
+
+    id :ccrr_tnm_primary_tumor_category_validation_test
+    title 'Observation resources returned during previous tests conform to the TNM Primary Tumor Category profile'
+    description %(
+        This test verifies resources returned from the first search conform to
+        the TNM Primary Tumor Category profile.
+        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
+      'Observation'
+    end
+
+    def scratch_resources
+      scratch[:tnm_primary_tumor_category_resources] ||= {}
+    end
+
+    run do
+      perform_validation_test(scratch_resources[:all] || [],
+                              'http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-tnm-primary-tumor-category',
+                              '3.0.0',
+                              skip_if_empty: true)
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative 'tnm_primary_tumor_category/tnm_primary_tumor_category_search_test'
+require_relative 'tnm_primary_tumor_category/tnm_primary_tumor_category_must_support_test'
+require_relative 'tnm_primary_tumor_category/tnm_primary_tumor_category_validation_test'
+
+module CancerRegistryReportingTestKit
+  class EHRTNMPrimaryTumorCategoryTests < Inferno::TestGroup
+    title 'mCODE TNM Primary Tumor Category'
+    description %(
+      # Background
+      The mCODE TNM Primary Tumor Category group verifies that the system under test is
+      able to provide correct responses for TNM Primary Tumor Category Observation queries. These queries
+      return resources conforming to the [mCODE TNM Primary Tumor Category Profile](https://hl7.org/fhir/us/mcode/STU3/StructureDefinition-mcode-tnm-primary-tumor-category.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 + code
+
+      ### Search Parameters
+      The first search uses values from the **Patient IDs** and
+      **TNM Primary Tumor Category code** 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
+      Observation 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 Observation 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 TNM Primary Tumor Category Profile](https://hl7.org/fhir/us/mcode/STU3/StructureDefinition-mcode-tnm-primary-tumor-category.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_tnm_primary_tumor_category
+    run_as_group
+
+    def self.metadata
+      @metadata ||= HdeaGenerator::GroupMetadata.new(YAML.load_file(
+                                                       File.join(__dir__, 'tnm_primary_tumor_category',
+                                                                 'metadata.yml'), aliases: true
+                                                     ))
+    end
+    test from: :ccrr_tnm_primary_tumor_category_search_test
+    test from: :ccrr_tnm_primary_tumor_category_validation_test
+    test from: :ccrr_tnm_primary_tumor_category_must_support_test
+  end
+end

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

@@ -0,0 +1,64 @@
+---
+:name: mcode_tnm_regional_nodes_category
+:class_name: McodeTnmRegionalNodesCategorySequence
+:version: v1.0.0
+:reformatted_version: v100
+:resource: Observation
+:profile_url: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-tnm-regional-nodes-category
+:profile_name: TNM Regional Nodes Category Profile
+:profile_version: 3.0.0
+:title: Observation TNM Regional Nodes Category
+:short_description: Verify support for the server capabilities required by the TNM
+  Regional Nodes Category Profile.
+:must_supports:
+  :extensions: []
+  :slices: []
+  :elements:
+  - :path: status
+  - :path: code
+  - :path: subject
+    :types:
+    - Reference
+    :target_profiles:
+    - http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient
+  - :path: focus
+    :types:
+    - Reference
+    :target_profiles:
+    - http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-primary-cancer-condition
+  - :path: effective[x]
+  - :path: value[x]
+  - :path: method
+:mandatory_elements:
+- Observation.status
+- Observation.code
+- Observation.method
+- Observation.component.code
+:tests: []
+:id: ccrr_v100_mcode_tnm_regional_nodes_category
+:file_name: mcode_tnm_regional_nodes_category_group.rb
+:searches:
+- :expectation: SHALL
+  :names:
+  - patient
+  - code
+:search_definitions:
+  :patient:
+    :paths:
+    - subject
+    :full_paths:
+    - Observation.subject
+    :comparators: {}
+    :values: []
+    :type: Reference
+    :contains_multiple: false
+    :multiple_or: MAY
+  :code:
+    :paths:
+    - code
+    :full_paths:
+    - Observation.code
+    :comparators: {}
+    :type: CodeableConcept
+    :contains_multiple: true
+    :multiple_or: MAY

data/lib/cancer_registry_reporting_test_kit/ehr_suite/mcode_data_access_resources/tnm_regional_nodes_category/tnm_regional_nodes_category_must_support_test.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative '../../../must_support_test'
+
+module CancerRegistryReportingTestKit
+  class TNMRegionalNodesCategoryMustSupportTest < Inferno::Test
+    include CancerRegistryReportingTestKit::MustSupportTest
+
+    title 'All must support elements are provided in the mCODE TNM Regional Nodes Category Observation 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 Observation resources
+      found previously for the following must support elements:
+
+      * Observation.category
+      * Observation.code
+      * Observation.effective[x]
+      * Observation.focus
+      * Observation.method
+      * Observation.performer
+      * Observation.status
+      * Observation.subject
+      * Observation.value[x]
+    )
+
+    id :ccrr_tnm_regional_nodes_category_must_support_test
+
+    def resource_type
+      'Observation'
+    end
+
+    def self.metadata
+      @metadata ||= HdeaGenerator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+    end
+
+    def scratch_resources
+      scratch[:tnm_regional_nodes_category_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/tnm_regional_nodes_category/tnm_regional_nodes_category_search_test.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative '../../../search_test'
+require_relative '../../../hdea_generator/group_metadata'
+
+module CancerRegistryReportingTestKit
+  class TNMRegionalNodesCategorySearchTest < Inferno::Test
+    include CancerRegistryReportingTestKit::SearchTest
+
+    title 'Server returns valid results for Observation search by patient + code'
+    description %(
+        A server SHALL support searching by
+        patient + code on the Observation 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_tnm_regional_nodes_category_search_test
+    input :patient_ids,
+          title: 'Patient IDs',
+          description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+
+    input :tnm_regional_nodes_category_code,
+          title: 'TNM Regional Nodes Category code',
+          description: %(
+            `Observation.code` value that distinguishes TNM Regional Nodes Category instances from other
+            Observations. Used as a search parameter value when searching for Observation instances to check
+            for conformance to the TNM Regional Nodes Category Observation profile.
+          ),
+          optional: true
+
+    def self.properties
+      @properties ||= CancerRegistryReportingTestKit::SearchTestProperties.new(
+        first_search: true,
+        fixed_value_search: false,
+        resource_type: 'Observation',
+        search_param_names: %w[patient code],
+        possible_status_search: true,
+        token_search_params: ['code'],
+        test_reference_variants: true,
+        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[:tnm_regional_nodes_category_resources] ||= {}
+    end
+
+    run do
+      skip_if tnm_regional_nodes_category_code.blank?,
+              'Provide a code search value for TNM Regional Nodes Categories in the ' \
+              '**TNM Regional Nodes Category code** input to run these tests.'
+
+      # manual params must be in the same order as the param names
+      @manual_search_params = [tnm_regional_nodes_category_code]
+      run_search_test
+    end
+  end
+end

data/lib/cancer_registry_reporting_test_kit/ehr_suite/mcode_data_access_resources/tnm_regional_nodes_category/tnm_regional_nodes_category_validation_test.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../../../validation_test'
+
+module CancerRegistryReportingTestKit
+  class TNMRegionalNodesCategoryValidationTest < Inferno::Test
+    include CancerRegistryReportingTestKit::ValidationTest
+
+    id :ccrr_tnm_regional_nodes_category_validation_test
+    title 'Observation resources returned during previous tests conform to the mCODE TNM Regional Nodes Category profile'
+    description %(
+        This test verifies resources returned from the first search conform to
+        the [mCODE TNM Regional Nodes Category Profile](https://hl7.org/fhir/us/mcode/STU3/StructureDefinition-mcode-tnm-regional-nodes-category.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.
+
+      )
+
+    def resource_type
+      'Observation'
+    end
+
+    def scratch_resources
+      scratch[:tnm_regional_nodes_category_resources] ||= {}
+    end
+
+    run do
+      perform_validation_test(scratch_resources[:all] || [],
+                              'http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-tnm-regional-nodes-category',
+                              '3.0.0',
+                              skip_if_empty: true)
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative 'tnm_regional_nodes_category/tnm_regional_nodes_category_search_test'
+require_relative 'tnm_regional_nodes_category/tnm_regional_nodes_category_must_support_test'
+require_relative 'tnm_regional_nodes_category/tnm_regional_nodes_category_validation_test'
+
+module CancerRegistryReportingTestKit
+  class EHRTNMRegionalNodeasCategoryTests < Inferno::TestGroup
+    title 'mCODE TNM Regional Nodes Category'
+    description %(
+      # Background
+      The mCODE TNM Regional Nodes Category group verifies that the system under test is
+      able to provide correct responses for mCODE TNM Regional Nodes Category Observation queries. These queries
+      return resources conforming to the [mCODE TNM Regional Nodes Category Profile](https://hl7.org/fhir/us/mcode/STU3/StructureDefinition-mcode-tnm-regional-nodes-category.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 + code
+
+      ### Search Parameters
+      The first search uses values from the **Patient IDs** and
+      **TNM Regional Nodes Category code** 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
+      Observation 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 Observation 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 TNM Regional Nodes Category Profile](https://hl7.org/fhir/us/mcode/STU3/StructureDefinition-mcode-tnm-regional-nodes-category.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_tnm_regional_nodes_category
+    run_as_group
+
+    def self.metadata
+      @metadata ||= HdeaGenerator::GroupMetadata.new(YAML.load_file(
+                                                       File.join(__dir__, 'tnm_regional_nodes_category',
+                                                                 'metadata.yml'), aliases: true
+                                                     ))
+    end
+    test from: :ccrr_tnm_regional_nodes_category_search_test
+    test from: :ccrr_tnm_regional_nodes_category_validation_test
+    test from: :ccrr_tnm_regional_nodes_category_must_support_test
+  end
+end

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

@@ -0,0 +1,68 @@
+---
+:name: mcode_tnm_stage_group
+:class_name: McodeTnmStageGroupSequence
+:version: v1.0.0
+:reformatted_version: v100
+:resource: Observation
+:profile_url: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-tnm-stage-group
+:profile_name: TNM Stage Group Profile
+:profile_version: 3.0.0
+:title: Observation TNM Stage Group
+:short_description: Verify support for the server capabilities required by the TNM
+  Stage Group Profile.
+:must_supports:
+  :extensions: []
+  :slices: []
+  :elements:
+  - :path: status
+  - :path: code
+  - :path: subject
+    :types:
+    - Reference
+    :target_profiles:
+    - http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient
+  - :path: focus
+    :types:
+    - Reference
+    :target_profiles:
+    - http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-primary-cancer-condition
+  - :path: effective[x]
+  - :path: value[x]
+  - :path: method
+  - :path: hasMember
+    :types:
+    - Reference
+:mandatory_elements:
+- Observation.status
+- Observation.code
+- Observation.focus
+- Observation.method
+- Observation.component.code
+:tests: []
+:id: ccrr_v100_mcode_tnm_stage_group
+:file_name: mcode_tnm_stage_group_group.rb
+:searches:
+- :expectation: SHALL
+  :names:
+  - patient
+  - code
+:search_definitions:
+  :patient:
+    :paths:
+    - subject
+    :full_paths:
+    - Observation.subject
+    :comparators: {}
+    :values: []
+    :type: Reference
+    :contains_multiple: false
+    :multiple_or: MAY
+  :code:
+    :paths:
+    - code
+    :full_paths:
+    - Observation.code
+    :comparators: {}
+    :type: CodeableConcept
+    :contains_multiple: true
+    :multiple_or: MAY

data/lib/cancer_registry_reporting_test_kit/ehr_suite/mcode_data_access_resources/tnm_stage_group/tnm_stage_group_must_support_test.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative '../../../must_support_test'
+
+module CancerRegistryReportingTestKit
+  class TNMStageGroupMustSupportTest < Inferno::Test
+    include CancerRegistryReportingTestKit::MustSupportTest
+
+    title 'All must support elements are provided in the mCODE TNM Stage Group Observation 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 Observation resources
+      found previously for the following must support elements:
+
+      * Observation.category
+      * Observation.code
+      * Observation.effective[x]
+      * Observation.focus
+      * Observation.hasMember
+      * Observation.method
+      * Observation.performer
+      * Observation.status
+      * Observation.subject
+      * Observation.value[x]
+    )
+
+    id :ccrr_tnm_stage_group_must_support_test
+
+    def resource_type
+      'Observation'
+    end
+
+    def self.metadata
+      @metadata ||= HdeaGenerator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+    end
+
+    def scratch_resources
+      scratch[:tnm_stage_group_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/tnm_stage_group/tnm_stage_group_search_test.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative '../../../search_test'
+require_relative '../../../hdea_generator/group_metadata'
+
+module CancerRegistryReportingTestKit
+  class TNMStageGroupSearchTest < Inferno::Test
+    include CancerRegistryReportingTestKit::SearchTest
+
+    title 'Server returns valid results for Observation search by patient + code'
+    description %(
+        A server SHALL support searching by
+        patient + code on the Observation 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_tnm_stage_group_search_test
+    input :patient_ids,
+          title: 'Patient IDs',
+          description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+
+    input :tnm_stage_group_code,
+          title: 'TNM Stage Group code',
+          description: %(
+            `Observation.code` value that distinguishes TNM Stage Group instances from other Observations. Used as
+            a search parameter value when searching for Observation instances to check for conformance to the
+            TNM Stage Group Observation profile.
+          ),
+          optional: true
+
+    def self.properties
+      @properties ||= CancerRegistryReportingTestKit::SearchTestProperties.new(
+        first_search: true,
+        fixed_value_search: false,
+        resource_type: 'Observation',
+        search_param_names: %w[patient code],
+        possible_status_search: true,
+        token_search_params: ['code'],
+        test_reference_variants: true,
+        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[:tnm_stage_group_resources] ||= {}
+    end
+
+    run do
+      skip_if tnm_stage_group_code.blank?,
+              'Provide a code search value for TNM Stage Groups in the ' \
+              '**TNM Stage Group code** input to run these tests.'
+
+      # manual params must be in the same order as the param names
+      @manual_search_params = [tnm_stage_group_code]
+      run_search_test
+    end
+  end
+end