Notice: This guidance is under active development by NHS England and content may be added or updated on a regular basis.
View Specific Relationship - Search on RelatedPerson id
Existing relationships for a person can be found by searching on the id of the RelatedPerson resource. There would have been a previous query (for example Search on Patient NHS Number) to identify RelatedPerson resources of interest (and to return their id).
GET https://pdsrepository.example.nhs.uk/FHIR/R4/RelatedPerson/{id}
or
GET https://pdsrepository.example.nhs.uk/FHIR/R4/RelatedPerson?_{id}
to return related Provenance resources
GET https://pdsrepository.example.nhs.uk/FHIR/R4/RelatedPerson?_{id}&_revinclude=Provenance:target
This request is then submitted to the Personal Demographics Service via FHIR RESTful API
Search Examples
Without Provenance
GET https://pdsrepository.example.nhs.uk/FHIR/R4/RelatedPerson/RelatedPerson-NHS-9100000009
or
GET https://pdsrepository.example.nhs.uk/FHIR/R4/RelatedPerson?_id=RelatedPerson-NHS-9100000009
Example response:
With Provenance
GET https://pdsrepository.example.nhs.uk/FHIR/R4/RelatedPerson?_id=RelatedPerson-NHS-9100000009&_revinclude=Provenance:target
Example response: