Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Retrieval Provider Guidance

Provider requirements and guidance for record and document retrieval.

HTTP Request

Retrieval of documents/records is achieved through an HTTP GET request. See the Retrieval Read Interaction page for details of the requirements for responding to an HTTP GET request for retrieval.

Provider Endpoint and Interaction ID Registration

Endpoints for retrieval must be registered on the Spine Directory Service (SDS). For the Beta phase, this will be done by the NHS Digital Deployment Issue and Resolution (DIR) team following completion of assurance.

The requirements for registering endpoints on SDS are as follows:

  1. Every system MUST have a unique ASID for each organisation using it. For example, the same system deployed into three organisations would be represented by three unique ASIDs.
  2. All interactions with the SSP MUST be over port 443.
  3. Endpoints MUST NOT include explicit port declarations (e.g. :443).
  4. Endpoints MUST have be registered with the interaction ID urn:nhs:names:services:nrl:DocumentReference.content.

See the Spine Core specification for further detail on registering provider endpoints.

Providers MUST ensure that the record author ODS code on the pointer metadata matches the ODS code for the endpoint registered in SDS. This is required to enable Consumers to perform an SDS lookup to obtain the Provider system ASID and populate the Ssp-To header in the retrieval request.

Fully Qualified Domain Name (FQDN)

Following completion of assurance, Providers will be supplied with an X.509 Certificate and an FQDN. The FQDN will form the base of Provider Endpoints as detailed above. For more details, see the Security page.


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