Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Documents overview

Development overview to the Access Record Documents capability

Introduction

The Access Record Documents capability provides the ability to retrieve unstructured documents from a patient’s GP.

FHIR® resources

The FHIR resources pages provide a detailed reference on population and consumption of the FHIR profiled resources used in this capability.

FHIR® examples

The following pages provide example request and response messages:

API definition

The following API definitions are included in this capability:

Spine interactions

The Access Record Structured capability message set includes the following set of Spine interactions:

Operation InteractionID
Read metadata urn:nhs:names:services:gpconnect:documents:fhir:rest:read:metadata-1
Patient search urn:nhs:names:services:gpconnect:documents:fhir:rest:search:patient-1
Search for documents urn:nhs:names:services:gpconnect:documents:fhir:rest:search:documentreference-1
Retrieve documents urn:nhs:names:services:gpconnect:documents:fhir:rest:read:binary-1

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