ipa_test_kit 0.2.0

data/lib/ipa_test_kit/generated/practitioner/practitioner_name_search_test.rb

@@ -0,0 +1,49 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module IpaTestKit
+  class PractitionerNameSearchTest < Inferno::Test
+    include IpaTestKit::SearchTest
+
+    title 'Server returns valid results for Practitioner search by name'
+    description %(
+A server SHALL support searching by
+name on the Practitioner 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 IPA v0.1.0.
+
+[IPA Server CapabilityStatement](https://build.fhir.org/ig/HL7/fhir-ipa/CapabilityStatement-ipa-server.html)
+
+    )
+
+    id :ipa_010_practitioner_name_search_test
+    def self.properties
+      @properties ||= SearchTestProperties.new(
+        first_search: true,
+        resource_type: 'Practitioner',
+        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[:practitioner_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/ipa_test_kit/generated/practitioner/practitioner_read_test.rb

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

data/lib/ipa_test_kit/generated/practitioner/practitioner_reference_resolution_test.rb

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

data/lib/ipa_test_kit/generated/practitioner/practitioner_validation_test.rb

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

data/lib/ipa_test_kit/generated/practitioner_group.rb

@@ -0,0 +1,84 @@
+require_relative 'practitioner/practitioner_read_test'
+require_relative 'practitioner/practitioner_name_search_test'
+require_relative 'practitioner/practitioner_identifier_search_test'
+require_relative 'practitioner/practitioner_validation_test'
+require_relative 'practitioner/practitioner_must_support_test'
+require_relative 'practitioner/practitioner_reference_resolution_test'
+
+module IpaTestKit
+  class PractitionerGroup < Inferno::TestGroup
+    title 'Practitioner Tests'
+    short_description 'Verify support for the server capabilities required by the IPA Practitioner Profile.'
+    description %(
+# Background
+
+The IPA Practitioner sequence verifies that the system under test is
+able to provide correct responses for Practitioner queries. These queries
+must contain resources conforming to the IPA Practitioner 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:
+
+* name
+* identifier
+
+### 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
+Practitioner 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 Practitioner 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 Practitioner Profile](http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner). 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_practitioner
+    run_as_group
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'practitioner', 'metadata.yml')))
+    end
+
+    test from: :ipa_010_practitioner_read_test
+    test from: :ipa_010_practitioner_name_search_test
+    test from: :ipa_010_practitioner_identifier_search_test
+    test from: :ipa_010_practitioner_validation_test
+    test from: :ipa_010_practitioner_must_support_test
+    test from: :ipa_010_practitioner_reference_resolution_test
+  end
+end

data/lib/ipa_test_kit/generated/practitioner_role/metadata.yml

@@ -0,0 +1,141 @@
+---
+:name: ipa_practitioner_role
+:class_name: Ipav010PractitionerRoleSequence
+:version: v0.1.0
+:reformatted_version: v010
+:resource: PractitionerRole
+:profile_url: http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole
+:profile_name: IPA Practitioner Role Profile
+:title: PractitionerRole
+:short_description: Verify support for the server capabilities required by the IPA
+  Practitioner Role Profile.
+:interactions:
+- :code: create
+  :expectation: MAY
+- :code: search-type
+  :expectation: SHALL
+- :code: read
+  :expectation: SHALL
+- :code: vread
+  :expectation: SHOULD
+- :code: update
+  :expectation: MAY
+- :code: patch
+  :expectation: MAY
+- :code: delete
+  :expectation: MAY
+- :code: history-instance
+  :expectation: SHOULD
+- :code: history-type
+  :expectation: MAY
+:operations: []
+:searches:
+- :names:
+  - practitioner
+  :expectation: SHALL
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :names:
+  - identifier
+  :expectation: SHALL
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+:search_definitions:
+  :practitioner:
+    :path: practitioner
+    :full_path: PractitionerRole.practitioner
+    :comparators: {}
+    :values: []
+    :type: Reference
+    :contains_multiple: false
+    :multiple_or: MAY
+    :chain:
+    - :chain: identifier
+      :expectation: SHALL
+    - :chain: name
+      :expectation: SHALL
+  :identifier:
+    :path: identifier
+    :full_path: PractitionerRole.identifier
+    :comparators: {}
+    :values: []
+    :type: Identifier
+    :contains_multiple: true
+    :multiple_or: MAY
+:include_params: []
+:revincludes: []
+:required_concepts: []
+:must_supports:
+  :extensions: []
+  :slices: []
+  :elements:
+  - :path: active
+  - :path: practitioner
+:mandatory_elements:
+- PractitionerRole.active
+- PractitionerRole.practitioner
+- PractitionerRole.notAvailable.description
+:bindings:
+- :type: code
+  :strength: preferred
+  :system: http://hl7.org/fhir/ValueSet/languages
+  :path: language
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/identifier-use
+  :path: identifier.use
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/ValueSet/identifier-type
+  :path: identifier.type
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/name-use
+  :path: name.use
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/administrative-gender
+  :path: gender
+- :type: CodeableConcept
+  :strength: example
+  :system: http://terminology.hl7.org/ValueSet/v2-2.7-0360
+  :path: qualification.code
+- :type: CodeableConcept
+  :strength: preferred
+  :system: http://hl7.org/fhir/ValueSet/languages
+  :path: communication
+:references:
+- :path: PractitionerRole.identifier.assigner
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: PractitionerRole.practitioner
+  :profiles:
+  - http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner
+- :path: PractitionerRole.organization
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: PractitionerRole.location
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Location
+- :path: PractitionerRole.healthcareService
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/HealthcareService
+- :path: PractitionerRole.endpoint
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Endpoint
+:tests:
+- :id: ipa_010_practitioner_role_read_test
+  :file_name: practitioner_role_read_test.rb
+- :id: ipa_010_practitioner_role_practitioner_search_test
+  :file_name: practitioner_role_practitioner_search_test.rb
+- :id: ipa_010_practitioner_role_identifier_search_test
+  :file_name: practitioner_role_identifier_search_test.rb
+- :id: ipa_010_practitioner_role_validation_test
+  :file_name: practitioner_role_validation_test.rb
+- :id: ipa_010_practitioner_role_must_support_test
+  :file_name: practitioner_role_must_support_test.rb
+- :id: ipa_010_practitioner_role_reference_resolution_test
+  :file_name: practitioner_role_reference_resolution_test.rb
+:id: ipa_010_practitioner_role
+:file_name: practitioner_role_group.rb
+:delayed_references: []

data/lib/ipa_test_kit/generated/practitioner_role/practitioner_role_identifier_search_test.rb

@@ -0,0 +1,40 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module IpaTestKit
+  class PractitionerRoleIdentifierSearchTest < Inferno::Test
+    include IpaTestKit::SearchTest
+
+    title 'Server returns valid results for PractitionerRole search by identifier'
+    description %(
+A server SHALL support searching by
+identifier on the PractitionerRole 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_practitioner_role_identifier_search_test
+    def self.properties
+      @properties ||= SearchTestProperties.new(
+        resource_type: 'PractitionerRole',
+        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[:practitioner_role_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/ipa_test_kit/generated/practitioner_role/practitioner_role_must_support_test.rb

@@ -0,0 +1,40 @@
+require_relative '../../must_support_test'
+
+module IpaTestKit
+  class PractitionerRoleMustSupportTest < Inferno::Test
+    include IpaTestKit::MustSupportTest
+
+    title 'All must support elements are provided in the PractitionerRole 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 PractitionerRole resources
+      found previously for the following must support elements:
+
+      * PractitionerRole.identifier
+      * PractitionerRole.identifier.system
+      * PractitionerRole.identifier.value
+      * PractitionerRole.identifier:NPI
+      * PractitionerRole.name
+      * PractitionerRole.name.family
+    )
+
+    id :ipa_010_practitioner_role_must_support_test
+
+    def resource_type
+      'PractitionerRole'
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:practitioner_role_resources] ||= {}
+    end
+
+    run do
+      perform_must_support_test(all_scratch_resources)
+    end
+  end
+end

data/lib/ipa_test_kit/generated/practitioner_role/practitioner_role_practitioner_search_test.rb

@@ -0,0 +1,51 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module IpaTestKit
+  class PractitionerRolePractitionerSearchTest < Inferno::Test
+    include IpaTestKit::SearchTest
+
+    title 'Server returns valid results for PractitionerRole search by practitioner'
+    description %(
+A server SHALL support searching by
+practitioner on the PractitionerRole 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 IPA v0.1.0.
+
+[IPA Server CapabilityStatement](https://build.fhir.org/ig/HL7/fhir-ipa/CapabilityStatement-ipa-server.html)
+
+    )
+
+    id :ipa_010_practitioner_role_practitioner_search_test
+    def self.properties
+      @properties ||= SearchTestProperties.new(
+        first_search: true,
+        resource_type: 'PractitionerRole',
+        search_param_names: ['practitioner'],
+        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[:practitioner_role_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/ipa_test_kit/generated/practitioner_role/practitioner_role_read_test.rb

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

data/lib/ipa_test_kit/generated/practitioner_role/practitioner_role_reference_resolution_test.rb

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

data/lib/ipa_test_kit/generated/practitioner_role/practitioner_role_validation_test.rb

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

data/lib/ipa_test_kit/generated/practitioner_role_group.rb

@@ -0,0 +1,84 @@
+require_relative 'practitioner_role/practitioner_role_read_test'
+require_relative 'practitioner_role/practitioner_role_practitioner_search_test'
+require_relative 'practitioner_role/practitioner_role_identifier_search_test'
+require_relative 'practitioner_role/practitioner_role_validation_test'
+require_relative 'practitioner_role/practitioner_role_must_support_test'
+require_relative 'practitioner_role/practitioner_role_reference_resolution_test'
+
+module IpaTestKit
+  class PractitionerRoleGroup < Inferno::TestGroup
+    title 'PractitionerRole Tests'
+    short_description 'Verify support for the server capabilities required by the IPA PractitionerRole Profile.'
+    description %(
+# Background
+
+The IPA PractitionerRole sequence verifies that the system under test is
+able to provide correct responses for PractitionerRole queries. These queries
+must contain resources conforming to the IPA PractitionerRole 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:
+
+* practitioner
+* identifier
+
+### 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
+PractitionerRole 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 PractitionerRole 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 PractitionerRole Profile](http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole). 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_practitioner_role
+    run_as_group
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'practitioner_role', 'metadata.yml')))
+    end
+
+    test from: :ipa_010_practitioner_role_read_test
+    test from: :ipa_010_practitioner_role_practitioner_search_test
+    test from: :ipa_010_practitioner_role_identifier_search_test
+    test from: :ipa_010_practitioner_role_validation_test
+    test from: :ipa_010_practitioner_role_must_support_test
+    test from: :ipa_010_practitioner_role_reference_resolution_test
+  end
+end