service_base_url_test_kit 0.9.1 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ffc8388386fb4a40cc4fd90999bfe34e8984b22c64d4ddd26f570184b58376d
-  data.tar.gz: aa10cdf0856818dc96813e1f75c9ee02cd38899868ad772cd9105b139186d36c
+  metadata.gz: 7930c517e65b84c6011ba94dc5419c9d26548b931194bad1724bda2e26f632e6
+  data.tar.gz: d73dcf49c51873fb5aad07f079bc66b72d0912fea69e52d4a4e790bb167b6af2
 SHA512:
-  metadata.gz: 805e95a41f4fdaef58fde70e1e7f5cbba74626ea32b49568aabe736fbeba95b30ac0ec7c3461f900925a839fb3b7d5d769358a0204181283cc58447946912af5
-  data.tar.gz: 436893f8217d45279dadb906a934905d4269a8740536423e2b720caf688a70c99ab047b70e002608834d8586173eb05d87aae512f4286f834c31f5f4ba870da6
+  metadata.gz: 3d572a5d516ad116afc9787c4816493fb48788c89a163c4365ee664dd94bbd745a19eef429ae0095a13d2e7742113f64f134f80e399469798a60f08442c33157
+  data.tar.gz: b7b0e8b87f62e5ecedeaadb0b3693ec81d9a94dd6d916616fbef54d6c023c603e30f6eb6c12567a780686a2472c64348423b757ec40e45fb0fcb444ec4837251

data/lib/service_base_url_test_kit/service_base_url_test_group.rb

@@ -6,14 +6,14 @@ module ServiceBaseURLTestKit
     id :service_base_url_test_group
     title 'Retrieve and Validate Service Base URL List'
     description %(    
-    Verify that the developer makes its Service Base URL list publicly available
+    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
-    list is in the Bundle resource format containing its service base URLs and
+    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 in the API
+    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

data/lib/service_base_url_test_kit/service_base_url_validate_group.rb

@@ -3,10 +3,10 @@ module ServiceBaseURLTestKit
     id :service_base_url_validate_list
     title 'Validate Service Base URL List'
     description %(
-      These tests ensure that the developer's Service Base URL list is in the
-      Bundle resource format, with its service base URLs and organizational
+      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 in the API Condition and
+      the specifications detailed in the HTI-1 rule and the API Condition and
       Maintenance of Certification.
     )
     run_as_group
@@ -15,7 +15,7 @@ module ServiceBaseURLTestKit
       title: 'Service Base URL List Bundle',
       description: 'The developer\'s Service Base URL List in the JSON string format',
       type: 'textarea'
-    
+
     # @private
     def find_referenced_org(bundle_resource, endpoint_id)
       bundle_resource
@@ -58,7 +58,7 @@ module ServiceBaseURLTestKit
             The given Bundle does not contain any resources
           )
         end
-      end      
+      end
     end
 
     # VALID ENDPOINT TESTS
@@ -79,7 +79,7 @@ module ServiceBaseURLTestKit
       )
 
       run do
-        
+
         skip_if bundle_response.blank?, 'No Bundle response was provided'
 
         bundle_resource = FHIR.from_contents(bundle_response)
@@ -91,7 +91,7 @@ module ServiceBaseURLTestKit
             'Endpoint': nil
           }
         )
-        
+
         endpoint_ids =
           bundle_resource
             .entry
@@ -105,7 +105,7 @@ module ServiceBaseURLTestKit
           assert !endpoint_referenced_orgs.empty?, "Endpoint with id: #{endpoint_id} does not have any associated Organizations in the Bundle."
 
         end
-      end      
+      end
     end
 
     # ENDPOINT VALID URL TESTS
@@ -131,15 +131,17 @@ module ServiceBaseURLTestKit
         .map(&:resource)
         .select { |resource| resource.resourceType == 'Endpoint' }
         .map(&:address)
+        .uniq
         .each do |address|
-          assert_valid_http_uri(address) 
+          assert_valid_http_uri(address)
 
           address = address.delete_suffix("/")
-          get("#{address}/metadata", client: nil, headers: {'Accept': 'application/json, application/fhir+json'})
+          get("#{address}/metadata", client: nil, headers: {'Accept': 'application/fhir+json'})
           assert_response_status(200)
-          assert_resource_type(:capability_statement)        
+          assert resource.present?, 'The content received does not appear to be a valid FHIR resource'
+          assert_resource_type(:capability_statement)
         end
-      end      
+      end
     end
 
 
@@ -155,7 +157,7 @@ module ServiceBaseURLTestKit
           - Contain must have elements including:
             - active
             - name
-          - Include the organization's name, location, and provider identifier 
+          - Include the organization's name, location, and facility identifier
           - Use the endpoint field to reference Endpoints associated with the Organization:
             - Must reference only Endpoint resources in the endpoint field
             - Must reference at least one Endpoint resource in the endpoint field
@@ -174,7 +176,7 @@ module ServiceBaseURLTestKit
             'Organization': nil
           }
         )
-        
+
         endpoint_ids =
           bundle_resource
             .entry
@@ -188,14 +190,14 @@ module ServiceBaseURLTestKit
           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"
 
-          
+
           for endpoint_id_ref in organization.endpoint.map(&:reference)
             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."
-            
+
           end
-        end 
-      end      
+        end
+      end
     end
   end
-end
+end

data/lib/service_base_url_test_kit/version.rb

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

data/lib/service_base_url_test_kit.rb

@@ -7,49 +7,54 @@ module ServiceBaseURLTestKit
     id :service_base_url
     title 'Service Base URL Test Suite'
     description %(
-      This test kit provides a draft set of tests to validate conformance to
-      [HTI-1](https://www.healthit.gov/topic/laws-regulation-and-policy/health-data-technology-and-interoperability-certification-program)
-      [rule](https://www.ecfr.gov/current/title-45/subtitle-A/subchapter-D/part-170/subpart-D/section-170.404#p-170.404(b)(2))
-      from the API Condition and Maintenance of Certification to include the
-      requirement for Certified API Developers with patient-facing apps to
-      publish their service base URLs in [a specified
-      format](https://www.federalregister.gov/d/2023-07229/p-2342).
+      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
+      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).
+      Please review the [Application Programming Interfaces Certification Companion
+      Guide](https://www.healthit.gov/condition-ccg/application-programming-interfaces)
+      for additional guidance.
 
-      A Certified API developer must publish, at no charge, the service base
-      URLs and related organizational details that can be used by patients to
-      access their electronic health information. This test kit will test that a
-      server's service base URL list conforms to the following:
-        - Service base URL list is publicly accessible
-        - Service based URLs are published in the Endpoint resource format
-          according to the standard adopted in § 170.215\(a\) - FHIR 4.0.1 release
-        - Organization details for each service base URL are published in the
-          Organization resource format according to the standard adopted in §
-          170.215\(a\) - FHIR 4.0.1 release
-        - Each Endpoint resource must:
-          - Have at least one Organization resource that references it in the Bundle
-        - Each Organization resource must:
-          - Have a populated Organization.endpoint field that contains
-            references to the Endpoint resources containing service base URLs
-            managed by this organization
-          - Contain the organization's name, location, and provider identifier 
-        - Endpoint and Organization resources must be:
-          - Collected into a Bundle resource formatted according to the standard
-            adopted in FHIR v4.0.1: § 170.215\(a\) for publication
-
-      While these tests do not specifically verify conformance to
-      [Patient-Access
-      Brands](https://build.fhir.org/ig/HL7/smart-app-launch/brands.html) within
-      the draft SMART App Launch v2.2.0 standard, systems that implement that
-      standard should pass these tests. Please report an issue if there are any
-      problems.
-
-      The tests within this test kit are available for developers that would
-      like to evaluate their service list against the specified format. This is
-      a draft set of tests and may contain errors or issues. 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 of
+      Maintenance of Certification.  Use of these tests is not required.  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)):
+
+      Service Base URL publication:
+
+      For all Health IT Modules certified to § 170.315(g)(10), a Certified API
+      Developer must publish, at no charge, the service base URLs and related
+      organization details that can be used by patients to access their
+      electronic health information, by December 31, 2024. This includes all
+      customers regardless of whether the Health IT Modules certified to §
+      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: 
+          - 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.
+       - 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; 
+         - and Reviewed quarterly and, as
+            necessary, updated.
+
+
     )
     version VERSION
 
@@ -80,12 +85,15 @@ module ServiceBaseURLTestKit
       route :get, File.join('/examples/', filename), my_bundle_route_handler
     end
 
-    # All FHIR validation requests will use this FHIR validator
-    validator :default do
-      url ENV.fetch('VALIDATOR_URL', 'http://validator_service:4567')
+    VALIDATION_MESSAGE_FILTERS = [
+      /A resource should have narrative for robust management/,
+      /\A\S+: \S+: URL value '.*' does not resolve/
+    ]
 
+    # All FHIR validation requests will use this FHIR validator
+    fhir_resource_validator :default do
       exclude_message do |message|
-        message.message.include?('A resource should have narrative for robust management')
+        VALIDATION_MESSAGE_FILTERS.any? { |filter| filter.match? message.message }
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_base_url_test_kit
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.1
 platform: ruby
 authors:
 - Inferno Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-08 00:00:00.000000000 Z
+date: 2024-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inferno_core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: 0.4.37
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: 0.4.37
 - !ruby/object:Gem::Dependency
   name: database_cleaner-sequel
   requirement: !ruby/object:Gem::Requirement