PDS FHIR API onboarding support information

The Personal Demographic Service - FHIR API uses digital onboarding. During the process you'll be asked to download and use documents on this page.

Information on this page might impact the design of your software.

We provide a hazard log template, pre-populated with the minimum hazards you must address as part of your clinical safety review, when integrating with the PDS FHIR API. If you identify more than these minimum hazards, add them to your hazard log.

You can use our template or create your own, so long as it includes the same hazards.

Upload your completed hazard log when requested to do so within the digital onboarding portal.

This is a Microsoft Excel file. To request a different format, contact us.

PDS FHIR API onboarding uses risk-based assurance.

You're asked to demonstrate that you've mitigated risks in your software by submitting a risk log for each API access mode that it uses.

During testing, you need to provide evidence of your mitigations against each of the risks identified in the pre-populated risk log template for your chosen access mode. For the risk log, we are only interested in the pre-populated risks in each template.

To do this:

1. Download the appropriate risk log template for your software's access mode - this is a pre-populated Excel spreadsheet. For example, if your software uses both 'application-restricted' and 'healthcare worker with update' access modes, you need to download both of these risk logs.
2. Complete the risk log template with the mitigating actions that you have taken, against each of the risks listed in it.
3. Upload your completed risk logs when requested to do so within the digital onboarding portal.
4. The test team will contact you to arrange evidence testing of the mitigations that you listed in your risk logs.

These are Microsoft Excel files. To request a different format, contact us.