service_base_url_test_kit 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 638bed4317d3630a7ffdfbc9cef4be2dc266ab285de017d890a1ceadec4858fc
-  data.tar.gz: fab6cb020b68f87db82348891f3b80eb0d5e3bc9181639c9bf1b5a9505611de4
+  metadata.gz: e91f9cae9a6fea650a22c5b41fe94c40602926a05f6b3c0c41873cb7bed5a0f8
+  data.tar.gz: 0c2dffafe8294da0b5552f3bb89ba7efa77d91ad6e982d010349248c78a98dfe
 SHA512:
-  metadata.gz: 61b58536e24b25039953dc99cc4a507202c08297a8be0f70edb0d340ec0fa77824dbaee0de8be5bb548306eaf5c0e5b47dc143405882ebb5f91537bd258ccb68
-  data.tar.gz: 1fccec1d67cb3642771fa89360e90b3ad9f157bed70d35ee5beb09324cc5b649f74554638df4202834ffba3ca43c1578751477df79eb7c626707371ace21d205
+  metadata.gz: e29145b7ad925d1a511b3706d15ecd9411c819561adc94589c8b956b9736e1c68f4f9e583c3f4439b201d972ec16e47ed821fedaeb03922949391038b729a2d1
+  data.tar.gz: fdcdac8c678ea131b6e94772a32817a11fd064d99af05dd6d2146e37f310d08ef25144e7925f551b291f267d43f9a8111ecf50495c9ee39a76fc8db9d2957d81

data/config/presets/service_base_url_local_host_endpoint_list_preset.json.erb

@@ -0,0 +1,13 @@
+{
+  "title": "Example Service Base URL",
+  "id": null,
+  "test_suite_id": "service_base_url",
+  "inputs": [
+    {
+      "name": "service_base_url_publication_url",
+      "value": "<%= Inferno::Application['base_url'] %>/custom/service_base_url/examples/testBundleValid.json",
+      "title": "Service Base URL Publication URL",
+      "type": "text"
+    }
+  ]
+}

data/lib/service_base_url_test_kit/metadata.rb

@@ -0,0 +1,79 @@
+module ServiceBaseURLTestKit
+  class Metadata < Inferno::TestKit
+    id :service_base_url_test_kit
+    title 'Service Base URL Test Kit'
+    suite_ids ['service_base_url']
+    tags ['Endpoint Publication']
+    last_updated ::ServiceBaseURLTestKit::LAST_UPDATED
+    version ::ServiceBaseURLTestKit::VERSION
+    maturity 'Medium'
+    authors ['Inferno Team']
+    repo 'https://github.com/inferno-framework/service-base-url-test-kit'
+    description <<~DESCRIPTION
+      The Service Base URL Test Kit provides a set of tests that verify
+      conformance of Service Base URL publications to data format requirements
+      as described in
+      [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).
+      Please review the
+      [Application Programming Interfaces Certification Companion Guide](https://www.healthit.gov/condition-ccg/application-programming-interfaces)
+      for additional guidance. <!-- break -->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 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).
+  
+      This Test Kit specifically targets requirements provided within the Conditions
+      and Maintenance of Certification. Testing for the related
+      [SMART User-access Brands and Endpoints](http://hl7.org/fhir/smart-app-launch/STU2.2/brands.html)
+      specification is provided separately within the
+      [SMART App Launch Test Kit](https://inferno.healthit.gov/test-kits/smart-app-launch).
+  
+      Relevant requirements from the Conditions and Maintenance of
+      Certification - Application programming interfaces:
+  
+      **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.
+  
+      ## Providing Feedback and Reporting Issues
+  
+      We welcome feedback on the tests, including but not limited to the following areas:
+  
+      - Validation logic, such as potential bugs, lax checks, and unexpected failures.
+      - Requirements coverage, such as requirements that have been missed, tests that
+        necessitate features that the IG does not require, or other issues with the
+        interpretation of the IG’s requirements.
+      - User experience, such as confusing or missing information in the test UI.
+  
+      Please report any issues with this set of tests in the
+      [issues section](https://github.com/inferno-framework/service-base-url-test-kit/issues)
+      of the source code repository.
+    DESCRIPTION
+  end
+end

data/lib/service_base_url_test_kit/service_base_url_test_group.rb

@@ -6,22 +6,19 @@ module ServiceBaseURLTestKit
     id :service_base_url_test_group
     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.
+      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 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

data/lib/service_base_url_test_kit/service_base_url_validate_group.rb

@@ -76,6 +76,14 @@ module ServiceBaseURLTestKit
         .select { |endpoint_id| endpoint_id_ref.include? endpoint_id }
     end
 
+    def find_parent_organization(bundle_resource, org_reference)
+      bundle_resource
+        .entry
+        .map(&:resource)
+        .select { |resource| resource.resourceType == 'Organization' }
+        .find { |parent_org| org_reference.include? parent_org.id }
+    end
+
     def skip_message
       %(
         No Service Base URL request was made in the previous test, and no Service Base URL Publication Bundle
@@ -274,10 +282,13 @@ module ServiceBaseURLTestKit
             - active
             - name
           - 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
-            - Must reference only Endpoints that are contained in the Service Base URL Bundle
+          - For Endpoint information, the Organization must either:
+            - 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
+              - Must reference only Endpoints that are contained in the Service Base URL Bundle
+            - Use the partOf field to reference a parent Organization that already contains the applicable endpoint
+            information in its own "Organization.endpoint" element
       )
 
       run do
@@ -313,18 +324,31 @@ module ServiceBaseURLTestKit
         end
 
         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)
+          if organization.endpoint.empty?
+            assert organization.partOf.present?, %(
+                    Organization with id: #{organization.id} does not have the endpoint or partOf field populated
+                  )
+            parent_organization = find_parent_organization(bundle_resource, organization.partOf.reference)
+            assert(parent_organization.present?, %(
+              Organization with id: #{organization.id} references parent Organization not found in the Bundle:
+              #{organization.partOf.reference}
+            ))
+            assert(!parent_organization.endpoint.empty?, %(
+              Organization with id: #{organization.id} has parent Organization with id: #{parent_organization.id} that
+              does not have the `endpoint` field populated.
+            ))
+          else
+            endpoint_references = 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."
+            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."
+            end
           end
         end
       end

data/lib/service_base_url_test_kit/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module ServiceBaseURLTestKit
-  VERSION = '0.11.0'
+  VERSION = '0.12.0'
+  LAST_UPDATED = '2025-02-15'
 end

data/lib/service_base_url_test_kit.rb

@@ -1,4 +1,4 @@
-require_relative 'service_base_url_test_kit/version'
+require_relative 'service_base_url_test_kit/metadata'
 require_relative 'service_base_url_test_kit/service_base_url_test_group'
 require 'erb'
 
@@ -47,18 +47,19 @@ module ServiceBaseURLTestKit
        - 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.
+          - Either:
+            - A reference, in the Organization endpoint element, to the Endpoint
+            resources containing service base URLs managed by this organization
+            - A reference, in the Organization partOf element, to the parent Organization that contains the applicable
+            endpoint information in its own "Organization.endpoint" element
        - 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.
+            adopted in § 170.215(a) (FHIR v4.0.1) for publication
+         - Reviewed quarterly and, as necessary, updated.
 
 
     )
-    version VERSION
 
     input_instructions <<~INSTRUCTIONS
       For systems that make their Service Base URL Bundle available at a public endpoint, please input
@@ -79,6 +80,10 @@ module ServiceBaseURLTestKit
         label: 'Open Source',
         url: 'https://github.com/inferno-framework/service-base-url-test-kit'
       },
+      {
+        label: 'Download',
+        url: 'https://github.com/inferno-framework/service-base-url-test-kit/releases'
+      },
       {
         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)'

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: service_base_url_test_kit
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Inferno Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-10 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inferno_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.37
+        version: 0.6.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.37
+        version: 0.6.4
 - !ruby/object:Gem::Dependency
   name: database_cleaner-sequel
   requirement: !ruby/object:Gem::Requirement
@@ -88,10 +88,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- config/presets/service_base_url_local_host_endpoint_list_preset.json.erb
 - 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/igs/put_ig_package_dot_tgz_here
+- lib/service_base_url_test_kit/metadata.rb
 - lib/service_base_url_test_kit/service_base_url_retrieve_group.rb
 - lib/service_base_url_test_kit/service_base_url_test_group.rb
 - lib/service_base_url_test_kit/service_base_url_validate_group.rb
@@ -102,6 +104,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/inferno-framework/service-base-url-test-kit
   source_code_uri: https://github.com/inferno-framework/service-base-url-test-kit
+  inferno_test_kit: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -110,14 +113,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.2
+      version: 3.3.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Inferno Service Base URL Test Kit

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

@@ -1,105 +0,0 @@
-{
-    "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"
-      }
-    }]
-  }