Overview of the integration process
The Developer and Integration Hub is designed to streamline the process of integration, while maintaining conformance to required specifications.
The NHSD offers three main types of FHIR integration:
- FHIR API: real time search, individual queries, read only access
- FHIR Bulk Export Service: large dataset exports supplemented by delta files at a specified frequency, read only access
- FHIR Ingestion API and Data Acquisition Hub: write capability for publishing updates to the NHSD
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.
Please review the documentation for each access method prior to submitting a request to access the NHSD Test Environment (Opens in new tab). Please note, test environment access is disabled following six months of inactivity. For technical support during testing and implementation, please submit the technical support form (Opens in new tab).
Integration process
The diagrams below give an indication of the roles of the integrator and the NHSD team in the integration process.
Read-only integration to retrieve data from NHSD
Read-only integration to retrieve data from NHSD
Download required documentation to consume data from NHSD:
- NHSD Data and API Licence Agreement
- NHSD Data and API Licence Agreement Schedule
- NHSD Cybersecurity Checklist
- Review the specifications and implementation guides
After submitting the test environment registration form, complete the NHSD Data and API Licence Agreement Schedule and NHSD Cybersecurity Checklist and submit to nhsd@healthdirect.org.au to initiate the agreement process.
Two-way integration to share data with NHSD
Two-way integration to share data with NHSD
Download required documentation to share data with NHSD:
- NHSD Data Sharing Agreement
- NHSD Data Sharing Agreement Schedule
- NHSD Cybersecurity Checklist
- Review the specifications and implementation guides
If you would like to establish a data sharing arrangement with the NHSD, please email nhsd@healthdirect.org.au outlining the data you wish to share.
Booking provider integration to share booking links with NHSD
Booking provider integration to share booking links with NHSD
Download required documentation to share booking links with NHSD:
A data sharing agreement is required to enable booking provider integration. Please refer to the documentation referenced in the two-way data sharing workflow.
To learn about NHSD products, more information can be found on the Integration and documentation page.