Skip to content

Commit 5327983

Browse files
kamran-iqbal4-NHSDkamran-iqbal4-NHSD
committed
NPA-3889: Reworked examples to reflect spec list
1 parent 69a56cb commit 5327983

13 files changed

+286
-282
lines changed

specification/examples/responses/GET_RelatedPerson/list-relationship-no-records-returned.yaml renamed to specification/examples/responses/GET_RelatedPerson/empty_response_9000000033.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
ListRelationshipNoRecordsReturned:
1+
RelatedEmptyResponse:
22
summary: Without additional records.
33
description: |
44
Example response containing no details of any matched candidate proxy relationships.

‎specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-missing.yaml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
RelatedPersonInvalidIdentifierMissing:
2+
summary: Invalid Identifier Missing
3+
description: The request was unsuccessful due to missing system identifier.
4+
value:
5+
issue:
6+
- code: invalid
7+
details:
8+
coding:
9+
- code: MISSING_IDENTIFIER_VALUE
10+
display: Missing RelatedPerson NHS number.
11+
system: https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode
12+
version: '1'
13+
diagnostics: The 'identifier' parameter is required
14+
severity: error
15+
resourceType: OperationOutcome

‎specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-system.yaml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
RelatedPersonInvalidIdentifierSystem:
2+
summary: Invalid Identifier System
3+
description: The request was unsuccessful due to incorrect system identifier.
4+
value:
5+
issue:
6+
- code: invalid
7+
diagnostics: The identifier system is not valid.
8+
severity: error
9+
details:
10+
coding:
11+
- code: INVALID_IDENTIFIER_SYSTEM
12+
display: Invalid identifier system.
13+
system: https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode
14+
version: '1'
15+
resourceType: OperationOutcome

‎specification/examples/responses/GET_RelatedPerson/include-patients.yaml‎

Lines changed: 0 additions & 60 deletions
This file was deleted.

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

Lines changed: 0 additions & 96 deletions
This file was deleted.

‎specification/examples/responses/GET_RelatedPerson/list_relationship_9000000017.yaml‎

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

‎specification/examples/responses/GET_RelatedPerson/list_relationship_9000000017_include.yaml‎

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

‎specification/examples/responses/GET_RelatedPerson/verify_relationship_9000000009.yaml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
VerifyRelationship9000000009:
2+
summary: Verify relationship response for 9000000009
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` resource for the 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+
entry:
13+
- fullUrl: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742
14+
resource:
15+
id: BE974742
16+
identifier:
17+
- system: https://fhir.nhs.uk/Id/nhs-number
18+
value: '9000000017'
19+
patient:
20+
identifier:
21+
system: https://fhir.nhs.uk/Id/nhs-number
22+
value: '9000000009'
23+
type: Patient
24+
relationship:
25+
- coding:
26+
- code: MTH
27+
display: mother
28+
system: http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
29+
resourceType: RelatedPerson
30+
search:
31+
mode: match
32+
link:
33+
- relation: self
34+
url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?patient:identifier=9000000009&identifier=9000000017

0 commit comments

Comments
 (0)