CCM:12774 Event documentation (#85)

tdroza-nhs · web-flow · commit 58e51986d686 · 2025-10-27T16:27:25.000Z
* CCM-12774: Add event documentation for digital letter read, PDM file saved, retries exceeded, unavailable, and daily report
* CCM-12774: Updated icons
diff --git a/docs/architecture/c4/notifhir/digitalletters/callback/index.md b/docs/architecture/c4/notifhir/digitalletters/callback/index.md
@@ -9,7 +9,7 @@ last_modified_date: 2024-05-28
 owner: Ross Buggins
 author: Ross Buggins
 diagrams: [c4code-nhsapp-callback]
-events-raised: []
+events-raised: [digital-letter-read]
 events-consumed: []
 c4type: code
 ---
diff --git a/docs/architecture/c4/notifhir/mesh/poller/index.md b/docs/architecture/c4/notifhir/mesh/poller/index.md
@@ -9,7 +9,7 @@ last_modified_date: 2024-10-13
 owner: Tom D'Roza
 author: Tom D'Roza
 diagrams: [c4code-mesh-poller]
-events-raised: [mesh-file-found]
+events-raised: [mesh-inbox-message-received]
 events-consumed: [mesh-timer-schedule-expired]
 c4type: code
 ---
diff --git a/docs/architecture/c4/notifhir/mesh/retriever/index.md b/docs/architecture/c4/notifhir/mesh/retriever/index.md
@@ -9,7 +9,7 @@ last_modified_date: 2024-05-28
 owner: Ross Buggins
 author: Ross Buggins
 diagrams: [c4code-mesh-retriever]
-events-raised: [mesh-file-saved]
-events-consumed: [mesh-file-found]
+events-raised: [mesh-inbox-message-downloaded]
+events-consumed: [mesh-inbox-message-received]
 c4type: code
 ---
diff --git a/docs/architecture/c4/notifhir/mesh/statusreporter/index.md b/docs/architecture/c4/notifhir/mesh/statusreporter/index.md
@@ -1,15 +1,15 @@
 ---
 
-title: MESH Status Reporter
-parent:  MESH Services
+title: MESH Status Reporting
+parent:   Digital Letter Status Reports
 nav_order: 4
 has_children: true
 is_not_draft: false
-last_modified_date: 2025-10-15
+last_modified_date: 2025-10-24
 owner: Ross Buggins
 author: Tom D'Roza
 diagrams: [c4code-mesh-statusreporter-scheduler, c4code-mesh-statusreporter-generator, c4code-mesh-statusreporter-sender]
-events-raised: [mesh-status-report-sent]
-events-consumed: [reporting-daily-report-generated]
+events-raised: [reporting-generate-daily-report, reporting-daily-report-generated]
+events-consumed: [reporting-generate-daily-report, reporting-daily-report-generated]
 c4type: code
 ---
diff --git a/docs/architecture/c4/notifhir/notifier/notifyclient/index.md b/docs/architecture/c4/notifhir/notifier/notifyclient/index.md
@@ -5,11 +5,11 @@ parent:  Core System Notifier
 nav_order: 1
 has_children: true
 is_not_draft: false
-last_modified_date: 2024-05-28
+last_modified_date: 2026-10-24
 owner: Ross Buggins
-author: Ross Buggins
-diagrams: []
-events-raised: []
-events-consumed: []
+author: Tom D'Roza
+diagrams: [c4code-core-notifier]
+events-raised: [notify-core-request-submitted]
+events-consumed: [pdm-resource-available]
 c4type: code
 ---
diff --git a/docs/architecture/c4/notifhir/pdm/poller/index.md b/docs/architecture/c4/notifhir/pdm/poller/index.md
@@ -5,11 +5,11 @@ parent:  PDM Services
 nav_order: 1
 has_children: true
 is_not_draft: false
-last_modified_date: 2024-05-28
+last_modified_date: 2025-10-24
 owner: Ross Buggins
-author: Ross Buggins
+author: Tom D'Roza
 diagrams: [c4code-pdm-poller]
-events-raised: [pdm-file-saved]
-events-consumed: [pdm-file-uploaded]
+events-raised: [pdm-resource-available, pdm-resource-unavailable, pdm-resource-retries-exceeded]
+events-consumed: [pdm-resource-submitted]
 c4type: code
 ---
diff --git a/docs/architecture/c4/notifhir/pdm/saver/index.md b/docs/architecture/c4/notifhir/pdm/saver/index.md
@@ -1,15 +1,15 @@
 ---
 
-title: PDM Saver
+title: PDM Uploader
 parent:  PDM Services
 nav_order: 1
 has_children: true
 is_not_draft: false
-last_modified_date: 2024-05-28
+last_modified_date: 2025-10-24
 owner: Ross Buggins
-author: Ross Buggins
+author: Tom D'Roza
 diagrams: [c4code-pdm-upload]
-events-raised: [pdm-file-uploaded]
-events-consumed: []
+events-raised: [pdm-resource-submitted]
+events-consumed: [mesh-inbox-message-downloaded]
 c4type: code
 ---
diff --git a/docs/architecture/c4/notifhir/tracker/listener/index.md b/docs/architecture/c4/notifhir/tracker/listener/index.md
@@ -1,20 +1,21 @@
 ---
 
-title: Report Generator
+title: Report Recorder
 parent:  Digital Letter Status Reports
 nav_order: 1
 has_children: true
 is_not_draft: false
-last_modified_date: 2025-10-17
+last_modified_date: 2025-10-24
 owner: Tom D'Roza
 author: Tom D'Roza
 diagrams: [c4code-tracker-listener, c4component-nhsapp-callback, sequence-nhsapp-callback]
 events-raised: [reporting-daily-report-generated]
 events-consumed: [
     mesh-file-found,
     mesh-file-saved,
-    mesh-status-report-sent,
-    pdm-file-saved]
+    pdm-file-saved,
+    callback-digital-letter-read,
+    mesh-status-report-sent]
 description: Listens to all events and generates up the report
 c4type: code
 
diff --git a/docs/collections/_diagrams/c4code-core-notifier.md b/docs/collections/_diagrams/c4code-core-notifier.md
@@ -0,0 +1,22 @@
+---
+
+title: c4code-core-notifier
+
+---
+
+```mermaid
+architecture-beta
+    group coreNotifier(cloud)[CoreNotifier]
+    service meshDownloaded(aws:res-amazon-eventbridge-event)[Scheduled Poll Event]
+    service sqs(logos:aws-sqs)[CoreNotifier Queue] in coreNotifier
+    service coreNotified(aws:res-amazon-eventbridge-event)[NotifyCoreRequestSubmitted Event]
+    service notifier(logos:aws-lambda)[CoreNotifier] in coreNotifier
+    service apig(aws:arch-amazon-api-gateway)[API Gateway] in coreNotifier
+    service notify(server)[NHS Notify Core]
+
+    meshDownloaded:R --> L:sqs
+    sqs:R -->  L:notifier
+    notifier:B --> T:apig
+    apig:B --> T:notify
+    notifier:R --> L:coreNotified
+```
diff --git a/docs/collections/_diagrams/c4code-mesh-retriever.md b/docs/collections/_diagrams/c4code-mesh-retriever.md
@@ -15,7 +15,7 @@ architecture-beta
     service meshDownloadQueue(logos:aws-sqs)[MeshDownload Queue] in meshRetriever
     service meshDownloadLambda(logos:aws-lambda)[MeshDownload] in meshRetriever
     service mesh(server)[MESH]
-    service s3(logos:aws-s3)[S3 Bucket] in meshRetriever
+    service s3(logos:aws-s3)[Digital Letters Bucket] in meshRetriever
 
 
     meshDownloaded:R -- L:meshDownloadQueue
diff --git a/docs/collections/_diagrams/c4code-mesh-statusreporter-generator.md b/docs/collections/_diagrams/c4code-mesh-statusreporter-generator.md
@@ -11,14 +11,16 @@ title: c4code-mesh-statusreporter-generator
 
 ```mermaid
 architecture-beta
-    group reportGenerator(cloud)[ReportScheduler]
+    group reportGenerator(cloud)[ReportGenerator]
     service generateReportEvent(aws:res-amazon-eventbridge-event)[GenerateReport Event]
+    service sqs(logos:aws-sqs)[ReportGenerator Queue] in reportGenerator
     service reportGeneratorLambda(logos:aws-lambda)[Report Generator] in reportGenerator
     service s3(logos:aws-s3)[Reports] in reportGenerator
-    service reportsdb(logos:aws-dynamodb)[Reports] in reportGenerator
+    service reportsdb(aws:arch-amazon-dynamodb)[Reports] in reportGenerator
     service reportGeneratedEvent(aws:res-amazon-eventbridge-event)[ReportGenerated Event]
 
-    generateReportEvent:R -- L:reportGeneratorLambda
+    generateReportEvent:R --> L:sqs
+    sqs:R --> L:reportGeneratorLambda
     reportGeneratorLambda:T <-- B:reportsdb
     reportGeneratorLambda:B --> T:s3
     reportGeneratorLambda:R --> L:reportGeneratedEvent
diff --git a/docs/collections/_diagrams/c4code-mesh-statusreporter-scheduler.md b/docs/collections/_diagrams/c4code-mesh-statusreporter-scheduler.md
@@ -14,7 +14,6 @@ architecture-beta
     group reportScheduler(cloud)[ReportScheduler]
     service scheduledEvent(aws:res-amazon-eventbridge-event)[Scheduled Event]
     service reportSchedulerLambda(logos:aws-lambda)[Report Scheduler] in reportScheduler
-    service reportsdb(logos:aws-dynamodb)[Reports] in reportScheduler
     service report1Event(aws:res-amazon-eventbridge-event)[GenerateReport Trust1]
     service report2Event(aws:res-amazon-eventbridge-event)[GenerateReport Trust2]
     service report3Event(aws:res-amazon-eventbridge-event)[GenerateReport TrustN]
@@ -23,7 +22,6 @@ architecture-beta
     junction j3
 
     scheduledEvent:R -- L:reportSchedulerLambda
-    reportSchedulerLambda:T -- B:reportsdb
     reportSchedulerLambda:R -- L:j1
     j1:T -- B:j2
     j1:B -- T:j3
diff --git a/docs/collections/_diagrams/c4code-mesh-statusreporter-sender.md b/docs/collections/_diagrams/c4code-mesh-statusreporter-sender.md
@@ -9,11 +9,13 @@ title: c4code-mesh-statusreporter-sender
 architecture-beta
     group reportSender(cloud)[ReportSender]
     service reportGenerated(aws:res-amazon-eventbridge-event)[ReportGenerated Event]
+    service sqs(logos:aws-sqs)[ReportSender Queue] in reportSender
     service reportSenderLambda(logos:aws-lambda)[Report Sender] in reportSender
     service s3(logos:aws-s3)[Reports] in reportSender
     service mesh(server)[MESH]
 
-    reportGenerated:R --> L:reportSenderLambda
+    reportGenerated:R --> L:sqs
+    sqs:R --> L:reportSenderLambda
     reportSenderLambda:B <-- T:s3
     reportSenderLambda:R --> L:mesh
 
diff --git a/docs/collections/_diagrams/c4code-mesh-timer.md b/docs/collections/_diagrams/c4code-mesh-timer.md
@@ -4,8 +4,6 @@ title: c4code-mesh-timer
 
 ---
 
-
-
 ```mermaid
 architecture-beta
     service timerexpired(aws:res-amazon-eventbridge-event)[TimerExpired]
diff --git a/docs/collections/_diagrams/c4code-nhsapp-callback.md b/docs/collections/_diagrams/c4code-nhsapp-callback.md
@@ -11,7 +11,7 @@ architecture-beta
     service apiGateway(aws:arch-amazon-api-gateway)[API Gateway]
     service lambda(logos:aws-lambda)[NHS App Callback Handler] in CallbackHandler
     service sqs(logos:aws-sqs)[Callback Queue] in CallbackHandler
-    service ddb(logos:aws-dynamodb)[Items With TTL] in CallbackHandler
+    service ddb(aws:arch-amazon-dynamodb)[Items With TTL] in CallbackHandler
     service docReadEvent(aws:res-amazon-eventbridge-event)[DigitalLetterRead Event]
 
     nhsapp:R --> L:apiGateway
diff --git a/docs/collections/_diagrams/c4code-pdm-poller.md b/docs/collections/_diagrams/c4code-pdm-poller.md
@@ -17,7 +17,7 @@ description: PDM Poller
 ```mermaid
 architecture-beta
     service pdmResourceSubmitted(aws:res-amazon-eventbridge-event)[PDMResourceSubmitted Event]
-    service pdmResourceAvailable(aws:res-amazon-eventbridge-event)[PDMResourceAvailable Event]
+    service pdmResourceAvailable(aws:res-amazon-eventbridge-event)[PDMResourceUnavailable Event]
     service pdmResourceUnavailable2(aws:res-amazon-eventbridge-event)[PDMResourceAvailable Event]
     service pdmRetriesExceeded(aws:res-amazon-eventbridge-event)[PDMResourceRetriesExceeded Event]
     service pdmResourceUnavailable(aws:res-amazon-eventbridge-event)[PDMResourceUnavailable Event]
diff --git a/docs/collections/_diagrams/c4code-printer-removefromqueue.md b/docs/collections/_diagrams/c4code-printer-removefromqueue.md
@@ -10,7 +10,7 @@ architecture-beta
    group manageTTL(cloud)[ManageTTL]
    service pollEvent(aws:res-amazon-eventbridge-event)[Scheduled Poll TTL Event]
    service manageLambda(logos:aws-lambda)[Poll TTL] in manageTTL
-   service manageDb(logos:aws-dynamodb)[ItemsWithTTL] in manageTTL
+   service manageDb(aws:arch-amazon-dynamodb)[ItemsWithTTL] in manageTTL
    service ttlStream(aws:res-amazon-dynamodb-stream) in manageTTL
    service manageTtlExpiry(logos:aws-lambda)[HandleTTLExpiry] in manageTTL
    service printTTLExpired(aws:res-amazon-eventbridge-event)[ItemReady Event] in manageTTL
diff --git a/docs/collections/_diagrams/c4code-printer-sendtoqueue.md b/docs/collections/_diagrams/c4code-printer-sendtoqueue.md
@@ -1,16 +1,14 @@
 ---
-
 title: c4code-printer-sendtoqueue
 description: PDM Upload
 ---
 
-
 ```mermaid
    architecture-beta
     group createTtl(cloud)[Time_To_Live]
 
-    service db(logos:aws-dynamodb)[ItemsWithTTL] in createTtl
-    service createLambda(logos:aws-lambda)[Create PrintLetter TTL] in createTtl
+    service db(aws:arch-amazon-dynamodb)[ItemsWithTTL] in createTtl
+    service createLambda(logos:aws-lambda)[CreateTTL] in createTtl
     service queue(logos:aws-sqs)[SQS] in createTtl
     service storedEvent(aws:res-amazon-eventbridge-event)[MESHInboxMessageDownloaded event]
     service scheduledEvent(aws:res-amazon-eventbridge-event) [ItemEnqueued event]
diff --git a/docs/collections/_diagrams/c4code-tracker-listener.md b/docs/collections/_diagrams/c4code-tracker-listener.md
@@ -10,8 +10,9 @@ architecture-beta
     service report1Event(aws:res-amazon-eventbridge-event)[DigitalLetterRead Event]
     service report2Event(aws:res-amazon-eventbridge-event)[PrintingDispatched Event]
     service report3Event(aws:res-amazon-eventbridge-event)[NHSAppMessageRequested Event]
-    service reportGeneratorLambda(logos:aws-lambda)[Status Recorder] in statusRecorder
-    service ddb(aws:arch-amazon-dynamodb)[LetterRequests] in statusRecorder
+    service sqs(logos:aws-sqs)[StatusRecorder Queue] in statusRecorder
+    service reportGeneratorLambda(logos:aws-lambda)[StatusRecorder] in statusRecorder
+    service ddb(aws:arch-amazon-dynamodb)[Reports] in statusRecorder
     junction j1
     junction j2
 
@@ -20,7 +21,8 @@ architecture-beta
     report2Event:R -- L:j1
     report3Event:R -- B:j1
 
-    j1:R --> L:reportGeneratorLambda
+    j1:R --> L:sqs
+    sqs:R --> L:reportGeneratorLambda
     reportGeneratorLambda:B --> T:ddb
 
 ```
diff --git a/docs/collections/_events/callback-digital-letter-read.md b/docs/collections/_events/callback-digital-letter-read.md
@@ -0,0 +1,9 @@
+---
+title: callback-digital-letter-read
+type: uk.nhs.notify.digital.letters.callback.digital.letter.read.v1
+nice_name: DigitalLetterRead
+schema_envelope: https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event.schema.json
+schema_data: https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event-data.schema.json
+---
+
+This is an event.
diff --git a/docs/collections/_events/mesh-file-found.md b/docs/collections/_events/mesh-file-found.md
@@ -1,8 +1,7 @@
 ---
-title: mesh-file-found
-type: uk.nhs.notify.digital.letters.mesh.file.found.v1
-nice_name: MeshFileFound
-service: Mesh Services
+title: mesh-inbox-message-received
+type: uk.nhs.notify.digital.letters.mesh.inbox.message.received.v1
+nice_name: MESHInboxMessageReceived
 schema_envelope: https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event.schema.json
 schema_data: https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event-data.schema.json
 ---
diff --git a/docs/collections/_events/mesh-file-saved.md b/docs/collections/_events/mesh-file-saved.md
@@ -1,8 +1,7 @@
 ---
-title: mesh-file-saved
-type: uk.nhs.notify.digital.letters.mesh.file.saved.v1
-nice_name: MeshFileSaved
-service: Mesh Services
+title: mesh-inbox-message-downloaded
+type: uk.nhs.notify.digital.letters.mesh.inbox.message.downloaded.v1
+nice_name: MESHInboxMessageDownloaded
 schema_envelope: https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event.schema.json
 schema_data: https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event-data.schema.json
 ---
diff --git a/docs/collections/_events/notify-core-request-submitted.md b/docs/collections/_events/notify-core-request-submitted.md
@@ -0,0 +1,9 @@
+---
+title: notify-core-request-submitted
+type: uk.nhs.notify.digital.letters.reporting.generate.daily.report.v1
+nice_name: NotifyCoreRequestSubmitted
+schema_envelope: https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event.schema.json
+schema_data: https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event-data.schema.json
+---
+
+This is an event.
diff --git a/docs/collections/_events/pdm-file-uploaded.md b/docs/collections/_events/pdm-file-uploaded.md
@@ -1,8 +1,7 @@
 ---
-title: pdm-file-uploaded
-type: uk.nhs.notify.digital.letters.pdm.file.uploaded.v1
-nice_name: FileUploaded
-service: PDM Services
+title: pdm-resource-submitted
+type: uk.nhs.notify.digital.letters.pdm.resource.submitted.v1
+nice_name: PDMResourceSubmitted
 schema_envelope: https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event.schema.json
 schema_data: https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event-data.schema.json
 ---
diff --git a/docs/collections/_events/pdm-resource-available.md b/docs/collections/_events/pdm-resource-available.md
@@ -1,8 +1,7 @@
 ---
-title: pdm-file-saved
-type: uk.nhs.notify.digital.letters.pdm.file.saved.v1
-nice_name: FileSaved
-service: PDM Services
+title: pdm-resource-available
+type: uk.nhs.notify.digital.letters.pdm.resource.available.v1
+nice_name: PDMResourceAvailable
 schema_envelope: https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event.schema.json
 schema_data: https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event-data.schema.json
 ---
diff --git a/docs/collections/_events/pdm-resource-retries-exceeded.md b/docs/collections/_events/pdm-resource-retries-exceeded.md
@@ -0,0 +1,11 @@
+---
+title: pdm-resource-retries-exceeded
+type: uk.nhs.notify.digital.letters.pdm.resource.retries.exceeded.v1
+nice_name: PDMResourceRetriesExceeded
+type: uk.nhs.notify.digital.letters.pdm.resource.available.v1
+nice_name: PDMResourceAvailable
+schema_envelope: https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event.schema.json
+schema_data: https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event-data.schema.json
+---
+
+This is an event.
diff --git a/docs/collections/_events/pdm-resource-unavailable.md b/docs/collections/_events/pdm-resource-unavailable.md
@@ -0,0 +1,9 @@
+---
+title: pdm-resource-unavailable
+type: uk.nhs.notify.digital.letters.pdm.resource.unavailable.v1
+nice_name: PDMResourceUnavailable
+schema_envelope: https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event.schema.json
+schema_data: https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event-data.schema.json
+---
+
+This is an event.
diff --git a/docs/collections/_events/reporting-generate-daily-report.md b/docs/collections/_events/reporting-generate-daily-report.md
@@ -0,0 +1,9 @@
+---
+title: reporting-generate-daily-report
+type: uk.nhs.notify.digital.letters.reporting.generate.daily.report.v1
+nice_name: ReportingGenerateDailyReport
+schema_envelope: https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event.schema.json
+schema_data: https://nhsdigital.github.io/nhs-notify-standards/cloudevents/nhs-notify-example-event-data.schema.json
+---
+
+This is an event.
diff --git a/docs/diagrams/expire-print-ttl-sequence.md b/docs/diagrams/expire-print-ttl-sequence.md
diff --git a/docs/diagrams/mesh-download-sequence.md b/docs/diagrams/mesh-download-sequence.md
diff --git a/docs/diagrams/mesh-poll-sequence.md b/docs/diagrams/mesh-poll-sequence.md
diff --git a/docs/diagrams/pdm-poll.md b/docs/diagrams/pdm-poll.md
