How to onboard your digital asset (eg. API, digital service or event) to the Digital Services Hub
If you have an digital asset that you think could benefit our platform and our customers, please get in touch. We’re open to discussing how your offering might integrate with our system. For a general overview of our integration process and requirements, see the diagram and detailed steps below.
-
Step 1: Learn about the Health New Zealand API standards and review the digital asset onboarding checklist
Learn about the Health New Zealand API standards, policies and best practices to check if you are able to meet our API requirements. Also check our digital asset Onboarding Checklist. It provides a comprehensive guide to the required activities and necessary documentation to successfully integrate your digital asset or service into our Digital Services Hub.
-
Step 2: Complete an expression of interest form
When ready, submit an Expression of Interest form. This will get you a ‘Coming Soon’ listing. The completed form should be emailed back to us at digitalserviceshub@tewhatuora.govt.nz.
-
Step 3: Build and collaborate
During the build phase of your digital asset or service, it is essential to collaborate with relevant Subject Matter Expert (SME) teams—such as Security, Privacy, and Clinical—to gather the necessary artifacts for release to production and publication on the Digital Services Hub. These requirements are detailed in the checklist referenced in Step 1.
-
Step 4: When your digital asset is ready
When your digital asset is ready for conformance testing, please fill out our Digital asset Onboarding form which will progress to the next stage of listing your digital asset or data service in our API catalogue.
-
Step 5: Road to Production
Once you have gained all the relevant approvals from the SME teams, gained successful test exit and have approved the wording of your draft listing, we can book in a date to release and publish your digital asset.
-
Step 6: Your digital asset is listed on the Digital Services Hub
Your digital asset is listed on the Digital Services Hub and you are operating as business as usual with agreed version control and release management processes in place.
-
Digital asset onboarding checklist
Whilst you build and test your digital asset, please consider and prepare the following