Skip to content

CCM-15019: Adding remaining required parameters for the eventpub lambda #25

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
nhsd-angel-pastor merged 1 commit into from
Apr 10, 2026
Merged

CCM-15019: Adding remaining required parameters for the eventpub lambda #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
53 changes: 47 additions & 6 deletions cloudevents/docs/cloudevents/common/2026-04/nhs-notify-profile.schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr><td><a href="#type-6">Disallow 'handled' token (String)</a></td></tr>
<tr><td><a href="#type-7">Disallow 'status' token (String)</a></td></tr>
<tr><td><a href="#type-8">Disallow 'started' token (String)</a></td></tr>
<tr><td><a href="#type-9">Disallow 'failed' token (String)</a></td></tr><tr><td colspan="2"><a href="#time">time</a></td><td>String</td></tr><tr><td colspan="2"><a href="#datacontenttype">datacontenttype</a></td><td>String=application/json</td></tr><tr><td colspan="2"><a href="#dataschema">dataschema</a></td><td>String</td></tr><tr><td colspan="2"><a href="#data">data</a></td><td>Object</td></tr><tr><td colspan="2"><a href="#traceparent">traceparent</a></td><td>String</td></tr><tr><td colspan="2"><a href="#tracestate">tracestate</a></td><td>String</td></tr><tr><td colspan="2"><a href="#partitionkey">partitionkey</a></td><td>String</td></tr><tr><td colspan="2"><a href="#recordedtime">recordedtime</a></td><td>String</td></tr><tr><td colspan="2"><a href="#sampledrate">sampledrate</a></td><td>Integer</td></tr><tr><td colspan="2"><a href="#sequence">sequence</a></td><td>String</td></tr><tr><td colspan="2"><a href="#severitytext">severitytext</a></td><td>String</td></tr><tr><td colspan="2"><a href="#severitynumber">severitynumber</a></td><td>Integer</td></tr><tr><td colspan="2"><a href="#dataclassification">dataclassification</a></td><td>String</td></tr><tr><td colspan="2"><a href="#dataregulation">dataregulation</a></td><td>String</td></tr><tr><td colspan="2"><a href="#datacategory">datacategory</a></td><td>String</td></tr><tr><td colspan="2" rowspan="9">All of:</td><td>Object</td></tr><tr><td></td></tr><tr><td></td></tr><tr><td></td></tr><tr><td></td></tr><tr><td></td></tr><tr><td></td></tr><tr><td></td></tr><tr><td></td></tr></tbody></table>
<tr><td><a href="#type-9">Disallow 'failed' token (String)</a></td></tr><tr><td colspan="2"><a href="#time">time</a></td><td>String</td></tr><tr><td colspan="2"><a href="#datacontenttype">datacontenttype</a></td><td>String=application/json</td></tr><tr><td colspan="2"><a href="#dataschema">dataschema</a></td><td>String</td></tr><tr><td colspan="2"><a href="#dataschemaversion">dataschemaversion</a></td><td>String</td></tr><tr><td colspan="2"><a href="#data">data</a></td><td>Object</td></tr><tr><td colspan="2"><a href="#traceparent">traceparent</a></td><td>String</td></tr><tr><td colspan="2"><a href="#tracestate">tracestate</a></td><td>String</td></tr><tr><td colspan="2"><a href="#partitionkey">partitionkey</a></td><td>String</td></tr><tr><td colspan="2"><a href="#recordedtime">recordedtime</a></td><td>String</td></tr><tr><td colspan="2"><a href="#sampledrate">sampledrate</a></td><td>Integer</td></tr><tr><td colspan="2"><a href="#sequence">sequence</a></td><td>String</td></tr><tr><td colspan="2"><a href="#severitytext">severitytext</a></td><td>String</td></tr><tr><td colspan="2"><a href="#severitynumber">severitynumber</a></td><td>Integer</td></tr><tr><td colspan="2"><a href="#dataclassification">dataclassification</a></td><td>String</td></tr><tr><td colspan="2"><a href="#dataregulation">dataregulation</a></td><td>String</td></tr><tr><td colspan="2"><a href="#datacategory">datacategory</a></td><td>String</td></tr><tr><td colspan="2" rowspan="9">All of:</td><td>Object</td></tr><tr><td></td></tr><tr><td></td></tr><tr><td></td></tr><tr><td></td></tr><tr><td></td></tr><tr><td></td></tr><tr><td></td></tr><tr><td></td></tr></tbody></table>


## Example
Expand All @@ -31,7 +31,7 @@

```
{
"pecversion": "1.0",
"specversion": "1.0",
"id": "6f1c2a53-3d54-4a0a-9a0b-0e9ae2d4c111",
"source": "/nhs/england/notify/development/dev-12345/ordering",
"subject": "customer/920fca11-596a-4eca-9c47-99f624614658/order/769acdd4-6a47-496f-999f-76a6fd2c3959/item/4f5e17c0-ec57-4cee-9a86-14580cf5af7d",
Expand All @@ -46,6 +46,7 @@
"severitynumber": 1,
"datacontenttype": "application/json",
"dataschema": "https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event-data.schema.yaml",
"dataschemaversion": "1.0.0",
"dataclassification": "restricted",
"dataregulation": "ISO-27001",
"datacategory": "sensitive",
Expand Down Expand Up @@ -487,7 +488,7 @@
<tr><th>Type</th><td colspan="2">String</td></tr>
<tr>
<th>Required</th>
<td colspan="2">No</td>
<td colspan="2">Yes</td>
</tr>
<tr>
<th>Const</th>
Expand All @@ -514,7 +515,7 @@
<tr><th>Type</th><td colspan="2">String</td></tr>
<tr>
<th>Required</th>
<td colspan="2">No</td>
<td colspan="2">Yes</td>
</tr>
<tr>
<th>Examples</th>
Expand All @@ -526,6 +527,33 @@



## dataschemaversion


<table class="jssd-property-table">
<tbody>
<tr>
<th>Description</th>
<td colspan="2">Version of the event payload schema (semantic versioning format).</td>
</tr>
<tr><th>Type</th><td colspan="2">String</td></tr>
<tr>
<th>Required</th>
<td colspan="2">Yes</td>
</tr>
<tr>
<th>Pattern</th>
<td colspan="2">^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$</td>
</tr><tr>
<th>Examples</th>
<td colspan="2"><li>1.0.0</li></td>
</tr>
</tbody>
</table>




## data


Expand Down Expand Up @@ -1043,6 +1071,15 @@
],
"$comment": "URI to event payload schema."
},
"dataschemaversion": {
"type": "string",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",
"description": "Version of the event payload schema (semantic versioning format).",
"examples": [
"1.0.0"
],
"$comment": "Version of the event payload schema (semantic versioning, see https://semver.org/)."
},
"data": {
"type": "object",
"description": "Container object wrapping the structured Notify payload.",
Expand Down Expand Up @@ -1200,7 +1237,10 @@
"recordedtime",
"severitynumber",
"traceparent",
"data"
"data",
"datacontenttype",
"dataschema",
"dataschemaversion"
],
"dependentRequired": {
"severitynumber": [
Expand Down Expand Up @@ -1401,7 +1441,7 @@
],
"examples": [
{
"pecversion": "1.0",
"specversion": "1.0",
"id": "6f1c2a53-3d54-4a0a-9a0b-0e9ae2d4c111",
"source": "/nhs/england/notify/development/dev-12345/ordering",
"subject": "customer/920fca11-596a-4eca-9c47-99f624614658/order/769acdd4-6a47-496f-999f-76a6fd2c3959/item/4f5e17c0-ec57-4cee-9a86-14580cf5af7d",
Expand All @@ -1416,6 +1456,7 @@
"severitynumber": 1,
"datacontenttype": "application/json",
"dataschema": "https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event-data.schema.yaml",
"dataschemaversion": "1.0.0",
"dataclassification": "restricted",
"dataregulation": "ISO-27001",
"datacategory": "sensitive",
Expand Down
17 changes: 15 additions & 2 deletions cloudevents/schemas/common/2026-04/nhs-notify-profile.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,15 @@
],
"$comment": "URI to event payload schema."
},
"dataschemaversion": {
"type": "string",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",
"description": "Version of the event payload schema (semantic versioning format).",
"examples": [
"1.0.0"
],
"$comment": "Version of the event payload schema (semantic versioning, see https://semver.org/)."
},
"data": {
"type": "object",
"description": "Container object wrapping the structured Notify payload.",
Expand Down Expand Up @@ -339,7 +348,10 @@
"recordedtime",
"severitynumber",
"traceparent",
"data"
"data",
"datacontenttype",
"dataschema",
"dataschemaversion"
],
"dependentRequired": {
"severitynumber": [
Expand Down Expand Up @@ -540,7 +552,7 @@
],
"examples": [
{
"pecversion": "1.0",
"specversion": "1.0",
"id": "6f1c2a53-3d54-4a0a-9a0b-0e9ae2d4c111",
"source": "/nhs/england/notify/development/dev-12345/ordering",
"subject": "customer/920fca11-596a-4eca-9c47-99f624614658/order/769acdd4-6a47-496f-999f-76a6fd2c3959/item/4f5e17c0-ec57-4cee-9a86-14580cf5af7d",
Expand All @@ -555,6 +567,7 @@
"severitynumber": 1,
"datacontenttype": "application/json",
"dataschema": "https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event-data.schema.yaml",
"dataschemaversion": "1.0.0",
"dataclassification": "restricted",
"dataregulation": "ISO-27001",
"datacategory": "sensitive",
Expand Down
13 changes: 12 additions & 1 deletion cloudevents/schemas/common/2026-04/nhs-notify-profile.schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,13 @@ properties:
examples:
- https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event-data.schema.json
$comment: URI to event payload schema.
dataschemaversion:
type: string
pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
description: Version of the event payload schema (semantic versioning format).
examples:
- 1.0.0
$comment: Version of the event payload schema (semantic versioning, see https://semver.org/).
data:
type: object
description: Container object wrapping the structured Notify payload.
Expand Down Expand Up @@ -258,6 +265,9 @@ required:
- severitynumber
- traceparent
- data
- datacontenttype
- dataschema
- dataschemaversion
dependentRequired:
severitynumber:
- severitytext
Expand Down Expand Up @@ -366,7 +376,7 @@ allOf:
- data_base64
description: "CloudEvents spec: data and data_base64 are mutually exclusive. Only one can be present."
examples:
- pecversion: "1.0"
- specversion: "1.0"
id: 6f1c2a53-3d54-4a0a-9a0b-0e9ae2d4c111
source: /nhs/england/notify/development/dev-12345/ordering
subject: customer/920fca11-596a-4eca-9c47-99f624614658/order/769acdd4-6a47-496f-999f-76a6fd2c3959/item/4f5e17c0-ec57-4cee-9a86-14580cf5af7d
Expand All @@ -381,6 +391,7 @@ examples:
severitynumber: 1
datacontenttype: application/json
dataschema: https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event-data.schema.yaml
dataschemaversion: 1.0.0
dataclassification: restricted
dataregulation: ISO-27001
datacategory: sensitive
Expand Down
13 changes: 12 additions & 1 deletion cloudevents/src/cloudevents/domains/common/2026-04/nhs-notify-profile.schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,13 @@ properties:
examples:
- https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event-data.schema.json
$comment: URI to event payload schema.
dataschemaversion:
type: string
pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
description: Version of the event payload schema (semantic versioning format).
examples:
- 1.0.0
$comment: Version of the event payload schema (semantic versioning, see https://semver.org/).
data:
type: object
description: Container object wrapping the structured Notify payload.
Expand Down Expand Up @@ -257,6 +264,9 @@ required:
- severitynumber
- traceparent
- data
- datacontenttype
- dataschema
- dataschemaversion
dependentRequired:
severitynumber:
- severitytext
Expand Down Expand Up @@ -365,7 +375,7 @@ allOf:
- data_base64
description: "CloudEvents spec: data and data_base64 are mutually exclusive. Only one can be present."
examples:
- pecversion: "1.0"
- specversion: "1.0"
id: 6f1c2a53-3d54-4a0a-9a0b-0e9ae2d4c111
source: /nhs/england/notify/development/dev-12345/ordering
subject: customer/920fca11-596a-4eca-9c47-99f624614658/order/769acdd4-6a47-496f-999f-76a6fd2c3959/item/4f5e17c0-ec57-4cee-9a86-14580cf5af7d
Expand All @@ -380,6 +390,7 @@ examples:
severitynumber: 1
datacontenttype: application/json
dataschema: https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event-data.schema.yaml
dataschemaversion: 1.0.0
dataclassification: restricted
dataregulation: ISO-27001
datacategory: sensitive
Expand Down
2 changes: 1 addition & 1 deletion cloudevents/src/cloudevents/readme-index.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# To regenerate, run: make update-readme
# To customize labels and purposes, edit: readme-metadata.yaml

generated: '2026-04-07T08:27:26.674Z'
generated: '2026-04-10T08:30:35.780Z'
common:
versions:
- version: 2025-10
Expand Down