NHSD Implementation Guide - Outbound
4.0.1 - active

NHSD Implementation Guide - Outbound - Local Development build (v4.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

General Guidance

Server Access

The National Health Services Directory production environment is deployed on the domain: https://api.fhir.nhsd.healthdirect.org.au/v4

The production server require the following authentication credentials:
* an API-key
* a Bearer Token (AccessToken obtained though an OAuth Client-Credential grant process)

Please refer to the security section for technical connection details.

Process to request API Key and OAuth Credentials

Submit an application for registration and access to the NHSD Test/Production environment, please submit the request via the NHSD Developer and Integration Hub: https://about.healthdirect.gov.au/nhsd/developer-and-integration-hub/getting-started

Known defects or non-supported features:

The following are known areas of functions that are not supported or earmarked to be addressed in future releases.

  • Search HealthcareService.specialty is not supported

Paging

  • No support for the previous / next relation links. Should you wish to page to the next, issue a subsequent query with the appropriate page=000 request parameter. See capability statement for more information.

Client Certificate or Mutual Authentication

Client Certificate or Mutual Authentication is not supported as at October 2020.

General FHIR references and Implementation Notes

Please note, that not all of the FHIR specification search behaviours have been implemented. Where possible, these have been noted throughout this implementation guide.

Questions or Feedback?

If you need further information or have any questions or feedback, please contact the NHSD team on nhsd [at] healthdirect.org.au