Skip to content

Commit 69a56cb

Browse files
kamran-iqbal4-NHSDkamran-iqbal4-NHSD
committed
NPA-3889: Expanded examples for the related person
1 parent 510b228 commit 69a56cb

File tree

6 files changed

+265
-0
lines changed

6 files changed

+265
-0
lines changed

‎specification/examples/responses/GET_RelatedPerson/list-relationship-include-patient.yaml‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
ListRelationshipIncludePatient:
2+
summary: With patient '_include'
3+
description: |
4+
Example response containing the details of a matched candidate proxy relationship between a birth mother and her children.
5+
6+
The FHIR Bundle contains a `RelatedPerson` and a `Patient` resource per relationship verified against authoritative sources.
7+
8+
`Patient` resources are included in the bundle when the `_include=RelatedPerson:patient` query parameter is specified.
9+
value:
10+
resourceType: Bundle
11+
timestamp: '2024-01-01T00:00:00+00:00'
12+
total: 4
13+
type: searchset
14+
link:
15+
- relation: self
16+
url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?identifier=9000000017&_include=RelatedPerson:patient
17+
18+
entry:
19+
- fullUrl: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9000000009
20+
resource:
21+
birthDate: '2017-09-23'
22+
id: '9000000009'
23+
identifier:
24+
- system: https://fhir.nhs.uk/Id/nhs-number
25+
value: '9000000009'
26+
name:
27+
- family: MOGAJI
28+
given:
29+
- GADIL
30+
id: BLnbA
31+
period:
32+
start: '2021-07-08'
33+
prefix:
34+
- MR
35+
use: usual
36+
resourceType: Patient
37+
search:
38+
mode: include
39+
- fullUrl: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742
40+
resource:
41+
id: BE974742
42+
identifier:
43+
- system: https://fhir.nhs.uk/Id/nhs-number
44+
value: '9000000017'
45+
patient:
46+
identifier:
47+
system: https://fhir.nhs.uk/Id/nhs-number
48+
value: '9000000009'
49+
type: Patient
50+
relationship:
51+
- coding:
52+
- code: MTH
53+
display: mother
54+
system: http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
55+
resourceType: RelatedPerson
56+
search:
57+
mode: match
58+
- fullUrl: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9000000025
59+
resource:
60+
birthDate: '2018-04-27'
61+
id: '9000000025'
62+
identifier:
63+
- system: https://fhir.nhs.uk/Id/nhs-number
64+
value: '9000000025'
65+
name:
66+
- family: FEARON
67+
given:
68+
- Daren
69+
id: vitjN
70+
period:
71+
start: '2018-09-21'
72+
prefix:
73+
- MR
74+
use: usual
75+
resourceType: Patient
76+
search:
77+
mode: include
78+
- fullUrl: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/A3CC67E2
79+
resource:
80+
id: A3CC67E2
81+
identifier:
82+
- system: https://fhir.nhs.uk/Id/nhs-number
83+
value: '9000000017'
84+
patient:
85+
identifier:
86+
system: https://fhir.nhs.uk/Id/nhs-number
87+
value: '9000000025'
88+
type: Patient
89+
relationship:
90+
- coding:
91+
- code: MTH
92+
display: mother
93+
system: http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
94+
resourceType: RelatedPerson
95+
search:
96+
mode: match

‎specification/examples/responses/GET_RelatedPerson/list-relationship-no-records-returned.yaml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
ListRelationshipNoRecordsReturned:
2+
summary: Without additional records.
3+
description: |
4+
Example response containing no details of any matched candidate proxy relationships.
5+
6+
value:
7+
resourceType: Bundle
8+
timestamp: '2024-01-01T00:00:00+00:00'
9+
total: 0
10+
type: searchset
11+
link:
12+
- relation: self
13+
url: https://sandbox.api.service.nhs.uk/validated-relationships-service-api/FHIR/R4/RelatedPerson?identifier=9000000033

‎specification/examples/responses/GET_RelatedPerson/list-relationship.yaml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
ListRelationship:
2+
summary: List a relationship
3+
description: |
4+
Example response containing the details of a single matched candidate proxy relationship between a birth mother and her child.
5+
6+
The FHIR Bundle contains a `RelatedPerson` and a `Patient` resource per relationship verified against authoritative sources.
7+
value:
8+
resourceType: Bundle
9+
timestamp: '2024-01-01T00:00:00+00:00'
10+
total: 2
11+
type: searchset
12+
link:
13+
- relation: self
14+
url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?identifier=9000000017
15+
16+
entry:
17+
- fullUrl: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742
18+
resource:
19+
id: BE974742
20+
identifier:
21+
- system: https://fhir.nhs.uk/Id/nhs-number
22+
value: '9000000017'
23+
patient:
24+
identifier:
25+
system: https://fhir.nhs.uk/Id/nhs-number
26+
value: '9000000009'
27+
type: Patient
28+
relationship:
29+
- coding:
30+
- code: MTH
31+
display: mother
32+
system: http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
33+
resourceType: RelatedPerson
34+
search:
35+
mode: match
36+
- fullUrl: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/A3CC67E2
37+
resource:
38+
id: A3CC67E2
39+
identifier:
40+
- system: https://fhir.nhs.uk/Id/nhs-number
41+
value: '9000000017'
42+
patient:
43+
identifier:
44+
system: https://fhir.nhs.uk/Id/nhs-number
45+
value: '9000000025'
46+
type: Patient
47+
relationship:
48+
- coding:
49+
- code: MTH
50+
display: mother
51+
system: http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
52+
resourceType: RelatedPerson
53+
search:
54+
mode: match
55+

‎specification/examples/responses/GET_RelatedPerson/verify-relationship-patient-proxy-with-include.yaml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
VerifyRelationshipPatientProxyWithInclude:
2+
summary: With patient '_include'
3+
description: |
4+
Example response containing the details of a single matched candidate proxy relationship between a birth mother and her child.
5+
6+
The FHIR Bundle contains a `RelatedPerson` and a `Patient` resource per relationship verified against authoritative sources.
7+
8+
`Patient` resources are included in the bundle when the `_include=RelatedPerson:patient` query parameter is specified.
9+
value:
10+
resourceType: Bundle
11+
timestamp: '2024-01-01T00:00:00+00:00'
12+
total: 2
13+
type: searchset
14+
link:
15+
- relation: self
16+
url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?patient:identifier=9000000009&identifier=9000000017&_include=RelatedPerson:patient
17+
18+
entry:
19+
- fullUrl: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9000000009
20+
resource:
21+
birthDate: '2017-09-23'
22+
id: '9000000009'
23+
identifier:
24+
- system: https://fhir.nhs.uk/Id/nhs-number
25+
value: '9000000009'
26+
name:
27+
- family: MOGAJI
28+
given:
29+
- GADIL
30+
id: BLnbA
31+
period:
32+
start: '2021-07-08'
33+
prefix:
34+
- MR
35+
use: usual
36+
resourceType: Patient
37+
search:
38+
mode: include
39+
- fullUrl: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742
40+
resource:
41+
id: BE974742
42+
identifier:
43+
- system: https://fhir.nhs.uk/Id/nhs-number
44+
value: '9000000017'
45+
patient:
46+
identifier:
47+
system: https://fhir.nhs.uk/Id/nhs-number
48+
value: '9000000009'
49+
type: Patient
50+
relationship:
51+
- coding:
52+
- code: MTH
53+
display: mother
54+
system: http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
55+
resourceType: RelatedPerson
56+
search:
57+
mode: match

‎specification/examples/responses/GET_RelatedPerson/verify-relationship-patient-proxy.yaml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
VerifyRelationshipPatientProxy:
2+
summary: Verify a relationship between a patient and proxy
3+
description: |
4+
Example response containing the details of a single matched candidate proxy relationship between a birth mother and her child.
5+
6+
The FHIR Bundle contains a `RelatedPerson` and a `Patient` resource per relationship verified against authoritative sources.
7+
value:
8+
resourceType: Bundle
9+
timestamp: '2024-01-01T00:00:00+00:00'
10+
total: 1
11+
type: searchset
12+
link:
13+
- relation: self
14+
url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?patient:identifier=9000000009&identifier=9000000017
15+
entry:
16+
- fullUrl: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742
17+
resource:
18+
id: BE974742
19+
identifier:
20+
- system: https://fhir.nhs.uk/Id/nhs-number
21+
value: '9000000017'
22+
patient:
23+
identifier:
24+
system: https://fhir.nhs.uk/Id/nhs-number
25+
value: '9000000009'
26+
type: Patient
27+
relationship:
28+
- coding:
29+
- code: MTH
30+
display: mother
31+
system: http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
32+
resourceType: RelatedPerson
33+
search:
34+
mode: match

‎specification/validated-relationships-service-api.yaml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -297,6 +297,16 @@ paths:
297297
schema:
298298
$ref: "#/components/schemas/RelatedPersonBundle"
299299
examples:
300+
listRelationship:
301+
$ref: './examples/responses/GET_RelatedPerson/list-relationship.yaml#/ListRelationship'
302+
listRelationshipIncludePatient:
303+
$ref: './examples/responses/GET_RelatedPerson/list-relationship-include-patient.yaml#/ListRelationshipIncludePatient'
304+
listRelationshipNoRecordsReturned:
305+
$ref: './examples/responses/GET_RelatedPerson/list-relationship-no-records-returned.yaml#/ListRelationshipNoRecordsReturned'
306+
verifyRelationshipPatientProxy:
307+
$ref: './examples/responses/GET_RelatedPerson/verify-relationship-patient-proxy.yaml#/VerifyRelationshipPatientProxy'
308+
verifyRelationshipPatientProxyWithInclude:
309+
$ref: './examples/responses/GET_RelatedPerson/verify-relationship-patient-proxy-with-include.yaml#/VerifyRelationshipPatientProxyWithInclude'
300310
relatedPersonWithoutPatients:
301311
$ref: './examples/responses/GET_RelatedPerson/without-patients.yaml#/RelatedPersonWithoutPatients'
302312
relatedPersonIncludePatients:

0 commit comments

Comments
 (0)