Human Service Data API Suite (HSDA)¶
The Human Service Data API Suite (HSDA) consist of a set of protocols for accessing, updating, exchanging and synchronising community resource directory data.
HSDA is one of the Open Referral specifications, and builds on HSDS. Open Referral's goal is to enable interoperability among diverse technologies that might use resource directory information to help meet people’s needs.
When to use HSDA?
HSDA provides a family of OpenAPI specifications that can be used as a blueprint for the design or adaptation of API platforms to provide read or read/write access to information on organizations, services, locations and the details about them.
The core API protocol can be used by mobile apps, websites and other services to access individual resources, or listings. Providers can also support updates via API if they choose. In conjuction with the search protocol, this provides most of the functionality needed for simple access and exchange of data.
More complex data synchronisation between distributed systems is supported through the additional protocols.
These specifications use the OpenAPI format. This is widely supported in a range of tools and software libraries.
HSDA versioning is independent from HSDS. HSDA is currently in version 1.2
The Human Service Data API specifications consist of a core protocol and associated secondary protocols.
The core HSDA protocol (HSDA) describes read/write functionality for the Open Referral’s Human Services Data Specification (HSDS), including resources for organizations, their locations, and their services. Through the HSDA Full protocol, third-parties can access entire contents of a database with a single call.
Find the core HSDA protocol in a YAML file here.
HSDA v1.2 also includes complementary sets of “microservice” protocols that address specific user needs (as documented in user personas and use cases generated through our community’s participatory research process). This modular microservice approach enables specific protocols to be developed independently, while working complementarily in concert with each other.
These secondary HSDA specifications facilitate the flow of resource directory data.
- HSDA Search: the Search protocol is specifically designed for third-party software developers to enable their tools to query a resource database for specific sets of information.
- HSDA Taxonomy: the Taxonomy protocol specifies the use of taxonomic schema for core resources. It can accommodate multiple classification formats.
- HSDA Bulk: the Bulk protocol is specifically designed for database administrators to enable mass transfer of data between systems — with changelogs, scheduling, and other key features.
These secondary specifications facilitate the monitoring, permissioning and associated management of a resource directory API platform. These are experimental features, and are subject to ongoing development.
- HSDA Meta: the Meta protocol logs all activity across the above protocols. This data about API usage is sometimes known as ‘exhaust,’ or ‘paradata’ — valuable for both technical monitoring as well as research and analysis of community needs.
- HSDA Management: the Management protocol specifies which users have access to what sections of the database, enabling API providers to have fine-grained control over their traffic.
- HSDA Validator: tools for building and validating data schema to help stabilize operations.
- HSDA Orchestration: the Orchestration protocol facilitates activities across and between HSDA protocols.
HSDA has been through a number of iterations during development:
- HSDA v1.1 is accessible for reference.
Prior to HSDA, the Ohana API acted as a reference implementation of an early version the Human Services Data Spec, and it was used as one of the inputs to the recent API development process. Systems based on Ohana will need to be updated to follow the new HSDA specifications.
The HSDA has been designed by @kinlane, the API Evangelist, with guidance from a range of contributors in the Open Referral network.
The first cycle of HSDA's development was made possible by support from the Digital Impact program at Stanford's Center for Philanthropy and Civil Society.
You can use the portal to explore how a fully implemented API should respond to various requests. As the Miami implementation of this portal shows you can fork the code and use it provide developers with clear information on your own API implementation.