Digital Health Checks acknowledgement event

This event notifies subscribers when a health check has been processed by a GP practice.

This event is in development

There are no current timescales for putting this event into production.

Overview

This event notifies subscribers when a health check has been processed by a GP practice.

Publisher: Patient Data Manager (PDM)
Event name: nhshco-hc-complete-1-ack-1
Delivery mechanism: Multicast Notification Service (MNS)
Payload type: Notification (event only)
Data retrieval: PDM

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

When should I use this event

This event notifies subscribers when a health check has been processed by a GP practice.

Example use cases

The Digital Health Check acknowledgement event is designed to let subscribers know when a GP practice has processed a health check event.

How this event works

This event follows a notification and retrieval pattern:

A Digital Health Check record is updated in Patient Data Manager.
A health check complete nhshco-hc-complete-1 event is published to MNS
The subscribed GPIT system consumes the event
The subscribed system retrieves related data from Patient Data Manager
The subscribed system calls Patient Data Manager API with an Acknowledgement message
Patient Data Manager publishes an acknowledgement (nhshco-hc-complete-1-ack-1) event to MNS
Digital Health Check online consume the acknowledgement event.

Event status

The PDM nhshc-hc-complete-1-ack-1 event is currently in development.

Event structure

This event is available in FHIR format. FHIR events can be published by anybody.

FHIR	Type	Mandatory	Cardinality	Description
specversion	string	M	1..1	version of the schema
id	string	M	1..1	A unique reference ID
source	string	M	1..1	ODS code from messageHeader.sender.identifier (where system = https://fhir.nhs.uk/Id/ods-organization-code)
type	string	M	1..1	name of the event
time	string (RFC 3339)	M	1..1	meta.lastUpdated from the Bundle resource, converted to UTC ISO 8601 / RFC 3339
dataref	string (URI)	M	1..1	Canonical URL: https://api.service.nhs.uk/patient-data-manager/FHIR/R4/Bundle/{bundle_id}

FHIR example

{
 "specversion": "1.0",
 "id": "notification-event-id-message-bundle-id",
 "source": "ABC123",
 "type": "nhshco-hc-complete-1-ack-1",
 "time": "2026-07-17T09:58:31+00:00",
 "dataref": "https://api.service.nhs.uk/patient-data-manager/FHIR/R4/Bundle/<bundle-id>"
}

Example of the FHIR ACK bundle at dataref

{
  "resourceType": "Bundle",
  "id": "2adbf7c4-8f21-4159-8681-3f41bc06215c",
  "type": "message",
  "entry": [
    {
      "fullUrl": "urn:uuid:7c451367-d637-4fe7-9eab-140e743b88b3",
      "resource": {
        "resourceType": "MessageHeader",
        "id": "7c451367-d637-4fe7-9eab-140e743b88b3",
        "meta": {
          "profile": [
            "https://fhir.nhs.uk/StructureDefinition/NHSDigital-MessageHeader-Acknowledgement"
          ]
        },
        "eventCoding": {
          "system": "https://fhir.nhs.uk/CodeSystem/message-event",
          "code": "nhshco-hc-complete-1-ack-1",
          "display": "NHS Health Check online service event"
        },
        "destination": [
          {
            "name": "Digital Health Check online",
            "endpoint": "https://destination.nhs.uk/api"
          }
        ],
        "source": {
          "name": "GP Practice System",
          "software": "SupplierSoftwareName",
          "version": "v1.2.3",
          "contact": {
            "system": "email",
            "value": "[email protected]"
          },
          "endpoint": "https://api.supplier.com/fhir/R4"
        },
        "sender": {
          "identifier": {
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "{ODS_Code}"
          }
        },
        "response": {
          "identifier": "msg-12345-67890",
          "code": "ok",
          "details": {
            "reference": "urn:uuid:8283e341-67ae-48e7-b3ae-2c6a0a824b2c"
          }
        }
      }
    },
    {
      "fullUrl": "urn:uuid:8283e341-67ae-48e7-b3ae-2c6a0a824b2c",
      "resource": {
        "resourceType": "OperationOutcome",
        "id": "8283e341-67ae-48e7-b3ae-2c6a0a824b2c",
        "issue": [
          {
            "severity": "information",
            "code": "informational",
            "details": {
              "coding": [
                {
                  "system": "https://fhir.nhs.uk/CodeSystem/AcknowledgementFrameworkResponseCode",
                  "code": "TECHNICAL_SUCCESS",
                  "display": "Request successfully received"
                }
              ]
            }
          }
        ]
      }
    }
  ]
}

Event filtering

There is no filtering for this event.

Versioning

This is the only version of this event.

Testing

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

Last edited: 31 July 2026 10:26 am