davinci_plan_net_test_kit 0.10.1 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/config/presets/plan_net_reference_server_v110_preset.json +50 -0
- data/lib/davinci_plan_net_test_kit/custom_groups/reverse_chain_tests/examples.md +17 -0
- data/lib/davinci_plan_net_test_kit/generated/v1.1.0/davinci_plan_net_test_suite.rb +5 -2
- data/lib/davinci_plan_net_test_kit/generator/templates/combination_search_test.rb.erb +49 -0
- data/lib/davinci_plan_net_test_kit/generator/templates/forward_chain_test.rb.erb +51 -0
- data/lib/davinci_plan_net_test_kit/generator/templates/group.rb.erb +24 -0
- data/lib/davinci_plan_net_test_kit/generator/templates/include_search.rb.erb +48 -0
- data/lib/davinci_plan_net_test_kit/generator/templates/must_support.rb.erb +41 -0
- data/lib/davinci_plan_net_test_kit/generator/templates/read.rb.erb +26 -0
- data/lib/davinci_plan_net_test_kit/generator/templates/reference_resolution.rb.erb +42 -0
- data/lib/davinci_plan_net_test_kit/generator/templates/resource_list.rb.erb +9 -0
- data/lib/davinci_plan_net_test_kit/generator/templates/reverse_chain_search.rb.erb +57 -0
- data/lib/davinci_plan_net_test_kit/generator/templates/revinclude_search.rb.erb +55 -0
- data/lib/davinci_plan_net_test_kit/generator/templates/search.rb.erb +40 -0
- data/lib/davinci_plan_net_test_kit/generator/templates/search_no_params.rb.erb +45 -0
- data/lib/davinci_plan_net_test_kit/generator/templates/suite.rb.erb +222 -0
- data/lib/davinci_plan_net_test_kit/generator/templates/validation.rb.erb +31 -0
- data/lib/davinci_plan_net_test_kit/igs/Plan Net Requirements Interpretation.xlsx +0 -0
- data/lib/davinci_plan_net_test_kit/igs/README.md +21 -0
- data/lib/davinci_plan_net_test_kit/metadata.rb +64 -0
- data/lib/davinci_plan_net_test_kit/search_test.rb +12 -60
- data/lib/davinci_plan_net_test_kit/version.rb +2 -1
- data/lib/davinci_plan_net_test_kit.rb +1 -0
- metadata +30 -10
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 284f80361ea70304f59670f152adaba45e1e6026cbdb9df95ba1eef7479d6e7b
|
4
|
+
data.tar.gz: 52e2e45f8f4073626120329c4dad4997560d1302b644912a16b8b2d50c2d191f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 13ba9cb7712b0d9e47d3a3a243e8b282ec1e35c517913a7236690b0adc83019596ec164a7a2c656eb8fdd931c1ddb043d46ee236101d04a26e014e4d833c7170
|
7
|
+
data.tar.gz: a8591a443304870bcb41d38e6354ef21c161272bd25c088b750a29a8e90179d2e577207770578f20e00f4dd89691f27bf6d718a73ece5d3f5e5a198dcaedc482
|
@@ -0,0 +1,50 @@
|
|
1
|
+
{
|
2
|
+
"title": "Da Vinci PDEX Plan Net Reference Server",
|
3
|
+
"id": "davinci_plan_net_reference_server_v110",
|
4
|
+
"test_suite_id": "davinci_plan_net_server_v110",
|
5
|
+
"inputs": [
|
6
|
+
{
|
7
|
+
"name": "url",
|
8
|
+
"description": "URL of the FHIR endpoint",
|
9
|
+
"title": "FHIR Endpoint",
|
10
|
+
"type": "text",
|
11
|
+
"value": "https://plan-net-ri.davinci.hl7.org/fhir"
|
12
|
+
},
|
13
|
+
{
|
14
|
+
"name": "no_param_search",
|
15
|
+
"default": "true",
|
16
|
+
"description": "If No, then the lists of ids by profile are required. If yes, the lists of ids by profile are optional.",
|
17
|
+
"options": {
|
18
|
+
"list_options": [
|
19
|
+
{
|
20
|
+
"label": "Yes",
|
21
|
+
"value": "true"
|
22
|
+
},
|
23
|
+
{
|
24
|
+
"label": "No",
|
25
|
+
"value": "false"
|
26
|
+
}
|
27
|
+
]
|
28
|
+
},
|
29
|
+
"title": "Use parameterless searches to identify instances?",
|
30
|
+
"type": "radio",
|
31
|
+
"value": "true"
|
32
|
+
},
|
33
|
+
{
|
34
|
+
"name": "max_instances",
|
35
|
+
"default": "200",
|
36
|
+
"description": "Only used when parameterless searches are used. A higher number will evaluate more instances in the tests, if they are available. The test will stop looking when the page limit has been reached.",
|
37
|
+
"title": "Maximum number of instances to gather using parameterless searches",
|
38
|
+
"type": "text",
|
39
|
+
"value": "200"
|
40
|
+
},
|
41
|
+
{
|
42
|
+
"name": "max_pages",
|
43
|
+
"default": "20",
|
44
|
+
"description": "Only used when parameterless searches are used. A higher number will evaluate more instances in the tests, if they are available. The test will not consider further pages once the maximum number of instances has been reached.",
|
45
|
+
"title": "Maximum pages of results to consider when using parameterless searches",
|
46
|
+
"type": "text",
|
47
|
+
"value": "20"
|
48
|
+
}
|
49
|
+
]
|
50
|
+
}
|
@@ -0,0 +1,17 @@
|
|
1
|
+
Practitioner:
|
2
|
+
- _has:PractitionerRole:practitioner:location
|
3
|
+
- _has:PractitionerRole:practitioner:network
|
4
|
+
- _has:PractitionerRole:practitioner:speciality
|
5
|
+
- _has:PractitionerRole:practitioner:role
|
6
|
+
|
7
|
+
Organization:
|
8
|
+
- _has:OrganizationAffiliation:participating-organization:location
|
9
|
+
- _has:OrganizationAffiliation:participating-organization:network
|
10
|
+
- _has:OrganizationAffiliation:participating-organization:speciality
|
11
|
+
- _has:InsurancePlan:owned-by:coverage-area
|
12
|
+
|
13
|
+
Location:
|
14
|
+
- _has:InsurancePlan:coverage-area:owned-by
|
15
|
+
|
16
|
+
Network:
|
17
|
+
- _has:PractitionerRole:network:location
|
@@ -135,7 +135,6 @@ module DaVinciPlanNetTestKit
|
|
135
135
|
on the [target profile] referenced in the [reference element] element when run as a single group
|
136
136
|
to identify the value to use when performing the reverse chain search.
|
137
137
|
)
|
138
|
-
version VERSION
|
139
138
|
|
140
139
|
VALIDATION_MESSAGE_FILTERS = [
|
141
140
|
%r{Sub-extension url 'introspect' is not defined by the Extension http://fhir-registry\.smarthealthit\.org/StructureDefinition/oauth-uris},
|
@@ -175,9 +174,13 @@ module DaVinciPlanNetTestKit
|
|
175
174
|
url: 'https://github.com/inferno-framework/davinci-plan-net-test-kit/issues'
|
176
175
|
},
|
177
176
|
{
|
178
|
-
label: 'Source
|
177
|
+
label: 'Open Source',
|
179
178
|
url: 'https://github.com/inferno-framework/davinci-plan-net-test-kit'
|
180
179
|
},
|
180
|
+
{
|
181
|
+
label: 'Download',
|
182
|
+
url: 'https://github.com/inferno-framework/davinci-plan-net-test-kit/releases'
|
183
|
+
},
|
181
184
|
{
|
182
185
|
label: 'Implementation Guide',
|
183
186
|
url: 'https://hl7.org/fhir/us/davinci-pdex-plan-net/STU1.1'
|
@@ -0,0 +1,49 @@
|
|
1
|
+
require_relative '../../../search_test'
|
2
|
+
require_relative '../../../generator/group_metadata'
|
3
|
+
|
4
|
+
module DaVinciPlanNetTestKit
|
5
|
+
module <%= module_name %>
|
6
|
+
class <%= class_name %> < Inferno::Test
|
7
|
+
include DaVinciPlanNetTestKit::SearchTest
|
8
|
+
|
9
|
+
title 'Server capable of combination search, e.g. being able to <%= test_goal %>'
|
10
|
+
description %(
|
11
|
+
A server SHALL support searching with a combination of parameters. <%= test_description %>
|
12
|
+
)
|
13
|
+
|
14
|
+
id :<%= test_id %>
|
15
|
+
|
16
|
+
def properties
|
17
|
+
@properties ||= SearchTestProperties.new(
|
18
|
+
<%= search_test_properties_string %>
|
19
|
+
)
|
20
|
+
end
|
21
|
+
|
22
|
+
<% if optional_input? %>
|
23
|
+
input :<%= input_name %>,
|
24
|
+
title: 'Combination Search Reverse Chain',
|
25
|
+
description: '<%= input_description %>',
|
26
|
+
optional: true
|
27
|
+
<% end %>
|
28
|
+
def self.metadata
|
29
|
+
@metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
|
30
|
+
end
|
31
|
+
|
32
|
+
def self.additional_metadata
|
33
|
+
@additional_metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, '..', '<%= additional_resource_type.underscore.gsub('organization_affiliation', 'org_affil') %>', 'metadata.yml'), aliases: true))
|
34
|
+
end
|
35
|
+
|
36
|
+
def scratch_resources
|
37
|
+
scratch[:<%= profile_identifier %>_resources] ||= {}
|
38
|
+
end
|
39
|
+
|
40
|
+
def scratch_additional_resources
|
41
|
+
scratch[:<%= additional_resource_type.underscore %>_resources] ||= {}
|
42
|
+
end
|
43
|
+
|
44
|
+
run do
|
45
|
+
run_combination_search_test
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
@@ -0,0 +1,51 @@
|
|
1
|
+
require_relative '../../../search_test'
|
2
|
+
require_relative '../../../generator/group_metadata'
|
3
|
+
|
4
|
+
module DaVinciPlanNetTestKit
|
5
|
+
module <%= module_name %>
|
6
|
+
class <%= class_name %> < Inferno::Test
|
7
|
+
include DaVinciPlanNetTestKit::SearchTest
|
8
|
+
|
9
|
+
title 'Server capable of forward chaining with <%= "#{chain_param_base}.#{chain_param}" %>'
|
10
|
+
description %(
|
11
|
+
A server SHALL be capable of supporting chaining for <%= chain_param %> through the search parameter <%= chain_param_base %>
|
12
|
+
for the <%= profile_identifier.capitalize %> profile.
|
13
|
+
|
14
|
+
This test will perform a search with <%= "#{chain_param_base}.#{chain_param}" %> using a value
|
15
|
+
in the <%= "#{chain_param}" %> element on an instance found during _include tests executed
|
16
|
+
previously during this sequence. To validate the returned instances, the test will perform a search
|
17
|
+
on the <%= "#{chained_resource}" %> resource type using the same <%= "#{chain_param}" %> search
|
18
|
+
parameter and value and check that this search contains any instances referenced through the
|
19
|
+
<%= "#{chain_param_base}" %> element of instances returned by the tested search.
|
20
|
+
)
|
21
|
+
|
22
|
+
id :<%= test_id %>
|
23
|
+
|
24
|
+
def properties
|
25
|
+
@properties ||= SearchTestProperties.new(
|
26
|
+
<%= search_test_properties_string %>
|
27
|
+
)
|
28
|
+
end
|
29
|
+
|
30
|
+
def self.metadata
|
31
|
+
@metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
|
32
|
+
end
|
33
|
+
|
34
|
+
def self.additional_metadata
|
35
|
+
@additional_metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, '..', '<%= chained_resource.underscore.gsub('organization_affiliation', 'org_affil') %>', 'metadata.yml'), aliases: true))
|
36
|
+
end
|
37
|
+
|
38
|
+
def scratch_resources
|
39
|
+
scratch[:<%= profile_identifier %>_resources] ||= {}
|
40
|
+
end
|
41
|
+
|
42
|
+
def scratch_additional_resources
|
43
|
+
scratch[:<%= chained_resource.underscore %>_resources] ||= {}
|
44
|
+
end
|
45
|
+
|
46
|
+
run do
|
47
|
+
run_forward_chain_search_test
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
<% test_file_list.each do |file_name| %>require_relative '<%= file_name %>'
|
2
|
+
<% end %>
|
3
|
+
module DaVinciPlanNetTestKit
|
4
|
+
module <%= module_name %>
|
5
|
+
class <%= class_name %> < Inferno::TestGroup
|
6
|
+
title '<%= title %> Tests'
|
7
|
+
short_description '<%= short_description %>'
|
8
|
+
description %(
|
9
|
+
<%= description %>
|
10
|
+
)
|
11
|
+
|
12
|
+
id :<%= group_id %>
|
13
|
+
run_as_group<% if optional? %>
|
14
|
+
optional
|
15
|
+
<% end %>
|
16
|
+
|
17
|
+
def self.metadata
|
18
|
+
@metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, '<%= profile_identifier %>', 'metadata.yml'), aliases: true))
|
19
|
+
end
|
20
|
+
<% test_id_list.each do |id| %>
|
21
|
+
test from: :<%= id %><% end %>
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
@@ -0,0 +1,48 @@
|
|
1
|
+
require_relative '../../../search_test'
|
2
|
+
require_relative '../../../generator/group_metadata'
|
3
|
+
|
4
|
+
module DaVinciPlanNetTestKit
|
5
|
+
module <%= module_name %>
|
6
|
+
class <%= class_name %> < Inferno::Test
|
7
|
+
include DaVinciPlanNetTestKit::SearchTest
|
8
|
+
|
9
|
+
title 'Server returns <%= include_param_resource %> resources from <%= resource_type %> search with <%= include_param_string %>'
|
10
|
+
description %(
|
11
|
+
A server SHALL be capable of supporting _includes on search parameter <%= include_param %>.
|
12
|
+
|
13
|
+
This test will perform a search on <%= resource_type %> with <%= include_param_string %>
|
14
|
+
and the '_id' search parameter using an id with a reference to <%= a_or_an(include_param_resource) %>
|
15
|
+
identified during instance gathering. The test will pass if at least one <%= include_param_resource %>
|
16
|
+
resource is found in the response and each instance that does is referenced by a returned <%= resource_type %> instance.
|
17
|
+
)
|
18
|
+
|
19
|
+
id :<%= test_id %>
|
20
|
+
|
21
|
+
def properties
|
22
|
+
@properties ||= SearchTestProperties.new(
|
23
|
+
<%= search_test_properties_string %>
|
24
|
+
)
|
25
|
+
end
|
26
|
+
|
27
|
+
def self.metadata
|
28
|
+
@metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
|
29
|
+
end
|
30
|
+
|
31
|
+
def self.additional_metadata
|
32
|
+
@additional_metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, '..', '<%= include_param_resource.underscore.gsub('organization_affiliation', 'org_affil') %>', 'metadata.yml'), aliases: true))
|
33
|
+
end
|
34
|
+
|
35
|
+
def scratch_resources
|
36
|
+
scratch[:<%= profile_identifier %>_resources] ||= {}
|
37
|
+
end
|
38
|
+
|
39
|
+
def scratch_additional_resources
|
40
|
+
scratch[:<%= include_param_resource.underscore %>_resources] ||= {}
|
41
|
+
end
|
42
|
+
|
43
|
+
run do
|
44
|
+
run_include_search_test
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
@@ -0,0 +1,41 @@
|
|
1
|
+
require_relative '../../../must_support_test'
|
2
|
+
|
3
|
+
module DaVinciPlanNetTestKit
|
4
|
+
module <%= module_name %>
|
5
|
+
class <%= class_name %> < Inferno::Test
|
6
|
+
include DaVinciPlanNetTestKit::MustSupportTest
|
7
|
+
|
8
|
+
title 'All must support elements are provided in the <%= resource_type %> resources returned'
|
9
|
+
description %(
|
10
|
+
Plan Net Responders SHALL be capable of populating all data elements as
|
11
|
+
part of the query results as specified by the Plan Net Server Capability
|
12
|
+
Statement. This test will look through the <%= resource_type %> resources
|
13
|
+
found previously for the following must support elements:
|
14
|
+
|
15
|
+
<%= must_support_list_string %><% if uscdi_list_string.present? %>
|
16
|
+
|
17
|
+
For ONC USCDI requirements, each <%= resource_type %> must support the following additional elements:
|
18
|
+
|
19
|
+
<%= uscdi_list_string %><% end %>
|
20
|
+
)
|
21
|
+
|
22
|
+
id :<%= test_id %>
|
23
|
+
|
24
|
+
def resource_type
|
25
|
+
'<%= resource_type %>'
|
26
|
+
end
|
27
|
+
|
28
|
+
def self.metadata
|
29
|
+
@metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
|
30
|
+
end
|
31
|
+
|
32
|
+
def scratch_resources
|
33
|
+
scratch[:<%= profile_identifier %>_resources] ||= {}
|
34
|
+
end
|
35
|
+
|
36
|
+
run do
|
37
|
+
perform_must_support_test(<%= resource_collection_string %>)
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
41
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
require_relative '../../../read_test'
|
2
|
+
|
3
|
+
module DaVinciPlanNetTestKit
|
4
|
+
module <%= module_name %>
|
5
|
+
class <%= class_name %> < Inferno::Test
|
6
|
+
include DaVinciPlanNetTestKit::ReadTest
|
7
|
+
|
8
|
+
title 'Server returns correct <%= resource_type %> resource from <%= resource_type %> read interaction'
|
9
|
+
description 'A server <%= conformance_expectation %> support the <%= resource_type %> read interaction.'
|
10
|
+
|
11
|
+
id :<%= test_id %>
|
12
|
+
|
13
|
+
def resource_type
|
14
|
+
'<%= resource_type %>'
|
15
|
+
end
|
16
|
+
|
17
|
+
def scratch_resources
|
18
|
+
scratch[:<%= profile_identifier %>_resources] ||= {}
|
19
|
+
end
|
20
|
+
|
21
|
+
run do
|
22
|
+
perform_read_test(all_scratch_resources)
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,42 @@
|
|
1
|
+
require_relative '../../../reference_resolution_test'
|
2
|
+
require_relative '../resource_list'
|
3
|
+
|
4
|
+
module DaVinciPlanNetTestKit
|
5
|
+
module <%= module_name %>
|
6
|
+
class <%= class_name %> < Inferno::Test
|
7
|
+
include DaVinciPlanNetTestKit::ReferenceResolutionTest
|
8
|
+
include ResourceList
|
9
|
+
|
10
|
+
title 'MustSupport references within <%= resource_type %> resources are valid'
|
11
|
+
description %(
|
12
|
+
This test will attempt to read external references provided within elements
|
13
|
+
marked as 'MustSupport', if any are available.
|
14
|
+
|
15
|
+
It verifies that at least one external reference for each MustSupport Reference element
|
16
|
+
can be accessed by the test client, and conforms to corresponding Plan Net profile.
|
17
|
+
|
18
|
+
Elements which may provide external references include:
|
19
|
+
|
20
|
+
<%= must_support_reference_list_string %>
|
21
|
+
)
|
22
|
+
|
23
|
+
id :<%= test_id %>
|
24
|
+
|
25
|
+
def resource_type
|
26
|
+
'<%= resource_type %>'
|
27
|
+
end
|
28
|
+
|
29
|
+
def self.metadata
|
30
|
+
@metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
|
31
|
+
end
|
32
|
+
|
33
|
+
def scratch_resources
|
34
|
+
scratch[:<%= profile_identifier %>_resources] ||= {}
|
35
|
+
end
|
36
|
+
|
37
|
+
run do
|
38
|
+
perform_reference_resolution_test(<%= resource_collection_string %>)
|
39
|
+
end
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
@@ -0,0 +1,57 @@
|
|
1
|
+
require_relative '../../../search_test'
|
2
|
+
require_relative '../../../generator/group_metadata'
|
3
|
+
|
4
|
+
module DaVinciPlanNetTestKit
|
5
|
+
module <%= module_name %>
|
6
|
+
class <%= class_name %> < Inferno::Test
|
7
|
+
include DaVinciPlanNetTestKit::SearchTest
|
8
|
+
|
9
|
+
title 'Server capable of reverse chaining through <%= source_resource %>\'s <%= constraining_param %> element'
|
10
|
+
description %(
|
11
|
+
Test will perform a search using the reverse chaining parameter
|
12
|
+
<%= "_has:#{source_resource}:#{target_param}:#{constraining_param}" %>
|
13
|
+
using a value from either a previously identified <%= "#{source_resource}" %> when
|
14
|
+
run from the suite level, or the "\'<%= "#{constraining_param}" %>\' value from <%= "#{a_or_an(source_resource)}" %>
|
15
|
+
instance with \'<%= "#{target_param}" %>\' populated" input when run at the group level. To validate the
|
16
|
+
returned instances, the test will perform a search
|
17
|
+
on the <%= "#{source_resource}" %> resource type using the same <%= "#{constraining_param}" %> search
|
18
|
+
parameter and value and check that the instances returned by the tested search are all referenced
|
19
|
+
by the <%= "#{target_param}" %> element of instances returned by the additional search.
|
20
|
+
)
|
21
|
+
|
22
|
+
id :<%= test_id %>
|
23
|
+
input :<%= input_name %>,
|
24
|
+
title: '\'<%= "#{constraining_param}" %>\' value from <%= "#{a_or_an(source_resource)}" %> instance with \'<%= "#{target_param}" %>\' populated',
|
25
|
+
description: 'Single value from the \'<%= constraining_param %>\' element of <%= a_or_an(source_resource) %>
|
26
|
+
on an instance that also references <%= "#{a_or_an(resource_type)}" %> instance in its \'<%= target_param %>\' element to be used for test
|
27
|
+
\'Server capable of reverse chaining through <%= source_resource %>\'s <%= constraining_param %> element\' when run at the group level.',
|
28
|
+
optional: true
|
29
|
+
|
30
|
+
def properties
|
31
|
+
@properties ||= SearchTestProperties.new(
|
32
|
+
<%= search_test_properties_string %>
|
33
|
+
)
|
34
|
+
end
|
35
|
+
|
36
|
+
def self.metadata
|
37
|
+
@metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
|
38
|
+
end
|
39
|
+
|
40
|
+
def self.additional_metadata
|
41
|
+
@additional_metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, '..', '<%= source_resource.underscore.gsub('organization_affiliation', 'org_affil') %>', 'metadata.yml'), aliases: true))
|
42
|
+
end
|
43
|
+
|
44
|
+
def scratch_resources
|
45
|
+
scratch[:<%= profile_identifier %>_resources] ||= {}
|
46
|
+
end
|
47
|
+
|
48
|
+
def scratch_additional_resources
|
49
|
+
scratch[:<%= source_resource.underscore %>_resources] ||= {}
|
50
|
+
end
|
51
|
+
|
52
|
+
run do
|
53
|
+
run_reverse_chain_search_test
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
@@ -0,0 +1,55 @@
|
|
1
|
+
require_relative '../../../search_test'
|
2
|
+
require_relative '../../../generator/group_metadata'
|
3
|
+
|
4
|
+
module DaVinciPlanNetTestKit
|
5
|
+
module <%= module_name %>
|
6
|
+
class <%= class_name %> < Inferno::Test
|
7
|
+
include DaVinciPlanNetTestKit::SearchTest
|
8
|
+
|
9
|
+
title 'Server returns <%= revinclude_param_resource %> resources from <%= resource_type %> search with <%= revinclude_param_string %>'
|
10
|
+
description %(
|
11
|
+
A server SHALL be capable of supporting searches _revincludes on search parameter <%= revinclude_param %>.
|
12
|
+
|
13
|
+
This test will perform a search on <%= resource_type %> with <%= revinclude_param_string %> and the '_id'
|
14
|
+
search parameter using an id previously identified during a suite level run or an id provided
|
15
|
+
in the "<%= resource_type %> instance ids referenced in <%= "#{revinclude_param_resource}.#{rev_param_sp}" %>" input if run at the group level.
|
16
|
+
The test will pass if at least one <%= revinclude_param_resource %> resource found in the response
|
17
|
+
and each instance that does includes a reference to the <%= resource_type %> with the searched id.
|
18
|
+
)
|
19
|
+
|
20
|
+
id :<%= test_id %>
|
21
|
+
input :<%= input_name %>,
|
22
|
+
title: '<%= resource_type %> instance ids referenced in <%= "#{revinclude_param_resource}.#{rev_param_sp}" %>',
|
23
|
+
description: %(Comma separated list of <%= resource_type %> instance ids that are referenced by <%= "#{a_or_an(revinclude_param_resource)}" %>
|
24
|
+
instance in its <%= "#{rev_param_sp}" %> element. Used for test "Server returns <%= revinclude_param_resource %> resources from <%= resource_type %> search with <%= revinclude_param_string %>"
|
25
|
+
when run at the group level.),
|
26
|
+
optional: true
|
27
|
+
|
28
|
+
def properties
|
29
|
+
@properties ||= SearchTestProperties.new(
|
30
|
+
<%= search_test_properties_string %>
|
31
|
+
)
|
32
|
+
end
|
33
|
+
|
34
|
+
def self.metadata
|
35
|
+
@metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
|
36
|
+
end
|
37
|
+
|
38
|
+
def self.additional_metadata
|
39
|
+
@additional_metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, '..', '<%= revinclude_param_resource.underscore.gsub('organization_affiliation', 'org_affil') %>', 'metadata.yml'), aliases: true))
|
40
|
+
end
|
41
|
+
|
42
|
+
def scratch_resources
|
43
|
+
scratch[:<%= profile_identifier %>_resources] ||= {}
|
44
|
+
end
|
45
|
+
|
46
|
+
def scratch_additional_resources
|
47
|
+
scratch[:<%= revinclude_param_resource.underscore %>_resources] ||= {}
|
48
|
+
end
|
49
|
+
|
50
|
+
run do
|
51
|
+
run_revinclude_search_test
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
@@ -0,0 +1,40 @@
|
|
1
|
+
require_relative '../../../search_test'
|
2
|
+
require_relative '../../../generator/group_metadata'
|
3
|
+
|
4
|
+
module DaVinciPlanNetTestKit
|
5
|
+
module <%= module_name %>
|
6
|
+
class <%= class_name %> < Inferno::Test
|
7
|
+
include DaVinciPlanNetTestKit::SearchTest
|
8
|
+
|
9
|
+
title 'Server returns valid results for <%= resource_type %> search by <%= search_param_name_string %>'
|
10
|
+
description %(
|
11
|
+
<%= description %>
|
12
|
+
)
|
13
|
+
|
14
|
+
id :<%= test_id %><% if optional? %>
|
15
|
+
optional
|
16
|
+
<% end %><% if needs_resource_id? %>
|
17
|
+
input :<%= resource_type %>_ids,
|
18
|
+
title: '<%= resource_type %> IDs',
|
19
|
+
description: 'Comma separated list of <%= resource_type %> IDs that in sum contain all MUST SUPPORT elements'
|
20
|
+
<% end %>
|
21
|
+
def self.properties
|
22
|
+
@properties ||= SearchTestProperties.new(
|
23
|
+
<%= search_test_properties_string %>
|
24
|
+
)
|
25
|
+
end
|
26
|
+
|
27
|
+
def self.metadata
|
28
|
+
@metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
|
29
|
+
end
|
30
|
+
|
31
|
+
def scratch_resources
|
32
|
+
scratch[:<%= profile_identifier %>_resources] ||= {}
|
33
|
+
end
|
34
|
+
|
35
|
+
run do
|
36
|
+
run_search_test
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
@@ -0,0 +1,45 @@
|
|
1
|
+
require_relative '../../../search_test'
|
2
|
+
require_relative '../../../generator/group_metadata'
|
3
|
+
|
4
|
+
module DaVinciPlanNetTestKit
|
5
|
+
module <%= module_name %>
|
6
|
+
class <%= class_name %> < Inferno::Test
|
7
|
+
include DaVinciPlanNetTestKit::SearchTest
|
8
|
+
|
9
|
+
title 'Client can identify instances of <%= profile_name %> on the server'
|
10
|
+
description %(
|
11
|
+
<%= description %>
|
12
|
+
)
|
13
|
+
|
14
|
+
id :<%= test_id %><% if optional? %>
|
15
|
+
optional
|
16
|
+
<% end %>
|
17
|
+
|
18
|
+
input :<%= test_id %>_ids,
|
19
|
+
title: 'ids of <%= profile_name %> instances',
|
20
|
+
optional: true,
|
21
|
+
description: 'Required if parameterless searches are not being used for instance gathering.'
|
22
|
+
input :no_param_search
|
23
|
+
input :max_instances
|
24
|
+
input :max_pages
|
25
|
+
|
26
|
+
def self.properties
|
27
|
+
@properties ||= SearchTestProperties.new(
|
28
|
+
<%= search_test_properties_string %>
|
29
|
+
)
|
30
|
+
end
|
31
|
+
|
32
|
+
def self.metadata
|
33
|
+
@metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
|
34
|
+
end
|
35
|
+
|
36
|
+
def scratch_resources
|
37
|
+
scratch[:<%= profile_identifier %>_resources] ||= {}
|
38
|
+
end
|
39
|
+
|
40
|
+
run do
|
41
|
+
run_search_no_params_test(<%= test_id %>_ids)
|
42
|
+
end
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
@@ -0,0 +1,222 @@
|
|
1
|
+
require 'inferno/dsl/oauth_credentials'
|
2
|
+
require_relative '../../version'
|
3
|
+
require_relative '<%= capability_statement_file_name %>'
|
4
|
+
<% group_file_list.each do |file_name| %>require_relative '<%= file_name %>'
|
5
|
+
<% end %>
|
6
|
+
module DaVinciPlanNetTestKit
|
7
|
+
module <%= module_name %>
|
8
|
+
class <%= class_name %> < Inferno::TestSuite
|
9
|
+
title '<%= title %>'
|
10
|
+
description %(
|
11
|
+
The Plan Net Test Kit tests servers for their conformance to the [Plan Net
|
12
|
+
Implementation Guide](<%=ig_link %>).
|
13
|
+
|
14
|
+
## Scope
|
15
|
+
|
16
|
+
These tests are a **DRAFT** intended to allow Plan Net server implementers to perform
|
17
|
+
preliminary checks of their servers against Plan Net IG requirements and [provide
|
18
|
+
feedback](https://github.com/inferno-framework/davinci-plan-net-test-kit/issues)
|
19
|
+
to ONC on the tests. Future versions of these tests may validate other
|
20
|
+
requirements and may change the test validation logic.
|
21
|
+
|
22
|
+
## Test Methodology
|
23
|
+
|
24
|
+
Inferno will act as a client and make a series of requests to the
|
25
|
+
server under test. The responses will be checked for conformance to the Plan
|
26
|
+
Net IG requirements individually and used in aggregate to determine whether
|
27
|
+
required features and functionality are present.
|
28
|
+
|
29
|
+
HL7® FHIR® resources are validated with the Java validator using
|
30
|
+
`tx.fhir.org` as the terminology server.
|
31
|
+
|
32
|
+
## Running the Tests
|
33
|
+
|
34
|
+
### Quick Start
|
35
|
+
|
36
|
+
The tests are designed to be runnable with a single input from the user:
|
37
|
+
the base FHIR URL of the server under test. To run in this mode:
|
38
|
+
1. Click the `RUN ALL TESTS` button in the upper right
|
39
|
+
2. Provide the URL for the server in the first "FHIR Endpoint (required)" input
|
40
|
+
3. Click the `Submit` button in the lower right of the input display
|
41
|
+
4. Wait for Inferno to run the tests (will take several minutes)
|
42
|
+
5. Expand tests with failures to determine the reason
|
43
|
+
|
44
|
+
If you would like to try out the tests but don't have a Plan Net server implementation,
|
45
|
+
you can use the publicly available reference implementation available at URL
|
46
|
+
https://plan-net-ri.davinci.hl7.org/fhir. Select this endpoint by using that URL as the
|
47
|
+
"FHIR Endpoint (required)" input or prepopulating it by selecting the
|
48
|
+
`Da Vinci Plan Net Reference Server` preset in the upper left. Note that this
|
49
|
+
system is not currently expected to pass all of the tests.
|
50
|
+
|
51
|
+
The feedback provided may require
|
52
|
+
- Configuration updates (see *Test Configuration Details* below) to better guide Inferno's test execution.
|
53
|
+
- Additional data within the system under test, e.g., to demonstrate all Must Support elements.
|
54
|
+
- Fixes to the system under test.
|
55
|
+
|
56
|
+
Note that this mode requires that the server support parameterless searches against
|
57
|
+
Plan Net resource types (e.g., `GET [FHIR Endpoint]/InsurancePlan`), which are not required
|
58
|
+
by the Plan Net IG. If your server does not support these searches, or some returned instances
|
59
|
+
will not conform to Plan Net profiles, see the *Instance Gathering* section under
|
60
|
+
*Test Configuration Details* below for how to disable these searches and direct the tests
|
61
|
+
toward specific instances of each profile instead.
|
62
|
+
|
63
|
+
### Running Groups Individually
|
64
|
+
|
65
|
+
Each test group listed on the left can be run individually using the `RUN TESTS`
|
66
|
+
button in the upper right of the group page. However, note that running
|
67
|
+
them individually requires additional inputs so that Inferno can find appropriate values for searches
|
68
|
+
(see *Determination of Search Values When Running Single Groups* below for details).
|
69
|
+
|
70
|
+
## Test Configuration Details
|
71
|
+
|
72
|
+
The details provided here supplement the documentation of individual inputs in the input dialog
|
73
|
+
that appears when initiating a test run.
|
74
|
+
|
75
|
+
### Authentication
|
76
|
+
|
77
|
+
The Plan Net IG requires that "A conformant Plan-Net service SHALL NOT
|
78
|
+
require a directory mobile application to send consumer identifying information
|
79
|
+
in order to query content." A simple way to ensure this is to not require authentication,
|
80
|
+
which is safe because the information in scope does not include PHI. Thus, the
|
81
|
+
tests do not send authentication details by default.
|
82
|
+
|
83
|
+
If a server under test requires authentication information to be sent, an access token
|
84
|
+
may be provided using the "OAuth Credentials - Access Token" input. When populated,
|
85
|
+
requests to the server will include an HTTP header of the form `Authorization: Bearer [access token]`.
|
86
|
+
|
87
|
+
### Instance Gathering
|
88
|
+
|
89
|
+
Inferno needs to identify instances of each profile to use to validate conformance to
|
90
|
+
structural and search API requirements. Inferno will use one or a combination of the
|
91
|
+
following two approaches as directed by the inputs.
|
92
|
+
|
93
|
+
#### Parameterless searches (default)
|
94
|
+
|
95
|
+
Inferno will use a search against the base resource type without any search
|
96
|
+
parameters (`GET [FHIR Endpoint]/[Resource Type]`) to identify instances of each profile.
|
97
|
+
This behavior can be controlled using the following inputs:
|
98
|
+
- "Use parameterless searches to identify instances?": if the server under test does not support
|
99
|
+
parameterless searches, this can be set to `No` to disable parameterless searches.
|
100
|
+
- "Maximum number of instances to gather using parameterless searches (required)" and
|
101
|
+
"Maximum pages of results to consider when using parameterless searches (required)": if fewer
|
102
|
+
instances (e.g., to improve performance) or more instances (e.g., to improve Must Support
|
103
|
+
element coverage) should be gathered, these inputs can be adjusted to tune the number
|
104
|
+
of instances that Inferno will gather using parameterless searches.
|
105
|
+
|
106
|
+
#### Specific instance ids
|
107
|
+
|
108
|
+
Inputs of the form "ids of [profile] instances" can be used by the user to specify particular
|
109
|
+
instances for Inferno to gather for use in testing. Inferno will perform a read on each provided id
|
110
|
+
to gather the instances. When parameterless searches are not used, all inputs of this form must be populated.
|
111
|
+
When instance ids are provided in addition to parameterless searches, instances provided by the user
|
112
|
+
are prioritized for use in determining search values for search tests.
|
113
|
+
|
114
|
+
### Determination of Search Values When Running Single Groups
|
115
|
+
|
116
|
+
Validation of search parameters requires Inferno to identify values that are expected
|
117
|
+
to return instances. By default, Inferno does this by examining gathered instances of each profile
|
118
|
+
to identify search values that should return results when performed against the server under
|
119
|
+
test. For `_revinclude` and reverse chaining tests, Inferno needs access to instances of other profiles
|
120
|
+
in order to determine appropriate search values. When test groups are run individually, Inferno will not
|
121
|
+
have access to instances identified while running other groups. Thus, when running at the group level,
|
122
|
+
two additional inputs are required to allow the tests to identify appropriate search values:
|
123
|
+
- "[target profile] instance ids referenced in [referencing profile].[reference element]":
|
124
|
+
used by `_revinclude` tests on [target profile] when run as a group to identify
|
125
|
+
instances of the [target profile] that have instances of [referencing profile] that reference it.
|
126
|
+
- "'[constraining element]' value from a [referencing profile] instance with '[reference element]' populated": used by reverse chaining tests
|
127
|
+
on the [target profile] referenced in the [reference element] element when run as a single group
|
128
|
+
to identify the value to use when performing the reverse chain search.
|
129
|
+
)
|
130
|
+
version VERSION
|
131
|
+
|
132
|
+
VALIDATION_MESSAGE_FILTERS = [
|
133
|
+
%r{Sub-extension url 'introspect' is not defined by the Extension http://fhir-registry\.smarthealthit\.org/StructureDefinition/oauth-uris},
|
134
|
+
%r{Sub-extension url 'revoke' is not defined by the Extension http://fhir-registry\.smarthealthit\.org/StructureDefinition/oauth-uris},
|
135
|
+
/Observation\.effective\.ofType\(Period\): .*us-core-1:/, # Invalid invariant in US Core v3.1.1
|
136
|
+
/\A\S+: \S+: URL value '.*' does not resolve/,
|
137
|
+
].freeze
|
138
|
+
|
139
|
+
VERSION_SPECIFIC_MESSAGE_FILTERS = <%=version_specific_message_filters%>.freeze
|
140
|
+
|
141
|
+
def self.metadata
|
142
|
+
@metadata ||= YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true)[:groups].map do |raw_metadata|
|
143
|
+
Generator::GroupMetadata.new(raw_metadata)
|
144
|
+
end
|
145
|
+
end
|
146
|
+
|
147
|
+
id :<%= suite_id %>
|
148
|
+
|
149
|
+
fhir_resource_validator do
|
150
|
+
igs '<%= ig_identifier %>'
|
151
|
+
|
152
|
+
message_filters = VALIDATION_MESSAGE_FILTERS + VERSION_SPECIFIC_MESSAGE_FILTERS
|
153
|
+
|
154
|
+
exclude_message do |message|
|
155
|
+
|
156
|
+
message_filters.any? { |filter| filter.match? message.message }
|
157
|
+
end
|
158
|
+
|
159
|
+
perform_additional_validation do |resource, profile_url|
|
160
|
+
ProvenanceValidator.validate(resource) if resource.instance_of?(FHIR::Provenance)
|
161
|
+
end
|
162
|
+
end
|
163
|
+
|
164
|
+
links [
|
165
|
+
{
|
166
|
+
label: 'Report Issue',
|
167
|
+
url: 'https://github.com/inferno-framework/davinci-plan-net-test-kit/issues'
|
168
|
+
},
|
169
|
+
{
|
170
|
+
label: 'Source Code',
|
171
|
+
url: 'https://github.com/inferno-framework/davinci-plan-net-test-kit'
|
172
|
+
},
|
173
|
+
{
|
174
|
+
label: 'Implementation Guide',
|
175
|
+
url: '<%=ig_link %>'
|
176
|
+
}
|
177
|
+
]
|
178
|
+
|
179
|
+
input :url,
|
180
|
+
title: 'FHIR Endpoint',
|
181
|
+
description: 'URL of the FHIR endpoint'
|
182
|
+
input :smart_credentials,
|
183
|
+
title: 'OAuth Credentials',
|
184
|
+
type: :oauth_credentials,
|
185
|
+
optional: true
|
186
|
+
input :no_param_search,
|
187
|
+
title: 'Use parameterless searches to identify instances?',
|
188
|
+
type: 'radio',
|
189
|
+
options: {
|
190
|
+
list_options: [
|
191
|
+
{
|
192
|
+
label: 'Yes',
|
193
|
+
value: 'true'
|
194
|
+
},
|
195
|
+
{
|
196
|
+
label: 'No',
|
197
|
+
value: 'false'
|
198
|
+
}
|
199
|
+
]
|
200
|
+
},
|
201
|
+
default: 'true',
|
202
|
+
description: 'If `Yes`, Inferno will gather instances of each profile using searches of the form `GET [FHIR Endpoint]/[resource type]`. If searches of this form are not supported or some instances on the server will not be expected to conform to Plan Net profiles, select `No` and enter instance ids of each profile in the "ids of [profile] instances" inputs.'
|
203
|
+
input :max_instances,
|
204
|
+
title: 'Maximum number of instances to gather using parameterless searches',
|
205
|
+
default: '200',
|
206
|
+
description: 'Only used with parameterless searches. A higher number will gather more instances for the tests, if they are available. The test will stop looking when the page limit has been reached.'
|
207
|
+
input :max_pages,
|
208
|
+
title: 'Maximum pages of results to consider when using parameterless searches',
|
209
|
+
default: '20',
|
210
|
+
description: 'Only used with parameterless searches. A higher number will gather more instances for the tests, if they are available. The test will not consider further pages once the maximum number of instances has been reached.'
|
211
|
+
|
212
|
+
fhir_client do
|
213
|
+
url :url
|
214
|
+
oauth_credentials :smart_credentials
|
215
|
+
end
|
216
|
+
|
217
|
+
group from: :<%= capability_statement_group_id %>
|
218
|
+
<% group_id_list.each do |id| %>
|
219
|
+
group from: :<%= id %><% end %>
|
220
|
+
end
|
221
|
+
end
|
222
|
+
end
|
@@ -0,0 +1,31 @@
|
|
1
|
+
require_relative '../../../validation_test'
|
2
|
+
|
3
|
+
module DaVinciPlanNetTestKit
|
4
|
+
module <%= module_name %>
|
5
|
+
class <%= class_name %> < Inferno::Test
|
6
|
+
include DaVinciPlanNetTestKit::ValidationTest
|
7
|
+
|
8
|
+
id :<%= test_id %>
|
9
|
+
title '<%= resource_type %> resources returned during previous tests conform to the <%= profile_name %>'
|
10
|
+
description %(
|
11
|
+
<%= description %>
|
12
|
+
)
|
13
|
+
output :dar_code_found, :dar_extension_found
|
14
|
+
|
15
|
+
def resource_type
|
16
|
+
'<%= resource_type %>'
|
17
|
+
end
|
18
|
+
|
19
|
+
def scratch_resources
|
20
|
+
scratch[:<%= profile_identifier %>_resources] ||= {}
|
21
|
+
end
|
22
|
+
|
23
|
+
run do
|
24
|
+
perform_validation_test(scratch_resources[:all] || [],
|
25
|
+
'<%= profile_url %>',
|
26
|
+
'<%= profile_version %>',
|
27
|
+
skip_if_empty: <%= skip_if_empty %>)
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
31
|
+
end
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# Note on this IGs folder
|
2
|
+
|
3
|
+
There are three reasons why it would be necessary to put an IG package.tgz in this folder. If none of these apply, you do not need to put any files here, or can consider removing any existing files to make it clear they are unused.
|
4
|
+
|
5
|
+
## 1. Generated Test Suites
|
6
|
+
Some test kits use a "generator" to automatically generate the contents of a test suite for an IG. The IG files are required every time the test suites need to be regenerated. Examples of test kits that use this approach are the US Core Test Kit and CARIN IG for Blue Button® Test Kit.
|
7
|
+
|
8
|
+
|
9
|
+
## 2. Non-published IG
|
10
|
+
If your IG, or the specific version of the IG you want to test against, is not published, then the validator service needs to load the IG from file in order to be able to validate resources with it. The IG must be referenced in the `fhir_resource_validator` block in the test suite definition by filename, ie:
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
fhir_resource_validator do
|
14
|
+
igs 'igs/filename.tgz'
|
15
|
+
|
16
|
+
...
|
17
|
+
end
|
18
|
+
```
|
19
|
+
|
20
|
+
## 3. Inferno Validator UI
|
21
|
+
The Inferno Validator UI is configured to auto-load any IGs present in the igs folder and include them in all validations. The Inferno Validator UI is currently disabled by default, so this is only relevant if you choose to re-enable it. In general, the Inferno team is currently leaving IGs in this folder even if not otherwise necessary to make it easy to re-enable the validator UI.
|
@@ -0,0 +1,64 @@
|
|
1
|
+
module DaVinciPlanNetTestKit
|
2
|
+
class Metadata < Inferno::TestKit
|
3
|
+
id :davinci_plan_net_test_kit
|
4
|
+
title 'Da Vinci Plan Net Test Kit'
|
5
|
+
suite_ids [ 'davinci_plan_net_server_v110' ]
|
6
|
+
tags ['Da Vinci']
|
7
|
+
last_updated ::DaVinciPlanNetTestKit::LAST_UPDATED
|
8
|
+
version ::DaVinciPlanNetTestKit::VERSION
|
9
|
+
maturity 'Low'
|
10
|
+
authors ['Karl Naden']
|
11
|
+
repo 'https://github.com/inferno-framework/davinci-plan-net-test-kit'
|
12
|
+
description <<~DESCRIPTION
|
13
|
+
The DaVinci Plan Net Test Kit validates the conformance of a server
|
14
|
+
implementation to version 1.1.0 of the
|
15
|
+
[DaVinci PDEX Plan Net Implementation Guide](http://hl7.org/fhir/us/davinci-pdex-plan-net/STU1.1).
|
16
|
+
|
17
|
+
<!-- break -->
|
18
|
+
|
19
|
+
Inferno will act as a client and make a series of requests to the
|
20
|
+
server under test. The responses will be checked for conformance
|
21
|
+
to the Plan Net IG requirements individually and used in aggregate
|
22
|
+
to determine whether required features and functionality are present.
|
23
|
+
|
24
|
+
The test kit currently tests the following requirements:
|
25
|
+
|
26
|
+
- Support for Must Support Elements
|
27
|
+
- JSON Support
|
28
|
+
- Support for all Plan Net Profiles
|
29
|
+
- Read Interaction
|
30
|
+
- Individual Search Parameters
|
31
|
+
- _include Searches
|
32
|
+
- _revinclude Searches
|
33
|
+
- Forward Chain Searches
|
34
|
+
- Reverse Chain Searches
|
35
|
+
- Search Parameters in Combination
|
36
|
+
|
37
|
+
The DaVinci Plan Net Test Kit is built using the
|
38
|
+
[Inferno Framework](https://inferno-framework.github.io/).
|
39
|
+
The Inferno Framework is designed for reuse and aims to make it easier
|
40
|
+
to build test kits for any FHIR-based data exchange.
|
41
|
+
|
42
|
+
### Known Limitations
|
43
|
+
|
44
|
+
The following areas of the IG are not fully tested in this draft version
|
45
|
+
of the test kit:
|
46
|
+
|
47
|
+
- All search parameter combinations: the tests check for support of only
|
48
|
+
specific combinations of search parameters driven by
|
49
|
+
[anticipated searches listed in the IG](http://hl7.org/fhir/us/davinci-pdex-plan-net/implementation.html#Representing).
|
50
|
+
- Response classes: the Plan Net IG lists HTTP response codes that the
|
51
|
+
server needs to be able to return, but does not indicate specific
|
52
|
+
criteria for requests that elicit these status codes.
|
53
|
+
|
54
|
+
Additional details on these and other areas where the tests may not align
|
55
|
+
with the IGs requirements, see this requirements analysis spreadsheet.
|
56
|
+
|
57
|
+
## Reporting Issues
|
58
|
+
|
59
|
+
Please report any issues with this set of tests in the
|
60
|
+
[GitHub Issues](https://github.com/inferno-framework/davinci-plan-net-test-kit/issues)
|
61
|
+
section of this repository.
|
62
|
+
DESCRIPTION
|
63
|
+
end
|
64
|
+
end
|
@@ -203,7 +203,7 @@ module DaVinciPlanNetTestKit
|
|
203
203
|
|
204
204
|
check_search_response
|
205
205
|
|
206
|
-
returned_resources = fetch_all_bundled_resources(additional_resource_types: [additional_resource_type])
|
206
|
+
returned_resources = fetch_all_bundled_resources(resource_type: self.resource_type, additional_resource_types: [additional_resource_type])
|
207
207
|
|
208
208
|
base_resources = returned_resources
|
209
209
|
.select { |res| res.resourceType == resource_type }
|
@@ -238,7 +238,7 @@ module DaVinciPlanNetTestKit
|
|
238
238
|
|
239
239
|
check_search_response
|
240
240
|
|
241
|
-
matching_resources = fetch_all_bundled_resources(additional_resource_types: [additional_resource_type])
|
241
|
+
matching_resources = fetch_all_bundled_resources(resource_type: self.resource_type, additional_resource_types: [additional_resource_type])
|
242
242
|
.select { |res| res.resourceType == additional_resource_type }
|
243
243
|
.reject { |res| res.id == params[:_id] }
|
244
244
|
|
@@ -306,7 +306,7 @@ module DaVinciPlanNetTestKit
|
|
306
306
|
fhir_search additional_resource_type, params: additional_resource_params
|
307
307
|
|
308
308
|
check_search_response
|
309
|
-
additional_resources = fetch_all_bundled_resources(additional_resource_types: [additional_resource_type])
|
309
|
+
additional_resources = fetch_all_bundled_resources(resource_type: self.resource_type, additional_resource_types: [additional_resource_type])
|
310
310
|
.select { |res| res.resourceType == additional_resource_type }
|
311
311
|
|
312
312
|
additional_resources.each { |res| check_resource_against_params(res, additional_resource_params) }
|
@@ -328,7 +328,7 @@ module DaVinciPlanNetTestKit
|
|
328
328
|
|
329
329
|
check_search_response
|
330
330
|
|
331
|
-
returned_resources = fetch_all_bundled_resources(additional_resource_types: [additional_resource_type])
|
331
|
+
returned_resources = fetch_all_bundled_resources(resource_type: self.resource_type, additional_resource_types: [additional_resource_type])
|
332
332
|
assert !returned_resources.empty?, "No #{resource_type} resources returned"
|
333
333
|
base_resources = returned_resources
|
334
334
|
.select { |res| res.resourceType == resource_type }
|
@@ -356,7 +356,7 @@ module DaVinciPlanNetTestKit
|
|
356
356
|
|
357
357
|
check_search_response
|
358
358
|
|
359
|
-
returned_resources = fetch_all_bundled_resources(additional_resource_types: [additional_resource_type])
|
359
|
+
returned_resources = fetch_all_bundled_resources(resource_type: self.resource_type, additional_resource_types: [additional_resource_type])
|
360
360
|
input_based_skip_assert(returned_resources, "No resources found.")
|
361
361
|
base_resources = returned_resources
|
362
362
|
.select { |res| res.resourceType == resource_type }
|
@@ -380,7 +380,7 @@ module DaVinciPlanNetTestKit
|
|
380
380
|
|
381
381
|
check_search_response
|
382
382
|
|
383
|
-
returned_resources = fetch_all_bundled_resources(additional_resource_types: [additional_resource_type])
|
383
|
+
returned_resources = fetch_all_bundled_resources(resource_type: self.resource_type, additional_resource_types: [additional_resource_type])
|
384
384
|
assert !returned_resources.empty?, "No #{resource_type} resources found"
|
385
385
|
|
386
386
|
base_resources = returned_resources
|
@@ -424,7 +424,7 @@ module DaVinciPlanNetTestKit
|
|
424
424
|
check_search_response
|
425
425
|
|
426
426
|
resources_returned =
|
427
|
-
fetch_all_bundled_resources.select { |resource| resource.resourceType == resource_type }
|
427
|
+
fetch_all_bundled_resources(resource_type: self.resource_type).select { |resource| resource.resourceType == resource_type }
|
428
428
|
|
429
429
|
return [] if resources_returned.blank?
|
430
430
|
|
@@ -456,7 +456,7 @@ module DaVinciPlanNetTestKit
|
|
456
456
|
|
457
457
|
check_search_response
|
458
458
|
|
459
|
-
post_search_resources = fetch_all_bundled_resources.select { |resource| resource.resourceType == resource_type }
|
459
|
+
post_search_resources = fetch_all_bundled_resources(resource_type: self.resource_type).select { |resource| resource.resourceType == resource_type }
|
460
460
|
|
461
461
|
filter_conditions(post_search_resources) if resource_type == 'Condition' && metadata.version == 'v5.0.1'
|
462
462
|
filter_devices(post_search_resources) if resource_type == 'Device'
|
@@ -562,7 +562,7 @@ module DaVinciPlanNetTestKit
|
|
562
562
|
|
563
563
|
search_and_check_response(params_with_comparator)
|
564
564
|
|
565
|
-
fetch_all_bundled_resources.each do |resource|
|
565
|
+
fetch_all_bundled_resources(resource_type: self.resource_type).each do |resource|
|
566
566
|
check_resource_against_params(resource, params_with_comparator) if resource.resourceType == resource_type
|
567
567
|
end
|
568
568
|
end
|
@@ -578,7 +578,7 @@ module DaVinciPlanNetTestKit
|
|
578
578
|
new_search_params = params.merge(resource_type.underscore => "#{resource_type}/#{params['resource']}")
|
579
579
|
search_and_check_response(new_search_params)
|
580
580
|
|
581
|
-
reference_with_type_resources = fetch_all_bundled_resources.select { |resource| resource.resourceType == resource_type }
|
581
|
+
reference_with_type_resources = fetch_all_bundled_resources(resource_type: self.resource_type).select { |resource| resource.resourceType == resource_type }
|
582
582
|
|
583
583
|
|
584
584
|
new_resource_count = reference_with_type_resources.count
|
@@ -601,7 +601,7 @@ module DaVinciPlanNetTestKit
|
|
601
601
|
search_and_check_response(search_params)
|
602
602
|
|
603
603
|
resources_returned =
|
604
|
-
fetch_all_bundled_resources
|
604
|
+
fetch_all_bundled_resources(resource_type: self.resource_type)
|
605
605
|
.select { |resource| resource.resourceType == resource_type }
|
606
606
|
|
607
607
|
assert resources_returned.present?, "No resources were returned when searching by `system|code`"
|
@@ -672,7 +672,7 @@ module DaVinciPlanNetTestKit
|
|
672
672
|
search_and_check_response(search_params)
|
673
673
|
|
674
674
|
resources_returned =
|
675
|
-
fetch_all_bundled_resources
|
675
|
+
fetch_all_bundled_resources(resource_type: self.resource_type)
|
676
676
|
.select { |resource| resource.resourceType == resource_type }
|
677
677
|
|
678
678
|
multiple_or_search_params.each do |param_name|
|
@@ -855,54 +855,6 @@ module DaVinciPlanNetTestKit
|
|
855
855
|
"#{msg}."
|
856
856
|
end
|
857
857
|
|
858
|
-
def fetch_all_bundled_resources(
|
859
|
-
reply_handler: nil,
|
860
|
-
max_pages: 0,
|
861
|
-
additional_resource_types: [],
|
862
|
-
resource_type: self.resource_type
|
863
|
-
)
|
864
|
-
page_count = 1
|
865
|
-
resources = []
|
866
|
-
bundle = resource
|
867
|
-
resources += bundle&.entry&.map { |entry| entry&.resource }
|
868
|
-
|
869
|
-
until bundle.nil? || (page_count == max_pages && max_pages != 0)
|
870
|
-
|
871
|
-
next_bundle_link = bundle&.link&.find { |link| link.relation == 'next' }&.url
|
872
|
-
reply_handler&.call(response)
|
873
|
-
|
874
|
-
break if next_bundle_link.blank?
|
875
|
-
|
876
|
-
reply = fhir_client.raw_read_url(next_bundle_link)
|
877
|
-
|
878
|
-
store_request('outgoing') { reply }
|
879
|
-
error_message = cant_resolve_next_bundle_message(next_bundle_link)
|
880
|
-
|
881
|
-
assert_response_status(200)
|
882
|
-
assert_valid_json(reply.body, error_message)
|
883
|
-
|
884
|
-
bundle = fhir_client.parse_reply(FHIR::Bundle, fhir_client.default_format, reply)
|
885
|
-
resources += bundle&.entry&.map { |entry| entry&.resource }
|
886
|
-
|
887
|
-
page_count += 1
|
888
|
-
end
|
889
|
-
|
890
|
-
valid_resource_types = [resource_type, 'OperationOutcome'].concat(additional_resource_types)
|
891
|
-
|
892
|
-
invalid_resource_types =
|
893
|
-
resources.reject { |entry| valid_resource_types.include? entry.resourceType }
|
894
|
-
.map(&:resourceType)
|
895
|
-
.uniq
|
896
|
-
|
897
|
-
if invalid_resource_types.any?
|
898
|
-
info "Received resource type(s) #{invalid_resource_types.join(', ')} in search bundle, " \
|
899
|
-
"but only expected resource types #{valid_resource_types.join(', ')}. " + \
|
900
|
-
"This is unusual but allowed if the server believes additional resource types are relevant."
|
901
|
-
end
|
902
|
-
|
903
|
-
resources
|
904
|
-
end
|
905
|
-
|
906
858
|
def fetch_matching_bundled_resources(
|
907
859
|
max_pages: 20,
|
908
860
|
max_instances: 200,
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: davinci_plan_net_test_kit
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.11.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Karl Naden
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2025-02-25 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: inferno_core
|
@@ -16,28 +16,28 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: 0.
|
19
|
+
version: 0.6.2
|
20
20
|
type: :runtime
|
21
21
|
prerelease: false
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
23
23
|
requirements:
|
24
24
|
- - ">="
|
25
25
|
- !ruby/object:Gem::Version
|
26
|
-
version: 0.
|
26
|
+
version: 0.6.2
|
27
27
|
- !ruby/object:Gem::Dependency
|
28
28
|
name: tls_test_kit
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
30
30
|
requirements:
|
31
|
-
- - "
|
31
|
+
- - ">="
|
32
32
|
- !ruby/object:Gem::Version
|
33
|
-
version: 0.
|
33
|
+
version: 0.3.0
|
34
34
|
type: :runtime
|
35
35
|
prerelease: false
|
36
36
|
version_requirements: !ruby/object:Gem::Requirement
|
37
37
|
requirements:
|
38
|
-
- - "
|
38
|
+
- - ">="
|
39
39
|
- !ruby/object:Gem::Version
|
40
|
-
version: 0.
|
40
|
+
version: 0.3.0
|
41
41
|
- !ruby/object:Gem::Dependency
|
42
42
|
name: database_cleaner-sequel
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|
@@ -102,6 +102,7 @@ extensions: []
|
|
102
102
|
extra_rdoc_files: []
|
103
103
|
files:
|
104
104
|
- LICENSE
|
105
|
+
- config/presets/plan_net_reference_server_v110_preset.json
|
105
106
|
- lib/davinci_plan_net_test_kit.rb
|
106
107
|
- lib/davinci_plan_net_test_kit/custom_groups/capability_statement/conformance_support_test.rb
|
107
108
|
- lib/davinci_plan_net_test_kit/custom_groups/capability_statement/fhir_version_test.rb
|
@@ -111,6 +112,7 @@ files:
|
|
111
112
|
- lib/davinci_plan_net_test_kit/custom_groups/combination_searches/examples.json
|
112
113
|
- lib/davinci_plan_net_test_kit/custom_groups/data_absent_reason_group.rb
|
113
114
|
- lib/davinci_plan_net_test_kit/custom_groups/reverse_chain_tests/examples.json
|
115
|
+
- lib/davinci_plan_net_test_kit/custom_groups/reverse_chain_tests/examples.md
|
114
116
|
- lib/davinci_plan_net_test_kit/custom_groups/v1.1.0/capability_statement_group.rb
|
115
117
|
- lib/davinci_plan_net_test_kit/date_search_validation.rb
|
116
118
|
- lib/davinci_plan_net_test_kit/fhir_resource_navigation.rb
|
@@ -409,12 +411,29 @@ files:
|
|
409
411
|
- lib/davinci_plan_net_test_kit/generator/search_test_generator.rb
|
410
412
|
- lib/davinci_plan_net_test_kit/generator/special_cases.rb
|
411
413
|
- lib/davinci_plan_net_test_kit/generator/suite_generator.rb
|
414
|
+
- lib/davinci_plan_net_test_kit/generator/templates/combination_search_test.rb.erb
|
415
|
+
- lib/davinci_plan_net_test_kit/generator/templates/forward_chain_test.rb.erb
|
416
|
+
- lib/davinci_plan_net_test_kit/generator/templates/group.rb.erb
|
417
|
+
- lib/davinci_plan_net_test_kit/generator/templates/include_search.rb.erb
|
418
|
+
- lib/davinci_plan_net_test_kit/generator/templates/must_support.rb.erb
|
419
|
+
- lib/davinci_plan_net_test_kit/generator/templates/read.rb.erb
|
420
|
+
- lib/davinci_plan_net_test_kit/generator/templates/reference_resolution.rb.erb
|
421
|
+
- lib/davinci_plan_net_test_kit/generator/templates/resource_list.rb.erb
|
422
|
+
- lib/davinci_plan_net_test_kit/generator/templates/reverse_chain_search.rb.erb
|
423
|
+
- lib/davinci_plan_net_test_kit/generator/templates/revinclude_search.rb.erb
|
424
|
+
- lib/davinci_plan_net_test_kit/generator/templates/search.rb.erb
|
425
|
+
- lib/davinci_plan_net_test_kit/generator/templates/search_no_params.rb.erb
|
426
|
+
- lib/davinci_plan_net_test_kit/generator/templates/suite.rb.erb
|
427
|
+
- lib/davinci_plan_net_test_kit/generator/templates/validation.rb.erb
|
412
428
|
- lib/davinci_plan_net_test_kit/generator/terminology_binding_metadata_extractor.rb
|
413
429
|
- lib/davinci_plan_net_test_kit/generator/validation_test_generator.rb
|
414
430
|
- lib/davinci_plan_net_test_kit/generator/value_extractor.rb
|
431
|
+
- lib/davinci_plan_net_test_kit/igs/Plan Net Requirements Interpretation.xlsx
|
432
|
+
- lib/davinci_plan_net_test_kit/igs/README.md
|
415
433
|
- lib/davinci_plan_net_test_kit/igs/package.tgz
|
416
434
|
- lib/davinci_plan_net_test_kit/igs/package/SearchParameter-Resource-id.json
|
417
435
|
- lib/davinci_plan_net_test_kit/igs/package/SearchParameter-Resource-lastUpdated.json
|
436
|
+
- lib/davinci_plan_net_test_kit/metadata.rb
|
418
437
|
- lib/davinci_plan_net_test_kit/must_support_test.rb
|
419
438
|
- lib/davinci_plan_net_test_kit/provenance_validator.rb
|
420
439
|
- lib/davinci_plan_net_test_kit/read_test.rb
|
@@ -430,6 +449,7 @@ licenses:
|
|
430
449
|
metadata:
|
431
450
|
homepage_uri: https://github.com/inferno-framework/davinci-plan-net-test-kit
|
432
451
|
source_code_uri: https://github.com/inferno-framework/davinci-plan-net-test-kit
|
452
|
+
inferno_test_kit: 'true'
|
433
453
|
post_install_message:
|
434
454
|
rdoc_options: []
|
435
455
|
require_paths:
|
@@ -438,14 +458,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
438
458
|
requirements:
|
439
459
|
- - ">="
|
440
460
|
- !ruby/object:Gem::Version
|
441
|
-
version: 3.
|
461
|
+
version: 3.3.6
|
442
462
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
443
463
|
requirements:
|
444
464
|
- - ">="
|
445
465
|
- !ruby/object:Gem::Version
|
446
466
|
version: '0'
|
447
467
|
requirements: []
|
448
|
-
rubygems_version: 3.
|
468
|
+
rubygems_version: 3.5.22
|
449
469
|
signing_key:
|
450
470
|
specification_version: 4
|
451
471
|
summary: DaVinci Plan Net Test Kit
|