CCM-12274: Review comments addressed

tdroza-nhs · tdroza-nhs · commit 6c1d27aed877 · 2025-10-28T16:55:39.000Z
diff --git a/docs/architecture/c4/notifhir/mesh/poller/index.md b/docs/architecture/c4/notifhir/mesh/poller/index.md
@@ -4,12 +4,11 @@ title: MESH Poller
 parent:  MESH Services
 nav_order: 2
 has_children: true
-is_not_draft: false
-last_modified_date: 2024-10-13
+last_modified_date: 2024-10-28
 owner: Tom D'Roza
 author: Tom D'Roza
 diagrams: [c4code-mesh-poller]
 events-raised: [mesh-inbox-message-received]
-events-consumed: [mesh-timer-schedule-expired]
+events-consumed: [mesh-poller-timer-expired]
 c4type: code
 ---
diff --git a/docs/architecture/c4/notifhir/mesh/reportgenerator/index.md b/docs/architecture/c4/notifhir/mesh/reportgenerator/index.md
@@ -0,0 +1,15 @@
+---
+
+title: MESH Report Generator
+parent: Status Reports
+nav_order: 4
+has_children: true
+is_not_draft: false
+last_modified_date: 2025-10-28
+owner: Ross Buggins
+author: Tom D'Roza
+diagrams: [c c4code-mesh-statusreporter-generator]
+events-raised: [reporting-daily-report-generated]
+events-consumed: [reporting-generate-daily-report]
+c4type: code
+---
diff --git a/docs/architecture/c4/notifhir/mesh/reportscheduler/index.md b/docs/architecture/c4/notifhir/mesh/reportscheduler/index.md
@@ -0,0 +1,15 @@
+---
+
+title: MESH Report Scheduler
+parent: Status Reports
+nav_order: 4
+has_children: true
+is_not_draft: false
+last_modified_date: 2025-10-28
+owner: Ross Buggins
+author: Tom D'Roza
+diagrams: [c4code-mesh-statusreporter-scheduler]
+events-raised: [reporting-generate-daily-report]
+events-consumed: []
+c4type: code
+---
diff --git a/docs/architecture/c4/notifhir/mesh/sender/index.md b/docs/architecture/c4/notifhir/mesh/sender/index.md
@@ -0,0 +1,15 @@
+---
+
+title: MESH Report Sender
+parent: MESH Services
+nav_order: 4
+has_children: true
+is_not_draft: false
+last_modified_date: 2025-10-28
+owner: Ross Buggins
+author: Tom D'Roza
+diagrams: [c4code-mesh-statusreporter-sender]
+events-raised: [r]
+events-consumed: [reporting-daily-report-generated]
+c4type: code
+---
diff --git a/docs/architecture/c4/notifhir/mesh/statusreporter/index.md b/docs/architecture/c4/notifhir/mesh/statusreporter/index.md
diff --git a/docs/architecture/c4/notifhir/pdm/poller/index.md b/docs/architecture/c4/notifhir/pdm/poller/index.md
@@ -10,6 +10,6 @@ owner: Ross Buggins
 author: Tom D'Roza
 diagrams: [c4code-pdm-poller]
 events-raised: [pdm-resource-available, pdm-resource-unavailable, pdm-resource-retries-exceeded]
-events-consumed: [pdm-resource-submitted]
+events-consumed: [pdm-resource-submitted, pdm-resource-unavailable]
 c4type: code
 ---
diff --git a/docs/architecture/c4/notifhir/queuettl/removefromqueue/index.md b/docs/architecture/c4/notifhir/queuettl/removefromqueue/index.md
@@ -5,11 +5,11 @@ parent:  Queue Services
 nav_order: 2
 has_children: true
 is_not_draft: false
-last_modified_date: 2024-05-28
+last_modified_date: 2025-10-28
 owner: Ross Buggins
-author: Ross Buggins
+author: Tom D'Roza
 diagrams: [c4code-printer-removefromqueue]
-events-raised: []
-events-consumed: []
+events-raised: [item-ready]
+events-consumed: [print-queue-poller-timer-expired]
 c4type: code
 ---
diff --git a/docs/architecture/c4/notifhir/queuettl/sendtoqueue/index.md b/docs/architecture/c4/notifhir/queuettl/sendtoqueue/index.md
@@ -9,7 +9,7 @@ last_modified_date: 2024-05-28
 owner: Ross Buggins
 author: Ross Buggins
 diagrams: [c4code-printer-sendtoqueue]
-events-raised: []
-events-consumed: []
+events-raised: [item-enqueued]
+events-consumed: [mesh-inbox-message-downloaded]
 c4type: code
 ---
diff --git a/docs/collections/_diagrams/c4code-core-notifier.md b/docs/collections/_diagrams/c4code-core-notifier.md
@@ -7,16 +7,14 @@ title: c4code-core-notifier
 ```mermaid
 architecture-beta
     group coreNotifier(cloud)[CoreNotifier]
-    service meshDownloaded(aws:res-amazon-eventbridge-event)[Scheduled Poll Event]
+    service meshDownloaded(aws:res-amazon-eventbridge-event)[PDMResourceAvailable 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:B --> T:notify
     notifier:R --> L:coreNotified
 ```
diff --git a/docs/collections/_diagrams/c4code-mesh-poller.md b/docs/collections/_diagrams/c4code-mesh-poller.md
@@ -4,12 +4,10 @@ title: c4code-mesh-poller
 
 ---
 
-
-
 ```mermaid
 architecture-beta
     group meshPoller(cloud)[MeshPoller]
-    service meshDownloaded(aws:res-amazon-eventbridge-event)[Scheduled Poll Event]
+    service meshDownloaded(aws:res-amazon-eventbridge-event)[MeshPollerTimerExpired Event]
     service pdmSaved(aws:res-amazon-eventbridge-event)[MESHInboxMessageReceived Event]
     service meshPollLambda(logos:aws-lambda)[MeshPoll] in meshPoller
     service mesh(server)[MESH]
diff --git a/docs/collections/_diagrams/c4code-mesh-statusreporter-scheduler.md b/docs/collections/_diagrams/c4code-mesh-statusreporter-scheduler.md
@@ -7,7 +7,9 @@ title: c4code-mesh-statusreporter-scheduler
 ## Decisions
 
 1. ReportScheulder lambda publishes a `GenerateReport` event for each trust that has new report data in the previous 24 hours.
-2. The event metadata contains the trust ID so the ReportGenerator lambda knows which trust to generate a report for.
+2. A scheduled event triggers ReportScheduler lambda every 24 hours.
+3. ReportScheduler lambda reads Client Configuration from Parameter Store to get list of trusts.
+4. The `GenerateReport` event metadata contains the trust ID so the ReportGenerator lambda knows which trust to generate a report for.
 
 ```mermaid
 architecture-beta
@@ -17,11 +19,13 @@ architecture-beta
     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]
+    service clientConfig(aws:res-aws-systems-manager-parameter-store)[Client Configuration] in reportScheduler
     junction j1
     junction j2
     junction j3
 
     scheduledEvent:R -- L:reportSchedulerLambda
+    clientConfig:B --> T:reportSchedulerLambda
     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
@@ -10,12 +10,14 @@ 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 clientConfig(aws:res-aws-systems-manager-parameter-store)[Client Configuration] 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:sqs
     sqs:R --> L:reportSenderLambda
+    clientConfig:B --> T:reportSenderLambda
     reportSenderLambda:B <-- T:s3
     reportSenderLambda:R --> L:mesh
 
diff --git a/docs/collections/_diagrams/c4code-pdm-upload.md b/docs/collections/_diagrams/c4code-pdm-upload.md
@@ -9,17 +9,21 @@ 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]
     group uploadToPdm(cloud)[UploadToPDM]
     service uploadQueue(logos:aws-sqs)[UploadToPDM Queue] in uploadToPdm
     service uploadLambda(logos:aws-lambda)[UploadToPDM] in uploadToPdm
     service s3(logos:aws-s3)[S3 Bucket] in uploadToPdm
     service pdm(server)[PDM]
+    junction j1
 
 
     meshDownloaded:R -- L:uploadQueue
     uploadQueue:R --> L:uploadLambda
     uploadLambda:B <-- T:s3
-    uploadLambda:T --> L:pdmSaved
-    uploadLambda:R --> L:pdm
+    uploadLambda:R -- L:j1
+    j1:R --> L:pdmSaved
+    j1:B --> L:pdmFailed
+    uploadLambda:T --> B:pdm
 
 ```
diff --git a/docs/collections/_events/item-enqueued.md b/docs/collections/_events/item-enqueued.md
@@ -0,0 +1,10 @@
+---
+title: item-enqueued
+type: uk.nhs.notify.digital.letters.item.enqueued.v1
+nice_name: ItemEnqueued
+service: Event Bus
+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/item-ready.md b/docs/collections/_events/item-ready.md
@@ -0,0 +1,10 @@
+---
+title: item-ready
+type: uk.nhs.notify.digital.letters.item.ready.v1
+nice_name: ItemReady
+service: Event Bus
+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
@@ -2,6 +2,7 @@
 title: mesh-inbox-message-received
 type: uk.nhs.notify.digital.letters.mesh.inbox.message.received.v1
 nice_name: MESHInboxMessageReceived
+service: Mesh Services
 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
@@ -2,6 +2,7 @@
 title: mesh-inbox-message-downloaded
 type: uk.nhs.notify.digital.letters.mesh.inbox.message.downloaded.v1
 nice_name: MESHInboxMessageDownloaded
+service: Mesh Services
 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-poller-timer-expired.md b/docs/collections/_events/mesh-poller-timer-expired.md
@@ -1,7 +1,7 @@
 ---
-title: mesh-timer-schedule-expired
-type: uk.nhs.notify.digital.letters.mesh.schedule.exipred.v1
-nice_name: ScheuleRetrieveMeshFileListTimerExpired
+title: mesh-poller-timer-expired
+type: uk.nhs.notify.digital.letters.mesh.poller.timer.expired.v1
+nice_name: MeshPollerTimerExpired
 service: Mesh Services
 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-file-uploaded.md b/docs/collections/_events/pdm-file-uploaded.md
@@ -2,6 +2,7 @@
 title: pdm-resource-submitted
 type: uk.nhs.notify.digital.letters.pdm.resource.submitted.v1
 nice_name: PDMResourceSubmitted
+service: PDM Services
 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-poller-timer-expired.md b/docs/collections/_events/pdm-poller-timer-expired.md
@@ -0,0 +1,10 @@
+---
+title: print-queue-poller-timer-expired
+type: uk.nhs.notify.digital.letters.print.queue.poller.timer.expired.v1
+nice_name: PrintQueuePollerTimerExpired
+service: Event Bus
+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-available.md b/docs/collections/_events/pdm-resource-available.md
@@ -2,6 +2,7 @@
 title: pdm-resource-available
 type: uk.nhs.notify.digital.letters.pdm.resource.available.v1
 nice_name: PDMResourceAvailable
+service: PDM Services
 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
@@ -2,8 +2,7 @@
 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
+service: PDM Services
 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-unavailable.md b/docs/collections/_events/pdm-resource-unavailable.md
@@ -2,6 +2,7 @@
 title: pdm-resource-unavailable
 type: uk.nhs.notify.digital.letters.pdm.resource.unavailable.v1
 nice_name: PDMResourceUnavailable
+service: PDM Services
 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
 ---
