An illustration of consumer document API session
A GP Connect Document API consumer application would follow the typical API session described below to retrieve a patient’s documents.
Consumer session - querying and retrieving documents
The sequence diagram below illustrates which individual API calls are required by a consumer to both query for and retrieve a document from a GP practice in the simplest case. It describes interactions with the provider system at the GP practice, and does not include details of the prerequisite interactions with Spine services.
Step | Description |
---|---|
1a | Consumer makes a call to find patient providing the patient’s NHS number |
1b | Provider finds patient record and returns the logical identifier of the patient record at this practice in their system. |
2a | Consumer queries for a list of the patient’s documents |
2b | Provider responds with a list of document metadata for the patient’s documents |
2a | Consumer makes a request to retrieve a patient’s document using the location returned as part of the document metadata in step 2b |
2b | Provider responds with the requested document |