healthdirect australia logo

NHSD products and documentation

Healthdirect Australia provides a variety of NHSD products including FHIR services, the NHSD widget and the Provider Appointments API.

The NHSD FHIR Developer Guide provides end-to-end information for developers wishing to understand the NHSD data model and the APIs offered, configuration options and status codes.

Outbound FHIR API

Inbound FHIR API

  • The NHSD FHIR Implementation Guide – Inbound FHIR Ingestion aims to assist integration partners who wish to publish data to the NHSD via the data acquisition hub.
  • The NHSD FHIR R4 Data Model – Inbound provides simplified summary information about the NHSD FHIR Data Model including each FHIR Resource (Organization, Healthcare Services, Location, Endpoint, Practitioner and Practitioner Role) and the respective data attributes.

NHSD Widget

The NHSD widget (Opens in new tab) is designed to provide consumers with a quick, convenient way of accessing reliable information about Australian health services via an embeddable web interface. Built using responsive design principles, the widget is easily customisable, supporting system integrations where technical resources are limited. The widget requires a simple code snippet that can be deployed to any webpage or mobile app.

The widget allows users to search the NHSD for health services, including general practices, pharmacies, emergency departments and hospitals, and present the results in a user-friendly interface.

Depending on the configuration, search and filtering options are also available. Background and font colours can be adjusted to align the widget with various website designs. 

To request a customised widget for your website or mobile app, please submit the widget request form (Opens in new tab).

Booking Provider Appointments API

The Provider Appointments API supports integration between the NHSD and booking providers. This capability supports providing available clinic appointments and functionality for consumers to complete online appointment bookings through real-time integration with the NHSD.

Real-time integration with the NHSD requires booking providers to:

  1. Provide contextualised real-time APIs according to Healthdirect's specifications
  2. Provide contextualised booking URLs to support a consistent consumer journey, allowing consumers to be directed from Service Finder to the correct appointment type
  3. Onboard clinics to the booking provider’s platform and ensure appointments are configured for the expected appointment type.

For more information on the Booking Provider Appointments API, download Onboarding Pack — Provider Appointments API (Opens in new tab).

What’s the right access method for you?

  • I want to consume data from the NHSD ⇾ Outbound FHIR
  • I want to publish data to the NHSD ⇾ Inbound FHIR
  • I want to embed the NHSD widget on my website ⇾ NHSD widget
  • I want to provide “real-time” appointments information to the NHSD ⇾ Provider Appointments API

If you aren’t sure which access method is right for you, please contact us at nhsd@healthdirect.org.au detailing your proposed use case and our team will assist.

Testing

To support testing in the integration process, prospective integration partners should explore the secure, externally accessible NHSD test environment, which is designed for both consumption read-only and ingestion read-write functionalities.

The NHSD test environment includes:

  1. Outbound read-only test data area, or
  2. Ingestion read-write test data area, or
  3. If you have specific testing needs please contact the NHSD Team to discuss available options to support your integration.

To apply for registration and access to the NHSD Integrator Test Environment, please complete the NHSD Integrator Test Environment Registration Form (Opens in new tab).