Skip to main content

Digital

Patient Flag API supplier interest form

To register your interest and begin onboarding to the Patient Flag API, complete the form below.

This form is for system suppliers looking to onboard with the Patient Flag API. If you are not a system supplier and have a question about Patient Flag APIs, contact: [email protected].

Before you start

Before completing this form, you may find it useful to read the following information about Patient Flags:

Additional information

Existing flags, such as CP-IS and Reasonable Adjustments standalone APIs, are retired or merged to this standard Patient Flag API service. National Care Records Service (NCRS) is the only alternative method to view and create patient flags, outside of using the Patient Flag API. 

NHS England national functionality

NHS England provide standalone functionality via the National Care Records Service (NCRS) to provide both read and write Patient Flag information. A number of your end user organisations may already use this functionality.

Patient Flag API new interest form

About you and your organisation
Main contact
Complete for each system
To use this API you will need the patient's NHS number, which can be retrieved by using the Personal Demographics Services (FHIR) API (link in Before you start section above). Use this API to search for patients and retrieve their details. It can also be used to update patient details in some cases.
Supporting information
For each flag, when do you expect to begin onboarding to the Digital Onboarding Service (DOS)?

Is your use case for read only, or read and write (as required by your users)? This information will allow us to manage our pipeline.

The date you expect to onboard to Digital Onboarding Service for Reasonable Adjustments Flag.
The date you expect to onboard for Digital Onboarding Service for Female Genital Mutilation - Information Sharing (FGM-IS) Flag.
The date you expect to onboard for Child Protection - Information Sharing (CP-IS).
Primary, secondary, acute, urgent, community, mental health, optician, dental, shared, social care, other

Once you have submitted the form, we will update our supplier activity list so your customers are aware you are progressing through the development or on-boarding process, to help reduce the number of people who contact you about this information. 

We will also use this information to review your timelines and the pipeline for suppliers moving through the Digital Onboarding Service (DOS) process. 

We will contact you to discuss further. 

If you have any questions about this process, email: [email protected].