Developers

Highlands Health Finder shares its listings with other systems through a REST API, a FHIR R4 server and a change feed. Without credentials you see what the public sees; partners with an agreement may see more.

REST API

Search and read services, locations, organisations and practitioners as JSON. Without credentials you can make 60 requests a minute and 10,000 a day from one address.

REST API address

https://api.hark.health/v1/d/pilot-highlands

OpenAPI document (every request and response) (opens in a new tab)

FHIR R4 server

Read and search Organization, Location, HealthcareService, Practitioner, PractitionerRole and Endpoint resources in FHIR 4.0.1, as JSON. The server is read only.

FHIR base address

https://api.hark.health/v1/d/pilot-highlands/fhir

CapabilityStatement (what the server supports) (opens in a new tab)

Resources claim these profiles (hl7.fhir.au.base#6.0.0):

Organization: http://hl7.org.au/fhir/StructureDefinition/au-organization
Location: http://hl7.org.au/fhir/StructureDefinition/au-location
HealthcareService: http://hl7.org.au/fhir/StructureDefinition/au-healthcareservice
Practitioner: http://hl7.org.au/fhir/StructureDefinition/au-practitioner
PractitionerRole: http://hl7.org.au/fhir/StructureDefinition/au-practitionerrole

Change feed and webhooks

Partners keep a copy up to date by following the change feed, or by having changes sent to their own system as signed webhooks. Both need partner credentials.

Change feed address

https://api.hark.health/v1/d/pilot-highlands/changes

Getting access

Partner credentials (OAuth 2.0 client credentials) come from the directory's team, who decide what you may read and do.

Token address

https://api.hark.health/oauth/token

What a partner client may be allowed to do

search:read: Search services and autocomplete
graph:read: Read organisations, locations, services, practitioners and roles, including filtered lists
feed:read: Read the change feed
export:run: Request and download exports
webhooks:manage: Register webhook endpoints that receive the change feed (needs feed:read too)

To ask for access, contact Highlands Health Finder through its About page.