WARNING
This guidance is under active development by NHS England and content may be added or updated on a regular basis.Scenario - View a Relationship
Actors
| Name | Type | Description |
|---|---|---|
| Client Application | System | The application the Proxy or Practitioner uses |
| NHS England Proxy Repository | System | NHS England National Proxy Data Repository |
Use Case(s)
View a Relationship
The sequence diagram below is a high level view of the actual process which focuses on the interactions exchanged between the actors.
View Relationship - Search on Patient NHS Number
Proxies for a patient can be found by searching on the patient's NHS Number.
GET https://proxyrepository.example.nhs.uk/FHIR/R4/RelatedPerson?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|{nhsNumber}
This request is then submitted to the national proxy service via FHIR RESTful API
Search Example
GET https://proxyrepository.example.nhs.uk/FHIR/R4/RelatedPerson?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9000000017
Example response:
View Relationship - Search on Proxy NHS Number
Existing proxy relationships for a proxy can be found by searching on the proxy's NHS Number.
GET https://proxyrepository.example.nhs.uk/FHIR/R4/RelatedPerson?identifier=https://fhir.nhs.uk/Id/nhs-number|{nhsNumber}
This request is then submitted to the national proxy service via FHIR RESTful API
Search Example
GET https://proxyrepository.example.nhs.uk/FHIR/R4/RelatedPerson?identifier=https://fhir.nhs.uk/Id/nhs-number|91000000009
Example response: