--- title: "Extract Carers for a Patient" canonical: "https://wiki.patientsknowbest.com/space/api/4960288844/Extract%20Carers%20for%20a%20Patient" format: markdown --- - [What](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4960288844/Extract+Carers+for+a+Patient#What) - [Prerequisites](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4960288844/Extract+Carers+for+a+Patient#Prerequisites) - [How to](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4960288844/Extract+Carers+for+a+Patient#How-to) - [Example](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4960288844/Extract+Carers+for+a+Patient#Example) ## What Enables you to pull a list of Consent and Patient resources for your patients' carers. ## Prerequisites - You must have a national ID (NHS number) for the patient. If you don’t already have an identifier, see the [Patient demographic retrieval](https://pkbdev.atlassian.net/wiki/spaces/api/pages/4504551428) page. - You must have [access to the data in the patient’s PKB record](https://pkbdev.atlassian.net/wiki/spaces/api/pages/4491968591). - The patient’s PKB record must be in your PKB organisation. - You must have access to overlapping privacy labels with the patient’s carers for them to be returned - [Obtain an access token to the Aggregated FHIR endpoint](https://pkbdev.atlassian.net/wiki/spaces/api/pages/4513202208). ## How to - With a valid token, call the $carers custom operation on the Consent resource, using the patient’s identifier (with the corresponding system) as a query parameter. - *National ID Example: *https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/Consent/$carers?patient:Patient.identifier=https://fhir.nhs.uk/Id/nhs-number%7C**1234567** - A FHIR bundle is returned to you in json format with a Consent resource and Patient resource for each of the patient’s carers. - The Consent resource represents the carer’s relationship with the patient and contains the privacy labels that the carers has access to, where the organisation has access to these privacy labels too. If the carer has access to more privacy labels than the team, the additional privacy labels are not included in the Consent resource. - The Patient resource represents the carer. It contains the following fields: name, address, date of birth, gender, email address, telephone numbers, registration status, deceased flag, PKB public ID ## **Example** Here’s an example response for retrieving the carers for a patient: **GET**** **[https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/Consent/$carers?patient:Patient.identifier=https://fhir.nhs.uk/Id/nhs-number%7C6733905604](https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/Consent/$carers?patient:Patient.identifier=https://fhir.nhs.uk/Id/nhs-number%7C6733905604) ``` { "resourceType": "Bundle", "type": "searchset", "total": 4, "entry": [ { "link": [ { "relation": "self", "url": "https://rcaggregated.fhir-api.rc.pkb.io/Consent/a86c2a57-ffc5-3031-8627-7129c3c5b1b8" } ], "fullUrl": "https://rcaggregated.fhir-api.rc.pkb.io/Consent/a86c2a57-ffc5-3031-8627-7129c3c5b1b8", "resource": { "resourceType": "Consent", "id": "a86c2a57-ffc5-3031-8627-7129c3c5b1b8", "meta": { "extension": [ { "url": "http://fhir.patientsknowbest.com/structuredefinition/version-persisted", "valueDateTime": "2025-08-20T11:36:13.211+00:00" }, { "url": "ex:createdAt", "valueInstant": "2025-08-20T11:36:13.588147Z" } ], "versionId": "6086665", "lastUpdated": "2025-08-20T11:40:14.165487Z" }, "extension": [ { "url": "http://fhir.patientsknowbest.com/structuredefinition/only-professionals-may-edit", "valueBoolean": false } ], "identifier": [ { "system": "http://fhir.patientsknowbest.com/id/patientconsent-legacy-identifier", "value": "3265840" } ], "status": "active", "scope": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/consentscope", "code": "patient-privacy" } ] }, "category": [ { "coding": [ { "system": "http://fhir.patientsknowbest.com/codesystem/consent-category", "code": "PATIENTCONSENT" } ] } ], "patient": { "reference": "Patient/66f11f66-f780-3e0b-ae65-315a7b6f9252" }, "dateTime": "2025-08-20T11:36:12.478+00:00", "policy": [ { "authority": "http://www.patientsknowbest.com" } ], "provision": { "type": "permit", "actor": [ { "role": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "CONSENTER" } ] }, "reference": { "reference": "Patient/f022dbe3-e8c4-3968-84f6-b3b575e1d646" } } ], "securityLabel": [ { "system": "http://fhir.patientsknowbest.com/codesystem/privacy-label", "code": "SOCIAL_CARE" } ] } }, "search": { "mode": "match" } }, { "link": [ { "relation": "self", "url": "https://rcaggregated.fhir-api.rc.pkb.io/Consent/3c3d0dc4-8d8c-383d-b585-d3fef76c2fe0" } ], "fullUrl": "https://rcaggregated.fhir-api.rc.pkb.io/Consent/3c3d0dc4-8d8c-383d-b585-d3fef76c2fe0", "resource": { "resourceType": "Consent", "id": "3c3d0dc4-8d8c-383d-b585-d3fef76c2fe0", "meta": { "extension": [ { "url": "http://fhir.patientsknowbest.com/structuredefinition/version-persisted", "valueDateTime": "2025-08-20T11:34:29.064+00:00" }, { "url": "ex:createdAt", "valueInstant": "2025-08-20T11:34:30.081541Z" } ], "versionId": "6086660", "lastUpdated": "2025-08-20T11:34:30.081541Z" }, "extension": [ { "url": "http://fhir.patientsknowbest.com/structuredefinition/only-professionals-may-edit", "valueBoolean": false } ], "identifier": [ { "system": "http://fhir.patientsknowbest.com/id/patientconsent-legacy-identifier", "value": "3265838" } ], "status": "active", "scope": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/consentscope", "code": "patient-privacy" } ] }, "category": [ { "coding": [ { "system": "http://fhir.patientsknowbest.com/codesystem/consent-category", "code": "PATIENTCONSENT" } ] } ], "patient": { "reference": "Patient/66f11f66-f780-3e0b-ae65-315a7b6f9252" }, "dateTime": "2025-08-20T11:34:28.619+00:00", "policy": [ { "authority": "http://www.patientsknowbest.com" } ], "provision": { "type": "permit", "actor": [ { "role": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "CONSENTER" } ] }, "reference": { "reference": "Patient/f6f7022d-15ba-3ec1-859b-e0afd7329e69" } } ], "securityLabel": [ { "system": "http://fhir.patientsknowbest.com/codesystem/privacy-label", "code": "GENERAL_HEALTH" } ] } }, "search": { "mode": "match" } }, { "link": [ { "relation": "self", "url": "https://rcaggregated.fhir-api.rc.pkb.io/Patient/f022dbe3-e8c4-3968-84f6-b3b575e1d646" } ], "fullUrl": "https://rcaggregated.fhir-api.rc.pkb.io/Patient/f022dbe3-e8c4-3968-84f6-b3b575e1d646", "resource": { "resourceType": "Patient", "id": "f022dbe3-e8c4-3968-84f6-b3b575e1d646", "meta": { "versionId": "6086663" }, "extension": [ { "url": "http://fhir.patientsknowbest.com/structuredefinition/status", "valueString": "EMAIL_CONFIRMED" } ], "identifier": [ { "system": "http://fhir.patientsknowbest.com/id/public-id", "value": "f7a7f6b0-413c-4ada-824b-e0fbbc173c56" } ], "name": [ { "family": "James", "given": [ "Stephen" ], "prefix": [ "Mr" ] } ], "telecom": [ { "system": "email", "value": "stephen.james@pkbtest.com", "rank": 1 } ], "gender": "unknown", "birthDate": "1990-01-01", "address": [ { "line": [ "123 Test Street" ], "city": "Test City", "state": "Test County", "postalCode": "TT44TTq", "country": "GB-ENG" } ] }, "search": { "mode": "include" } }, { "link": [ { "relation": "self", "url": "https://rcaggregated.fhir-api.rc.pkb.io/Patient/f6f7022d-15ba-3ec1-859b-e0afd7329e69" } ], "fullUrl": "https://rcaggregated.fhir-api.rc.pkb.io/Patient/f6f7022d-15ba-3ec1-859b-e0afd7329e69", "resource": { "resourceType": "Patient", "id": "f6f7022d-15ba-3ec1-859b-e0afd7329e69", "meta": { "versionId": "6086659" }, "extension": [ { "url": "http://fhir.patientsknowbest.com/structuredefinition/status", "valueString": "EMAIL_CONFIRMED" } ], "identifier": [ { "system": "http://fhir.patientsknowbest.com/id/public-id", "value": "57de7528-dd0f-46de-9bae-3abe1880303f" } ], "name": [ { "family": "Jackson", "given": [ "Stephanie" ], "prefix": [ "Miss" ] } ], "telecom": [ { "system": "email", "value": "stephanie.jackson@pkbtest.com", "rank": 1 } ], "gender": "unknown", "birthDate": "1990-01-01", "address": [ { "line": [ "123 Test Road" ], "city": "Test City", "state": "Test County", "postalCode": "TT44TT", "country": "GB-ENG" } ] }, "search": { "mode": "include" } } ] } ```