ipa_test_kit 0.2.0

data/lib/ipa_test_kit/generated/condition_group.rb

@@ -0,0 +1,91 @@
+require_relative 'condition/condition_patient_search_test'
+require_relative 'condition/condition_patient_onset_date_search_test'
+require_relative 'condition/condition_patient_category_search_test'
+require_relative 'condition/condition_patient_clinical_status_search_test'
+require_relative 'condition/condition_patient_code_search_test'
+require_relative 'condition/condition_read_test'
+require_relative 'condition/condition_provenance_revinclude_search_test'
+require_relative 'condition/condition_validation_test'
+require_relative 'condition/condition_must_support_test'
+require_relative 'condition/condition_reference_resolution_test'
+
+module IpaTestKit
+  class ConditionGroup < Inferno::TestGroup
+    title 'Condition Tests'
+    short_description 'Verify support for the server capabilities required by the IPA Condition Profile.'
+    description %(
+# Background
+
+The IPA Condition sequence verifies that the system under test is
+able to provide correct responses for Condition queries. These queries
+must contain resources conforming to the IPA Condition Profile as
+specified in the IPA v0.1.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 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
+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 [IPA Condition Profile](http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-condition). 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 :ipa_010_condition
+    run_as_group
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'condition', 'metadata.yml')))
+    end
+
+    test from: :ipa_010_condition_patient_search_test
+    test from: :ipa_010_condition_patient_onset_date_search_test
+    test from: :ipa_010_condition_patient_category_search_test
+    test from: :ipa_010_condition_patient_clinical_status_search_test
+    test from: :ipa_010_condition_patient_code_search_test
+    test from: :ipa_010_condition_read_test
+    test from: :ipa_010_condition_provenance_revinclude_search_test
+    test from: :ipa_010_condition_validation_test
+    test from: :ipa_010_condition_must_support_test
+    test from: :ipa_010_condition_reference_resolution_test
+  end
+end

data/lib/ipa_test_kit/generated/document_reference/document_reference_id_search_test.rb

@@ -0,0 +1,40 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module IpaTestKit
+  class DocumentReferenceIdSearchTest < Inferno::Test
+    include IpaTestKit::SearchTest
+
+    title 'Server returns valid results for DocumentReference search by _id'
+    description %(
+A server SHALL support searching by
+_id on the DocumentReference resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+[IPA Server CapabilityStatement](https://build.fhir.org/ig/HL7/fhir-ipa/CapabilityStatement-ipa-server.html)
+
+    )
+
+    id :ipa_010_document_reference__id_search_test
+    def self.properties
+      @properties ||= SearchTestProperties.new(
+        resource_type: 'DocumentReference',
+        search_param_names: ['_id'],
+        possible_status_search: true
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:document_reference_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/ipa_test_kit/generated/document_reference/document_reference_must_support_test.rb

@@ -0,0 +1,49 @@
+require_relative '../../must_support_test'
+
+module IpaTestKit
+  class DocumentReferenceMustSupportTest < Inferno::Test
+    include IpaTestKit::MustSupportTest
+
+    title 'All must support elements are provided in the DocumentReference resources returned'
+    description %(
+      IPA Responders SHALL be capable of populating all data elements as
+      part of the query results as specified by the IPA Server Capability
+      Statement. This test will look through the DocumentReference resources
+      found previously for the following must support elements:
+
+      * DocumentReference.author
+      * DocumentReference.category
+      * DocumentReference.content
+      * DocumentReference.content.attachment
+      * DocumentReference.content.attachment.contentType
+      * DocumentReference.content.format
+      * DocumentReference.context
+      * DocumentReference.context.encounter
+      * DocumentReference.context.period
+      * DocumentReference.custodian
+      * DocumentReference.date
+      * DocumentReference.identifier
+      * DocumentReference.status
+      * DocumentReference.subject
+      * DocumentReference.type
+    )
+
+    id :ipa_010_document_reference_must_support_test
+
+    def resource_type
+      'DocumentReference'
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:document_reference_resources] ||= {}
+    end
+
+    run do
+      perform_must_support_test(all_scratch_resources)
+    end
+  end
+end

data/lib/ipa_test_kit/generated/document_reference/document_reference_patient_category_date_search_test.rb

@@ -0,0 +1,46 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module IpaTestKit
+  class DocumentReferencePatientCategoryDateSearchTest < Inferno::Test
+    include IpaTestKit::SearchTest
+
+    title 'Server returns valid results for DocumentReference search by patient + category + date'
+    description %(
+A server SHALL support searching by
+patient + category + date on the DocumentReference resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+[IPA Server CapabilityStatement](https://build.fhir.org/ig/HL7/fhir-ipa/CapabilityStatement-ipa-server.html)
+
+    )
+
+    id :ipa_010_document_reference_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: 'DocumentReference',
+        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[:document_reference_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/ipa_test_kit/generated/document_reference/document_reference_patient_category_search_test.rb

@@ -0,0 +1,45 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module IpaTestKit
+  class DocumentReferencePatientCategorySearchTest < Inferno::Test
+    include IpaTestKit::SearchTest
+
+    title 'Server returns valid results for DocumentReference search by patient + category'
+    description %(
+A server SHALL support searching by
+patient + category on the DocumentReference resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+[IPA Server CapabilityStatement](https://build.fhir.org/ig/HL7/fhir-ipa/CapabilityStatement-ipa-server.html)
+
+    )
+
+    id :ipa_010_document_reference_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: 'DocumentReference',
+        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[:document_reference_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/ipa_test_kit/generated/document_reference/document_reference_patient_search_test.rb

@@ -0,0 +1,61 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module IpaTestKit
+  class DocumentReferencePatientSearchTest < Inferno::Test
+    include IpaTestKit::SearchTest
+
+    title 'Server returns valid results for DocumentReference search by patient'
+    description %(
+A server SHALL support searching by
+patient on the DocumentReference 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. IPA
+requires that both forms are supported by IPA 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 IPA v0.1.0.
+
+[IPA Server CapabilityStatement](https://build.fhir.org/ig/HL7/fhir-ipa/CapabilityStatement-ipa-server.html)
+
+    )
+
+    id :ipa_010_document_reference_patient_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: 'DocumentReference',
+        search_param_names: ['patient'],
+        saves_delayed_references: true,
+        possible_status_search: true,
+        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[:document_reference_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/ipa_test_kit/generated/document_reference/document_reference_patient_status_search_test.rb

@@ -0,0 +1,46 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module IpaTestKit
+  class DocumentReferencePatientStatusSearchTest < Inferno::Test
+    include IpaTestKit::SearchTest
+
+    title 'Server returns valid results for DocumentReference search by patient + status'
+    description %(
+A server SHOULD support searching by
+patient + status on the DocumentReference resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+[IPA Server CapabilityStatement](https://build.fhir.org/ig/HL7/fhir-ipa/CapabilityStatement-ipa-server.html)
+
+    )
+
+    id :ipa_010_document_reference_patient_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: 'DocumentReference',
+        search_param_names: ['patient', 'status'],
+        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[:document_reference_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/ipa_test_kit/generated/document_reference/document_reference_patient_type_period_search_test.rb

@@ -0,0 +1,48 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module IpaTestKit
+  class DocumentReferencePatientTypePeriodSearchTest < Inferno::Test
+    include IpaTestKit::SearchTest
+
+    title 'Server returns valid results for DocumentReference search by patient + type + period'
+    description %(
+A server SHOULD support searching by
+patient + type + period on the DocumentReference resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+[IPA Server CapabilityStatement](https://build.fhir.org/ig/HL7/fhir-ipa/CapabilityStatement-ipa-server.html)
+
+    )
+
+    id :ipa_010_document_reference_patient_type_period_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: 'DocumentReference',
+        search_param_names: ['patient', 'type', 'period'],
+        possible_status_search: true,
+        token_search_params: ['type'],
+        params_with_comparators: ['period']
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:document_reference_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/ipa_test_kit/generated/document_reference/document_reference_patient_type_search_test.rb

@@ -0,0 +1,45 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module IpaTestKit
+  class DocumentReferencePatientTypeSearchTest < Inferno::Test
+    include IpaTestKit::SearchTest
+
+    title 'Server returns valid results for DocumentReference search by patient + type'
+    description %(
+A server SHALL support searching by
+patient + type on the DocumentReference resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+[IPA Server CapabilityStatement](https://build.fhir.org/ig/HL7/fhir-ipa/CapabilityStatement-ipa-server.html)
+
+    )
+
+    id :ipa_010_document_reference_patient_type_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: 'DocumentReference',
+        search_param_names: ['patient', 'type'],
+        possible_status_search: true,
+        token_search_params: ['type']
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:document_reference_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/ipa_test_kit/generated/document_reference/document_reference_provenance_revinclude_search_test.rb

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

data/lib/ipa_test_kit/generated/document_reference/document_reference_read_test.rb

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

data/lib/ipa_test_kit/generated/document_reference/document_reference_reference_resolution_test.rb

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

data/lib/ipa_test_kit/generated/document_reference/document_reference_validation_test.rb

@@ -0,0 +1,34 @@
+require_relative '../../validation_test'
+
+module IpaTestKit
+  class DocumentReferenceValidationTest < Inferno::Test
+    include IpaTestKit::ValidationTest
+
+    id :ipa_010_document_reference_validation_test
+    title 'DocumentReference resources returned during previous tests conform to the IPA DocumentReference Profile'
+    description %(
+This test verifies resources returned from the first search conform to
+the [IPA DocumentReference Profile](http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference).
+
+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
+      'DocumentReference'
+    end
+
+    def scratch_resources
+      scratch[:document_reference_resources] ||= {}
+    end
+
+    run do
+      perform_validation_test(scratch_resources[:all] || [], 'http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference')
+    end
+  end
+end