Who can use this
This API can only be used where there is a legal basis to do so.
Make sure you have a valid use case before you go too far with your development. To do this, contact us.
For details of the legal basis for sharing NEMS healthcare events, see the NEMS controller catalogue.
You must do this before you can go live (see 'Onboarding' below).
Technology
This API is a publish-subscribe event API .
All endpoints use FHIR, specifically FHIR STU3, and:
- the subscription endpoints use RESTful FHIR
- the publish endpoint uses FHIR messaging
To collect events that you have subscribed to, use our MESH API.
The message payload is also FHIR - the same format as used by the sending system.
Security and authorisation
This API is application-restricted, meaning the calling application is authenticated but the end user is either not authenticated or not present.
In particular, this API uses TLS-MA authentication.
It also implements authorisation controls which restrict the event types the connecting application can subscribe to or publish.
For more details, see application-restricted APIs.
Environments and testing
NEMS is available in Opentest for testing of subscribe message formats using the Toolkit Workbench (TKW).
You do not need access to MESH in Opentest for NEMS testing in Opentest.
Successful validation of subscribe messages in Opentest allows you to proceed to integration testing. For details, see the NEMS onboarding guide.
NEMS is also available for testing purposes in:
- development (DEV)
- integration (INT)
- deployment (DEP)
The base URLs are as follows:
Environment |
Network availability |
URL |
OpenTest |
OpenVPN |
https://msg.opentest.hscic.gov.uk/ |
Development |
HSCN |
https://msg.dev.spine2.ncrs.nhs.uk/ |
Integration |
HSCN |
https://msg.int.spine2.ncrs.nhs.uk/ |
Integration |
Internet |
https://msg.intspineservices.nhs.uk/ |
Deployment |
HSCN |
https://msg.dep.spine2.ncrs.nhs.uk/ |
Production |
HSCN |
Contact us |
Production |
Internet |
Contact us |
The base URL for the publishing and subscribing interactions are the same, but the path is different, for example:
- publish in integration over HSCN:
https://msg.int.spine2.ncrs.nhs.uk/STU3/Events/1/$process-message
- subscribe in integration over HSCN:
https://msg.int.spine2.ncrs.nhs.uk/STU3/Subscription
- publish in integration over the internet:
https://msg.intspineservices.nhs.uk/STU3/Events/1/$process-message
- subscribe in integration over the internet:
https://msg.intspineservices.nhs.uk/STU3/Subscription
There is a testing tool which allows you to simulate a provider publishing event messages. You can also simulate making changes on PDS to trigger PDS-published event messages so you can test event message consumption.
To get advice on how to begin testing, contact us.
Onboarding
You need to get your software approved with us before it can go live with this API. We call this onboarding. The onboarding process can sometimes be quite long, so it’s worth planning well ahead.
As part of this process, you need to demonstrate that you can manage risks and that your software conforms technically with the requirements for this API. This might impact the design of your software. For details, see NEMS FHIR API onboarding support information.
To understand how our online digital onboarding process works, see digital onboarding.
Last edited: 6 March 2024 2:00 pm