us_core_test_kit 0.2.5 → 0.3.0

data/lib/us_core_test_kit/generated/v5.0.1/organization/metadata.yml

@@ -0,0 +1,161 @@
+---
+:name: us_core_organization
+:class_name: USCorev501OrganizationSequence
+:version: v5.0.1
+:reformatted_version: v501
+:resource: Organization
+:profile_url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization
+:profile_name: US Core Organization Profile
+:profile_version: 5.0.1
+:title: Organization
+:short_description: Verify support for the server capabilities required by the US
+  Core Organization 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:
+  - name
+  :expectation: SHALL
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :names:
+  - address
+  :expectation: SHALL
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+:search_definitions:
+  :name:
+    :paths:
+    - name
+    - alias
+    :full_paths:
+    - Organization.name
+    - Organization.alias
+    :comparators: {}
+    :values: []
+    :type: string
+    :contains_multiple: false
+    :multiple_or: MAY
+  :address:
+    :paths:
+    - address
+    :full_paths:
+    - Organization.address
+    :comparators: {}
+    :values: []
+    :type: Address
+    :contains_multiple: true
+    :multiple_or: MAY
+:include_params: []
+:revincludes: []
+:required_concepts: []
+:must_supports:
+  :extensions: []
+  :slices:
+  - :name: Organization.identifier:NPI
+    :path: identifier
+    :discriminator:
+      :type: patternIdentifier
+      :path: ''
+      :system: http://hl7.org/fhir/sid/us-npi
+  :elements:
+  - :path: identifier
+  - :path: identifier.system
+  - :path: identifier.value
+  - :path: active
+  - :path: name
+  - :path: telecom
+  - :path: telecom.system
+  - :path: telecom.value
+  - :path: address
+  - :path: address.line
+  - :path: address.city
+  - :path: address.state
+  - :path: address.postalCode
+  - :path: address.country
+:mandatory_elements:
+- Organization.active
+- Organization.name
+: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: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/organization-type
+  :path: type
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/contact-point-system
+  :path: telecom.system
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/contact-point-use
+  :path: telecom.use
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/address-use
+  :path: address.use
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/address-type
+  :path: address.type
+- :type: string
+  :strength: extensible
+  :system: http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
+  :path: address.state
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/ValueSet/contactentity-type
+  :path: contact.purpose
+:references:
+- :path: Organization.identifier.assigner
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Organization.partOf
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Organization.endpoint
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Endpoint
+:tests:
+- :id: us_core_v501_organization_read_test
+  :file_name: organization_read_test.rb
+- :id: us_core_v501_organization_name_search_test
+  :file_name: organization_name_search_test.rb
+- :id: us_core_v501_organization_address_search_test
+  :file_name: organization_address_search_test.rb
+- :id: us_core_v501_organization_validation_test
+  :file_name: organization_validation_test.rb
+- :id: us_core_v501_organization_must_support_test
+  :file_name: organization_must_support_test.rb
+:id: us_core_v501_organization
+:file_name: organization_group.rb
+:delayed_references: []

data/lib/us_core_test_kit/generated/v5.0.1/organization/organization_address_search_test.rb

@@ -0,0 +1,41 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV501
+    class OrganizationAddressSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Organization search by address'
+      description %(
+A server SHALL support searching by
+address 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.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core//CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v501_organization_address_search_test
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'Organization',
+        search_param_names: ['address']
+        )
+      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
+end

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

@@ -0,0 +1,51 @@
+require_relative '../../../must_support_test'
+
+module USCoreTestKit
+  module USCoreV501
+    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
+        * Organization.telecom.system
+        * Organization.telecom.value
+      )
+
+      id :us_core_v501_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
+end

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

@@ -0,0 +1,51 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV501
+    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 v5.0.1.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core//CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v501_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
+end

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

@@ -0,0 +1,26 @@
+require_relative '../../../read_test'
+
+module USCoreTestKit
+  module USCoreV501
+    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_v501_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
+end

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

@@ -0,0 +1,40 @@
+require_relative '../../../validation_test'
+
+module USCoreTestKit
+  module USCoreV501
+    class OrganizationValidationTest < Inferno::Test
+      include USCoreTestKit::ValidationTest
+
+      id :us_core_v501_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).
+Systems must demonstrate at least one valid example in order to pass this test.
+
+It verifies the presence of mandatory elements and that elements with
+required bindings contain appropriate values. CodeableConcept element
+bindings will fail if none of their codings have a code/system belonging
+to the bound ValueSet. Quantity, Coding, and code element bindings will
+fail if their code/system are not found in the valueset.
+
+      )
+      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',
+                                '5.0.1',
+                                skip_if_empty: true)
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v5.0.1/organization_group.rb

@@ -0,0 +1,85 @@
+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'
+
+module USCoreTestKit
+  module USCoreV501
+    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 v5.0.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
+At least one instance of each external reference in elements marked as
+"must support" within the resources provided by the system must resolve.
+The test will attempt to read each reference found and will fail if no
+read succeeds.
+
+      )
+
+      id :us_core_v501_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_v501_organization_read_test
+      test from: :us_core_v501_organization_name_search_test
+      test from: :us_core_v501_organization_address_search_test
+      test from: :us_core_v501_organization_validation_test
+      test from: :us_core_v501_organization_must_support_test
+    end
+  end
+end