GP Connect - Access Document

This guidance is under active development by NHS Digital and content may be added or updated on a regular basis.

Migrate a document

Use case

Retrieve a document for the purpose of migrating it to a patient’s new registered practice.

API specification

See GP Connect Access Document - FHIR API.

Interaction diagram

documents-get-patient-document-interaction-diagram

Request

Availability of data

The record migration use case requires that information is always available regardless of whether the documents capability has been enabled, or whether clinical areas have been turned off using configuration for clinical areas.

Confidential and sensitive documents

This interaction allows confidential and sensitive documents to be retrieved. This interaction can only be used if an appropriate requested_scope value is provided in the JWT, more guidance is available in the Cross-organisation audit and provenance page

File size limit

There is no limit on the size of files able to be retrieved through this API. Files may exceed 100MB and in rare circumstances they maybe closer to 250MB. However, due to there being no imposed limit they may be larger than this.

Payload response body

Provider systems MUST:

  • return a 200 OK HTTP status code to indicate successful execution of the operation
  • return a Binary resource conforming to the Binary resource definition
  • include the versionId of the current version of the Binary resource

Examples

See Retrieve a document.

back to top