Patient Flags FHIR API onboarding support information

The Patient Flags API uses digital onboarding.

To onboard to any flag supported by the Patient Flags API you must onboard to the Patient Flags API and also the specific flag you are integrating to.  You must complete and upload the Generic Patient Flags API Hazard log and the related documents for your specific flag.

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 Patient Flags 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.

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 Reasonable Adjustments Flag via the Patient Flags 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.

Reasonable Adjustments Flag via the Patient Flags API onboarding uses risk-based assurance.

You're asked to demonstrate that you've mitigated risks in your software by submitting a risk log.

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

To do this:

1. Download the risk log template that is appropriate for your use case - this is a pre-populated Excel spreadsheet.
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 log 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 log.

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

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 Child Protection - Information Sharing Flag  via the Patient Flags 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.

Child Protection - Information Sharing Flag via the Patient Flags API onboarding uses risk-based assurance.

You're asked to demonstrate that you've mitigated risks in your software by submitting a risk log.

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

To do this:

1. Download the risk log template that is appropriate for your use case - this is a pre-populated Excel spreadsheet.
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 log 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 log.

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