ipa_test_kit 0.2.0 → 0.3.0

data/lib/ipa_test_kit/generated/{immunization_group.rb → v1.0.0/immunization_group.rb}

@@ -8,16 +8,17 @@ require_relative 'immunization/immunization_must_support_test'
 require_relative 'immunization/immunization_reference_resolution_test'
 
 module IpaTestKit
-  class ImmunizationGroup < Inferno::TestGroup
-    title 'Immunization Tests'
-    short_description 'Verify support for the server capabilities required by the IPA Immunization Profile.'
-    description %(
-# Background
+  module IpaV100
+    class ImmunizationGroup < Inferno::TestGroup
+      title 'Immunization Tests'
+      short_description 'Verify support for the server capabilities required by the IPA-Immunization.'
+      description %(
+  # Background
 
 The IPA Immunization sequence verifies that the system under test is
 able to provide correct responses for Immunization queries. These queries
-must contain resources conforming to the IPA Immunization Profile as
-specified in the IPA v0.1.0 Implementation Guide.
+must contain resources conforming to the IPA-Immunization as
+specified in the IPA v1.0.0 Implementation Guide.
 
 # Testing Methodology
 ## Searching
@@ -54,7 +55,7 @@ elements.
 
 ## Profile Validation
 Each resource returned from the first search is expected to conform to
-the [IPA Immunization Profile](http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization). Each element is checked against
+the [IPA-Immunization](http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization). Each element is checked against
 teminology binding and cardinality requirements.
 
 Elements with a required binding are validated against their bound
@@ -62,26 +63,32 @@ 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.
+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 :ipa_010_immunization
-    run_as_group
+      id :ipa_v100_immunization
+      run_as_group
+      input :standalone_smart_credentials,
+            title: 'SMART App Launch Credentials',
+            type: 'oauth_credentials',
+            optional: true
 
-    def self.metadata
-      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'immunization', 'metadata.yml')))
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'immunization', 'metadata.yml'), aliases: true))
+      end
+  
+      test from: :ipa_v100_immunization_patient_search_test
+      test from: :ipa_v100_immunization_patient_date_search_test
+      test from: :ipa_v100_immunization_patient_status_search_test
+      test from: :ipa_v100_immunization_read_test
+      test from: :ipa_v100_immunization_provenance_revinclude_search_test
+      test from: :ipa_v100_immunization_validation_test
+      test from: :ipa_v100_immunization_must_support_test
+      test from: :ipa_v100_immunization_reference_resolution_test
     end
-
-    test from: :ipa_010_immunization_patient_search_test
-    test from: :ipa_010_immunization_patient_date_search_test
-    test from: :ipa_010_immunization_patient_status_search_test
-    test from: :ipa_010_immunization_read_test
-    test from: :ipa_010_immunization_provenance_revinclude_search_test
-    test from: :ipa_010_immunization_validation_test
-    test from: :ipa_010_immunization_must_support_test
-    test from: :ipa_010_immunization_reference_resolution_test
   end
 end

data/lib/ipa_test_kit/generated/v1.0.0/ipa_test_suite.rb

@@ -0,0 +1,113 @@
+require 'inferno/dsl/oauth_credentials'
+require 'smart_app_launch_test_kit'
+
+require_relative '../../version'
+require_relative '../../custom_groups/v1.0.0/capability_statement_group'
+require_relative '../../custom_groups/v1.0.0/ipa_smart_launch_group'
+require_relative '../../provenance_validator'
+require_relative 'patient_group'
+require_relative 'allergy_intolerance_group'
+require_relative 'condition_group'
+require_relative 'problem_list_item_group'
+require_relative 'document_reference_group'
+require_relative 'immunization_group'
+require_relative 'medication_request_group'
+require_relative 'medication_statement_group'
+require_relative 'observation_group'
+require_relative 'vitalsigns_group'
+require_relative 'medication_group'
+require_relative 'practitioner_group'
+require_relative 'practitioner_role_group'
+
+module IpaTestKit
+  module IpaV100
+    class IpaTestSuite < Inferno::TestSuite
+      title 'International Patient Access (v1.0.0)'
+      short_title 'IPA v1.0.0'
+      description %(
+        This test suite evaluates the ability of a system to support applications
+        acting on behalf of patients to access clinical records using a FHIR R4 API
+        in accordance to the [International Patient Access Implementation Guide (IPA IG)](https://www.hl7.org/fhir/uv/ipa/).
+        
+        It accomplishes this by simulating requests performed by a realistic IPA Requestor
+        and validating responses based on requirements specified within the IPA IG and
+        the base FHIR specification.
+
+        Resources are validated with the FHIR Java validator using `tx.fhir.org`
+        as the terminology server.
+
+        The following are not yet implemented:
+        * Test for `client-confidential-asymmetric`.
+        * Verify that the server supports all required SMART capabilities, rather than
+          just verifying that the server advertises support for them.
+        * Test `$docref` operation.
+        * Test `Patient.link` requirements.
+        * Verify that the server requires both a code and system for Patient identifier
+          search.
+      )
+      version VERSION
+
+      VALIDATION_MESSAGE_FILTERS = [
+        %r{Sub-extension url 'introspect' is not defined by the Extension http://fhir-registry\.smarthealthit\.org/StructureDefinition/oauth-uris},
+        %r{Sub-extension url 'revoke' is not defined by the Extension http://fhir-registry\.smarthealthit\.org/StructureDefinition/oauth-uris},
+        /Observation\.effective\.ofType\(Period\): .*vs-1:/, # Invalid invariant in FHIR v4.0.1
+      ].freeze
+
+      def self.metadata
+        @metadata ||= YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true)[:groups].map do |raw_metadata|
+            Generator::GroupMetadata.new(raw_metadata)
+          end
+      end
+
+      validator do
+        url ENV.fetch('IPA_V100_VALIDATOR_URL', 'http://validator_service:4567')
+        exclude_message do |message|
+          VALIDATION_MESSAGE_FILTERS.any? { |filter| filter.match? message.message }
+        end
+
+        perform_additional_validation do |resource, profile_url|
+          ProvenanceValidator.validate(resource) if resource.instance_of?(FHIR::Provenance)
+        end
+      end
+
+      id :ipa_v100
+
+
+      input :url,
+        title: 'FHIR Endpoint',
+        description: 'URL of the FHIR endpoint'
+
+      fhir_client do
+        url :url
+        oauth_credentials :standalone_smart_credentials
+      end
+
+      group from: :ipa_v100_smart_launch
+
+      group do
+        title 'IPA Responder Tests'
+        description %(
+          The IPA Responder Tests evaluate the ability of an IPA Responder (IPA FHIR Server)
+          to support required and optional FHIR operations and search parameters to return
+          conformant IPA resources.
+        )
+
+        group from: :ipa_v100_capability_statement
+    
+        group from: :ipa_v100_patient
+        group from: :ipa_v100_allergy_intolerance
+        group from: :ipa_v100_condition
+        group from: :ipa_v100_problem_list_item
+        group from: :ipa_v100_document_reference
+        group from: :ipa_v100_immunization
+        group from: :ipa_v100_medication_request
+        group from: :ipa_v100_medication_statement
+        group from: :ipa_v100_observation
+        group from: :ipa_v100_vitalsigns
+        group from: :ipa_v100_medication
+        group from: :ipa_v100_practitioner
+        group from: :ipa_v100_practitioner_role
+      end
+    end
+  end
+end

data/lib/ipa_test_kit/generated/v1.0.0/medication/medication_must_support_test.rb

@@ -0,0 +1,43 @@
+require_relative '../../../must_support_test'
+
+module IpaTestKit
+  module IpaV100
+    class MedicationMustSupportTest < Inferno::Test
+      include IpaTestKit::MustSupportTest
+
+      title 'All must support elements are provided in the Medication resources returned'
+      description %(
+        Responders conforming to a profile in IPA SHALL return a Must Support
+        element if that element is available. This test will look through the
+        Medication resources found previously for the following must
+        support elements:
+
+        * Medication.code
+
+        Note: Responders who cannot store or return a data element tagged as
+        Supported in IPA profiles can still claim conformance to the IPA
+        profiles per the IPA conformance resources.
+      )
+
+      id :ipa_v100_medication_must_support_test
+
+      optional
+
+      def resource_type
+        'Medication'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:medication_resources] ||= {}
+      end
+
+      run do
+        perform_must_support_test(all_scratch_resources)
+      end
+    end
+  end
+end

data/lib/ipa_test_kit/generated/v1.0.0/medication/medication_read_test.rb

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

data/lib/ipa_test_kit/generated/v1.0.0/medication/medication_validation_test.rb

@@ -0,0 +1,39 @@
+require_relative '../../../validation_test'
+
+module IpaTestKit
+  module IpaV100
+    class MedicationValidationTest < Inferno::Test
+      include IpaTestKit::ValidationTest
+
+      id :ipa_v100_medication_validation_test
+      title 'Medication resources returned during previous tests conform to the IPA-Medication'
+      description %(
+This test verifies resources returned from previous tests conform to
+the [IPA-Medication](http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication).
+
+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
+        'Medication'
+      end
+
+      def scratch_resources
+        scratch[:medication_resources] ||= {}
+      end
+
+      run do
+        perform_validation_test(scratch_resources[:all] || [],
+                                'http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication',
+                                '1.0.0',
+                                skip_if_empty: false)
+      end
+    end
+  end
+end

data/lib/ipa_test_kit/generated/v1.0.0/medication/metadata.yml

@@ -0,0 +1,52 @@
+---
+:name: ipa_medication
+:class_name: Ipav100MedicationSequence
+:version: v1.0.0
+:reformatted_version: v100
+:resource: Medication
+:profile_url: http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication
+:profile_name: IPA-Medication
+:profile_version: 1.0.0
+:title: Medication
+:short_description: Verify support for the server capabilities required by the IPA-Medication.
+:interactions:
+- :code: read
+  :expectation: SHALL
+:operations: []
+:searches: []
+:search_definitions: {}
+:include_params: []
+:revincludes:
+- Provenance:target
+:required_concepts: []
+:must_supports:
+  :extensions: []
+  :slices: []
+  :elements:
+  - :path: code
+:mandatory_elements:
+- Medication.code
+- Medication.ingredient.item[x]
+:bindings:
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/medication-status
+  :path: status
+:references:
+- :path: Medication.manufacturer
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Medication.ingredient.itemReference
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Substance
+  - http://hl7.org/fhir/StructureDefinition/Medication
+:tests:
+- :id: ipa_v100_medication_read_test
+  :file_name: medication_read_test.rb
+- :id: ipa_v100_medication_validation_test
+  :file_name: medication_validation_test.rb
+- :id: ipa_v100_medication_must_support_test
+  :file_name: medication_must_support_test.rb
+:id: ipa_v100_medication
+:file_name: medication_group.rb
+:delayed_references: []

data/lib/ipa_test_kit/generated/v1.0.0/medication_group.rb

@@ -0,0 +1,61 @@
+require_relative 'medication/medication_read_test'
+require_relative 'medication/medication_validation_test'
+require_relative 'medication/medication_must_support_test'
+
+module IpaTestKit
+  module IpaV100
+    class MedicationGroup < Inferno::TestGroup
+      title 'Medication Tests'
+      short_description 'Verify support for the server capabilities required by the IPA-Medication.'
+      description %(
+  # Background
+
+The IPA Medication sequence verifies that the system under test is
+able to provide correct responses for Medication queries. These queries
+must contain resources conforming to the IPA-Medication as
+specified in the IPA v1.0.0 Implementation Guide.
+
+# Testing Methodology
+
+
+## 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 Medication 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-Medication](http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication). 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 :ipa_v100_medication
+      run_as_group
+      input :standalone_smart_credentials,
+            title: 'SMART App Launch Credentials',
+            type: 'oauth_credentials',
+            optional: true
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'medication', 'metadata.yml'), aliases: true))
+      end
+  
+      test from: :ipa_v100_medication_read_test, config: { options: { read_all_resources: true } }
+      test from: :ipa_v100_medication_validation_test
+      test from: :ipa_v100_medication_must_support_test
+    end
+  end
+end

data/lib/ipa_test_kit/generated/v1.0.0/medication_request/medication_request_category_search_test.rb

@@ -0,0 +1,51 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module IpaTestKit
+  module IpaV100
+    class MedicationRequestCategorySearchTest < Inferno::Test
+      include IpaTestKit::SearchTest
+
+      title 'Server returns valid results for MedicationRequest search by category'
+      description %(
+A server SHOULD support searching by
+category on the MedicationRequest resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+If any MedicationRequest resources use external references to
+Medications, the search will be repeated with
+`_include=MedicationRequest:medication`.
+
+# TODO: Fix this
+# [US Core Server CapabilityStatement](http://hl7.org/fhir/us/core//CapabilityStatement-us-core-server.html)
+
+
+      )
+
+      id :ipa_v100_medication_request_category_search_test
+      optional
+  
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'MedicationRequest',
+        search_param_names: ['category'],
+        test_medication_inclusion: true,
+        token_search_params: ['category']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:medication_request_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/ipa_test_kit/generated/v1.0.0/medication_request/medication_request_code_search_test.rb

@@ -0,0 +1,50 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module IpaTestKit
+  module IpaV100
+    class MedicationRequestCodeSearchTest < Inferno::Test
+      include IpaTestKit::SearchTest
+
+      title 'Server returns valid results for MedicationRequest search by code'
+      description %(
+A server SHOULD support searching by
+code on the MedicationRequest resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+If any MedicationRequest resources use external references to
+Medications, the search will be repeated with
+`_include=MedicationRequest:medication`.
+
+# TODO: Fix this
+# [US Core Server CapabilityStatement](http://hl7.org/fhir/us/core//CapabilityStatement-us-core-server.html)
+
+
+      )
+
+      id :ipa_v100_medication_request_code_search_test
+      optional
+  
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'MedicationRequest',
+        search_param_names: ['code'],
+        test_medication_inclusion: true
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:medication_request_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/ipa_test_kit/generated/v1.0.0/medication_request/medication_request_must_support_test.rb

@@ -0,0 +1,52 @@
+require_relative '../../../must_support_test'
+
+module IpaTestKit
+  module IpaV100
+    class MedicationRequestMustSupportTest < Inferno::Test
+      include IpaTestKit::MustSupportTest
+
+      title 'All must support elements are provided in the MedicationRequest resources returned'
+      description %(
+        Responders conforming to a profile in IPA SHALL return a Must Support
+        element if that element is available. This test will look through the
+        MedicationRequest resources found previously for the following must
+        support elements:
+
+        * MedicationRequest.authoredOn
+        * MedicationRequest.dosageInstruction
+        * MedicationRequest.dosageInstruction.text
+        * MedicationRequest.encounter
+        * MedicationRequest.intent
+        * MedicationRequest.medication[x]
+        * MedicationRequest.reported[x]
+        * MedicationRequest.requester
+        * MedicationRequest.status
+        * MedicationRequest.subject
+
+        Note: Responders who cannot store or return a data element tagged as
+        Supported in IPA profiles can still claim conformance to the IPA
+        profiles per the IPA conformance resources.
+      )
+
+      id :ipa_v100_medication_request_must_support_test
+
+      optional
+
+      def resource_type
+        'MedicationRequest'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:medication_request_resources] ||= {}
+      end
+
+      run do
+        perform_must_support_test(all_scratch_resources)
+      end
+    end
+  end
+end

data/lib/ipa_test_kit/generated/v1.0.0/medication_request/medication_request_patient_intent_authoredon_search_test.rb

@@ -0,0 +1,54 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module IpaTestKit
+  module IpaV100
+    class MedicationRequestPatientIntentAuthoredonSearchTest < Inferno::Test
+      include IpaTestKit::SearchTest
+
+      title 'Server returns valid results for MedicationRequest search by patient + intent + authoredon'
+      description %(
+A server SHOULD support searching by
+patient + intent + authoredon on the MedicationRequest resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+If any MedicationRequest resources use external references to
+Medications, the search will be repeated with
+`_include=MedicationRequest:medication`.
+
+# TODO: Fix this
+# [US Core Server CapabilityStatement](http://hl7.org/fhir/us/core//CapabilityStatement-us-core-server.html)
+
+
+      )
+
+      id :ipa_v100_medication_request_patient_intent_authoredon_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: 'MedicationRequest',
+        search_param_names: ['patient', 'intent', 'authoredon'],
+        test_medication_inclusion: true
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:medication_request_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end