us_core_test_kit 0.1.0

data/lib/us_core_test_kit/generated/procedure_group.rb

@@ -0,0 +1,90 @@
+require_relative 'procedure/procedure_patient_search_test'
+require_relative 'procedure/procedure_patient_date_search_test'
+require_relative 'procedure/procedure_patient_status_search_test'
+require_relative 'procedure/procedure_patient_code_date_search_test'
+require_relative 'procedure/procedure_read_test'
+require_relative 'procedure/procedure_provenance_revinclude_search_test'
+require_relative 'procedure/procedure_validation_test'
+require_relative 'procedure/procedure_must_support_test'
+require_relative 'procedure/procedure_reference_resolution_test'
+
+module USCoreTestKit
+  class ProcedureGroup < Inferno::TestGroup
+    title 'Procedure Tests'
+    short_description 'Verify support for the server capabilities required by the US Core Procedure Profile.'
+    description %(
+# Background
+
+The US Core Procedure sequence verifies that the system under test is
+able to provide correct responses for Procedure queries. These queries
+must contain resources conforming to the US Core Procedure Profile as
+specified in the US Core v3.1.1 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
+* patient + date
+
+### Search Parameters
+The first search uses the selected patient(s) from the prior launch
+sequence. 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 `_id`
+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
+Procedure 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 Procedure resources found in the first test for these
+elements.
+
+## Profile Validation
+Each resource returned from the first search is expected to conform to
+the [US Core Procedure Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure). 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
+Each reference within the resources found from the previous tests must
+resolve. The test will attempt to read each reference found and will
+fail if any attempted read fails.
+
+    )
+
+    id :us_core_311_procedure
+    run_as_group
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'procedure', 'metadata.yml')))
+    end
+
+    test from: :us_core_311_procedure_patient_search_test
+    test from: :us_core_311_procedure_patient_date_search_test
+    test from: :us_core_311_procedure_patient_status_search_test
+    test from: :us_core_311_procedure_patient_code_date_search_test
+    test from: :us_core_311_procedure_read_test
+    test from: :us_core_311_procedure_provenance_revinclude_search_test
+    test from: :us_core_311_procedure_validation_test
+    test from: :us_core_311_procedure_must_support_test
+    test from: :us_core_311_procedure_reference_resolution_test
+  end
+end

data/lib/us_core_test_kit/generated/provenance/provenance_must_support_test.rb

@@ -0,0 +1,44 @@
+require_relative '../../must_support_test'
+
+module USCoreTestKit
+  class ProvenanceMustSupportTest < Inferno::Test
+    include USCoreTestKit::MustSupportTest
+
+    title 'All must support elements are provided in the Provenance resources returned'
+    description %(
+      US Core Responders SHALL be capable of populating all data elements as
+      part of the query results as specified by the US Core Server Capability
+      Statement. This test will look through the Provenance resources
+      found previously for the following must support elements:
+
+      * Provenance.agent
+      * Provenance.agent.onBehalfOf
+      * Provenance.agent.type
+      * Provenance.agent.type.coding.code
+      * Provenance.agent.type.coding.code
+      * Provenance.agent.who
+      * Provenance.agent:ProvenanceAuthor
+      * Provenance.agent:ProvenanceTransmitter
+      * Provenance.recorded
+      * Provenance.target
+    )
+
+    id :us_core_311_provenance_must_support_test
+
+    def resource_type
+      'Provenance'
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:provenance_resources] ||= {}
+    end
+
+    run do
+      perform_must_support_test(all_scratch_resources)
+    end
+  end
+end

data/lib/us_core_test_kit/generated/provenance/provenance_read_test.rb

@@ -0,0 +1,24 @@
+require_relative '../../read_test'
+
+module USCoreTestKit
+  class ProvenanceReadTest < Inferno::Test
+    include USCoreTestKit::ReadTest
+
+    title 'Server returns correct Provenance resource from Provenance read interaction'
+    description 'A server SHALL support the Provenance read interaction.'
+
+    id :us_core_311_provenance_read_test
+
+    def resource_type
+      'Provenance'
+    end
+
+    def scratch_resources
+      scratch[:provenance_resources] ||= {}
+    end
+
+    run do
+      perform_read_test(all_scratch_resources)
+    end
+  end
+end

data/lib/us_core_test_kit/generated/provenance/provenance_reference_resolution_test.rb

@@ -0,0 +1,28 @@
+require_relative '../../reference_resolution_test'
+
+module USCoreTestKit
+  class ProvenanceReferenceResolutionTest < Inferno::Test
+    include USCoreTestKit::ReferenceResolutionTest
+
+    title 'Every reference within Provenance resources can be read'
+    description %(
+      This test will attempt to read the first 50 references found in the
+      resources from the first search. The test will fail if Inferno fails to
+      read any of those references.
+    )
+
+    id :us_core_311_provenance_reference_resolution_test
+
+    def resource_type
+      'Provenance'
+    end
+
+    def scratch_resources
+      scratch[:provenance_resources] ||= {}
+    end
+
+    run do
+      perform_reference_resolution_test(scratch_resources[:all])
+    end
+  end
+end

data/lib/us_core_test_kit/generated/provenance/provenance_validation_test.rb

@@ -0,0 +1,34 @@
+require_relative '../../validation_test'
+
+module USCoreTestKit
+  class ProvenanceValidationTest < Inferno::Test
+    include USCoreTestKit::ValidationTest
+
+    id :us_core_311_provenance_validation_test
+    title 'Provenance resources returned during previous tests conform to the US Core Provenance Profile'
+    description %(
+This test verifies resources returned from the first search conform to
+the [US Core Provenance Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance).
+
+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.
+
+    )
+    output :dar_code_found, :dar_extension_found
+
+    def resource_type
+      'Provenance'
+    end
+
+    def scratch_resources
+      scratch[:provenance_resources] ||= {}
+    end
+
+    run do
+      perform_validation_test(scratch_resources[:all] || [], 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance')
+    end
+  end
+end

data/lib/us_core_test_kit/generated/provenance_group.rb

@@ -0,0 +1,56 @@
+require_relative 'provenance/provenance_read_test'
+require_relative 'provenance/provenance_validation_test'
+require_relative 'provenance/provenance_must_support_test'
+require_relative 'provenance/provenance_reference_resolution_test'
+
+module USCoreTestKit
+  class ProvenanceGroup < Inferno::TestGroup
+    title 'Provenance Tests'
+    short_description 'Verify support for the server capabilities required by the US Core Provenance Profile.'
+    description %(
+# Background
+
+The US Core Provenance sequence verifies that the system under test is
+able to provide correct responses for Provenance queries. These queries
+must contain resources conforming to the US Core Provenance Profile as
+specified in the US Core v3.1.1 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 Provenance resources found in the first test for these
+elements.
+
+## Profile Validation
+Each resource returned from the first search is expected to conform to
+the [US Core Provenance Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance). 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
+Each reference within the resources found from the previous tests must
+resolve. The test will attempt to read each reference found and will
+fail if any attempted read fails.
+
+    )
+
+    id :us_core_311_provenance
+    run_as_group
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'provenance', 'metadata.yml')))
+    end
+
+    test from: :us_core_311_provenance_read_test
+    test from: :us_core_311_provenance_validation_test
+    test from: :us_core_311_provenance_must_support_test
+    test from: :us_core_311_provenance_reference_resolution_test
+  end
+end

data/lib/us_core_test_kit/generated/pulse_oximetry/pulse_oximetry_must_support_test.rb

@@ -0,0 +1,65 @@
+require_relative '../../must_support_test'
+
+module USCoreTestKit
+  class PulseOximetryMustSupportTest < Inferno::Test
+    include USCoreTestKit::MustSupportTest
+
+    title 'All must support elements are provided in the Observation resources returned'
+    description %(
+      US Core Responders SHALL be capable of populating all data elements as
+      part of the query results as specified by the US Core Server Capability
+      Statement. This test will look through the Observation resources
+      found previously for the following must support elements:
+
+      * Observation.category
+      * Observation.category.coding
+      * Observation.category.coding.code
+      * Observation.category.coding.system
+      * Observation.category:VSCat
+      * Observation.code
+      * Observation.code.coding
+      * Observation.code.coding.code
+      * Observation.code.coding.system
+      * Observation.code.coding:PulseOx
+      * Observation.component
+      * Observation.component.code
+      * Observation.component.code.coding.code
+      * Observation.component.code.coding.code
+      * Observation.component.value[x]
+      * Observation.component.value[x].code
+      * Observation.component.value[x].code
+      * Observation.component.value[x].system
+      * Observation.component.value[x].unit
+      * Observation.component.value[x].value
+      * Observation.component:Concentration
+      * Observation.component:FlowRate
+      * Observation.effective[x]
+      * Observation.status
+      * Observation.subject
+      * Observation.value[x]
+      * Observation.value[x].code
+      * Observation.value[x].system
+      * Observation.value[x].unit
+      * Observation.value[x].value
+      * Observation.value[x]:valueQuantity
+    )
+
+    id :us_core_311_pulse_oximetry_must_support_test
+
+    def resource_type
+      'Observation'
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:pulse_oximetry_resources] ||= {}
+    end
+
+    run do
+      perform_must_support_test(all_scratch_resources)
+    end
+  end
+end

data/lib/us_core_test_kit/generated/pulse_oximetry/pulse_oximetry_patient_category_date_search_test.rb

@@ -0,0 +1,46 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module USCoreTestKit
+  class PulseOximetryPatientCategoryDateSearchTest < Inferno::Test
+    include USCoreTestKit::SearchTest
+
+    title 'Server returns valid results for Observation search by patient + category + date'
+    description %(
+A server SHALL support searching by
+patient + category + date 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.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-server.html)
+
+    )
+
+    id :us_core_311_pulse_oximetry_patient_category_date_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(
+        resource_type: 'Observation',
+        search_param_names: ['patient', 'category', 'date'],
+        possible_status_search: true,
+        token_search_params: ['category'],
+        params_with_comparators: ['date']
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:pulse_oximetry_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/pulse_oximetry/pulse_oximetry_patient_category_search_test.rb

@@ -0,0 +1,45 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module USCoreTestKit
+  class PulseOximetryPatientCategorySearchTest < Inferno::Test
+    include USCoreTestKit::SearchTest
+
+    title 'Server returns valid results for Observation search by patient + category'
+    description %(
+A server SHALL support searching by
+patient + category 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.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-server.html)
+
+    )
+
+    id :us_core_311_pulse_oximetry_patient_category_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(
+        resource_type: 'Observation',
+        search_param_names: ['patient', 'category'],
+        possible_status_search: true,
+        token_search_params: ['category']
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:pulse_oximetry_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/pulse_oximetry/pulse_oximetry_patient_category_status_search_test.rb

@@ -0,0 +1,47 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module USCoreTestKit
+  class PulseOximetryPatientCategoryStatusSearchTest < Inferno::Test
+    include USCoreTestKit::SearchTest
+
+    title 'Server returns valid results for Observation search by patient + category + status'
+    description %(
+A server SHOULD support searching by
+patient + category + status 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.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-server.html)
+
+    )
+
+    id :us_core_311_pulse_oximetry_patient_category_status_search_test
+    optional
+
+    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(
+        resource_type: 'Observation',
+        search_param_names: ['patient', 'category', 'status'],
+        token_search_params: ['category'],
+        multiple_or_search_params: ['status']
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:pulse_oximetry_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/pulse_oximetry/pulse_oximetry_patient_code_date_search_test.rb

@@ -0,0 +1,48 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module USCoreTestKit
+  class PulseOximetryPatientCodeDateSearchTest < Inferno::Test
+    include USCoreTestKit::SearchTest
+
+    title 'Server returns valid results for Observation search by patient + code + date'
+    description %(
+A server SHOULD support searching by
+patient + code + date 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.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-server.html)
+
+    )
+
+    id :us_core_311_pulse_oximetry_patient_code_date_search_test
+    optional
+
+    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(
+        resource_type: 'Observation',
+        search_param_names: ['patient', 'code', 'date'],
+        possible_status_search: true,
+        token_search_params: ['code'],
+        params_with_comparators: ['date']
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:pulse_oximetry_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/pulse_oximetry/pulse_oximetry_patient_code_search_test.rb

@@ -0,0 +1,62 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module USCoreTestKit
+  class PulseOximetryPatientCodeSearchTest < Inferno::Test
+    include USCoreTestKit::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.
+
+This test verifies that the server supports searching by reference using
+the form `patient=[id]` as well as `patient=Patient/[id]`. The two
+different forms are expected to return the same number of results. US
+Core requires that both forms are supported by US Core responders.
+
+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. Search by POST is required by the
+FHIR R4 specification, and these tests interpret search by GET as a
+requirement of US Core v3.1.1.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-server.html)
+
+    )
+
+    id :us_core_311_pulse_oximetry_patient_code_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,
+        fixed_value_search: true,
+        resource_type: 'Observation',
+        search_param_names: ['patient', 'code'],
+        possible_status_search: true,
+        token_search_params: ['code'],
+        test_reference_variants: true,
+        test_post_search: true
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:pulse_oximetry_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/pulse_oximetry/pulse_oximetry_provenance_revinclude_search_test.rb

@@ -0,0 +1,51 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module USCoreTestKit
+  class PulseOximetryProvenanceRevincludeSearchTest < Inferno::Test
+    include USCoreTestKit::SearchTest
+
+    title 'Server returns Provenance resources from Observation search by patient + code + revInclude:Provenance:target'
+    description %(
+      A server SHALL be capable of supporting _revIncludes:Provenance:target.
+
+      This test will perform a search by patient + code + revInclude:Provenance:target and
+      will pass if a Provenance resource is found in the response.
+    %)
+
+    id :us_core_311_pulse_oximetry_provenance_revinclude_search_test
+
+    input :patient_ids,
+      title: 'Patient IDs',
+      description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+
+    def properties
+      @properties ||= SearchTestProperties.new(
+        fixed_value_search: true,
+        resource_type: 'Observation',
+        search_param_names: ['patient', 'code'],
+        possible_status_search: true
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def self.provenance_metadata
+      @provenance_metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, '..', 'provenance', 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:pulse_oximetry_resources] ||= {}
+    end
+
+    def scratch_provenance_resources
+      scratch[:provenance_resources] ||= {}
+    end
+
+    run do
+      run_provenance_revinclude_search_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/pulse_oximetry/pulse_oximetry_read_test.rb

@@ -0,0 +1,24 @@
+require_relative '../../read_test'
+
+module USCoreTestKit
+  class PulseOximetryReadTest < Inferno::Test
+    include USCoreTestKit::ReadTest
+
+    title 'Server returns correct Observation resource from Observation read interaction'
+    description 'A server SHALL support the Observation read interaction.'
+
+    id :us_core_311_pulse_oximetry_read_test
+
+    def resource_type
+      'Observation'
+    end
+
+    def scratch_resources
+      scratch[:pulse_oximetry_resources] ||= {}
+    end
+
+    run do
+      perform_read_test(all_scratch_resources)
+    end
+  end
+end