ipa_test_kit 0.2.0 → 0.3.1

data/lib/ipa_test_kit/custom_groups/capability_statement/json_support_test.rb

@@ -1,39 +0,0 @@
-module IpaTestKit
-  class JSONSupportTest < Inferno::Test
-    id :ipa_010_json_support
-    title 'FHIR server capability states JSON support'
-    description %(
-      FHIR provides multiple [representation
-      formats](https://www.hl7.org/fhir/formats.html) for resources, including
-      JSON and XML. IPA profiles require servers to use the [JSON
-      representation](https://www.hl7.org/fhir/json.html):
-
-      [```The IPA Server **SHALL** Support json source formats for all IPA
-      interactions.```](http://hl7.org/fhir/uv/ipa/CapabilityStatement-ipa-server.html#behavior)
-
-      The FHIR conformance interaction require servers to describe which
-      formats are available for clients to use. The server must explicitly
-      state that JSON is supported. This is located in the [format
-      element](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.format)
-      of the CapabilityStatement Resource.
-
-      This test checks that one of the following values are located in the
-      format field.
-
-      * json
-      * application/json
-      * application/fhir+json
-    )
-    uses_request :capability_statement
-
-    run do
-      assert_resource_type(:capability_statement)
-
-      json_formats = ['json', 'application/json', 'application/fhir+json']
-      server_formats = resource.format
-
-      assert server_formats.any? { |format| json_formats.include? format },
-              'CapabilityStatement does not state support for JSON'
-    end
-  end
-end

data/lib/ipa_test_kit/custom_groups/capability_statement/profile_support_test.rb

@@ -1,76 +0,0 @@
-module IpaTestKit
-  class ProfileSupportTest < Inferno::Test
-    id :ipa_010_profile_support
-    title 'Capability Statement lists support for required IPA Profiles'
-    description %(
-      The IPA Implementation Guide states:
-
-      ```
-      The IPA Server SHALL:
-      1. Support the IPA Patient resource profile.
-      2. Support at least one additional resource profile from the list of IPA
-          Profiles.
-      ```
-    )
-    uses_request :capability_statement
-
-    PROFILES = {
-      'AllergyIntolerance' => ['http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance'].freeze,
-      'Condition' => ['http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-condition'].freeze,
-      'DocumentReference' => ['http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference'].freeze,
-      'Immunization' => ['http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization'].freeze,
-      'Medication' => ['http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication'].freeze,
-      'MedicationRequest' => ['http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationrequest'].freeze,
-      'MedicationStatement' => ['http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationstatement'].freeze,
-      'Observation' => [
-        'http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation',
-        'http://hl7.org/fhir/StructureDefinition/bp/bmi',
-        'http://hl7.org/fhir/StructureDefinition/bp/oxygensat',
-        'http://hl7.org/fhir/StructureDefinition/bp',
-        'http://hl7.org/fhir/StructureDefinition/bodyheight',
-        'http://hl7.org/fhir/StructureDefinition/bodyweight',
-        'http://hl7.org/fhir/StructureDefinition/heartrate',
-        'http://hl7.org/fhir/StructureDefinition/resprate',
-        'http://hl7.org/fhir/StructureDefinition/bodytemp',
-        'http://hl7.org/fhir/StructureDefinition/headcircum'
-      ].freeze,
-      'Patient' => ['http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient'].freeze,
-      'Practitioner' => ['http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner'].freeze,
-      'PractitionerRole' => ['http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole'].freeze
-    }.freeze
-
-    run do
-      assert_resource_type(:capability_statement)
-      capability_statement = resource
-
-      supported_resources =
-        capability_statement.rest
-          &.each_with_object([]) do |rest, resources|
-            rest.resource.each { |resource| resources << resource.type }
-          end.uniq
-      supported_profiles =
-        capability_statement.rest
-          &.flat_map(&:resource)
-          &.flat_map { |resource| resource.supportedProfile + [resource.profile] }
-          &.compact || []
-      supported_profiles.map! { |profile_url| profile_url.split('|').first }
-
-      assert supported_resources.include?('Patient'), 'IPA Patient profile not supported'
-
-      other_resources = PROFILES.keys.reject { |resource_type| resource_type == 'Patient' }
-      other_resources_supported = other_resources.any? { |resource| supported_resources.include? resource }
-      assert other_resources_supported, 'No IPA resources other than Patient are supported'
-
-      PROFILES.each do |resource_type, profiles|
-        next unless supported_resources.include? resource_type
-
-        profiles.each do |profile|
-          warning do
-            assert supported_profiles&.include?(profile),
-                    "CapabilityStatement does not claim support for IPA #{resource_type} profile: #{profile}"
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ipa_test_kit/custom_groups/capability_statement_group.rb

@@ -1,64 +0,0 @@
-require 'tls_test_kit'
-require_relative 'capability_statement/conformance_support_test'
-require_relative 'capability_statement/fhir_version_test'
-require_relative 'capability_statement/json_support_test'
-require_relative 'capability_statement/profile_support_test'
-
-module IpaTestKit
-  class CapabilityStatementGroup < Inferno::TestGroup
-    id :ipa_010_capability_statement
-    title 'Capability Statement'
-    short_description 'Retrieve information about supported server functionality using the FHIR capabilties interaction.'
-    description %(
-      # Background
-      The #{title} Sequence tests a FHIR server's ability to formally describe
-      features supported by the API by using the [Capability
-      Statement](https://www.hl7.org/fhir/capabilitystatement.html) resource.
-      The features described in the Capability Statement must be consistent with
-      the required capabilities of a IPA server. The Capability Statement
-      must also advertise the location of the required SMART on FHIR endpoints
-      that enable authenticated access to the FHIR server resources.
-
-      The Capability Statement resource allows clients to determine which
-      resources are supported by a FHIR Server. Not all servers are expected to
-      implement all possible queries and data elements described in the IPA
-      API. For example, the IPA Implementation Guide requires that the
-      Patient resource and only one additional resource profile from the IPA
-      Profiles.
-
-      # Test Methodology
-
-      This test sequence accesses the server endpoint at `/metadata` using a
-      `GET` request. It parses the Capability Statement and verifies that:
-
-      * The endpoint is secured by an appropriate cryptographic protocol
-      * The resource matches the expected FHIR version defined by the tests
-      * The resource is a valid FHIR resource
-      * The server claims support for JSON encoding of resources
-      * The server claims support for the Patient resource and one other
-        resource
-
-      It collects the following information that is saved in the testing session
-      for use by later tests:
-
-      * List of resources supported
-      * List of queries parameters supported
-    )
-    run_as_group
-
-    test from: :tls_version_test,
-         id: :standalone_auth_tls,
-         title: 'FHIR server secured by transport layer security',
-         description: %(
-           Systems **SHALL** use TLS version 1.2 or higher for all transmissions
-           not taking place over a secure network connection.
-         ),
-         config: {
-           options: {  minimum_allowed_version: OpenSSL::SSL::TLS1_2_VERSION }
-         }
-    test from: :ipa_010_conformance_support
-    test from: :ipa_010_fhir_version
-    test from: :ipa_010_json_support
-    test from: :ipa_010_profile_support
-  end
-end

data/lib/ipa_test_kit/ext/fhir_models.rb

@@ -1,59 +0,0 @@
-require 'json'
-
-# Extension to FHIR::Model. Prepending this into FHIR::Model (done below)
-# allows us to call super() on initialize when we overriding it,
-# while also defining new methods and attributes
-module InfernoFHIRModelExtensions
-  attr_accessor :source_hash, :source_text
-
-  def initialize(hash = {})
-    super(hash)
-    @source_hash = hash
-  end
-
-  def source_contents
-    @source_text || JSON.generate(@source_hash)
-  end
-end
-
-module FHIR
-  class Model
-    prepend ::InfernoFHIRModelExtensions
-  end
-end
-
-# Extension to FHIR::Json. Prepending this into FHIR::Json (done below)
-# allows us to call super() on from_json
-module InfernoJson
-  def from_json(json)
-    resource = super(json)
-    resource.source_text = json
-    resource
-  end
-end
-
-# Extension to FHIR::Xml. Prepending this into FHIR::Xml (done below)
-# allows us to call super() on from_xml
-module InfernoXml
-  def from_xml(xml)
-    resource = super(xml)
-    resource.source_text = xml
-    resource
-  end
-end
-
-module FHIR
-  module Json
-    class << self
-      prepend InfernoJson
-    end
-  end
-end
-
-module FHIR
-  module Xml
-    class << self
-      prepend InfernoXml
-    end
-  end
-end

data/lib/ipa_test_kit/generated/allergy_intolerance/allergy_intolerance_must_support_test.rb

@@ -1,40 +0,0 @@
-require_relative '../../must_support_test'
-
-module IpaTestKit
-  class AllergyIntoleranceMustSupportTest < Inferno::Test
-    include IpaTestKit::MustSupportTest
-
-    title 'All must support elements are provided in the AllergyIntolerance 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 AllergyIntolerance resources
-      found previously for the following must support elements:
-
-      * AllergyIntolerance.clinicalStatus
-      * AllergyIntolerance.code
-      * AllergyIntolerance.patient
-      * AllergyIntolerance.reaction
-      * AllergyIntolerance.reaction.manifestation
-      * AllergyIntolerance.verificationStatus
-    )
-
-    id :ipa_010_allergy_intolerance_must_support_test
-
-    def resource_type
-      'AllergyIntolerance'
-    end
-
-    def self.metadata
-      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
-    end
-
-    def scratch_resources
-      scratch[:allergy_intolerance_resources] ||= {}
-    end
-
-    run do
-      perform_must_support_test(all_scratch_resources)
-    end
-  end
-end

data/lib/ipa_test_kit/generated/allergy_intolerance/allergy_intolerance_patient_clinical_status_search_test.rb

@@ -1,46 +0,0 @@
-require_relative '../../search_test'
-require_relative '../../generator/group_metadata'
-
-module IpaTestKit
-  class AllergyIntolerancePatientClinicalStatusSearchTest < Inferno::Test
-    include IpaTestKit::SearchTest
-
-    title 'Server returns valid results for AllergyIntolerance search by patient + clinical-status'
-    description %(
-A server SHOULD support searching by
-patient + clinical-status on the AllergyIntolerance 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_allergy_intolerance_patient_clinical_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: 'AllergyIntolerance',
-        search_param_names: ['patient', 'clinical-status'],
-        token_search_params: ['clinical-status']
-      )
-    end
-
-    def self.metadata
-      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
-    end
-
-    def scratch_resources
-      scratch[:allergy_intolerance_resources] ||= {}
-    end
-
-    run do
-      run_search_test
-    end
-  end
-end

data/lib/ipa_test_kit/generated/allergy_intolerance/allergy_intolerance_patient_search_test.rb

@@ -1,60 +0,0 @@
-require_relative '../../search_test'
-require_relative '../../generator/group_metadata'
-
-module IpaTestKit
-  class AllergyIntolerancePatientSearchTest < Inferno::Test
-    include IpaTestKit::SearchTest
-
-    title 'Server returns valid results for AllergyIntolerance search by patient'
-    description %(
-A server SHALL support searching by
-patient on the AllergyIntolerance 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_allergy_intolerance_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: 'AllergyIntolerance',
-        search_param_names: ['patient'],
-        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[:allergy_intolerance_resources] ||= {}
-    end
-
-    run do
-      run_search_test
-    end
-  end
-end

data/lib/ipa_test_kit/generated/allergy_intolerance/allergy_intolerance_provenance_revinclude_search_test.rb

@@ -1,49 +0,0 @@
-require_relative '../../search_test'
-require_relative '../../generator/group_metadata'
-
-module IpaTestKit
-  class AllergyIntoleranceProvenanceRevincludeSearchTest < Inferno::Test
-    include IpaTestKit::SearchTest
-
-    title 'Server returns Provenance resources from AllergyIntolerance 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_allergy_intolerance_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: 'AllergyIntolerance',
-        search_param_names: ['patient']
-      )
-    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[:allergy_intolerance_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/allergy_intolerance/allergy_intolerance_read_test.rb

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

data/lib/ipa_test_kit/generated/allergy_intolerance/allergy_intolerance_reference_resolution_test.rb

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

data/lib/ipa_test_kit/generated/allergy_intolerance/allergy_intolerance_validation_test.rb

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

data/lib/ipa_test_kit/generated/bmi/bmi_must_support_test.rb

@@ -1,49 +0,0 @@
-require_relative '../../must_support_test'
-
-module IpaTestKit
-  class BmiMustSupportTest < Inferno::Test
-    include IpaTestKit::MustSupportTest
-
-    title 'All must support elements are provided in the Observation 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 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.coding.code
-      * 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 :ipa_010_bmi_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[:bmi_resources] ||= {}
-    end
-
-    run do
-      perform_must_support_test(all_scratch_resources)
-    end
-  end
-end

data/lib/ipa_test_kit/generated/bmi/bmi_patient_category_date_search_test.rb

@@ -1,46 +0,0 @@
-require_relative '../../search_test'
-require_relative '../../generator/group_metadata'
-
-module IpaTestKit
-  class BmiPatientCategoryDateSearchTest < Inferno::Test
-    include IpaTestKit::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.
-
-[IPA Server CapabilityStatement](https://build.fhir.org/ig/HL7/fhir-ipa/CapabilityStatement-ipa-server.html)
-
-    )
-
-    id :ipa_010_bmi_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[:bmi_resources] ||= {}
-    end
-
-    run do
-      run_search_test
-    end
-  end
-end

data/lib/ipa_test_kit/generated/bmi/bmi_patient_category_search_test.rb

@@ -1,45 +0,0 @@
-require_relative '../../search_test'
-require_relative '../../generator/group_metadata'
-
-module IpaTestKit
-  class BmiPatientCategorySearchTest < Inferno::Test
-    include IpaTestKit::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.
-
-[IPA Server CapabilityStatement](https://build.fhir.org/ig/HL7/fhir-ipa/CapabilityStatement-ipa-server.html)
-
-    )
-
-    id :ipa_010_bmi_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[:bmi_resources] ||= {}
-    end
-
-    run do
-      run_search_test
-    end
-  end
-end