- 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

Author: tdroza-nhs

README.md

@@ -9,7 +9,7 @@ description: PDM Upload
 architecture-beta
     service meshDownloaded(aws:res-amazon-eventbridge-event)[MESHInboxMessageDownloaded Event]
     service pdmSaved(aws:res-amazon-eventbridge-event)[PDMResourceSubmitted Event]
-    service pdmFailed(aws:res-amazon-eventbridge-event)[PDMResourceSubmssionFailed Event]
+    service pdmFailed(aws:res-amazon-eventbridge-event)[PDMResourceSubmssionRejected Event]
     group uploadToPdm(cloud)[UploadToPDM]
     service uploadQueue(logos:aws-sqs)[UploadToPDM Queue] in uploadToPdm
     service uploadLambda(logos:aws-lambda)[UploadToPDM] in uploadToPdm

docs/collections/_diagrams/c4code-pdm-upload.md

@@ -7,7 +7,15 @@ properties:
     $ref: ../defs/requests.schema.yaml#/properties/messageReference
   senderId:
     $ref: ../defs/requests.schema.yaml#/properties/senderId
+  resourceId:
+    $ref: ../defs/pdm.schema.yaml#/properties/resourceId
+  nhsNumber:
+    $ref: ../defs/requests.schema.yaml#/properties/nhsNumber
+  odsCode:
+    $ref: ../defs/requests.schema.yaml#/properties/odsCode
 required:
   - messageReference
   - senderId
   - resourceId
+  - nhsNumber
+  - odsCode

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

@@ -9,6 +9,8 @@ properties:
     $ref: ../defs/requests.schema.yaml#/properties/senderId
   resourceId:
     $ref: ../defs/pdm.schema.yaml#/properties/resourceId
+  retryCount:
+    $ref: ../defs/pdm.schema.yaml#/properties/retryCount
 required:
   - messageReference
   - senderId

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

@@ -0,0 +1,12 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+title: PDMResourceSubmissionRejected Data
+description: Base data of the PDMResourceSubmissionRejected event
+additionalProperties: false
+properties:
+  messageReference:
+    $ref: ../defs/requests.schema.yaml#/properties/messageReference
+  senderId:
+    $ref: ../defs/requests.schema.yaml#/properties/senderId
+required:
+  - messageReference
+  - senderId

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

@@ -10,7 +10,10 @@ properties:
     $ref: ../defs/requests.schema.yaml#/properties/senderId
   resourceId:
     $ref: ../defs/pdm.schema.yaml#/properties/resourceId
+  retryCount:
+    $ref: ../defs/pdm.schema.yaml#/properties/retryCount
 required:
   - messageReference
   - senderId
   - resourceId
+  - retryCount

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

@@ -7,6 +7,12 @@ properties:
     $ref: ../defs/requests.schema.yaml#/properties/messageReference
   senderId:
     $ref: ../defs/requests.schema.yaml#/properties/senderId
+  resourceId:
+    $ref: ../defs/pdm.schema.yaml#/properties/resourceId
+  retryCount:
+    $ref: ../defs/pdm.schema.yaml#/properties/retryCount
 required:
   - messageReference
   - senderId
+  - resourceId
+  - retryCount

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

@@ -19,3 +19,16 @@ properties:
     description: Uri to the storage location of the FHIR resource relating to this message request
     examples:
       - "s3://my-bucket/path/to/my-object"
+  nhsNumber:
+    type: string
+    description: Unique identifier of the intended recipient of the digital letter
+    pattern: '^\d{10}$'
+    minLength: 10
+    maxLength: 10
+    examples:
+      - "4857773456"
+  odsCode:
+    type: string
+    description: The ODS Code of the sending organisation. Used to identify the sender in NHS App
+    examples:
+      - ""

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

@@ -15,10 +15,9 @@ properties:
 
   dataschema:
     type: string
-    const: ../data/digital-letter-base-data.schema.yaml
+    const: ../data/digital-letters-mesh-inbox-message-downloaded-data.schema.yaml
     description: Canonical URI of the example event's data schema.
     examples:
-      - digital-letter-base-data.schema.yaml
+      - digital-letters-mesh-inbox-message-downloaded-data.schema.yaml
   data:
     $ref: ../data/digital-letters-mesh-inbox-message-downloaded-data.schema.yaml
-    description: Example payload wrapper containing notify-payload.

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

@@ -15,9 +15,9 @@ properties:
 
   dataschema:
     type: string
-    const: ../data/digital-letter-base-data.schema.yaml
+    const: ../data/digital-letters-mesh-inbox-message-received-data.schema.yaml
     description: Canonical URI of the example event's data schema.
     examples:
-      - digital-letter-base-data.schema.yaml
+      - digital-letters-mesh-inbox-message-received-data.schema.yaml
   data:
     $ref: ../data/digital-letters-mesh-inbox-message-received-data.schema.yaml