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 a HTTP GET request. See the Retrieval Read Interaction page for details of the requirements for creating and sending a 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. 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.

Providers must ensure that endpoints for retrieval are registered with the correct interaction ID. The interaction ID for retrieving a record is specific to the record format code, which is included in the pointer meta-data. See Retrieval Formats for the mapping between format code and interaction ID.

Fully Qualified Doman Name (FQDN)

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


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