Skip to content

Commit e3c6e81

Browse files
NPA-5757: Updated the spec to include info on including the statusReason along with any status change
1 parent d9d26e5 commit e3c6e81

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

specification/validated-relationships-service-api.yaml

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -941,6 +941,11 @@ paths:
941941
* JSON Patch operations must be valid according to RFC 6902
942942
* Status changes must use valid status codes from <http://hl7.org/fhir/consent-state-codes>
943943
944+
**IMPORTANT: Business Rule Enforcement**
945+
If you update the `/status` of a role, you **MUST** also provide a corresponding update to the `/extension` path in the same patch array to provide the `statusReason`.
946+
947+
Requests that change status without providing a status reason will return an error
948+
944949
## Access modes
945950
946951
This endpoint supports the following access modes:
@@ -991,12 +996,21 @@ paths:
991996
summary: Set status to active with an end date
992997
description: |
993998
Example of a combined update to a record.
994-
The status will be changed to inactive.
999+
The status will be changed to active.
9951000
The relationship will be considered as ended following this date.
9961001
value:
9971002
- op: replace
9981003
path: /status
9991004
value: active
1005+
- op: replace
1006+
path: /extension
1007+
value:
1008+
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
1009+
valueCodeableConcept:
1010+
coding:
1011+
- system: http://terminology.hl7.org/CodeSystem/consent-reason
1012+
code: "ROLE_ACTIVATED"
1013+
display: "Role Activated"
10001014
- op: replace
10011015
path: /provision/period/end
10021016
value: "2026-12-31"

0 commit comments

Comments
 (0)