ipa_test_kit 0.2.0

data/lib/ipa_test_kit/generated/immunization/immunization_reference_resolution_test.rb

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

data/lib/ipa_test_kit/generated/immunization/immunization_validation_test.rb

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

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

@@ -0,0 +1,210 @@
+---
+:name: ipa_immunization
+:class_name: Ipav010ImmunizationSequence
+:version: v0.1.0
+:reformatted_version: v010
+:resource: Immunization
+:profile_url: http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization
+:profile_name: IPA Immunization Profile
+:title: Immunization
+:short_description: Verify support for the server capabilities required by the IPA
+  Immunization 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:
+  - patient
+  :expectation: SHALL
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHOULD
+  :names:
+  - patient
+  - date
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHOULD
+  :names:
+  - patient
+  - status
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+:search_definitions:
+  :patient:
+    :path: patient
+    :full_path: Immunization.patient
+    :comparators: {}
+    :values: []
+    :type: Reference
+    :contains_multiple: false
+    :multiple_or: MAY
+  :date:
+    :path: occurrence
+    :full_path: Immunization.occurrence
+    :comparators:
+      :eq: MAY
+      :ne: MAY
+      :gt: SHALL
+      :ge: SHALL
+      :lt: SHALL
+      :le: SHALL
+      :sa: MAY
+      :eb: MAY
+      :ap: MAY
+    :values: []
+    :type: date
+    :contains_multiple: false
+    :multiple_or: MAY
+  :status:
+    :path: status
+    :full_path: Immunization.status
+    :comparators: {}
+    :values:
+    - completed
+    - entered-in-error
+    - not-done
+    :type: code
+    :contains_multiple: false
+    :multiple_or: MAY
+:include_params: []
+:revincludes:
+- Provenance:target
+:required_concepts: []
+:must_supports:
+  :extensions: []
+  :slices: []
+  :elements:
+  - :path: status
+  - :path: statusReason
+  - :path: vaccineCode
+  - :path: patient
+  - :path: occurrence[x]
+  - :path: primarySource
+:mandatory_elements:
+- Immunization.status
+- Immunization.vaccineCode
+- Immunization.patient
+- Immunization.occurrence[x]
+- Immunization.primarySource
+- Immunization.performer.actor
+- Immunization.protocolApplied.doseNumber[x]
+:bindings:
+- :type: code
+  :strength: preferred
+  :system: http://hl7.org/fhir/ValueSet/languages
+  :path: language
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/immunization-status
+  :path: status
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/immunization-status-reason
+  :path: statusReason
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/uv/ipa/ValueSet/ipa-vaccines-cvx
+  :path: vaccineCode
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/immunization-origin
+  :path: reportOrigin
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/immunization-site
+  :path: site
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/immunization-route
+  :path: route
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/ValueSet/immunization-function
+  :path: performer.function
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/immunization-reason
+  :path: reasonCode
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
+  :path: subpotentReason
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/immunization-program-eligibility
+  :path: programEligibility
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/immunization-funding-source
+  :path: fundingSource
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/immunization-target-disease
+  :path: protocolApplied.targetDisease
+:references:
+- :path: Immunization.patient
+  :profiles:
+  - http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient
+- :path: Immunization.encounter
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Encounter
+- :path: Immunization.location
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Location
+- :path: Immunization.manufacturer
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Immunization.performer.actor
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Practitioner
+  - http://hl7.org/fhir/StructureDefinition/PractitionerRole
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Immunization.reasonReference
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Condition
+  - http://hl7.org/fhir/StructureDefinition/Observation
+  - http://hl7.org/fhir/StructureDefinition/DiagnosticReport
+- :path: Immunization.reaction.detail
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Observation
+- :path: Immunization.protocolApplied.authority
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Organization
+:tests:
+- :id: ipa_010_immunization_patient_search_test
+  :file_name: immunization_patient_search_test.rb
+- :id: ipa_010_immunization_patient_date_search_test
+  :file_name: immunization_patient_date_search_test.rb
+- :id: ipa_010_immunization_patient_status_search_test
+  :file_name: immunization_patient_status_search_test.rb
+- :id: ipa_010_immunization_read_test
+  :file_name: immunization_read_test.rb
+- :id: ipa_010_immunization_provenance_revinclude_search_test
+  :file_name: immunization_provenance_revinclude_search_test.rb
+- :id: ipa_010_immunization_validation_test
+  :file_name: immunization_validation_test.rb
+- :id: ipa_010_immunization_must_support_test
+  :file_name: immunization_must_support_test.rb
+- :id: ipa_010_immunization_reference_resolution_test
+  :file_name: immunization_reference_resolution_test.rb
+:id: ipa_010_immunization
+:file_name: immunization_group.rb
+:delayed_references: []

data/lib/ipa_test_kit/generated/immunization_group.rb

@@ -0,0 +1,87 @@
+require_relative 'immunization/immunization_patient_search_test'
+require_relative 'immunization/immunization_patient_date_search_test'
+require_relative 'immunization/immunization_patient_status_search_test'
+require_relative 'immunization/immunization_read_test'
+require_relative 'immunization/immunization_provenance_revinclude_search_test'
+require_relative 'immunization/immunization_validation_test'
+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
+
+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.
+
+# 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
+Immunization 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 Immunization 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 Immunization Profile](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
+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_immunization
+    run_as_group
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'immunization', 'metadata.yml')))
+    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/ipa_test_suite.rb

@@ -0,0 +1,88 @@
+require 'inferno/dsl/oauth_credentials'
+require_relative '../version'
+require_relative '../custom_groups/capability_statement_group'
+require_relative 'patient_group'
+require_relative 'allergy_intolerance_group'
+require_relative 'condition_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 'bmi_group'
+require_relative 'oxygensat_group'
+require_relative 'head_circumference_group'
+require_relative 'bodyheight_group'
+require_relative 'bodytemp_group'
+require_relative 'bp_group'
+require_relative 'bodyweight_group'
+require_relative 'heartrate_group'
+require_relative 'resprate_group'
+require_relative 'practitioner_group'
+#require_relative 'practitioner_role_group'
+require_relative 'provenance_group'
+
+module IpaTestKit
+  class IpaTestSuite < Inferno::TestSuite
+    title 'International Patient Access (IPA)'
+    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'))[:groups].map do |raw_metadata|
+          Generator::GroupMetadata.new(raw_metadata)
+        end
+    end
+
+    validator do
+      url ENV.fetch('VALIDATOR_URL', 'http://validator_service:4567')
+      exclude_message do |message|
+        VALIDATION_MESSAGE_FILTERS.any? { |filter| filter.match? message.message }
+      end
+    end
+
+    id :ipa_010
+
+    input :url,
+      title: 'FHIR Endpoint',
+      description: 'URL of the FHIR endpoint'
+    input :smart_credentials,
+      title: 'OAuth Credentials',
+      type: :oauth_credentials,
+      optional: true
+
+    fhir_client do
+      url :url
+      oauth_credentials :smart_credentials
+    end
+
+    group from: :ipa_010_capability_statement
+
+    group from: :ipa_010_patient
+    group from: :ipa_010_allergy_intolerance
+    group from: :ipa_010_condition
+    group from: :ipa_010_document_reference
+    group from: :ipa_010_immunization
+    group from: :ipa_010_medication_request
+    group from: :ipa_010_medication_statement
+    group from: :ipa_010_observation
+    group from: :ipa_010_bmi
+    group from: :ipa_010_oxygensat
+    group from: :ipa_010_head_circumference
+    group from: :ipa_010_bodyheight
+    group from: :ipa_010_bodytemp
+    group from: :ipa_010_bp
+    group from: :ipa_010_bodyweight
+    group from: :ipa_010_heartrate
+    group from: :ipa_010_resprate
+    group from: :ipa_010_practitioner
+    # still working on the PractitionerRole tests
+    #group from: :ipa_010_practitioner_role
+    group from: :ipa_010_provenance
+  end
+end

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

@@ -0,0 +1,44 @@
+require_relative '../../must_support_test'
+
+module IpaTestKit
+  class MedicationRequestMustSupportTest < Inferno::Test
+    include IpaTestKit::MustSupportTest
+
+    title 'All must support elements are provided in the MedicationRequest 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 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
+    )
+
+    id :ipa_010_medication_request_must_support_test
+
+    def resource_type
+      'MedicationRequest'
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:medication_request_resources] ||= {}
+    end
+
+    run do
+      perform_must_support_test(all_scratch_resources)
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module IpaTestKit
+  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`.
+
+[IPA Server CapabilityStatement](https://build.fhir.org/ig/HL7/fhir-ipa/CapabilityStatement-ipa-server.html)
+
+    )
+
+    id :ipa_010_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'],
+        possible_status_search: true,
+        test_medication_inclusion_mr: true,
+        params_with_comparators: ['authoredon'],
+        multiple_or_search_params: ['intent']
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:medication_request_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/ipa_test_kit/generated/medication_request/medication_request_patient_intent_encounter_search_test.rb

@@ -0,0 +1,52 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module IpaTestKit
+  class MedicationRequestPatientIntentEncounterSearchTest < Inferno::Test
+    include IpaTestKit::SearchTest
+
+    title 'Server returns valid results for MedicationRequest search by patient + intent + encounter'
+    description %(
+A server SHOULD support searching by
+patient + intent + encounter 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`.
+
+[IPA Server CapabilityStatement](https://build.fhir.org/ig/HL7/fhir-ipa/CapabilityStatement-ipa-server.html)
+
+    )
+
+    id :ipa_010_medication_request_patient_intent_encounter_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', 'encounter'],
+        possible_status_search: true,
+        test_medication_inclusion_mr: true,
+        multiple_or_search_params: ['intent']
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:medication_request_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/ipa_test_kit/generated/medication_request/medication_request_patient_intent_search_test.rb

@@ -0,0 +1,68 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module IpaTestKit
+  class MedicationRequestPatientIntentSearchTest < Inferno::Test
+    include IpaTestKit::SearchTest
+
+    title 'Server returns valid results for MedicationRequest search by patient + intent'
+    description %(
+A server SHALL support searching by
+patient + intent 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`.
+
+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_medication_request_patient_intent_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,
+        fixed_value_search: true,
+        resource_type: 'MedicationRequest',
+        search_param_names: ['patient', 'intent'],
+        saves_delayed_references: true,
+        possible_status_search: true,
+        test_medication_inclusion_mr: true,
+        test_reference_variants: true,
+        multiple_or_search_params: ['intent'],
+        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[:medication_request_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end