Skip to content

Commit a350e1e

Browse files
NPA-5088: Update to specification examples for ID to be UUID for Consent
1 parent 0da3c05 commit a350e1e

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

specification/validated-relationships-service-api.yaml

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -653,7 +653,7 @@ paths:
653653
location:
654654
schema:
655655
type: string
656-
example: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/9000000009
656+
example: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/90b9863e-e33c-4895-a333-fd0ea0e23205
657657
description: URL for the newly created proxy role
658658
content:
659659
application/fhir+json:
@@ -841,34 +841,35 @@ paths:
841841
842842
See the postman collection for example requests.
843843
844-
| Scenario | Request | Response |
845-
| ------------------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------- |
846-
| Successful status update | Valid patch changing status to 'active', request with id 'c6f48e4d' | HTTP Status 200 and OperationOutcome |
847-
| Successful access level update | Valid patch modifying the role end date, request with id '0c56a594' | HTTP Status 200 and OperationOutcome |
848-
| Multiple valid changes | Valid patch with multiple operations, request with id 'b02ea26c' | HTTP Status 200 and OperationOutcome |
849-
| Invalid patch format | Malformed JSON patch document, request with id '3a2679eb' | HTTP Status 400 and INVALID_PATCH_FORMAT error response |
850-
| Invalid path | Patch targeting non-existent element, request with id '94df7c8f' | HTTP Status 400 and INVALID_PATCH_PATH error response |
851-
| Invalid status code | Patch with invalid status value, request with id '2a7b736d' | HTTP Status 422 and INVALID_STATUS_CODE error response |
852-
| Invalid status reason | Patch with invalid status reason value, request with id '4b6792be' | HTTP Status 422 and INVALID_STATUS_REASON error response |
853-
| Resource not found | Patch for non-existent Consent, request with an id not listed here | HTTP Status 404 and RESOURCE_NOT_FOUND error response |
854-
| Invalid state transition | Patch attempting invalid status change, request with id '6fb4361b' | HTTP Status 422 and INVALID_STATE_TRANSITION error response |
844+
| Scenario | Request | Response |
845+
| ------------------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
846+
| Successful status update | Valid patch changing status to 'active', request with id 'c512b0db-6702-43ee-8c21-bbded2552da9' | HTTP Status 200 and OperationOutcome |
847+
| Successful access level update | Valid patch modifying the role end date, request with id '6b71ac92-baa3-4b76-b0f5-a601257e2722' | HTTP Status 200 and OperationOutcome |
848+
| Multiple valid changes | Valid patch with multiple operations, request with id '43003db8-ffcd-4bd6-ab2f-b49b9656f9e5' | HTTP Status 200 and OperationOutcome |
849+
| Invalid patch format | Malformed JSON patch document, request with id '849ea584-2318-471b-a24c-cee1b5ad0137' | HTTP Status 400 and INVALID_PATCH_FORMAT error response |
850+
| Invalid path | Patch targeting non-existent element, request with id '01abb0c5-b1ac-499d-9655-9cd0b8d3588f' | HTTP Status 400 and INVALID_PATCH_PATH error response |
851+
| Invalid status code | Patch with invalid status value, request with id '78c35330-fa2f-4934-a5dd-fff847f38de5' | HTTP Status 422 and INVALID_STATUS_CODE error response |
852+
| Invalid status reason | Patch with invalid status reason value, request with id '51fb4df5-815a-45cd-8427-04d6558336b7' | HTTP Status 422 and INVALID_STATUS_REASON error response |
853+
| Resource not found | Patch for non-existent Consent, request with an id not listed here | HTTP Status 404 and RESOURCE_NOT_FOUND error response |
854+
| Invalid state transition | Patch attempting invalid status change, request with id '7b7f47b8-96e5-43eb-b733-283bf1449f2c' | HTTP Status 422 and INVALID_STATE_TRANSITION error response |
855855
parameters:
856856
# Change id parameter to Component ConsentID when NPA-5088 is complete
857857
- name: id
858858
in: path
859859
required: true
860-
description: The logical id of the Consent resource to update
860+
description: The UUID of the Consent resource to update
861861
schema:
862862
type: string
863+
format: uuid
863864
examples:
864865
statusUpdate:
865-
value: c6f48e4d
866+
value: c512b0db-6702-43ee-8c21-bbded2552da9
866867
summary: Update consent status
867868
updateProvision:
868-
value: 0c56a594
869+
value: 6b71ac92-baa3-4b76-b0f5-a601257e2722
869870
summary: Set an end date for a role
870871
multipleUpdates:
871-
value: b02ea26c
872+
value: 43003db8-ffcd-4bd6-ab2f-b49b9656f9e5
872873
summary: Set status to active with an end date
873874
requestBody:
874875
required: true

0 commit comments

Comments
 (0)