Scenario - View a Relationship
Actors
| Name | Type | Description |
|---|---|---|
| Client Application | System | The application the user uses |
| NHS England PDS | System | NHS England Personal Demographics Service (PDS) |
Use Case(s)
- Use Case - Match Parents on General Register Office (GRO) Civil Birth Registration
- Use Case - National Back Office (NBO) Potential Relationships
- Use Case - National Back Office (NBO) Views a relationship
- Use Case - API Consumer Gets All Related Persons
- Use Case - API Consumer Gets Specific Relationship
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
RelatedPerson's for a patient can be found by searching on the patient's NHS Number.
GET https://pdsrepository.example.nhs.uk/FHIR/R4/RelatedPerson?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|{nhsNumber}
This request is then submitted to the Personal Demographics Service via FHIR RESTful API
Search Example
GET https://pdsrepository.example.nhs.uk/FHIR/R4/RelatedPerson?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9000000017
Example response:
View Relationship - Search on Person NHS Number
Existing RelatedPerson for a person can be found by searching on the person's NHS Number.
GET https://pdsrepository.example.nhs.uk/FHIR/R4/RelatedPerson?identifier=https://fhir.nhs.uk/Id/nhs-number|{nhsNumber}
This request is then submitted to the Personal Demographics Service via FHIR RESTful API
Search Example
GET https://pdsrepository.example.nhs.uk/FHIR/R4/RelatedPerson?identifier=https://fhir.nhs.uk/Id/nhs-number|91000000009
Example response:
View Relationship and Provenance - Search on Patient NHS Number
Existing RelatedPerson for a person can be found by searching on the person's NHS Number.
GET https://pdsrepository.example.nhs.uk/FHIR/R4/RelatedPerson?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|{nhsNumber}&_revinclude=Provenance:target
This request is then submitted to the Personal Demographics Service via FHIR RESTful API
Search Example
GET https://pdsrepository.example.nhs.uk/FHIR/R4/RelatedPerson?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|91000000009&_revinclude=Provenance:target
Example response:
View Relationship and Provenance - Search on Person NHS Number
Existing RelatedPerson for a person can be found by searching on the person's NHS Number.
GET https://pdsrepository.example.nhs.uk/FHIR/R4/RelatedPerson?identifier=https://fhir.nhs.uk/Id/nhs-number|{nhsNumber}&_revinclude=Provenance:target
This request is then submitted to the Personal Demographics Service via FHIR RESTful API
Search Example
GET https://pdsrepository.example.nhs.uk/FHIR/R4/RelatedPerson?identifier=https://fhir.nhs.uk/Id/nhs-number|91000000009&_revinclude=Provenance:target
Example response:
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: