POST/transactional-api/list-documents

List Documents

Lists the documents held against a patient record via GP Connect Access Document. The patient must have an NHS number. Returns a FHIR STU3 searchset Bundle of DocumentReference resources.

Authorization: Bearer token (JWT). See Authentication.

Request

curl -L -X POST 'https://{tenantId}.api.england.medicus.health/transactional-api/list-documents' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <token>' \
  -d '{
    "patientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }'

Body parameters

Field	Type	Required	Description
patientId	string<uuid>	Yes	Medicus patient identifier.

Responses

200 A FHIR STU3 searchset Bundle of the patient's documents.

{}

400 Validation error.

4 possible code values

Code	Description	When
invalid-patient-id	The patientId is not a UUID	patientId not a UUID
patient-not-found	Patient not found for this patientId	patientId doesn't exist
no-nhs-number	Patient does not have a NHS number.	patient has no NHS number
patient-restricted	Access to this patient is restricted for this staff member.	patient record is marked as restricted in Medicus; only explicitly permitted staff members can access it (not a configuration error, handle gracefully)

{
  "errors": [
    {
      "code": "invalid-patient-id",
      "description": "The patientId is not a UUID"
    }
  ]
}