Skip to content

Commit cf8c649

Browse files
tdroza-nhstdroza-nhs
authored
- Fix dataschema references in event schemas to point to specific data schemas
 instead of generic digital-letter-base-data.schema.yaml - Add missing properties to PDM resource event data schemas: * Add nhsNumber and odsCode to PDMResourceAvailable * Add retryCount to PDMResourceRetriesExceeded and PDMResourceUnavailable - Add corresponding properties to requests.schema.yaml for reusability - Ensure all new properties are marked as required in their respective schemas
1 parent 2c4e633 commit cf8c649

15 files changed

+130
-14
lines changed

‎README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,17 @@ _No common schemas defined yet._
101101
| ----------- | ------------- | ---------------- | ------------- |
102102
| **Core.request.submitted Data.v1** | [`src/digital-letters/2025-10-draft/data/core.request.submitted-data.v1.schema.yaml`](src/digital-letters/2025-10-draft/data/core.request.submitted-data.v1.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/core.request.submitted-data.v1.schema.json`](schemas/digital-letters/2025-10-draft/data/core.request.submitted-data.v1.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/core.request.submitted-data.v1.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/core.request.submitted-data.v1.schema.md) |
103103
| **Digital Letter Base Data** | [`src/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.md) |
104+
| **Digital Letters Mesh Inbox Message Downloaded Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-downloaded-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-downloaded-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-downloaded-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-downloaded-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-downloaded-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-downloaded-data.schema.md) |
105+
| **Digital Letters Mesh Inbox Message Received Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-received-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-received-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-received-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-received-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-received-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-received-data.schema.md) |
106+
| **Digital Letters Pdm Resource Available Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-available-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-available-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-available-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-available-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-available-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-available-data.schema.md) |
107+
| **Digital Letters Pdm Resource Retries Exceeded Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-retries-exceeded-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-retries-exceeded-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-retries-exceeded-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-retries-exceeded-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-retries-exceeded-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-retries-exceeded-data.schema.md) |
108+
| **Digital Letters Pdm Resource Submitted Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-submitted-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-submitted-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-submitted-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-submitted-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-submitted-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-submitted-data.schema.md) |
109+
| **Digital Letters Pdm Resource Unavailable Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-unavailable-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-unavailable-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-unavailable-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-unavailable-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-unavailable-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-unavailable-data.schema.md) |
104110
| **Messages.status.updated Data.v1** | [`src/digital-letters/2025-10-draft/data/messages.status.updated-data.v1.schema.yaml`](src/digital-letters/2025-10-draft/data/messages.status.updated-data.v1.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/messages.status.updated-data.v1.schema.json`](schemas/digital-letters/2025-10-draft/data/messages.status.updated-data.v1.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/messages.status.updated-data.v1.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/messages.status.updated-data.v1.schema.md) |
105111
| **Message Id** | [`src/digital-letters/2025-10-draft/defs/message-id.schema.yaml`](src/digital-letters/2025-10-draft/defs/message-id.schema.yaml) | [`schemas/digital-letters/2025-10-draft/defs/message-id.schema.json`](schemas/digital-letters/2025-10-draft/defs/message-id.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/defs/message-id.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/defs/message-id.schema.md) |
106112
| **Message Status** | [`src/digital-letters/2025-10-draft/defs/message-status.schema.yaml`](src/digital-letters/2025-10-draft/defs/message-status.schema.yaml) | [`schemas/digital-letters/2025-10-draft/defs/message-status.schema.json`](schemas/digital-letters/2025-10-draft/defs/message-status.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/defs/message-status.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/defs/message-status.schema.md) |
113+
| **Pdm** | [`src/digital-letters/2025-10-draft/defs/pdm.schema.yaml`](src/digital-letters/2025-10-draft/defs/pdm.schema.yaml) | [`schemas/digital-letters/2025-10-draft/defs/pdm.schema.json`](schemas/digital-letters/2025-10-draft/defs/pdm.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/defs/pdm.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/defs/pdm.schema.md) |
114+
| **Requests** | [`src/digital-letters/2025-10-draft/defs/requests.schema.yaml`](src/digital-letters/2025-10-draft/defs/requests.schema.yaml) | [`schemas/digital-letters/2025-10-draft/defs/requests.schema.json`](schemas/digital-letters/2025-10-draft/defs/requests.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/defs/requests.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/defs/requests.schema.md) |
107115
| **Someobject** | [`src/digital-letters/2025-10-draft/defs/someobject.schema.yaml`](src/digital-letters/2025-10-draft/defs/someobject.schema.yaml) | [`schemas/digital-letters/2025-10-draft/defs/someobject.schema.json`](schemas/digital-letters/2025-10-draft/defs/someobject.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/defs/someobject.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/defs/someobject.schema.md) |
108116
| **Profile** | [`src/digital-letters/2025-10-draft/digital-letters-event-bus-profile.schema.yaml`](src/digital-letters/2025-10-draft/digital-letters-event-bus-profile.schema.yaml) | [`schemas/digital-letters/2025-10-draft/digital-letters-event-bus-profile.schema.json`](schemas/digital-letters/2025-10-draft/digital-letters-event-bus-profile.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/digital-letters-event-bus-profile.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/digital-letters-event-bus-profile.schema.md) |
109117
| **Profile** | [`src/digital-letters/2025-10-draft/digital-letters-fhir-profile.schema.yaml`](src/digital-letters/2025-10-draft/digital-letters-fhir-profile.schema.yaml) | [`schemas/digital-letters/2025-10-draft/digital-letters-fhir-profile.schema.json`](schemas/digital-letters/2025-10-draft/digital-letters-fhir-profile.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/digital-letters-fhir-profile.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/digital-letters-fhir-profile.schema.md) |

‎src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-available-data.schema.yaml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,15 @@ properties:
77
$ref: ../defs/requests.schema.yaml#/properties/messageReference
88
senderId:
99
$ref: ../defs/requests.schema.yaml#/properties/senderId
10+
resourceId:
11+
$ref: ../defs/pdm.schema.yaml#/properties/resourceId
12+
nhsNumber:
13+
$ref: ../defs/requests.schema.yaml#/properties/nhsNumber
14+
odsCode:
15+
$ref: ../defs/requests.schema.yaml#/properties/odsCode
1016
required:
1117
- messageReference
1218
- senderId
1319
- resourceId
20+
- nhsNumber
21+
- odsCode

‎src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-retries-exceeded-data.schema.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ properties:
99
$ref: ../defs/requests.schema.yaml#/properties/senderId
1010
resourceId:
1111
$ref: ../defs/pdm.schema.yaml#/properties/resourceId
12+
retryCount:
13+
$ref: ../defs/pdm.schema.yaml#/properties/retryCount
1214
required:
1315
- messageReference
1416
- senderId

‎src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-submission-failed-data.schema.yaml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
$schema: https://json-schema.org/draft/2020-12/schema
2+
title: PDMResourceUnavailable Data
3+
description: Base data of the PDMResourceUnavailable event
4+
additionalProperties: false
5+
properties:
6+
messageReference:
7+
$ref: ../defs/requests.schema.yaml#/properties/messageReference
8+
senderId:
9+
$ref: ../defs/requests.schema.yaml#/properties/senderId
10+
required:
11+
- messageReference
12+
- senderId
13+
- resourceId

‎src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-submitted-data.schema.yaml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ properties:
1010
$ref: ../defs/requests.schema.yaml#/properties/senderId
1111
resourceId:
1212
$ref: ../defs/pdm.schema.yaml#/properties/resourceId
13+
retryCount:
14+
$ref: ../defs/pdm.schema.yaml#/properties/retryCount
1315
required:
1416
- messageReference
1517
- senderId
1618
- resourceId
19+
- retryCount

‎src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-unavailable-data.schema.yaml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@ properties:
77
$ref: ../defs/requests.schema.yaml#/properties/messageReference
88
senderId:
99
$ref: ../defs/requests.schema.yaml#/properties/senderId
10+
resourceId:
11+
$ref: ../defs/pdm.schema.yaml#/properties/resourceId
12+
retryCount:
13+
$ref: ../defs/pdm.schema.yaml#/properties/retryCount
1014
required:
1115
- messageReference
1216
- senderId
17+
- resourceId
18+
- retryCount

‎src/cloudevents/domains/digital-letters/2025-10-draft/defs/requests.schema.yaml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,16 @@ properties:
1919
description: Uri to the storage location of the FHIR resource relating to this message request
2020
examples:
2121
- "s3://my-bucket/path/to/my-object"
22+
nhsNumber:
23+
type: string
24+
description: Unique identifier of the intended recipient of the digital letter
25+
pattern: '^\d{10}$'
26+
minLength: 10
27+
maxLength: 10
28+
examples:
29+
- "4857773456"
30+
odsCode:
31+
type: string
32+
description: The ODS Code of the sending organisation. Used to identify the sender in NHS App
33+
examples:
34+
- ""

‎src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.mesh.inbox.message.downloaded.v1.schema.yaml‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,9 @@ properties:
1515

1616
dataschema:
1717
type: string
18-
const: ../data/digital-letter-base-data.schema.yaml
18+
const: ../data/digital-letters-mesh-inbox-message-downloaded-data.schema.yaml
1919
description: Canonical URI of the example event's data schema.
2020
examples:
21-
- digital-letter-base-data.schema.yaml
21+
- digital-letters-mesh-inbox-message-downloaded-data.schema.yaml
2222
data:
2323
$ref: ../data/digital-letters-mesh-inbox-message-downloaded-data.schema.yaml
24-
description: Example payload wrapper containing notify-payload.

‎src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.mesh.inbox.message.received.v1.schema.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ properties:
1515

1616
dataschema:
1717
type: string
18-
const: ../data/digital-letter-base-data.schema.yaml
18+
const: ../data/digital-letters-mesh-inbox-message-received-data.schema.yaml
1919
description: Canonical URI of the example event's data schema.
2020
examples:
21-
- digital-letter-base-data.schema.yaml
21+
- digital-letters-mesh-inbox-message-received-data.schema.yaml
2222
data:
2323
$ref: ../data/digital-letters-mesh-inbox-message-received-data.schema.yaml

‎src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.pdm.resource.available.v1.schema.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ properties:
1515

1616
dataschema:
1717
type: string
18-
const: ../data/digital-letter-base-data.schema.yaml
18+
const: ../data/digital-letters-pdm-resource-available-data.schema.yaml
1919
description: Canonical URI of the example event's data schema.
2020
examples:
21-
- digital-letter-base-data.schema.yaml
21+
- digital-letters-pdm-resource-available-data.schema.yaml
2222
data:
2323
$ref: ../data/digital-letters-pdm-resource-available-data.schema.yaml

0 commit comments

Comments
 (0)