API Service Base URL Availability

Developers of certified API technology that choose to certify to 45 CFR 170.315(g)(10) Standardized API for patient and population services must meet ongoing conformance requirements beyond initial testing for certification. As outlined in the API Maintenance of Certification requirements in 45 CFR 170.404(b)(2), any Certified API developer must publish the service base Uniform Resource Locators (URLs) for all Health IT Modules certified to 45 CFR 170.315(g)(10).  These service base URLs must be publicly available through the Certified Health IT Product List (CHPL) so that they can be used by patients to access their EHI.

ONC has implemented a comprehensive oversight framework using the CHPL Service Base URL Availability Report to monitor the consistent accessibility of service base URLs for each listing. The Lantern project extends this oversight by conducting daily assessments to check the discoverability of endpoints through the service base URLs and promptly offer a FHIR capability statement upon request.

The Service Base URL Availability Report linked below provides information on the public availability of the Service Base URL Lists provided on Health IT Modules certified to § 170.315(g)(10) on the Certified Health IT Product List (CHPL). ONC checks the availability of these Service Base URL Lists on CHPL every hour, from 8:00am to 8:00pm ET, Monday through Friday, and provides the information on how many of those checks were successful in the last 7 days, the last month, and the total number of checks since monitoring began. The Service Base URL Availability Report considers a URL availability to not be successful if any of the following conditions occur:

  • URL not found: This designation typically refers to a URL that cannot be located or does not exist on the internet. This may be because it was removed from the website or moved to another location without properly redirecting to a new source.
  • Timeout greater than 30 seconds: A timeout occurs when a server takes longer than 30 seconds to respond, often due to network or server issues, and an error message is displayed, indicating the failure to retrieve the requested content.
  • URL redirect: This is a technique where the given URL address forwards the user to a different URL address. This is considered an error as it does not accurately reflect the information provided by the developer and displayed in CHPL.
  • Malformed response: An improperly formatted response of a URL happens when the server generates an incorrectly structured or incorrectly formatted reply while accessing the specific web address.

To ensure transparency and ongoing compliance with 45 CFR 170.315(g)(10) you can access the Service Base URL Availability Report on the Download the CHPL page.