NHS number change event
Use this page to view the NHS number change event available via the Multicast Notification Service API (MNS).
You should use this document alongside the Create Subscriptions API documentation when you want to subscribe to this event.
Understanding events
Events inform subscribers of a particular type of change that has occurred in the event publishing service.
Event name
nhs-number-change-1
Event trigger
This event is triggered when the status of a patient’s NHS number changes within the Personal Demographics Service (PDS). For example, if the NHS number was marked as invalidated or replaced.
Event status
This event is currently in beta.
Event schema
Get event details
Subscribers must typically use a synchronous API of the event publishing service to retrieve full details of the event or change.
Event notifications contain information to facilitate this. This may be a URL pointing to a RESTful FHIR resource or some other identifier meaningful to the source system.
Publishing services may have more than one API available to retrieve this information. Details of events published by the Personal Demographics Service are retrieved:
Event subscription filtering
When subscribing to an event, it is possible to define notification filters; for example, ‘only notify me of events for a specific ODS number, or NHS number’.
This event currently has no filtering capability. The ability to filter on NHS number is currently in development.
Last edited: 12 February 2025 8:56 am