us_core_test_kit 0.1.0

data/lib/us_core_test_kit/generated/organization/organization_must_support_test.rb

@@ -0,0 +1,47 @@
+require_relative '../../must_support_test'
+
+module USCoreTestKit
+  class OrganizationMustSupportTest < Inferno::Test
+    include USCoreTestKit::MustSupportTest
+
+    title 'All must support elements are provided in the Organization 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 Organization resources
+      found previously for the following must support elements:
+
+      * Organization.active
+      * Organization.address
+      * Organization.address.city
+      * Organization.address.country
+      * Organization.address.line
+      * Organization.address.postalCode
+      * Organization.address.state
+      * Organization.identifier
+      * Organization.identifier.system
+      * Organization.identifier.value
+      * Organization.identifier:NPI
+      * Organization.name
+      * Organization.telecom
+    )
+
+    id :us_core_311_organization_must_support_test
+
+    def resource_type
+      'Organization'
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:organization_resources] ||= {}
+    end
+
+    run do
+      perform_must_support_test(all_scratch_resources)
+    end
+  end
+end

data/lib/us_core_test_kit/generated/organization/organization_name_search_test.rb

@@ -0,0 +1,49 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module USCoreTestKit
+  class OrganizationNameSearchTest < Inferno::Test
+    include USCoreTestKit::SearchTest
+
+    title 'Server returns valid results for Organization search by name'
+    description %(
+A server SHALL support searching by
+name on the Organization 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. 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_organization_name_search_test
+    def self.properties
+      @properties ||= SearchTestProperties.new(
+        first_search: true,
+        resource_type: 'Organization',
+        search_param_names: ['name'],
+        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[:organization_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/organization/organization_read_test.rb

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

data/lib/us_core_test_kit/generated/organization/organization_reference_resolution_test.rb

@@ -0,0 +1,28 @@
+require_relative '../../reference_resolution_test'
+
+module USCoreTestKit
+  class OrganizationReferenceResolutionTest < Inferno::Test
+    include USCoreTestKit::ReferenceResolutionTest
+
+    title 'Every reference within Organization 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_organization_reference_resolution_test
+
+    def resource_type
+      'Organization'
+    end
+
+    def scratch_resources
+      scratch[:organization_resources] ||= {}
+    end
+
+    run do
+      perform_reference_resolution_test(scratch_resources[:all])
+    end
+  end
+end

data/lib/us_core_test_kit/generated/organization/organization_validation_test.rb

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

data/lib/us_core_test_kit/generated/organization_group.rb

@@ -0,0 +1,84 @@
+require_relative 'organization/organization_read_test'
+require_relative 'organization/organization_name_search_test'
+require_relative 'organization/organization_address_search_test'
+require_relative 'organization/organization_validation_test'
+require_relative 'organization/organization_must_support_test'
+require_relative 'organization/organization_reference_resolution_test'
+
+module USCoreTestKit
+  class OrganizationGroup < Inferno::TestGroup
+    title 'Organization Tests'
+    short_description 'Verify support for the server capabilities required by the US Core Organization Profile.'
+    description %(
+# Background
+
+The US Core Organization sequence verifies that the system under test is
+able to provide correct responses for Organization queries. These queries
+must contain resources conforming to the US Core Organization 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:
+
+* name
+* address
+
+### 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
+Organization 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 Organization 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 Organization Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization). 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_organization
+    run_as_group
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'organization', 'metadata.yml')))
+    end
+
+    test from: :us_core_311_organization_read_test
+    test from: :us_core_311_organization_name_search_test
+    test from: :us_core_311_organization_address_search_test
+    test from: :us_core_311_organization_validation_test
+    test from: :us_core_311_organization_must_support_test
+    test from: :us_core_311_organization_reference_resolution_test
+  end
+end

data/lib/us_core_test_kit/generated/patient/patient_birthdate_family_search_test.rb

@@ -0,0 +1,41 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module USCoreTestKit
+  class PatientBirthdateFamilySearchTest < Inferno::Test
+    include USCoreTestKit::SearchTest
+
+    title 'Server returns valid results for Patient search by birthdate + family'
+    description %(
+A server SHOULD support searching by
+birthdate + family on the Patient 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_patient_birthdate_family_search_test
+    optional
+
+    def self.properties
+      @properties ||= SearchTestProperties.new(
+        resource_type: 'Patient',
+        search_param_names: ['birthdate', 'family']
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:patient_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/patient/patient_birthdate_name_search_test.rb

@@ -0,0 +1,39 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module USCoreTestKit
+  class PatientBirthdateNameSearchTest < Inferno::Test
+    include USCoreTestKit::SearchTest
+
+    title 'Server returns valid results for Patient search by birthdate + name'
+    description %(
+A server SHALL support searching by
+birthdate + name on the Patient 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_patient_birthdate_name_search_test
+    def self.properties
+      @properties ||= SearchTestProperties.new(
+        resource_type: 'Patient',
+        search_param_names: ['birthdate', 'name']
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:patient_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/patient/patient_family_gender_search_test.rb

@@ -0,0 +1,41 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module USCoreTestKit
+  class PatientFamilyGenderSearchTest < Inferno::Test
+    include USCoreTestKit::SearchTest
+
+    title 'Server returns valid results for Patient search by family + gender'
+    description %(
+A server SHOULD support searching by
+family + gender on the Patient 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_patient_family_gender_search_test
+    optional
+
+    def self.properties
+      @properties ||= SearchTestProperties.new(
+        resource_type: 'Patient',
+        search_param_names: ['family', 'gender']
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:patient_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/patient/patient_gender_name_search_test.rb

@@ -0,0 +1,39 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module USCoreTestKit
+  class PatientGenderNameSearchTest < Inferno::Test
+    include USCoreTestKit::SearchTest
+
+    title 'Server returns valid results for Patient search by gender + name'
+    description %(
+A server SHALL support searching by
+gender + name on the Patient 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_patient_gender_name_search_test
+    def self.properties
+      @properties ||= SearchTestProperties.new(
+        resource_type: 'Patient',
+        search_param_names: ['gender', 'name']
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:patient_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/patient/patient_id_search_test.rb

@@ -0,0 +1,53 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module USCoreTestKit
+  class PatientIdSearchTest < Inferno::Test
+    include USCoreTestKit::SearchTest
+
+    title 'Server returns valid results for Patient search by _id'
+    description %(
+A server SHALL support searching by
+_id on the Patient 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. 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_patient__id_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: 'Patient',
+        search_param_names: ['_id'],
+        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[:patient_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/patient/patient_identifier_search_test.rb

@@ -0,0 +1,40 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module USCoreTestKit
+  class PatientIdentifierSearchTest < Inferno::Test
+    include USCoreTestKit::SearchTest
+
+    title 'Server returns valid results for Patient search by identifier'
+    description %(
+A server SHALL support searching by
+identifier on the Patient 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_patient_identifier_search_test
+    def self.properties
+      @properties ||= SearchTestProperties.new(
+        resource_type: 'Patient',
+        search_param_names: ['identifier'],
+        token_search_params: ['identifier']
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:patient_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/patient/patient_must_support_test.rb

@@ -0,0 +1,57 @@
+require_relative '../../must_support_test'
+
+module USCoreTestKit
+  class PatientMustSupportTest < Inferno::Test
+    include USCoreTestKit::MustSupportTest
+
+    title 'All must support elements are provided in the Patient 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 Patient resources
+      found previously for the following must support elements:
+
+      * Patient.address
+      * Patient.address.city
+      * Patient.address.line
+      * Patient.address.period
+      * Patient.address.postalCode
+      * Patient.address.state
+      * Patient.birthDate
+      * Patient.communication
+      * Patient.communication.language
+      * Patient.extension:birthsex
+      * Patient.extension:ethnicity
+      * Patient.extension:race
+      * Patient.gender
+      * Patient.identifier
+      * Patient.identifier.system
+      * Patient.identifier.value
+      * Patient.name
+      * Patient.name.family
+      * Patient.name.given
+      * Patient.telecom
+      * Patient.telecom.system
+      * Patient.telecom.use
+      * Patient.telecom.value
+    )
+
+    id :us_core_311_patient_must_support_test
+
+    def resource_type
+      'Patient'
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:patient_resources] ||= {}
+    end
+
+    run do
+      perform_must_support_test(all_scratch_resources)
+    end
+  end
+end

data/lib/us_core_test_kit/generated/patient/patient_name_search_test.rb

@@ -0,0 +1,39 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module USCoreTestKit
+  class PatientNameSearchTest < Inferno::Test
+    include USCoreTestKit::SearchTest
+
+    title 'Server returns valid results for Patient search by name'
+    description %(
+A server SHALL support searching by
+name on the Patient 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_patient_name_search_test
+    def self.properties
+      @properties ||= SearchTestProperties.new(
+        resource_type: 'Patient',
+        search_param_names: ['name']
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:patient_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/patient/patient_provenance_revinclude_search_test.rb

@@ -0,0 +1,49 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module USCoreTestKit
+  class PatientProvenanceRevincludeSearchTest < Inferno::Test
+    include USCoreTestKit::SearchTest
+
+    title 'Server returns Provenance resources from Patient search by _id + revInclude:Provenance:target'
+    description %(
+      A server SHALL be capable of supporting _revIncludes:Provenance:target.
+
+      This test will perform a search by _id + revInclude:Provenance:target and
+      will pass if a Provenance resource is found in the response.
+    %)
+
+    id :us_core_311_patient_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(
+        resource_type: 'Patient',
+        search_param_names: ['_id']
+      )
+    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[:patient_resources] ||= {}
+    end
+
+    def scratch_provenance_resources
+      scratch[:provenance_resources] ||= {}
+    end
+
+    run do
+      run_provenance_revinclude_search_test
+    end
+  end
+end