POST/transactional-api/retrieve-confidential-care-record

Retrieve Confidential Care Record

Retrieves the patient's structured care record, including confidential items (allergies, medication, consultations, problems, immunisations, investigations, referrals, diary entries and uncategorised data), via GP Connect Access Record: Structured. The patient must have an NHS number. Returns a FHIR STU3 Bundle.

Authorization: Bearer token (JWT). See Authentication.

Request

curl -L -X POST 'https://{tenantId}.api.england.medicus.health/transactional-api/retrieve-confidential-care-record' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <token>' \
  -d '{
    "patientId": "4d59c916-9726-11ec-af3f-0a58a9feac02"
  }'

Body parameters

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

Responses

200 FHIR STU3 Bundle containing the patient's structured care record, including confidential items.

Response fields

Field	Type	Description
resourceType	string
type	string
entry	array<object>	FHIR resources making up the structured record.

{
  "resourceType": "Bundle",
  "type": "collection",
  "entry": []
}

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)

Response fields

Field	Type	Description
errors[].code	string
errors[].description	string

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