Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Messaging Architecture Overview

Overview of the Messaging Architecture section

NOTE: The publication of Digital Child Health event messages to the National Events Management Service (NEMS) will rely on the successful implementation of support for each event by the NEMS. Currently only the following Digital Child Health events are within the scope of this implementation by the NEMS:

  • Additional Demographics
  • Admission Details
  • Allergies and Adverse Reactions
  • Assessment Scales
  • Birth Details
  • Blood Spot Card Received
  • Blood Spot Sample Taken
  • Blood Spot Test Outcome
  • Clinical Risk Factors
  • Developmental Skills
  • Discharge Details
  • Early Years Progress
  • Educational History
  • Emergency Care Attendance
  • Examination Findings
  • Family History
  • Feeding Status
  • Individual Requirements
  • Information and Advice Given
  • Investigation Results
  • Legal Information
  • Medication Administration
  • Medication Statement
  • Newborn Hearing
  • NIPE outcome
  • Observations
  • Parent Guardian or Personal Comment
  • Personal Contacts
  • Plan and Requested Actions
  • Problem List
  • Professional Contacts
  • Professional Summary
  • Referral
  • Safety Alerts
  • Social Context
  • Social Context Household
  • Vaccinations

Message Patterns and Message Structure

The National Events Management Service is based on a Publish and Subscribe messaging pattern. The events are published to a national events hub, which also manages subscriptions to the published events.

Events

The event originator will construct an event message, as outlined in this implementation guide. Event messages will be sent into the Events Management Service hub using a simple FHIR Event Publication API.

Onward delivery to subscribers will initially be over MESH, although other delivery channels may be developed in future if there is a demand for them. For further information relating to MESH see Message Exchange for Social Care and Health (MESH).

Events Diagram

The diagram shows an example of an event message being published to the hub. The hub manages subscriptions to these publications (in accordance with the Hub Registration Authority):

Event message data item requirement notation

Each event message will detail the information requirements applicable to each data item requirement, these are described as:

Mandatory: should always be included in the electronic communication. Where there is no information then the message will contain appropriate coded text to identify this.
Required: where information should be recorded (and communicated) if available.
Optional: where local decisions can be made about whether or not to communicate the information

Tags: fhir

All content is available under the Open Government Licence v3.0, except where otherwise stated