# \#api **URL:** https://forum.openreferral.org/tag/api/2.md [Latest](https://forum.openreferral.org/latest.md) · [Categories](https://forum.openreferral.org/categories.md) · [Tags](https://forum.openreferral.org/tags.md) --- ## [Connect211 Proposal for New Field of HSDS Standardized Objects](https://forum.openreferral.org/t/connect211-proposal-for-new-field-of-hsds-standardized-objects/849)
**Author:** [@CheetoBandito](https://forum.openreferral.org/u/CheetoBandito)\ **Replies:** 3\ **Last updated:** [August 5, 2026, 3:50pm UTC](https://forum.openreferral.org/t/connect211-proposal-for-new-field-of-hsds-standardized-objects/849 "2026-08-05T15:50:44Z")
Hi all — I’d like to open a discussion around adding a small set of new objects to HSDS for exchanging feedback on existing records, and I’d appreciate a read-through and critique from this community. Because of our requ… --- ## [About the OR Validator category](https://forum.openreferral.org/t/about-the-or-validator-category/840)
**Author:** [@MikeThacker-iStandUK](https://forum.openreferral.org/u/MikeThacker-iStandUK)\ **Replies:** 0\ **Last updated:** [June 16, 2026, 12:02pm UTC](https://forum.openreferral.org/t/about-the-or-validator-category/840 "2026-06-16T12:02:49Z")
This category of the forum is to support the community that maintains and extends the iStandUK Open Referral Validator. The Validator has a GitHub repository and is surfaced here on the Open Referral UK website. A comm… --- ## [HSDS Profile Generation - to compile or not to compile?](https://forum.openreferral.org/t/hsds-profile-generation-to-compile-or-not-to-compile/776)
**Author:** [@jeffc](https://forum.openreferral.org/u/jeffc)\ **Replies:** 3\ **Last updated:** [March 18, 2026, 6:28pm UTC](https://forum.openreferral.org/t/hsds-profile-generation-to-compile-or-not-to-compile/776 "2026-03-18T18:28:47Z")
Thank you to Matt for running the walkthrough on the schema generation tooling recently. I usually harass Matt with my rants, he grabs his keyboard, opens up Vim, turns the lights off, and responds… It seems an appropr… --- ## [Notification of PATCH Update: bugfix for openapi.json file](https://forum.openreferral.org/t/notification-of-patch-update-bugfix-for-openapi-json-file/778)
**Author:** [@mrshll](https://forum.openreferral.org/u/mrshll)\ **Replies:** 1\ **Last updated:** [January 16, 2026, 8:55am UTC](https://forum.openreferral.org/t/notification-of-patch-update-bugfix-for-openapi-json-file/778 "2026-01-16T08:55:30Z")
As per the PATCH Process defined in the Specification Governance, I am posting to notify the committee of an upcoming PATCH-level change to the HSDS Standard. This PATCH represents a small one-line bugfix — and associat… --- ## [How should we mark endpoints as required in the OpenAPI Spec?](https://forum.openreferral.org/t/how-should-we-mark-endpoints-as-required-in-the-openapi-spec/649)
**Author:** [@mrshll](https://forum.openreferral.org/u/mrshll)\ **Replies:** 5\ **Last updated:** [November 17, 2025, 5:10pm UTC](https://forum.openreferral.org/t/how-should-we-mark-endpoints-as-required-in-the-openapi-spec/649 "2025-11-17T17:10:22Z")
I’m seeking input from people if you have an opinion on the technical method we use to mark HSDS API endpoints as REQUIREd in the OpenAPI.json file. This is to a) support future validation tooling producing a compliance … --- ## [ORUK Validator Compatability](https://forum.openreferral.org/t/oruk-validator-compatability/642)
**Author:** [@IlesdTPX](https://forum.openreferral.org/u/IlesdTPX)\ **Replies:** 2\ **Last updated:** [June 4, 2025, 12:52pm UTC](https://forum.openreferral.org/t/oruk-validator-compatability/642 "2025-06-04T12:52:21Z")
Hey all, I am testing out updating the ORUK validator to be compatible with HSDS V3.0. Are there any openly available APIs using the standard that could be used for testing? Thanks, Dave --- ## [Validator and dashboard for HSDS / HSDA 3.0 and beyond](https://forum.openreferral.org/t/validator-and-dashboard-for-hsds-hsda-3-0-and-beyond/415)
**Author:** [@MikeThacker-iStandUK](https://forum.openreferral.org/u/MikeThacker-iStandUK)\ **Replies:** 14\ **Last updated:** [June 4, 2025, 12:49pm UTC](https://forum.openreferral.org/t/validator-and-dashboard-for-hsds-hsda-3-0-and-beyond/415 "2025-06-04T12:49:48Z")
At @bloom’s request, I’ve drafted Por11474 - Open Referral Validator and Dashboard specification with my understanding of what’s needed for a validator for the API and how this should be used in a dashboard modelled on t… --- ## [Potential for using AirTable for small API feeds](https://forum.openreferral.org/t/potential-for-using-airtable-for-small-api-feeds/622)
**Author:** [@MikeThacker-iStandUK](https://forum.openreferral.org/u/MikeThacker-iStandUK)\ **Replies:** 6\ **Last updated:** [March 18, 2025, 3:17pm UTC](https://forum.openreferral.org/t/potential-for-using-airtable-for-small-api-feeds/622 "2025-03-18T15:17:18Z")
I’d appreciate comments on the feasibility of using AirTable for small databases of services with associated HSDS data and providing from that an API feed compliant with HSDA. In the UK (or just England) we have a possi… --- ## [Extra metadata with API feeds](https://forum.openreferral.org/t/extra-metadata-with-api-feeds/572)
**Author:** [@MikeThacker-iStandUK](https://forum.openreferral.org/u/MikeThacker-iStandUK)\ **Replies:** 13\ **Last updated:** [February 26, 2025, 3:44pm UTC](https://forum.openreferral.org/t/extra-metadata-with-api-feeds/572 "2025-02-26T15:44:25Z")
I’d like to propose extra optional fields to be returned by the root/stub API endpoint. Specifically to allow the Dashboard (new version is under development) to be documented entirely from a feed under the publisher’s … --- ## [HSDS officially interoperable with FHIR](https://forum.openreferral.org/t/hsds-officially-interoperable-with-fhir/444)
**Author:** [@bloom](https://forum.openreferral.org/u/bloom)\ **Replies:** 1\ **Last updated:** [October 5, 2023, 2:20pm UTC](https://forum.openreferral.org/t/hsds-officially-interoperable-with-fhir/444 "2023-10-05T14:20:20Z")
Exciting news this week, a culmination of work we’ve been doing for at least two years: We’ve now successfully aligned the HSDS model for social service directory information with the FHIR resources for healthcare provi… --- ## [Upgrade to UK standard and compliance rules (version 3.0)](https://forum.openreferral.org/t/upgrade-to-uk-standard-and-compliance-rules-version-3-0/427)
**Author:** [@MikeThacker-iStandUK](https://forum.openreferral.org/u/MikeThacker-iStandUK)\ **Replies:** 4\ **Last updated:** [September 11, 2023, 9:49am UTC](https://forum.openreferral.org/t/upgrade-to-uk-standard-and-compliance-rules-version-3-0/427 "2023-09-11T09:49:19Z")
The UK profile to Open Referral (HSDS and HSDA) 3.0 is now online and documented at Open Referral UK — Open Referral UK Profile 3.0.0 documentation. It is currently draft but will be made official if no errors or signifi… --- ## [Level 2 Compliance does not passing](https://forum.openreferral.org/t/level-2-compliance-does-not-passing/411)
**Author:** [@anisha](https://forum.openreferral.org/u/anisha)\ **Replies:** 10\ **Last updated:** [July 20, 2023, 9:53am UTC](https://forum.openreferral.org/t/level-2-compliance-does-not-passing/411 "2023-07-20T09:53:32Z")
Hello there, we have created the API for Feed, it passes through Level 1 Compliance but does not pass Level 2 Compliance and gives us the following error: Missing required fields service.id service.name Warnings \*T… --- ## [3.0 for review and comment](https://forum.openreferral.org/t/3-0-for-review-and-comment/364)
**Author:** [@Dan-ODS](https://forum.openreferral.org/u/Dan-ODS)\ **Replies:** 20\ **Last updated:** [June 22, 2023, 5:10pm UTC](https://forum.openreferral.org/t/3-0-for-review-and-comment/364 "2023-06-22T17:10:13Z")
Hi all, We’ve reached a point where we’d like the broader community to review the updated standard before we progress with the full release. A full list of changes can be found within the changelog. We’d appreciate it… --- ## [API: Post code based search giving same result](https://forum.openreferral.org/t/api-post-code-based-search-giving-same-result/399)
**Author:** [@sourav](https://forum.openreferral.org/u/sourav)\ **Replies:** 5\ **Last updated:** [June 13, 2023, 9:49am UTC](https://forum.openreferral.org/t/api-post-code-based-search-giving-same-result/399 "2023-06-13T09:49:11Z")
It seems like postcode-based search results are the same for any postcode given. Please let me know how can I make the search more specific to a postcode. --- ## [Any interest in supporting What 3 Words?](https://forum.openreferral.org/t/any-interest-in-supporting-what-3-words/114)
**Author:** [@pbrown](https://forum.openreferral.org/u/pbrown)\ **Replies:** 9\ **Last updated:** [April 20, 2023, 8:51pm UTC](https://forum.openreferral.org/t/any-interest-in-supporting-what-3-words/114 "2023-04-20T20:51:54Z")
Latitude and longitude is currently supported, however many people are using What3Words for precise location mapping as it can be somewhat more user friendly to use. Does anybody have any thoughts on maybe adding suppor… --- ## [API: Metadata too large to include in endpoints?](https://forum.openreferral.org/t/api-metadata-too-large-to-include-in-endpoints/378)
**Author:** [@timothyhinh](https://forum.openreferral.org/u/timothyhinh)\ **Replies:** 2\ **Last updated:** [April 2, 2023, 7:51pm UTC](https://forum.openreferral.org/t/api-metadata-too-large-to-include-in-endpoints/378 "2023-04-02T19:51:58Z")
Hello @devin @davidraznick ! The HSDS schema includes metadata for each object. But is this strictly necessary to include in the response for the API endpoints (e.g. services, service\_at\_locations, etc.) to be HSDS-comp… --- ## [API: taxonomy\_term\_id query parameter](https://forum.openreferral.org/t/api-taxonomy-term-id-query-parameter/377)
**Author:** [@timothyhinh](https://forum.openreferral.org/u/timothyhinh)\ **Replies:** 2\ **Last updated:** [April 2, 2023, 7:47pm UTC](https://forum.openreferral.org/t/api-taxonomy-term-id-query-parameter/377 "2023-04-02T19:47:06Z")
Hello, I’d like to clarify what “taxonomy\_term\_id” represents as a query parameter for the API endpoints. Does it represent the UUID or the code (e.g. “BY.1500”) associated with a specific taxonomy term? From the API sc… --- ## [Draft API Specification](https://forum.openreferral.org/t/draft-api-specification/338)
**Author:** [@Dan-ODS](https://forum.openreferral.org/u/Dan-ODS)\ **Replies:** 5\ **Last updated:** [February 23, 2023, 3:36pm UTC](https://forum.openreferral.org/t/draft-api-specification/338 "2023-02-23T15:36:24Z")
Draft API Specification As we are moving to an API first approach for HSDS we need to specify what a minimal API should look like. We also need to define some methods that, even if they are not required, should be consis… --- ## [Rules for the core and extended standard API (HSDA)](https://forum.openreferral.org/t/rules-for-the-core-and-extended-standard-api-hsda/205)
**Author:** [@MikeThacker-iStandUK](https://forum.openreferral.org/u/MikeThacker-iStandUK)\ **Replies:** 7\ **Last updated:** [September 19, 2022, 1:22am UTC](https://forum.openreferral.org/t/rules-for-the-core-and-extended-standard-api-hsda/205 "2022-09-19T01:22:06Z")
At the request of the Workgroup, I’ve extensively modified the document Por11328 - Aligning Open Referral and Open Referral UK - The API - HSDA. The document proposes: rules for going from the full data structure or a… --- ## [US and UK Alignment and version control](https://forum.openreferral.org/t/us-and-uk-alignment-and-version-control/150)
**Author:** [@MikeThacker-iStandUK](https://forum.openreferral.org/u/MikeThacker-iStandUK)\ **Replies:** 10\ **Last updated:** [August 21, 2022, 8:34pm UTC](https://forum.openreferral.org/t/us-and-uk-alignment-and-version-control/150 "2022-08-21T20:34:43Z")
The page Open Referral US and UK Alignment summarises work that has started to keep the international Open Referral standard and the UK extensions in line. We intend to keep the Human Services Data Structure (HSDS) back… --- ## [Natural Neighbourhoods Coverage](https://forum.openreferral.org/t/natural-neighbourhoods-coverage/65)
**Author:** [@Ian-DigitalGaps](https://forum.openreferral.org/u/Ian-DigitalGaps)\ **Replies:** 2\ **Last updated:** [November 10, 2021, 6:33pm UTC](https://forum.openreferral.org/t/natural-neighbourhoods-coverage/65 "2021-11-10T18:33:58Z")
We are using the LGA’s natural neighbourhoods to define the areas within Blackburn as URIs. This will support the OR coverage API but we wondered whether there might be a new API function which accepts a post code and re… --- ## [Validation test rules](https://forum.openreferral.org/t/validation-test-rules/136)
**Author:** [@Marcus-DigiCoproduct](https://forum.openreferral.org/u/Marcus-DigiCoproduct)\ **Replies:** 4\ **Last updated:** [October 7, 2021, 4:01pm UTC](https://forum.openreferral.org/t/validation-test-rules/136 "2021-10-07T16:01:23Z")
I can see there are several feeds within the Open Referral UK dashboard that show as either full or partially compliant. Some have compliance level 1 and others level 2. It is not overly clear what the rules are that l… --- ## [LocalGov Drupal implementation](https://forum.openreferral.org/t/localgov-drupal-implementation/106)
**Author:** [@ekes](https://forum.openreferral.org/u/ekes)\ **Replies:** 26\ **Last updated:** [August 12, 2021, 1:55pm UTC](https://forum.openreferral.org/t/localgov-drupal-implementation/106 "2021-08-12T13:55:45Z")
The technical counterpart to Integrating Open Referral UK with LocalGov Drupal In the spirit of LocalGov Drupal developing in the open, I’ll document, and maybe short-circuit some of the hard work by getting feedback on … --- ## [For anybody using the Apache CXF JAX-RS environment - URL issues](https://forum.openreferral.org/t/for-anybody-using-the-apache-cxf-jax-rs-environment-url-issues/80)
**Author:** [@pbrown](https://forum.openreferral.org/u/pbrown)\ **Replies:** 4\ **Last updated:** [May 27, 2021, 11:05am UTC](https://forum.openreferral.org/t/for-anybody-using-the-apache-cxf-jax-rs-environment-url-issues/80 "2021-05-27T11:05:32Z")
This may be of use to anybody using Java & specifically where Apache CXF is part of the stack. We’ve come across a rather unfortunate scenario where there is a clash between the use of /services in the web services url … --- ## [Taxonomy listing of Needs, Circumstances & Service types](https://forum.openreferral.org/t/taxonomy-listing-of-needs-circumstances-service-types/82)
**Author:** [@pbrown](https://forum.openreferral.org/u/pbrown)\ **Replies:** 1\ **Last updated:** [May 26, 2021, 1:25pm UTC](https://forum.openreferral.org/t/taxonomy-listing-of-needs-circumstances-service-types/82 "2021-05-26T13:25:23Z")
The API provides for returning lists of the following: Needs Circumstances Service Types E.g. https://host:port/o/ServiceDirectoryService/v2/taxonomies/?vocabulary=esdServiceTypes There seems to be some ambiguity as…