us_core_test_kit 0.1.0 → 0.2.1

data/lib/us_core_test_kit/generated/v3.1.1/encounter/metadata.yml

@@ -0,0 +1,384 @@
+---
+:name: us_core_encounter
+:class_name: USCorev311EncounterSequence
+:version: v3.1.1
+:reformatted_version: v311
+:resource: Encounter
+:profile_url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter
+:profile_name: US Core Encounter Profile
+:title: Encounter
+:short_description: Verify support for the server capabilities required by the US
+  Core Encounter 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
+- :names:
+  - _id
+  :expectation: SHALL
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :names:
+  - identifier
+  :expectation: SHOULD
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHOULD
+  :names:
+  - class
+  - patient
+  :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
+- :expectation: SHOULD
+  :names:
+  - patient
+  - type
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHALL
+  :names:
+  - date
+  - patient
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+:search_definitions:
+  :_id:
+    :paths:
+    - id
+    :full_paths:
+    - Encounter.id
+    :comparators: {}
+    :values: []
+    :type: http://hl7.org/fhirpath/System.String
+    :contains_multiple: false
+    :multiple_or: MAY
+  :identifier:
+    :paths:
+    - identifier
+    :full_paths:
+    - Encounter.identifier
+    :comparators: {}
+    :values: []
+    :type: Identifier
+    :contains_multiple: true
+    :multiple_or: MAY
+  :patient:
+    :paths:
+    - subject
+    :full_paths:
+    - Encounter.subject
+    :comparators: {}
+    :values: []
+    :type: Reference
+    :contains_multiple: false
+    :multiple_or: MAY
+  :class:
+    :paths:
+    - class
+    :full_paths:
+    - Encounter.class
+    :comparators: {}
+    :values:
+    - AMB
+    - EMER
+    - FLD
+    - HH
+    - IMP
+    - ACUTE
+    - NONAC
+    - OBSENC
+    - PRENC
+    - SS
+    - VR
+    :type: Coding
+    :contains_multiple: false
+    :multiple_or: MAY
+  :status:
+    :paths:
+    - status
+    :full_paths:
+    - Encounter.status
+    :comparators: {}
+    :values:
+    - planned
+    - arrived
+    - triaged
+    - in-progress
+    - onleave
+    - finished
+    - cancelled
+    - entered-in-error
+    - unknown
+    :type: code
+    :contains_multiple: false
+    :multiple_or: MAY
+  :type:
+    :paths:
+    - type
+    :full_paths:
+    - Encounter.type
+    :comparators: {}
+    :values:
+    - ADMS
+    - BD/BM-clin
+    - CCS60
+    - OKI
+    :type: CodeableConcept
+    :contains_multiple: true
+    :multiple_or: MAY
+  :date:
+    :paths:
+    - period
+    :full_paths:
+    - Encounter.period
+    :comparators:
+      :eq: MAY
+      :ne: MAY
+      :gt: SHALL
+      :ge: SHALL
+      :lt: SHALL
+      :le: SHALL
+      :sa: MAY
+      :eb: MAY
+      :ap: MAY
+    :values: []
+    :type: Period
+    :contains_multiple: false
+    :multiple_or: MAY
+:include_params: []
+:revincludes:
+- Provenance:target
+:required_concepts: []
+:must_supports:
+  :extensions: []
+  :slices: []
+  :elements:
+  - :path: identifier
+  - :path: identifier.system
+  - :path: identifier.value
+  - :path: status
+  - :path: class
+  - :path: type
+  - :path: subject
+    :types:
+    - Reference
+  - :path: participant
+  - :path: participant.type
+  - :path: participant.period
+  - :path: participant.individual
+    :types:
+    - Reference
+  - :path: period
+  - :path: reasonCode
+  - :path: hospitalization
+  - :path: hospitalization.dischargeDisposition
+  - :path: location
+  - :path: location.location
+    :types:
+    - Reference
+:mandatory_elements:
+- Encounter.identifier.system
+- Encounter.identifier.value
+- Encounter.status
+- Encounter.statusHistory.status
+- Encounter.statusHistory.period
+- Encounter.class
+- Encounter.classHistory.class
+- Encounter.classHistory.period
+- Encounter.type
+- Encounter.subject
+- Encounter.diagnosis.condition
+- Encounter.location.location
+: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/encounter-status
+  :path: status
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/encounter-status
+  :path: statusHistory.status
+- :type: Coding
+  :strength: extensible
+  :system: http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
+  :path: class
+- :type: Coding
+  :strength: extensible
+  :system: http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
+  :path: classHistory.class
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type
+  :path: type
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/service-type
+  :path: serviceType
+- :type: CodeableConcept
+  :strength: example
+  :system: http://terminology.hl7.org/ValueSet/v3-ActPriority
+  :path: priority
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/ValueSet/encounter-participant-type
+  :path: participant.type
+- :type: CodeableConcept
+  :strength: preferred
+  :system: http://hl7.org/fhir/ValueSet/encounter-reason
+  :path: reasonCode
+- :type: CodeableConcept
+  :strength: preferred
+  :system: http://hl7.org/fhir/ValueSet/diagnosis-role
+  :path: diagnosis.use
+- :type: CodeableConcept
+  :strength: preferred
+  :system: http://hl7.org/fhir/ValueSet/encounter-admit-source
+  :path: hospitalization.admitSource
+- :type: CodeableConcept
+  :strength: example
+  :system: http://terminology.hl7.org/ValueSet/v2-0092
+  :path: hospitalization.reAdmission
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/encounter-diet
+  :path: hospitalization.dietPreference
+- :type: CodeableConcept
+  :strength: preferred
+  :system: http://hl7.org/fhir/ValueSet/encounter-special-courtesy
+  :path: hospitalization.specialCourtesy
+- :type: CodeableConcept
+  :strength: preferred
+  :system: http://hl7.org/fhir/ValueSet/encounter-special-arrangements
+  :path: hospitalization.specialArrangement
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/encounter-discharge-disposition
+  :path: hospitalization.dischargeDisposition
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/encounter-location-status
+  :path: location.status
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/location-physical-type
+  :path: location.physicalType
+:references:
+- :path: Encounter.identifier.assigner
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Encounter.subject
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
+- :path: Encounter.episodeOfCare
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/EpisodeOfCare
+- :path: Encounter.basedOn
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/ServiceRequest
+- :path: Encounter.participant.individual
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
+- :path: Encounter.appointment
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Appointment
+- :path: Encounter.reasonReference
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Condition
+  - http://hl7.org/fhir/StructureDefinition/Procedure
+  - http://hl7.org/fhir/StructureDefinition/Observation
+  - http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation
+- :path: Encounter.diagnosis.condition
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Condition
+  - http://hl7.org/fhir/StructureDefinition/Procedure
+- :path: Encounter.account
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Account
+- :path: Encounter.hospitalization.origin
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Location
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Encounter.hospitalization.destination
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Location
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Encounter.location.location
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Location
+- :path: Encounter.serviceProvider
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Encounter.partOf
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Encounter
+:tests:
+- :id: us_core_v311_encounter_read_test
+  :file_name: encounter_read_test.rb
+- :id: us_core_v311_encounter_patient_search_test
+  :file_name: encounter_patient_search_test.rb
+- :id: us_core_v311_encounter__id_search_test
+  :file_name: encounter_id_search_test.rb
+- :id: us_core_v311_encounter_identifier_search_test
+  :file_name: encounter_identifier_search_test.rb
+- :id: us_core_v311_encounter_class_patient_search_test
+  :file_name: encounter_class_patient_search_test.rb
+- :id: us_core_v311_encounter_patient_status_search_test
+  :file_name: encounter_patient_status_search_test.rb
+- :id: us_core_v311_encounter_patient_type_search_test
+  :file_name: encounter_patient_type_search_test.rb
+- :id: us_core_v311_encounter_date_patient_search_test
+  :file_name: encounter_date_patient_search_test.rb
+- :id: us_core_v311_encounter_provenance_revinclude_search_test
+  :file_name: encounter_provenance_revinclude_search_test.rb
+- :id: us_core_v311_encounter_validation_test
+  :file_name: encounter_validation_test.rb
+- :id: us_core_v311_encounter_must_support_test
+  :file_name: encounter_must_support_test.rb
+- :id: us_core_v311_encounter_reference_resolution_test
+  :file_name: encounter_reference_resolution_test.rb
+:id: us_core_v311_encounter
+:file_name: encounter_group.rb
+:delayed_references:
+- :path: participant.individual
+  :resources:
+  - Practitioner

data/lib/us_core_test_kit/generated/v3.1.1/encounter_group.rb

@@ -0,0 +1,100 @@
+require_relative 'encounter/encounter_read_test'
+require_relative 'encounter/encounter_patient_search_test'
+require_relative 'encounter/encounter_id_search_test'
+require_relative 'encounter/encounter_identifier_search_test'
+require_relative 'encounter/encounter_class_patient_search_test'
+require_relative 'encounter/encounter_patient_status_search_test'
+require_relative 'encounter/encounter_patient_type_search_test'
+require_relative 'encounter/encounter_date_patient_search_test'
+require_relative 'encounter/encounter_provenance_revinclude_search_test'
+require_relative 'encounter/encounter_validation_test'
+require_relative 'encounter/encounter_must_support_test'
+require_relative 'encounter/encounter_reference_resolution_test'
+
+module USCoreTestKit
+  module USCoreV311
+    class EncounterGroup < Inferno::TestGroup
+      title 'Encounter Tests'
+      short_description 'Verify support for the server capabilities required by the US Core Encounter Profile.'
+      description %(
+  # Background
+
+The US Core Encounter sequence verifies that the system under test is
+able to provide correct responses for Encounter queries. These queries
+must contain resources conforming to the US Core Encounter Profile as
+specified in the US Core v3.1.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:
+
+* patient
+* _id
+* date + 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
+Encounter 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 Encounter 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 Encounter Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter). 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_v311_encounter
+      run_as_group
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'encounter', 'metadata.yml')))
+      end
+  
+      test from: :us_core_v311_encounter_read_test
+      test from: :us_core_v311_encounter_patient_search_test
+      test from: :us_core_v311_encounter__id_search_test
+      test from: :us_core_v311_encounter_identifier_search_test
+      test from: :us_core_v311_encounter_class_patient_search_test
+      test from: :us_core_v311_encounter_patient_status_search_test
+      test from: :us_core_v311_encounter_patient_type_search_test
+      test from: :us_core_v311_encounter_date_patient_search_test
+      test from: :us_core_v311_encounter_provenance_revinclude_search_test
+      test from: :us_core_v311_encounter_validation_test
+      test from: :us_core_v311_encounter_must_support_test
+      test from: :us_core_v311_encounter_reference_resolution_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v3.1.1/goal/goal_must_support_test.rb

@@ -0,0 +1,41 @@
+require_relative '../../../must_support_test'
+
+module USCoreTestKit
+  module USCoreV311
+    class GoalMustSupportTest < Inferno::Test
+      include USCoreTestKit::MustSupportTest
+
+      title 'All must support elements are provided in the Goal 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 Goal resources
+        found previously for the following must support elements:
+
+        * Goal.description
+        * Goal.lifecycleStatus
+        * Goal.subject
+        * Goal.target
+        * Goal.target.due[x]:dueDate
+      )
+
+      id :us_core_v311_goal_must_support_test
+
+      def resource_type
+        'Goal'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+      end
+
+      def scratch_resources
+        scratch[:goal_resources] ||= {}
+      end
+
+      run do
+        perform_must_support_test(all_scratch_resources)
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v3.1.1/goal/goal_patient_lifecycle_status_search_test.rb

@@ -0,0 +1,47 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV311
+    class GoalPatientLifecycleStatusSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Goal search by patient + lifecycle-status'
+      description %(
+A server SHOULD support searching by
+patient + lifecycle-status on the Goal 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/STU3.1.1/CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v311_goal_patient_lifecycle_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: 'Goal',
+        search_param_names: ['patient', 'lifecycle-status']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+      end
+
+      def scratch_resources
+        scratch[:goal_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v3.1.1/goal/goal_patient_search_test.rb

@@ -0,0 +1,62 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV311
+    class GoalPatientSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Goal search by patient'
+      description %(
+A server SHALL support searching by
+patient on the Goal 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. US
+Core requires that both forms are supported by US Core 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 US Core v3.1.1.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v311_goal_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: 'Goal',
+        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[:goal_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v3.1.1/goal/goal_patient_target_date_search_test.rb

@@ -0,0 +1,49 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV311
+    class GoalPatientTargetDateSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Goal search by patient + target-date'
+      description %(
+A server SHOULD support searching by
+patient + target-date on the Goal 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/STU3.1.1/CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v311_goal_patient_target_date_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: 'Goal',
+        search_param_names: ['patient', 'target-date'],
+        possible_status_search: true,
+        params_with_comparators: ['target-date']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+      end
+
+      def scratch_resources
+        scratch[:goal_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end