Skip to content

Commit aa591d4

Browse files
NPA-5757: update schema for status and status reason description
1 parent 89dd8a5 commit aa591d4

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
@@ -942,6 +942,11 @@ paths:
942942
* JSON Patch operations must be valid according to RFC 6902
943943
* Status changes must use valid status codes from <http://hl7.org/fhir/consent-state-codes>
944944
945+
**IMPORTANT: Business Rule Enforcement**
946+
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`.
947+
948+
Requests that change status without providing a status reason will return an error
949+
945950
## Access modes
946951
947952
This endpoint supports the following access modes:
@@ -992,12 +997,21 @@ paths:
992997
summary: Set status to active with an end date
993998
description: |
994999
Example of a combined update to a record.
995-
The status will be changed to inactive.
1000+
The status will be changed to active.
9961001
The relationship will be considered as ended following this date.
9971002
value:
9981003
- op: replace
9991004
path: /status
10001005
value: active
1006+
- op: replace
1007+
path: /extension
1008+
value:
1009+
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
1010+
valueCodeableConcept:
1011+
coding:
1012+
- system: http://terminology.hl7.org/CodeSystem/consent-reason
1013+
code: "ROLE_ACTIVATED"
1014+
display: "Role activated"
10011015
- op: replace
10021016
path: /provision/period/end
10031017
value: "2026-12-31"

0 commit comments

Comments
 (0)