us_core_test_kit 0.5.0 → 0.6.0

data/lib/us_core_test_kit/generated/v6.1.0/care_plan/metadata.yml

@@ -0,0 +1,278 @@
+---
+:name: us_core_careplan
+:class_name: USCorev610CareplanSequence
+:version: v6.1.0
+:reformatted_version: v610
+:resource: CarePlan
+:profile_url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan
+:profile_name: US Core CarePlan Profile
+:profile_version: 6.1.0
+:title: CarePlan
+:short_description: Verify support for the server capabilities required by the US
+  Core CarePlan 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:
+- :expectation: SHALL
+  :names:
+  - patient
+  - category
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHOULD
+  :names:
+  - patient
+  - category
+  - status
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHOULD
+  :names:
+  - patient
+  - category
+  - status
+  - date
+  :names_not_must_support_or_mandatory:
+  - date
+  :must_support_or_mandatory: false
+- :expectation: SHOULD
+  :names:
+  - patient
+  - category
+  - date
+  :names_not_must_support_or_mandatory:
+  - date
+  :must_support_or_mandatory: false
+:search_definitions:
+  :patient:
+    :paths:
+    - subject
+    :full_paths:
+    - CarePlan.subject
+    :comparators: {}
+    :values: []
+    :type: Reference
+    :contains_multiple: false
+    :multiple_or: MAY
+  :category:
+    :paths:
+    - category
+    :full_paths:
+    - CarePlan.category
+    :comparators: {}
+    :values:
+    - assess-plan
+    :type: CodeableConcept
+    :contains_multiple: true
+    :multiple_or: MAY
+  :status:
+    :paths:
+    - status
+    :full_paths:
+    - CarePlan.status
+    :comparators: {}
+    :values:
+    - draft
+    - active
+    - on-hold
+    - revoked
+    - completed
+    - entered-in-error
+    - unknown
+    :type: code
+    :contains_multiple: false
+    :multiple_or: SHALL
+  :date:
+    :paths:
+    - period
+    :full_paths:
+    - CarePlan.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:
+  - :name: CarePlan.category:AssessPlan
+    :path: category
+    :discriminator:
+      :type: patternCodeableConcept
+      :path: ''
+      :code: assess-plan
+      :system: http://hl7.org/fhir/us/core/CodeSystem/careplan-category
+  :elements:
+  - :path: text
+  - :path: text.status
+  - :path: text.div
+  - :path: status
+  - :path: intent
+  - :path: category
+  - :path: subject
+    :types:
+    - Reference
+:mandatory_elements:
+- CarePlan.text.status
+- CarePlan.text.div
+- CarePlan.status
+- CarePlan.intent
+- CarePlan.category
+- CarePlan.subject
+- CarePlan.activity.detail.status
+:bindings:
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/us/core/ValueSet/us-core-narrative-status
+  :path: text.status
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/request-status
+  :path: status
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/care-plan-intent
+  :path: intent
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/care-plan-activity-kind
+  :path: activity.detail.kind
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/care-plan-activity-status
+  :path: activity.detail.status
+:references:
+- :path: CarePlan.basedOn
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/CarePlan
+- :path: CarePlan.replaces
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/CarePlan
+- :path: CarePlan.partOf
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/CarePlan
+- :path: CarePlan.subject
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
+- :path: CarePlan.encounter
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Encounter
+- :path: CarePlan.author
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Patient
+  - http://hl7.org/fhir/StructureDefinition/Practitioner
+  - http://hl7.org/fhir/StructureDefinition/PractitionerRole
+  - http://hl7.org/fhir/StructureDefinition/Device
+  - http://hl7.org/fhir/StructureDefinition/RelatedPerson
+  - http://hl7.org/fhir/StructureDefinition/Organization
+  - http://hl7.org/fhir/StructureDefinition/CareTeam
+- :path: CarePlan.contributor
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Patient
+  - http://hl7.org/fhir/StructureDefinition/Practitioner
+  - http://hl7.org/fhir/StructureDefinition/PractitionerRole
+  - http://hl7.org/fhir/StructureDefinition/Device
+  - http://hl7.org/fhir/StructureDefinition/RelatedPerson
+  - http://hl7.org/fhir/StructureDefinition/Organization
+  - http://hl7.org/fhir/StructureDefinition/CareTeam
+- :path: CarePlan.careTeam
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/CareTeam
+- :path: CarePlan.addresses
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Condition
+- :path: CarePlan.supportingInfo
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Resource
+- :path: CarePlan.goal
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Goal
+- :path: CarePlan.activity.outcomeReference
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Resource
+- :path: CarePlan.activity.reference
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Appointment
+  - http://hl7.org/fhir/StructureDefinition/CommunicationRequest
+  - http://hl7.org/fhir/StructureDefinition/DeviceRequest
+  - http://hl7.org/fhir/StructureDefinition/MedicationRequest
+  - http://hl7.org/fhir/StructureDefinition/NutritionOrder
+  - http://hl7.org/fhir/StructureDefinition/Task
+  - http://hl7.org/fhir/StructureDefinition/ServiceRequest
+  - http://hl7.org/fhir/StructureDefinition/VisionPrescription
+  - http://hl7.org/fhir/StructureDefinition/RequestGroup
+- :path: CarePlan.activity.detail.reasonReference
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Condition
+  - http://hl7.org/fhir/StructureDefinition/Observation
+  - http://hl7.org/fhir/StructureDefinition/DiagnosticReport
+  - http://hl7.org/fhir/StructureDefinition/DocumentReference
+- :path: CarePlan.activity.detail.goal
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Goal
+- :path: CarePlan.activity.detail.location
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Location
+- :path: CarePlan.activity.detail.performer
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Practitioner
+  - http://hl7.org/fhir/StructureDefinition/PractitionerRole
+  - http://hl7.org/fhir/StructureDefinition/Organization
+  - http://hl7.org/fhir/StructureDefinition/RelatedPerson
+  - http://hl7.org/fhir/StructureDefinition/Patient
+  - http://hl7.org/fhir/StructureDefinition/CareTeam
+  - http://hl7.org/fhir/StructureDefinition/HealthcareService
+  - http://hl7.org/fhir/StructureDefinition/Device
+:tests:
+- :id: us_core_v610_care_plan_patient_category_search_test
+  :file_name: care_plan_patient_category_search_test.rb
+- :id: us_core_v610_care_plan_patient_category_status_search_test
+  :file_name: care_plan_patient_category_status_search_test.rb
+- :id: us_core_v610_care_plan_patient_category_status_date_search_test
+  :file_name: care_plan_patient_category_status_date_search_test.rb
+- :id: us_core_v610_care_plan_patient_category_date_search_test
+  :file_name: care_plan_patient_category_date_search_test.rb
+- :id: us_core_v610_care_plan_read_test
+  :file_name: care_plan_read_test.rb
+- :id: us_core_v610_care_plan_provenance_revinclude_search_test
+  :file_name: care_plan_provenance_revinclude_search_test.rb
+- :id: us_core_v610_care_plan_validation_test
+  :file_name: care_plan_validation_test.rb
+- :id: us_core_v610_care_plan_must_support_test
+  :file_name: care_plan_must_support_test.rb
+- :id: us_core_v610_care_plan_reference_resolution_test
+  :file_name: care_plan_reference_resolution_test.rb
+:id: us_core_v610_care_plan
+:file_name: care_plan_group.rb
+:delayed_references: []

data/lib/us_core_test_kit/generated/v6.1.0/care_plan_group.rb

@@ -0,0 +1,92 @@
+require_relative 'care_plan/care_plan_patient_category_search_test'
+require_relative 'care_plan/care_plan_patient_category_status_search_test'
+require_relative 'care_plan/care_plan_patient_category_status_date_search_test'
+require_relative 'care_plan/care_plan_patient_category_date_search_test'
+require_relative 'care_plan/care_plan_read_test'
+require_relative 'care_plan/care_plan_provenance_revinclude_search_test'
+require_relative 'care_plan/care_plan_validation_test'
+require_relative 'care_plan/care_plan_must_support_test'
+require_relative 'care_plan/care_plan_reference_resolution_test'
+
+module USCoreTestKit
+  module USCoreV610
+    class CarePlanGroup < Inferno::TestGroup
+      title 'CarePlan Tests'
+      short_description 'Verify support for the server capabilities required by the US Core CarePlan Profile.'
+      description %(
+  # Background
+
+The US Core CarePlan sequence verifies that the system under test is
+able to provide correct responses for CarePlan queries. These queries
+must contain resources conforming to the US Core CarePlan Profile as
+specified in the US Core v6.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 + category
+
+### 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
+CarePlan 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 CarePlan 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 CarePlan Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan). 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_v610_care_plan
+      run_as_group
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'care_plan', 'metadata.yml'), aliases: true))
+      end
+  
+      test from: :us_core_v610_care_plan_patient_category_search_test
+      test from: :us_core_v610_care_plan_patient_category_status_search_test
+      test from: :us_core_v610_care_plan_patient_category_status_date_search_test
+      test from: :us_core_v610_care_plan_patient_category_date_search_test
+      test from: :us_core_v610_care_plan_read_test
+      test from: :us_core_v610_care_plan_provenance_revinclude_search_test
+      test from: :us_core_v610_care_plan_validation_test
+      test from: :us_core_v610_care_plan_must_support_test
+      test from: :us_core_v610_care_plan_reference_resolution_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v6.1.0/care_team/care_team_must_support_test.rb

@@ -0,0 +1,41 @@
+require_relative '../../../must_support_test'
+
+module USCoreTestKit
+  module USCoreV610
+    class CareTeamMustSupportTest < Inferno::Test
+      include USCoreTestKit::MustSupportTest
+
+      title 'All must support elements are provided in the CareTeam 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 CareTeam resources
+        found previously for the following must support elements:
+
+        * CareTeam.participant
+        * CareTeam.participant.member
+        * CareTeam.participant.role
+        * CareTeam.status
+        * CareTeam.subject
+      )
+
+      id :us_core_v610_care_team_must_support_test
+
+      def resource_type
+        'CareTeam'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:care_team_resources] ||= {}
+      end
+
+      run do
+        perform_must_support_test(all_scratch_resources)
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v6.1.0/care_team/care_team_patient_role_search_test.rb

@@ -0,0 +1,49 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV610
+    class CareTeamPatientRoleSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for CareTeam search by patient + role'
+      description %(
+A server SHOULD support searching by
+patient + role on the CareTeam resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core//CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v610_care_team_patient_role_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: 'CareTeam',
+        search_param_names: ['patient', 'role'],
+        possible_status_search: true,
+        token_search_params: ['role']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:care_team_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v6.1.0/care_team/care_team_patient_status_search_test.rb

@@ -0,0 +1,63 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV610
+    class CareTeamPatientStatusSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for CareTeam search by patient + status'
+      description %(
+A server SHALL support searching by
+patient + status on the CareTeam 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 v6.1.0.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core//CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v610_care_team_patient_status_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: 'CareTeam',
+        search_param_names: ['patient', 'status'],
+        saves_delayed_references: 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'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:care_team_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v6.1.0/care_team/care_team_provenance_revinclude_search_test.rb

@@ -0,0 +1,52 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV610
+    class CareTeamProvenanceRevincludeSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns Provenance resources from CareTeam search by patient + status + revInclude:Provenance:target'
+      description %(
+        A server SHALL be capable of supporting _revIncludes:Provenance:target.
+
+        This test will perform a search by patient + status + revInclude:Provenance:target and
+        will pass if a Provenance resource is found in the response.
+      %)
+
+      id :us_core_v610_care_team_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(
+          fixed_value_search: true,
+        resource_type: 'CareTeam',
+        search_param_names: ['patient', 'status']
+        )
+      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'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:care_team_resources] ||= {}
+      end
+
+      def scratch_provenance_resources
+        scratch[:provenance_resources] ||= {}
+      end
+
+      run do
+        run_provenance_revinclude_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v6.1.0/care_team/care_team_read_test.rb

@@ -0,0 +1,26 @@
+require_relative '../../../read_test'
+
+module USCoreTestKit
+  module USCoreV610
+    class CareTeamReadTest < Inferno::Test
+      include USCoreTestKit::ReadTest
+
+      title 'Server returns correct CareTeam resource from CareTeam read interaction'
+      description 'A server SHALL support the CareTeam read interaction.'
+
+      id :us_core_v610_care_team_read_test
+
+      def resource_type
+        'CareTeam'
+      end
+
+      def scratch_resources
+        scratch[:care_team_resources] ||= {}
+      end
+
+      run do
+        perform_read_test(all_scratch_resources)
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v6.1.0/care_team/care_team_reference_resolution_test.rb

@@ -0,0 +1,43 @@
+require_relative '../../../reference_resolution_test'
+require_relative '../resource_list'
+
+module USCoreTestKit
+  module USCoreV610
+    class CareTeamReferenceResolutionTest < Inferno::Test
+      include USCoreTestKit::ReferenceResolutionTest
+      include ResourceList
+
+      title 'MustSupport references within CareTeam resources are valid'
+      description %(
+        This test will attempt to read external references provided within elements
+        marked as 'MustSupport', if any are available.
+
+        It verifies that at least one external reference for each MustSupport Reference element
+        can be accessed by the test client, and conforms to corresponding US Core profile.
+
+        Elements which may provide external references include:
+
+        * CareTeam.participant.member
+        * CareTeam.subject
+      )
+
+      id :us_core_v610_care_team_reference_resolution_test
+
+      def resource_type
+        'CareTeam'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:care_team_resources] ||= {}
+      end
+
+      run do
+        perform_reference_resolution_test(scratch_resources[:all])
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v6.1.0/care_team/care_team_role_search_test.rb

@@ -0,0 +1,45 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV610
+    class CareTeamRoleSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for CareTeam search by role'
+      description %(
+A server SHOULD support searching by
+role on the CareTeam resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core//CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v610_care_team_role_search_test
+      optional
+  
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'CareTeam',
+        search_param_names: ['role'],
+        possible_status_search: true,
+        token_search_params: ['role']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:care_team_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end