Skip to content

Commit 97f50df

Browse files
NPA-4313: Added location header to 201 response and updated performer in requests for POST
1 parent d342427 commit 97f50df

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

specification/validated-relationships-service-api.yaml

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,7 @@ paths:
355355
summary: Get proxy roles
356356
description: |
357357
## Overview
358-
Use this endpoint to get the details about proxy relationships, including current status, based on a provided proxy's NHS Number.
358+
Use this endpoint to get the details about proxy role, including current status, based on a provided proxy's NHS Number.
359359
360360
You can (optionally) include `status={status}` request parameter to filter the limit the response to records with a given status bound to the http://hl7.org/fhir/consent-state-codes CodeSystem e.g. `status=active`.
361361
@@ -523,10 +523,10 @@ paths:
523523
value: "9000000017"
524524
dateTime: "2025-02-11T14:30:00Z"
525525
performer:
526-
type: RelatedPerson
527-
identifier:
528-
system: https://fhir.nhs.uk/Id/nhs-number
529-
value: "9000000012"
526+
- type: RelatedPerson
527+
identifier:
528+
system: https://fhir.nhs.uk/Id/nhs-number
529+
value: "9000000012"
530530
provision:
531531
period:
532532
start: "2025-02-11"
@@ -573,10 +573,10 @@ paths:
573573
value: "9000000017"
574574
dateTime: "2025-02-11T14:30:00Z"
575575
performer:
576-
type: RelatedPerson
577-
identifier:
578-
system: https://fhir.nhs.uk/Id/nhs-number
579-
value: "9000000012"
576+
- type: RelatedPerson
577+
identifier:
578+
system: https://fhir.nhs.uk/Id/nhs-number
579+
value: "9000000012"
580580
provision:
581581
period:
582582
start: "2025-02-11"
@@ -601,6 +601,12 @@ paths:
601601
responses:
602602
"201":
603603
description: Consent resource successfully created
604+
headers:
605+
location:
606+
schema:
607+
type: string
608+
example: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/dfsdfsfsdfsdf
609+
description: URL for the newly created proxy role
604610
content:
605611
application/fhir+json:
606612
schema:

0 commit comments

Comments
 (0)