This site is under active development by NHS Digital and is intended to provide guidance and FHIR components for the National Events Management Service. This project is being developed using an agile methodology so iterative updates to content will be added on a regular basis, and remains subject to clinical review. Changes to this Implementation Guide following the initial beta release will be documented here.
1.5.4-Beta (19/06/2019)
Generic Publication API Guidance
- Updated specification around the use of NHS Numbers, making clear the requirement that NHS Numbers included in an event must be verified against the Spine at the point of publishing or directly before publishing an event message
1.5.3-Beta (02/05/2019)
- Updated Physical Exam link to be the new NIPE Outcome link
1.5.2-Beta (28/02/2019)
Generic Subscription API Guidance
- Updated claims information relating to
requesting_userto align with validation performed by the NEMS
1.5.1-Beta (26/02/2019)
- Corrected generic sections to align with the generic requirements for events passed through NEMS
1.5.0-Beta (21/02/2019)
- Made page content more generic rather than being PDS event message orientated to allow for the variation in FHIR resources within the DCH event messages.
Introduction to National Events Management Service
- Updated DCH spec link to the release candidate spec rather than the beta spec.
- Added information highlighting the intended use cases and what is considered an event.
- Added information pointing to National Record Locator (NRL) for record retrieval.
Messaging Architecture Overview
- Added additional wording to
Delivery Of Event Messagessection of the page, linking to theEvent Receiver Requirementswithin the spec.
- Added the
What data to publishersection to outline some requirements around when to publish data and highlight the risk that a publisher may receive back their own published event message. - Added the fixed value for the
InteractionIDhttp header.
- Added page to indicate which event messages are currently supported by the NEMS.
1.4.3-Beta (22/01/2019)
- Corrected examples to use the encoded
&rather than the&character as required to be valid xml.
Generic Publication API Guidance
- Added detail around the content type required for publishing event messages.
1.4.2-Beta (17/01/2019)
- Moved the Pre-requisites section to the “Generic Subscription API Guidance” page
- Corrected text in criteria element of the example xml to encode characters as required to be valid xml
Generic Publication API Guidance
- Page added with additional information around MIME types and JWT population for the publish API
Generic Subscription API Guidance
- Page added with additional information around MIME types and JWT population for subscription API
- Moved the Pre-requisites section to the “Generic Subscription API Guidance” page
- Corrected text in criteria element of the example xml to encode characters as required to be valid xml
- Moved the Pre-requisites section to the “Generic Publication API Guidance” page
1.4.1-Beta (15/01/2019)
- Updated the wording within the “EMS-Subscription-1 resource population” table to make the expectations around the
contactelement more clear.
1.4.0-Beta (11/01/2019)
- Updated wording relating to use of JSON and XML for API’s as both are supported for the publish and subscription API’s, the event messages currently can only be sent to subscribers in XML
- Added guidance around required headers for interactions with the subscription API
- Added information around error responses
- Updated serviceType subscription criteria to be optional
- Updated wording around the configuration of MESH and the use of WorkflowIDs.
- Added guidance around required headers for interactions with the subscription API
- Added information around error responses
- Updated EpisodeOfCare resource guidance making clear that the time periods within the resource are optional.
- Added guidance around required headers for interactions with the publish API
Publisher Information Governance
- Added new page with new requirements
- REMOVED - this has not been implemented yet so has been removed until it is implemented
Subscriber Information Governance
- Added new page with new requirements
1.3.0-Beta
- Changes page layout
- Added note around only supporting XML
- updated example to be XML
- Added additional population guidance and requirements around which fields should be populated with what.
Error Handling
- Removed this page as the content is now specified in more detail on the interaction specific pages, Publish an Event Message and Event Receiver Requirements
Introduction to National Events Management Service
- Updated all content with new wording, added a diagram and added a short description to the linked event message implementation guides.
- Updated example to be XML and added note about only XML support
Messaging Architecture Overview
- Updated information with more detail around publishers and subscribers
- Added note around only support for XML
- Updated example to be XML
- Added additional information around multiple subscription matches for a single event message
Versioning
- Removed this versioning page as it contained incorrect and missleading information. Any details which need to be included will be added to the other spec versioning page.
1.2.0-Beta
Create Subscription - Added:
- subscriptionRuleType to the criteria for generic subscriptions
- references to Search Parameters applicable to the criteria.
Manage Subscription - Added pre-requisites.
Search for Subscription - Added a page to describe how to search for subscriptions by ODS code of a subscribing organisation.
Receiver Requirements - Added guidance on FHIR representation of an event message bundle using the ITK3 Messaging Distribution wrapper.
1.1.0-Beta
About - renamed to Contact Us - this page has been updated to share contact information. Guidance around FHIR profiles for event messages has been removed as it is not within the scope of this Implementation Guide.
Event Header Design renamed to Event Header Information - this page has been updated to include references to FHIR profiles in use, and include further clarification.
Messaging Overview removed Event message data item requirement notation section.
Overview text edited to refer to Implementation Guides and not specifications.
The Implementation Guide has been updated to include guidance sections for
The NEMS Event Message Bundle Structure page has been update to include clarification on the use of absolute URL references to Organization resources via the FHIR ODS Lookup API.
Error Handling
The Implementation Guide has been updated to include guidance on Error Handling, replacing the NEMS Event Message Response.
The Messages section has been removed. This content has been redesigned and individual FHIR Event Message Implementation Guides have been created for this content:
Added page Versioning to clarify versioning of event instances and event definitions.
1.0.1-Beta
This implementation guide has been updated to include a guidance page for accessing example messages.
1.0.0-Beta
This Beta release includes implementation guidance to support the development of the following aspects of the National Events Management Service:
- NEMS Event Message Response
- National Failsafe Alert and Failsafe Nullify event messages
- Patient Demographics Service Updates event messages
