Health check complete event

This event notifies subscribers that a health check has been completed for a patient and is now available in Patient Data Manager (PDM) using the Multicast Notification Service (MNS).

• Publisher: Digital Health Checks
• Event name: nhshco-hc-complete-1
• Delivery mechanism: MNS
• Payload type: Notification (event only)
• Data retrieval: PDM

For general guidance on using MNS, refer to the MNS service page.

This event notifies subscribers when new health check data has been written back to PDM.

Example use cases

The Digital Health Check event is designed to let GP practices know that a health check has been completed for one of their patients. 

When should I not use this event?

This event is is not suitable for subscribers wanting to know about changes in a patient's demographic data.

This event follows a notification and retrieval pattern:

1. A Digital Health Check record is updated in Patient Data Manager (PDM).

2. An event is published.

3. A notification is sent to subscribed systems.

4. The subscribed system receives the notification.

5. The subscribed system calls Patient Data Manager API using the notification filters specified.

6. The subscribed system retrieves and applies the latest data.

This event is triggered when a health check is stored within PDM.

This event is currently in private beta.

Subscribers can choose to receive a notification of an event in their preferred format. This is specified when creating a subscription.

Formats differ in their presentation only; the content is the same. 

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.

The API catalogue entry for NHS health checks online is pending.

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 can be filtered on:

• GP practice

This event is available to test in the Path to Live (PTL) environments.

This is the first and only version of this event.