Skip to main content

Validated GP registration request event

Use this page to view the Validated GP registration request 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 informs subscribers of a particular type of change that has occurred in the event publishing service.


Event name

gpreg-change-gp-req-1


Trigger event

This event is triggered when a request has been made through the Register with a GP surgery service and has been auto approved/accepted.


Event status

This event is currently In development


Event schema

On subscribing to this event, subscribers will receive notification in the following format:


Get event details

Subscribers must typically use a synchronous API of the 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. Event details for the Register with a GP event can be retrieved from:

For this event type, there is the option to include a detailed signal alongside the MNS event notification. This is for subscribers who are unable to retrieve the record from the publisher API due to technical constraints. This is enabled at the point of subscription. 


Events 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 Code’.

This event can be filtered on:

  • GP Practice ODS (generalpractitioner)
  • GP IT Supplier ODS (supplierNACS)
  • Registration Encounter Code (registrationencountercode)

 

Last edited: 24 October 2024 3:42 pm