Skip to content

CCM-22853: clarify reason status usage #677

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
masl2 merged 4 commits into from
Aug 19, 2026
Merged

CCM-22853: clarify reason status usage #677

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fbea801
clarify reason status usage
masl2 Aug 18, 2026
022c82b
version bump
masl2 Aug 18, 2026
723ef1b
disable top lvl header as sub config not being picked up
masl2 Aug 18, 2026
71c8197
Merge branch 'main' into feature/CCM-22853_reason-clarification
masl2 Aug 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .markdownlint.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@
"siblings_only": true
},
// https://github.com/DavidAnson/markdownlint/blob/main/doc/md033.md
"MD033": false
"MD033": false,
"MD041": false
}
2 changes: 1 addition & 1 deletion VERSION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.3.0-${yyyy}${mm}${dd}.${HH}${MM}${SS}+${hash}
1.3.1-${yyyy}${mm}${dd}.${HH}${MM}${SS}+${hash}
6 changes: 0 additions & 6 deletions specification/.markdownlint.json
View file
Open in desktop

This file was deleted.

12 changes: 10 additions & 2 deletions specification/api/components/documentation/patchLetter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,19 @@ Allowed `status` values that can be used to are:

It is not possible to update a letter to status of `PENDING`.

### Reason Codes

Optionally a `reasonCode` and `reasonText` explaining the status (for example, validation failures) can be included in the request body.

### Example Error Codes
With the exception of the `RETURNED` status, `reasonCode` and `reasonText` can be agreed on an individual basis

#### RETURNED Updates

NHS Notify uses a standardised set of reasons for the `RETURNED` status.

Both a `reasonCode` and `reasonText` <b>must</b> be provided for a `RETURNED` status update.

Examples of reason codes and text that may be returned include (but are not limited to)
The reason codes and expected text for the `RETURNED` status are as follows:

| Reason Code | Reason Text |
|-------------|----------------------------|
Expand Down
10 changes: 8 additions & 2 deletions specification/api/components/documentation/postLetters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,15 @@ The request should not contain multiple letter objects with the same ID.

Optionally a `reasonCode` and `reasonText` explaining the status (for example, validation failures) can be included in the request body for each update.

### Example Error Codes
With the exception of the `RETURNED` status, `reasonCode` and `reasonText` can be agreed on an individual basis based on supplier workflows.

Examples of reason codes and text that may be returned include (but are not limited to)
#### RETURNED Updates

NHS Notify uses a standardised set of reasons for the `RETURNED` status.

Both a `reasonCode` and `reasonText` <b>must</b> be provided for a `RETURNED` status update.

The reason codes and expected text for the `RETURNED` status are as follows:

| Reason Code | Reason Text |
|-------------|----------------------------|
Expand Down
Loading