Skip to main content

Patient flags change event

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


Event name

patientflags-change-1


Trigger event

This event is triggered when a Patient Flags record has been created, updated or deleted.


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 Patient flags change event can be retrieved from:


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:

  • Patient Flag Type (flagtype)
  • GP Practice ODS (generalpractitioner)
  • GP IT Supplier ODS (supplierNACS)

 

Last edited: 12 November 2024 10:59 am