Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Generic Publication API Guidance

Generic additional guidance for using the Publication API

NHS Numbers

Any NHS Numbers included in an event message sent to the NEMS Publication API, MUST have been verified against the Spine PDS at the point of publishing the event message.

Information on how to verify an NHS Number against the Spine PDS is available on the Spine Core specification.

Endpoint Registration

To use the NEMS Publication API the submitting system will require national assurance and must be set up as a Spine Endpoint with an associated endpoint certificate (see here for details).

JWT

All requests to the Publication API SHALL include a JWT with information about the sending system and organisation (see the Spine Core specification for details). Additional NEMS specific requirements for population of the JWT are outlined below.

JWT Claims

claim Required requirements
scope Mandatory The scope claim must be patient/Bundle.write
Sub Mandatory If requesting_user claim is included in the JWT then the value of the sub claim must match the value of the requesting_user. If requesting_user claim is not present in the JWT then sub claim value must match the value of the requesting_system claim.
requesting_system Mandatory The requesting_system claim SHALL include the ASID of the system making the request to the API. This ASID must be valid and be registered with the Spine.
requesting_organisation Mandatory The requesting_organisation claim SHALL include the ODS code for the sending organisation. The ODS code must be known to Spine and it must be associated with the ASID included within the requesting_system JWT claim.
requesting_user Optional The requesting_user should contain the identity of the Health or Social Care professional making the request.

NEMS Supported MIME-types

The supported MIME-types for the NEMS, for use in the “Content-Type” and “Accept” headers are:

  • application/fhir+xml
  • application/fhir+xml;charset=utf-8
  • application/xml+fhir
  • application/xml+fhir;charset=utf-8

Where the MIME-type is not supplied the NEMS will default to application/xml+fhir;charset=utf-8

Tags: fhir

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