service_base_url_test_kit 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7930c517e65b84c6011ba94dc5419c9d26548b931194bad1724bda2e26f632e6
-  data.tar.gz: d73dcf49c51873fb5aad07f079bc66b72d0912fea69e52d4a4e790bb167b6af2
+  metadata.gz: 638bed4317d3630a7ffdfbc9cef4be2dc266ab285de017d890a1ceadec4858fc
+  data.tar.gz: fab6cb020b68f87db82348891f3b80eb0d5e3bc9181639c9bf1b5a9505611de4
 SHA512:
-  metadata.gz: 3d572a5d516ad116afc9787c4816493fb48788c89a163c4365ee664dd94bbd745a19eef429ae0095a13d2e7742113f64f134f80e399469798a60f08442c33157
-  data.tar.gz: b7b0e8b87f62e5ecedeaadb0b3693ec81d9a94dd6d916616fbef54d6c023c603e30f6eb6c12567a780686a2472c64348423b757ec40e45fb0fcb444ec4837251
+  metadata.gz: 61b58536e24b25039953dc99cc4a507202c08297a8be0f70edb0d340ec0fa77824dbaee0de8be5bb548306eaf5c0e5b47dc143405882ebb5f91537bd258ccb68
+  data.tar.gz: 1fccec1d67cb3642771fa89360e90b3ad9f157bed70d35ee5beb09324cc5b649f74554638df4202834ffba3ca43c1578751477df79eb7c626707371ace21d205

data/lib/service_base_url_test_kit/examples/SmartAccessBrand.json.erb

@@ -0,0 +1,105 @@
+{
+    "resourceType" : "Bundle",
+    "id" : "example1",
+    "type" : "collection",
+    "timestamp" : "2023-09-05T20:00:43.241070-07:00",
+    "entry" : [{
+      "fullUrl" : "https://fhir.labs.example.com/Organization/examplelabs",
+      "resource" : {
+        "resourceType" : "Organization",
+        "id" : "examplelabs",
+        "extension" : [{
+          "extension" : [{
+            "url" : "brandLogo",
+            "valueUrl" : "https://labs.example.com/images/logo.svg"
+          }],
+          "url" : "http://hl7.org/fhir/StructureDefinition/organization-brand"
+        },
+        {
+          "extension" : [{
+            "url" : "portalName",
+            "valueString" : "Example Labs HealthCentral Portal"
+          },
+          {
+            "url" : "portalUrl",
+            "valueUrl" : "https://healthcentral.labs.example.com"
+          },
+          {
+            "url" : "portalLogo",
+            "valueUrl" : "https://healthcentral.labs.example.com/logo.png"
+          },
+          {
+            "url" : "portalEndpoint",
+            "valueReference" : {
+              "reference" : "Endpoint/examplelabs",
+              "display" : "FHIR R4 Endpoint for ExampleLabs Brand"
+            }
+          }],
+          "url" : "http://hl7.org/fhir/StructureDefinition/organization-portal"
+        }],
+        "identifier" : [{
+          "system" : "urn:ietf:rfc:3986",
+          "value" : "https://examplelabs.org"
+        }],
+        "active" : true,
+        "type" : [{
+          "coding" : [{
+            "system" : "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category",
+            "code" : "laboratory",
+            "display" : "Laboratory"
+          }]
+        }],
+        "name" : "ExampleLabs",
+        "alias" : ["ExampleLabs Alaska",
+        "...(more here)...",
+        "ExampleLabs Wisconsin"],
+        "telecom" : [{
+          "system" : "url",
+          "value" : "https://labs.example.com"
+        }],
+        "address" : [{
+          "line" : ["4015 Lake Otis Pkwy"],
+          "city" : "Anchorage",
+          "state" : "AK",
+          "postalCode" : "99508"
+        },
+        {
+          "state" : "...(more here)..."
+        },
+        {
+          "line" : ["123 Main St"],
+          "city" : "Madison",
+          "state" : "WI",
+          "postalCode" : "53726"
+        }]
+      }
+    },
+    {
+      "fullUrl" : "https://fhir.labs.example.com/Endpoint/examplelabs",
+      "resource" : {
+        "resourceType" : "Endpoint",
+        "id" : "examplelabs",
+        "extension" : [{
+          "url" : "http://hl7.org/fhir/StructureDefinition/endpoint-fhir-version",
+          "valueCode" : "4.0.1"
+        }],
+        "status" : "active",
+        "connectionType" : {
+          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
+          "code" : "hl7-fhir-rest"
+        },
+        "name" : "FHIR R4 Endpoint for ExampleLabs",
+        "contact" : [{
+          "system" : "url",
+          "value" : "https://dev-portal.labs.example.com"
+        }],
+        "payloadType" : [{
+          "coding" : [{
+            "system" : "http://terminology.hl7.org/CodeSystem/endpoint-payload-type",
+            "code" : "none"
+          }]
+        }],
+        "address" : "<%= ENV['INFERNO_HOST'] %>/custom/service_base_url_test_kit_suite/examples/CapabilityStatement"
+      }
+    }]
+  }

data/lib/service_base_url_test_kit/service_base_url_retrieve_group.rb

@@ -1,40 +1,40 @@
 module ServiceBaseURLTestKit
   class ServiceBaseURLEndpointQueryGroup < Inferno::TestGroup
     id :service_base_url_retrieve_list
-    title 'Retrieve Service Base URL List'
+    title 'Retrieve Service Base URL Publication'
     description %(
-      A developer's Service Base URL list must be publicly available.  This test
+      A developer's Service Base URL publication must be publicly available.  This test
       issues a HTTP GET request against the supplied URL and expects to receive
-      the service base url list at this location.
+      the service base url publication at this location.
     )
     run_as_group
 
-    input :service_base_url_list_url,
-      title: 'Service Base URL List URL',
-      description: 'The URL to the developer\'s public Service Base URL List'
-
     http_client do
-      url :service_base_url_list_url
-      headers 'Accept': 'application/json, application/fhir+json'
+      url :service_base_url_publication_url
+      headers Accept: 'application/json, application/fhir+json'
     end
 
     test do
       id :service_base_url_retrieve_list_test
-      title 'Server returns publicly accessible Service Base URL List'
+      title 'Server returns publicly accessible Service Base URL Publication'
       description %(
         Verify that the developer's list of Service Base URLs can be publicly
         accessed at the supplied URL location.
       )
 
+      input :service_base_url_publication_url,
+            optional: true
+
       output :bundle_response
 
       makes_request :bundle_request
 
       run do
-        get
+        omit_if service_base_url_publication_url.blank?, 'URL for Service Base URL Publication not Inputted.'
+
+        get(tags: ['service_base_url_bundle'])
         assert_response_status(200)
-        output bundle_response: resource.to_json
-      end      
+      end
     end
   end
 end

data/lib/service_base_url_test_kit/service_base_url_test_group.rb

@@ -4,26 +4,53 @@ require_relative 'service_base_url_retrieve_group'
 module ServiceBaseURLTestKit
   class ServiceBaseURLGroup < Inferno::TestGroup
     id :service_base_url_test_group
-    title 'Retrieve and Validate Service Base URL List'
-    description %(    
-    Verify that the developer makes its Service Base URL publication publicly available
-    in the Bundle resource format with valid Endpoint and Organization entries.
-    This test group will issue a HTTP GET request against the supplied URL to
-    retrieve the developer's Service Base URL list and ensure the list is
-    publicly accessible. It will then ensure that the returned service base URL
-    publication is in the Bundle resource format containing its service base URLs and
-    related organizational details in valid Endpoint and Organization resources
-    that follow the specifications detailed in the HTI-1 rule and the API
-    Condition and Maintenance of Certification.
-
-    For systems that provide the service base URL Bundle at a URL, please run
-    all tests within this group.  While it is the expectation of the
-    specification for the service base URL Bundle to be served at a
-    public-facing endpoint, testers can validate a Service Base URL Bundle not
-    served at a public endpoint by running Test 1.2: Validate Service Base URL
-    List validation individually.
+    title 'Validate Service Base URL Publication'
+    description %(
+      Verify that the developer makes its Service Base URL publication publicly available
+      in the Bundle resource format with valid Endpoint and Organization entries.
+      This test group will issue a HTTP GET request against the supplied URL to
+      retrieve the developer's Service Base URL publication and ensure the list is
+      publicly accessible. It will then ensure that the returned service base URL
+      publication is in the Bundle resource format containing its service base URLs and
+      related organizational details in valid Endpoint and Organization resources
+      that follow the specifications detailed in the HTI-1 rule and the API
+      Condition and Maintenance of Certification.
+
+      For systems that provide the service base URL Bundle at a URL, please run
+      this test with the Service Base URL Publication URL input populated and the Service Base URL Publication Bundle
+      input left blank. While it is the expectation of the specification for the service base URL Bundle to be served at a
+      public-facing endpoint, testers can validate a Service Base URL Bundle not served at a public endpoint by running
+      these tests with the Service Base URL Publication Bundle input populated and the Service Base URL Publication URL
+      input left blank.
     )
-    
+
+    input_instructions <<~INSTRUCTIONS
+      For systems that make their Service Base URL Bundle available at a public endpoint, please input
+      the Service Base URL Publication URL to retrieve the Bundle from there in order to perform validation.
+
+      For systems that do not have a Service Base URL Bundle served at a public endpoint, testers can validate by
+      providing the Service Base URL Publication Bundle as an input and leaving the Service Base URL Publication URL
+      input blank.
+    INSTRUCTIONS
+
+    run_as_group
+
+    input :service_base_url_publication_url,
+          title: 'Service Base URL Publication URL',
+          description: %(The URL to the developer's public Service Base URL Publication. Insert your Service Base URL
+          publication URL if you host your Bundle at a public-facing endpoint and want Inferno to retrieve the Bundle
+          from there.),
+          optional: true
+
+    input :service_base_url_bundle,
+          title: 'Service Base URL Publication Bundle',
+          description: %(The developer's Service Base URL Publication in the JSON string format. If this input is
+          populated, Inferno will use the Bundle inserted here to do validation. Insert your Service Base URL
+          Publication Bundle in the JSON format in this input to validate your list without Inferno needing to access
+          the Bundle via a public-facing endpoint.),
+          type: 'textarea',
+          optional: true
+
     group from: :service_base_url_retrieve_list
     group from: :service_base_url_validate_list
   end

data/lib/service_base_url_test_kit/service_base_url_validate_group.rb

@@ -1,41 +1,87 @@
 module ServiceBaseURLTestKit
   class ServiceBaseURLBundleTestGroup < Inferno::TestGroup
     id :service_base_url_validate_list
-    title 'Validate Service Base URL List'
+    title 'Validate Service Base URL Publication'
     description %(
       These tests ensure that the developer's Service Base URL publication is in
       the Bundle resource format, with its service base URLs and organizational
       details contained in valid Endpoint and Organization entries that follow
       the specifications detailed in the HTI-1 rule and the API Condition and
       Maintenance of Certification.
+
+      These tests may be run individually, bypassing the first test group, if the Service Base URL Publication Bundle
+      input is populated and the Service Base URL Publication URL is left blank (or if it does not successfully return
+      a Service Base URL Publication Bundle). You may insert your Service Base URL Publication Bundle in the JSON
+      format in the Service Base URL Publication Bundle input to validate your list without Inferno needing to retrieve
+      the Bundle via a public-facing endpoint.
     )
     run_as_group
 
-    input :bundle_response,
-      title: 'Service Base URL List Bundle',
-      description: 'The developer\'s Service Base URL List in the JSON string format',
-      type: 'textarea'
+    input :service_base_url_bundle,
+          optional: true
+
+    input :endpoint_availability_success_rate,
+          title: 'Endpoint Availability Success Rate',
+          description: %(
+            Select an option to choose how many Endpoints have to be available and send back a valid capability
+            statement for the Endpoint validation test to pass.
+          ),
+          type: 'radio',
+          options: {
+            list_options: [
+              {
+                label: 'All',
+                value: 'all'
+              },
+              {
+                label: 'At Least One',
+                value: 'at_least_1'
+              },
+              {
+                label: 'None',
+                value: 'none'
+              }
+            ]
+          },
+          default: 'all'
+
+    input :endpoint_availability_limit,
+          title: 'Endpoint Availability Limit',
+          description: %(
+            In the case where the Endpoint Availability Success Rate is 'All', input a number to cap the number of
+            Endpoints that Inferno will send requests to check for availability. This can help speed up validation when
+            there are large number of endpoints in the Service Base URL Bundle.
+          ),
+          optional: true
 
     # @private
     def find_referenced_org(bundle_resource, endpoint_id)
       bundle_resource
-      .entry
-      .map(&:resource)
-      .select { |resource| resource.resourceType == 'Organization' }
-      .map { |resource| resource.endpoint }
-      .flatten
-      .map(&:reference)
-      .select { |reference| reference.include? endpoint_id }
+        .entry
+        .map(&:resource)
+        .select { |resource| resource.resourceType == 'Organization' }
+        .map(&:endpoint)
+        .flatten
+        .map(&:reference)
+        .select { |reference| reference.include? endpoint_id }
     end
 
     # @private
     def find_referenced_endpoint(bundle_resource, endpoint_id_ref)
       bundle_resource
-      .entry
-      .map(&:resource)
-      .select { |resource| resource.resourceType == 'Endpoint' }
-      .map(&:id)
-      .select { |endpoint_id| endpoint_id_ref.include? endpoint_id }
+        .entry
+        .map(&:resource)
+        .select { |resource| resource.resourceType == 'Endpoint' }
+        .map(&:id)
+        .select { |endpoint_id| endpoint_id_ref.include? endpoint_id }
+    end
+
+    def skip_message
+      %(
+        No Service Base URL request was made in the previous test, and no Service Base URL Publication Bundle
+        was provided as input instead. Either provide a Service Base URL Publication URL to retrieve the Bundle via a
+        HTTP GET request, or provide the Bundle as an input.
+      )
     end
 
     #  Valid BUNDLE TESTS
@@ -47,8 +93,16 @@ module ServiceBaseURLTestKit
       )
 
       run do
+        bundle_response = if service_base_url_bundle.blank?
+                            load_tagged_requests('service_base_url_bundle')
+                            skip skip_message if requests.length != 1
+                            requests.first.response_body
+                          else
+                            service_base_url_bundle
+                          end
         skip_if bundle_response.blank?, 'No Bundle response was provided'
 
+        assert_valid_json(bundle_response)
         bundle_resource = FHIR.from_contents(bundle_response)
         assert_valid_resource(resource: bundle_resource)
 
@@ -58,13 +112,24 @@ module ServiceBaseURLTestKit
             The given Bundle does not contain any resources
           )
         end
+
+        additional_resources = bundle_resource.entry
+          .map { |entry| entry.resource.resourceType }
+          .reject { |resource_type| ['Organization', 'Endpoint'].include?(resource_type) }
+          .uniq
+
+        warning do
+          assert(additional_resources.empty?, %(
+          The Service Base URL List contained the following additional resources other than Endpoint and
+          Organization resources: #{additional_resources.join(', ')}))
+        end
       end
     end
 
     # VALID ENDPOINT TESTS
     test do
       id :service_base_url_valid_endpoints
-      title 'Service Base URL List contains valid Endpoint resources'
+      title 'Service Base URL Publication contains valid Endpoint resources'
       description %(
         Verify that Bundle of Service Base URLs contains Endpoints that are
         valid Endpoint resources according to the format defined in FHIR v4.0.1.
@@ -79,18 +144,24 @@ module ServiceBaseURLTestKit
       )
 
       run do
-
+        bundle_response = if service_base_url_bundle.blank?
+                            load_tagged_requests('service_base_url_bundle')
+                            skip skip_message if requests.length != 1
+                            requests.first.response_body
+                          else
+                            service_base_url_bundle
+                          end
         skip_if bundle_response.blank?, 'No Bundle response was provided'
 
+        assert_valid_json(bundle_response)
         bundle_resource = FHIR.from_contents(bundle_response)
 
         skip_if bundle_resource.entry.empty?, 'The given Bundle does not contain any resources'
 
         assert_valid_bundle_entries(bundle: bundle_resource,
-          resource_types: {
-            'Endpoint': nil
-          }
-        )
+                                    resource_types: {
+                                      Endpoint: nil
+                                    })
 
         endpoint_ids =
           bundle_resource
@@ -99,11 +170,10 @@ module ServiceBaseURLTestKit
             .select { |resource| resource.resourceType == 'Endpoint' }
             .map(&:id)
 
-
-        for endpoint_id in endpoint_ids
+        endpoint_ids.each do |endpoint_id|
           endpoint_referenced_orgs = find_referenced_org(bundle_resource, endpoint_id)
-          assert !endpoint_referenced_orgs.empty?, "Endpoint with id: #{endpoint_id} does not have any associated Organizations in the Bundle."
-
+          assert !endpoint_referenced_orgs.empty?,
+                 "Endpoint with id: #{endpoint_id} does not have any associated Organizations in the Bundle."
         end
       end
     end
@@ -113,45 +183,91 @@ module ServiceBaseURLTestKit
       id :service_base_url_valid_urls
       title 'All Endpoint resource referenced URLS should be valid and available'
       description %(
-        Verify that Bundle of Service Base URLs contains Endpoints that contain service base URLs that are both valid and available.
+        Verify that Bundle of Service Base URLs contains Endpoints that contain service base URLs that are both valid
+        and available.
       )
 
-      output :testing
-
       run do
+        bundle_response = if service_base_url_bundle.blank?
+                            load_tagged_requests('service_base_url_bundle')
+                            skip skip_message if requests.length != 1
+                            requests.first.response_body
+                          else
+                            service_base_url_bundle
+                          end
         skip_if bundle_response.blank?, 'No Bundle response was provided'
 
+        assert_valid_json(bundle_response)
         bundle_resource = FHIR.from_contents(bundle_response)
 
         skip_if bundle_resource.entry.empty?, 'The given Bundle does not contain any resources'
 
+        endpoint_list = bundle_resource
+          .entry
+          .map(&:resource)
+          .select { |resource| resource.resourceType == 'Endpoint' }
+          .map(&:address)
+          .uniq
+
+        if endpoint_availability_limit.present? && endpoint_availability_limit.to_i < endpoint_list.count
+          info %(
+            Only the first #{endpoint_availability_limit.to_i} endpoints of #{endpoint_list.count} total will be
+            checked.
+          )
+        end
 
-        bundle_resource
-        .entry
-        .map(&:resource)
-        .select { |resource| resource.resourceType == 'Endpoint' }
-        .map(&:address)
-        .uniq
-        .each do |address|
+        one_endpoint_valid = false
+        endpoint_list.each_with_index do |address, index|
           assert_valid_http_uri(address)
 
-          address = address.delete_suffix("/")
-          get("#{address}/metadata", client: nil, headers: {'Accept': 'application/fhir+json'})
-          assert_response_status(200)
-          assert resource.present?, 'The content received does not appear to be a valid FHIR resource'
-          assert_resource_type(:capability_statement)
+          next if endpoint_availability_success_rate == 'none' ||
+                  (endpoint_availability_limit.present? && endpoint_availability_limit.to_i <= index)
+
+          address = address.delete_suffix('/')
+
+          response = nil
+          warning do
+            response = get("#{address}/metadata", client: nil, headers: { Accept: 'application/fhir+json' })
+          end
+
+          if endpoint_availability_success_rate == 'all'
+            assert response.present?, "Encountered issues while trying to make a request to #{address}/metadata."
+            assert_response_status(200)
+            assert resource.present?, 'The content received does not appear to be a valid FHIR resource'
+            assert_resource_type(:capability_statement)
+          else
+            if response.present?
+              warning do
+                assert_response_status(200)
+                assert resource.present?, 'The content received does not appear to be a valid FHIR resource'
+                assert_resource_type(:capability_statement)
+              end
+            end
+
+            if !one_endpoint_valid && response.present? && response.status == 200 && resource.present? &&
+               resource.resourceType == 'CapabilityStatement'
+              one_endpoint_valid = true
+            end
+          end
+        end
+
+        if endpoint_availability_success_rate == 'at_least_1'
+          assert(one_endpoint_valid, %(
+            There were no Endpoints that were available and returned a valid Capability Statement in the Service Base
+            URL Bundle'
+          ))
         end
       end
     end
 
-
     # ORGANIZATION TESTS
     test do
       id :service_base_url_valid_organizations
-      title 'Service Base URL List contains valid Organization resources'
+      title 'Service Base URL Publication contains valid Organization resources'
       description %(
 
-        Verify that Bundle of Service Base URLs contains Organizations that are valid Organization resources according to the format defined in FHIR v4.0.1.
+        Verify that Bundle of Service Base URLs contains Organizations that are valid Organization resources according
+        to the format defined in FHIR v4.0.1.
 
         Each Organization must:
           - Contain must have elements including:
@@ -165,36 +281,50 @@ module ServiceBaseURLTestKit
       )
 
       run do
+        bundle_response = if service_base_url_bundle.blank?
+                            load_tagged_requests('service_base_url_bundle')
+                            skip skip_message if requests.length != 1
+                            requests.first.response_body
+                          else
+                            service_base_url_bundle
+                          end
         skip_if bundle_response.blank?, 'No Bundle response was provided'
 
+        assert_valid_json(bundle_response)
         bundle_resource = FHIR.from_contents(bundle_response)
 
         skip_if bundle_resource.entry.empty?, 'The given Bundle does not contain any resources'
 
         assert_valid_bundle_entries(bundle: bundle_resource,
-          resource_types: {
-            'Organization': nil
-          }
-        )
-
-        endpoint_ids =
-          bundle_resource
-            .entry
-            .map(&:resource)
-            .select { |resource| resource.resourceType == 'Endpoint' }
-            .map(&:id)
-
-
-        for organization in bundle_resource.entry.map(&:resource).select { |resource| resource.resourceType == 'Organization' }
+                                    resource_types: {
+                                      Organization: nil
+                                    })
+
+        organization_resources = bundle_resource
+          .entry
+          .map(&:resource)
+          .select { |resource| resource.resourceType == 'Organization' }
+
+        warning do
+          # This was requested to be included because a publication with only a single organization
+          # seems like a likely error and should be checked manually.
+          assert(organization_resources.length > 1,
+                 'The provided Service Base URL List contains only 1 Organization resource')
+        end
 
-          assert !organization.endpoint.empty?, "Organization with id: #{organization.id} does not have the endpoint field populated"
-          assert !organization.address.empty?, "Organization with id: #{organization.id} does not have the address field populated"
+        organization_resources.each do |organization|
+          assert !organization.endpoint.empty?,
+                 "Organization with id: #{organization.id} does not have the endpoint field populated"
+          assert !organization.address.empty?,
+                 "Organization with id: #{organization.id} does not have the address field populated"
 
+          endpoint_references = organization.endpoint.map(&:reference)
 
-          for endpoint_id_ref in organization.endpoint.map(&:reference)
+          endpoint_references.each do |endpoint_id_ref|
             organization_referenced_endpts = find_referenced_endpoint(bundle_resource, endpoint_id_ref)
-            assert !organization_referenced_endpts.empty?, "Organization with id: #{organization.id} references an Endpoint that is not contained in this bundle."
-
+            assert !organization_referenced_endpts.empty?,
+                   "Organization with id: #{organization.id} references an Endpoint that is not contained in this
+                   bundle."
           end
         end
       end

data/lib/service_base_url_test_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ServiceBaseURLTestKit
-  VERSION = '0.10.1'
+  VERSION = '0.11.0'
 end

data/lib/service_base_url_test_kit.rb

@@ -9,7 +9,7 @@ module ServiceBaseURLTestKit
     description %(
       This Test Kit provides a set of tests that verify conformance of Service
       Base URL publications to data format requirements as described in
-      [Conditions of Maintenance of Certification - Application programming
+      [Conditions and Maintenance of Certification - Application programming
       interfaces](https://www.ecfr.gov/current/title-45/subtitle-A/subchapter-D/part-170/subpart-D/section-170.404#p-170.404(b)(2))
       and the [ONC HTI-1 Final
       Rule](https://www.healthit.gov/topic/laws-regulation-and-policy/health-data-technology-and-interoperability-certification-program).
@@ -17,17 +17,19 @@ module ServiceBaseURLTestKit
       Guide](https://www.healthit.gov/condition-ccg/application-programming-interfaces)
       for additional guidance.
 
-      This Test Kit is provided as a tool to help developers identify potential issues
-      or problems with the structure of their Service Base URL publication.  Test
-      failures do not necessarily indicate non-conformance to the Conditions of
-      Maintenance of Certification.  Use of these tests is not required.  Please
-      provide feedback on these tests by reporting an issue in
+      This Test Kit is provided as a tool to help developers identify potential
+      issues or problems with the structure of their Service Base URL
+      publication.  Test failures do not necessarily indicate non-conformance to
+      the Conditions and Maintenance of Certification.  Use of these tests is
+      not required for the participants of the ONC Health IT Certification Program.
+      Please provide feedback on these tests by reporting an issue in
       [GitHub](https://github.com/inferno-framework/service-base-url-test-kit/issues),
       or by reaching out to the team on the [Inferno FHIR Zulip
       channel](https://chat.fhir.org/#narrow/stream/179309-inferno).
 
-      Relevant requirements from the Conditions of [Maintenance of Certification -
-      Application programming interfaces](https://www.ecfr.gov/current/title-45/subtitle-A/subchapter-D/part-170/subpart-D/section-170.404#p-170.404(b)(2)):
+      Relevant requirements from the [Conditions and Maintenance of
+      Certification - Application programming
+      interfaces](https://www.ecfr.gov/current/title-45/subtitle-A/subchapter-D/part-170/subpart-D/section-170.404#p-170.404(b)(2)):
 
       Service Base URL publication:
 
@@ -39,18 +41,18 @@ module ServiceBaseURLTestKit
       170.315(g)(10) are centrally managed by the Certified API Developer or
       locally deployed by an API Information Source. These service base URLs and
       organization details must conform to the following:
-      
+
        - Service base URLs must be publicly published in Endpoint resource format
          according to the standard adopted in § 170.215(a) (FHIR v4.0.1).
        - Organization details for each service base URL must be publicly published in Organization
          resource format according to the standard adopted in § 170.215(a) (FHIR v4.0.1). Each
-         Organization resource must contain: 
+         Organization resource must contain:
           - A reference, in the Organization endpoint element, to the Endpoint
             resources containing service base URLs managed by this organization.
-          - The organization’s name, location, and facility identifier.
+          - The organization's name, location, and facility identifier.
        - Endpoint and Organization resources must be:
          - Collected into a Bundle resource formatted according to the standard
-            adopted in § 170.215(a) (FHIR v4.0.1) for publication; 
+            adopted in § 170.215(a) (FHIR v4.0.1) for publication;
          - and Reviewed quarterly and, as
             necessary, updated.
 
@@ -58,6 +60,16 @@ module ServiceBaseURLTestKit
     )
     version VERSION
 
+    input_instructions <<~INSTRUCTIONS
+      For systems that make their Service Base URL Bundle available at a public endpoint, please input
+      the Service Base URL Publication URL to retrieve the Bundle from there in order to perform validation, and leave
+      the Service Base URL Publication Bundle input blank.
+
+      For systems that do not have a Service Base URL Bundle served at a public endpoint, testers can validate by
+      providing the Service Base URL Publication Bundle as an input and leaving the Service Base URL Publication URL
+      input blank.
+    INSTRUCTIONS
+
     links [
       {
         label: 'Report Issue',
@@ -66,6 +78,14 @@ module ServiceBaseURLTestKit
       {
         label: 'Open Source',
         url: 'https://github.com/inferno-framework/service-base-url-test-kit'
+      },
+      {
+        label: 'Service base URL requirements',
+        url: 'https://www.ecfr.gov/current/title-45/subtitle-A/subchapter-D/part-170/subpart-D/section-170.404#p-170.404(b)(2)'
+      },
+      {
+        label: 'Certification Companion Guide',
+        url: 'https://www.healthit.gov/condition-ccg/application-programming-interfaces'
       }
     ]
 
@@ -76,11 +96,9 @@ module ServiceBaseURLTestKit
         my_bundle = JSON.parse(erb_template.result).to_json
         filename = filename.delete_suffix('.erb')
       end
-      if filename.include?("CapabilityStatement")
-        filename = filename.delete_suffix('.json') + "/metadata"
-      end
+      filename = "#{filename.delete_suffix('.json')}/metadata" if filename.include?('CapabilityStatement')
       my_bundle_route_handler = proc { [200, { 'Content-Type' => 'application/json' }, [my_bundle]] }
-      
+
       # Serve a JSON file at INFERNO_PATH/custom/service_base_url/examples/filename
       route :get, File.join('/examples/', filename), my_bundle_route_handler
     end
@@ -88,7 +106,7 @@ module ServiceBaseURLTestKit
     VALIDATION_MESSAGE_FILTERS = [
       /A resource should have narrative for robust management/,
       /\A\S+: \S+: URL value '.*' does not resolve/
-    ]
+    ].freeze
 
     # All FHIR validation requests will use this FHIR validator
     fhir_resource_validator :default do
@@ -99,4 +117,4 @@ module ServiceBaseURLTestKit
 
     group from: :service_base_url_test_group
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_base_url_test_kit
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Inferno Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-09 00:00:00.000000000 Z
+date: 2024-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inferno_core
@@ -90,6 +90,7 @@ files:
 - LICENSE
 - lib/service_base_url_test_kit.rb
 - lib/service_base_url_test_kit/examples/CapabilityStatement.json
+- lib/service_base_url_test_kit/examples/SmartAccessBrand.json.erb
 - lib/service_base_url_test_kit/examples/testBundleValid.json.erb
 - lib/service_base_url_test_kit/service_base_url_retrieve_group.rb
 - lib/service_base_url_test_kit/service_base_url_test_group.rb
@@ -116,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.10
 signing_key:
 specification_version: 4
 summary: Inferno Service Base URL Test Kit