Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Release Notes

Summary release notes of the versions released in National Events Management Service Implementation Guide

2.2.0-Beta (22/01/2020)

PDS Birth Notification

  • Correction to birth notification example where mothers NHS Number is not included. Also made example full message rather than just parts which were considered different to the example for where mothers details were included.

Supported Event Messages

  • Event maturity labels added to give developers a better indication of the chance of change to specific event types.

2.1.1-Beta (15/01/2020)

PDS Birth Notification

  • A birth can be registered on PDS without the mothers details, including her NHS Number. Previously the publication of these birth registrations as a PDS Birth Notification event messages resulted in an invalid event message being sent to subscribers. The PDS Birth Notification event message has been updated to support birth registrations without the mothers details, through relaxation of the cardinalities within some resources. Changes have been made to the routingDemographic extension in the MessageHeader resource and within the Patient resource representing the mother.

    For PDS Birth Notification event messages where there is no NHS number for the mother, these event messages will only be sent to subscribers who have a geographic based generic subscription and will not be sent to subscribers based on an explicit subscription.

2.1.0-Beta (09/01/2020)

Create Subscription

  • updated age criteria to include clarification on use of years

Event Message Sequencing

  • Added additional guidance around the use of sequence numbers in relation to update type event messages.

Event Receiver Requirements

Generic Event Message Requirements

  • Guidance added for population of dateTime elements and the use of time zone offsets.
  • Added a section on use of new, update and delete versions of event messages and how that links to the use of identifiers.

Message Content

  • Page added to explain message content, contained data, linked data and missed messages

Professional Contacts

  • Added new Professional Contacts event message

Publish an Event Message

  • Addition of guidance related to the maximum event message size that could be accepted by the NEMS

Subscriptions Overview

  • Additional information regarding generic subscriptions added

Supported Event Messages

  • Professional Contacts event added to supported event messages
  • Vaccinations event added to the supported event messages

Vaccinations

  • Addition of the Vaccinations event message

2.0.1-Beta (09/08/2019)

Event Message Sequencing

  • Improved wording around where the type of sequencing indicator will be defined for each event message to make it more clear that it will be defined per event type.

Generic Publication API Guidance

  • Added guidance around batch verification of NHS Numbers not being suitable to meet the NEMS requirements

Generic Subscription API Requirements

  • Added guidance around batch verification of NHS Numbers not being suitable to meet the NEMS requirements

Receiver Information Governance

  • Moved requirements from DPIA into specification around data retention
  • Moved requirements from DPIA into specification around data being received only being used for Direct Care
  • Moved requirements from DPIA into specification around lawful basis of receiving data about a patient

Subscription Information Governance

  • Page added for IG requirements on the subscriber
  • Moved requirements from DPIA into specification around data being received only being used for Direct Care
  • Moved requirements from DPIA into specification around legitimate relationships for subscribers
  • Moved requirements from DPIA into specification around lawful basis of receiving data about a patient

2.0.0-Beta (22/07/2019)

Create Subscription

  • Updated event codes to align with new event type value set (Breaking Change)

Event Feedback Mechanism

  • Added page with information on the feedback mechanism for NEMS

Event Lifecycle and Deprecation

  • Added page with information on Event-Lifecycle and Deprecation

Event Message Sequencing

  • Added page with information on Event Message Sequencing

Event Receiver Requirements

  • Removed ITK3 Wrapper from solution (Breaking Change)
  • Added requirement highlighting risk around MESH.

Generic Publication API Requirements

  • Added clarification on level of NHS Number validation required for NHS numbers used in the event messages.

Generic Requirements

  • Name of page and content changes to match new concept of message header, making this just generic population requirements. Name changed from Event Header Information -> Generic Requirements
  • FHIR Resource profiles updated to use CareConnect profiles rather than EMS profiled fhir resources (Breaking Change)
  • Added information about sequencing elements in MessageHeader resource
  • Added information about feedback contact information to MessageHeader resource (Breaking Change)
  • Added required extension to the MessageHeader resource which MUST contain details of the Patient who is the focus of the event message which will be used for routing to subscribers (Breaking Change)
  • Added requirement for new extension routingDemographics which is use by NEMS for message routing
  • Added wording to make clear that the MessageHeader will be the first resource in the bundle but other resources may appear in any order and order should not be assumed from the specification order.

Generic Subscription API Requirements

  • Added clarification for use of MIME types
  • Added clarification on level of NHS Number validation required for NHS numbers used in subscriptions.
  • Added additional audit requirements for use of the subscription API

Introduction to National Events Management Service

  • Updated wording around definition of what is an event within the context of the NEMS.

Manage Subscription

PDS Birth Notification

  • Added resource cardinality information to specification
  • Updated event codes to align with new event type value set (Breaking Change)
  • FHIR Resource profiles updated to use CareConnect profiles rather than EMS profiled fhir resources (Breaking Change)
  • WorkflowID updated

PDS Change of Address

  • Added resource cardinality information to specification
  • Updated event codes to align with new event type value set (Breaking Change)
  • FHIR Resource profiles updated to use CareConnect profiles rather than EMS profiled fhir resources (Breaking Change)
  • WorkflowID updated
  • Added guidance about volumes and known issues with the way providers update PDS resulting in flip flopping of addresses

PDS Change of GP

  • Added resource cardinality information to specification
  • Updated event codes to align with new event type value set (Breaking Change)
  • FHIR Resource profiles updated to use CareConnect profiles rather than EMS profiled fhir resources (Breaking Change)
  • WorkflowID updated

PDS death Notification

  • Added resource cardinality information to specification
  • Updated event codes to align with new event type value set (Breaking Change)
  • FHIR Resource profiles updated to use CareConnect profiles rather than EMS profiled fhir resources (Breaking Change)
  • WorkflowID updated

Publish an Event Message

  • Updated request header interactionID requirement

Publisher Information Governance

  • Improved audit requirements guidance

Read Subscription

  • Updated event codes to align with new event type value set

Receiver Information Governance

  • Moved the Subscription IG page to the Receiver section as requirements are around audit of received events rather than around use of the subscription API.
  • Added additional detail to make clear security requirements
  • Added specific requirements around legitimate relationships which originally was in the DPIA

Subscriptions Overview

  • Added information to the geographical rule based subscriptions section around appropriate use of this type of subscription.
Tags: development

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