Add the MESH Acknowledge component diagram & event

docs/architecture/c4/notifhir/mesh/acknowledger/index.md

@@ -0,0 +1,14 @@
+---
+
+title: MESH Acknowledger
+parent:  MESH Services
+nav_order: 4
+has_children: true
+last_modified_date: 2024-10-28
+owner: Tom D'Roza
+author: Tom D'Roza
+diagrams: [c4code-mesh-acknowledger]
+events-raised: [mesh-inbox-message-acknowledged]
+events-consumed: [mesh-inbox-message-downloaded]
+c4type: code
+---

docs/architecture/c4/notifhir/printer/sendtoprint/index.md

@@ -0,0 +1,15 @@
+---
+
+title: Send letter to print
+parent:  Print Supplier Services
+nav_order: 9
+has_children: false
+is_not_draft: false
+last_modified_date: 2025-12-04
+owner: Ross Buggins
+author: Tom D'Roza
+diagrams: []
+events-raised: [external-supplier-api-letter-prepared]
+events-consumed: [queue-item-dequeued]
+c4type: code
+---

docs/collections/_diagrams/c4code-mesh-acknowledger.md

@@ -0,0 +1,22 @@
+---
+
+title: c4code-mesh-acknowledger
+
+---
+
+## MESH Acknowledge
+
+```mermaid
+architecture-beta
+    group meshAcknowledger(cloud)[MeshAcknowledge]
+    service meshDownloaded(aws:res-amazon-eventbridge-event)[MESHInboxMessageDownloaded Event]
+    service meshAcknowledged(aws:res-amazon-eventbridge-event)[ MESHInboxMessageAcknowledged Event]
+    service meshAckQueue(logos:aws-sqs)[MeshAcknowledgement Queue] in meshAcknowledger
+    service meshAckLambda(logos:aws-lambda)[MeshAcknowledger] in meshAcknowledger
+    service mesh(server)[MESH]
+
+    meshDownloaded:R --> L:meshAckQueue
+    meshAckQueue:R --> L:meshAckLambda
+    meshAckLambda:B --> T:mesh
+    meshAckLambda:R --> L:meshAcknowledged
+```

docs/collections/_diagrams/c4code-mesh-poller.md

@@ -13,7 +13,7 @@ architecture-beta
     service clientConfig(aws:res-aws-systems-manager-parameter-store)[Client Configuration] in meshPoller
     service mesh(server)[MESH]
 
-    meshDownloaded:R -- L:meshPollLambda
+    meshDownloaded:R --> L:meshPollLambda
     clientConfig:B --> T:meshPollLambda
     meshPollLambda:B --> T:mesh
     meshPollLambda:R --> L:pdmSaved

docs/collections/_diagrams/c4code-mesh-retriever.md

@@ -10,16 +10,16 @@ title: c4code-mesh-retriever
 ```mermaid
 architecture-beta
     group meshRetriever(cloud)[MeshRetriever]
-    service meshDownloaded(aws:res-amazon-eventbridge-event)[MESHInboxMessageReceived Event]
-    service pdmSaved(aws:res-amazon-eventbridge-event)[ MESHInboxMessageDownloaded Event]
+    service meshReceived(aws:res-amazon-eventbridge-event)[MESHInboxMessageReceived Event]
+    service meshDownloaded(aws:res-amazon-eventbridge-event)[ MESHInboxMessageDownloaded Event]
     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)[DocumentReference] in meshRetriever
 
-    meshDownloaded:R -- L:meshDownloadQueue
+    meshReceived:R --> L:meshDownloadQueue
     meshDownloadQueue:R --> L:meshDownloadLambda
     meshDownloadLambda:T --> B:mesh
     meshDownloadLambda:B --> T:s3
-    meshDownloadLambda:R --> L:pdmSaved
+    meshDownloadLambda:R --> L:meshDownloaded
 ```

docs/collections/_diagrams/c4code-mesh-statusreporter-scheduler.md

@@ -24,7 +24,7 @@ architecture-beta
     junction j2
     junction j3
 
-    scheduledEvent:R -- L:reportSchedulerLambda
+    scheduledEvent:R --> L:reportSchedulerLambda
     clientConfig:B --> T:reportSchedulerLambda
     reportSchedulerLambda:R -- L:j1
     j1:T -- B:j2

docs/collections/_diagrams/c4code-mesh-statusreporter-sender.md

@@ -10,23 +10,22 @@ 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 reportSent(aws:res-amazon-eventbridge-event)[StatusReportSent Event]
     service mesh(server)[MESH]
-    junction j1
+    service clientConfig(aws:res-aws-systems-manager-parameter-store)[Client Configuration] in reportSender
+    service s3(logos:aws-s3)[Reports] in reportSender
+    junction j1 in reportSender
     junction j2
-    junction j3
+    service reportSent(aws:res-amazon-eventbridge-event)[ReportSent Event]
+
 
     reportGenerated:R --> L:sqs
     sqs:R --> L:reportSenderLambda
-    clientConfig:B --> T:reportSenderLambda
-    reportSenderLambda:B <-- T:s3
-    reportSenderLambda:R -- L:j1
-    j1:T -- B:j2
-    j2:R --> L:mesh
-    j1:B -- T:j3
-    j3:R --> L:reportSent
+    clientConfig:R -- T:reportSenderLambda
+    s3:L -- T:reportSenderLambda
+    j1:B --> T:reportSenderLambda
+    reportSenderLambda:B --> T:mesh
+    reportSenderLambda:R -- L:j2
+    j2:R --> L:reportSent
 
 ```

docs/collections/_diagrams/c4code-printer-removefromqueue.md

@@ -15,9 +15,9 @@ architecture-beta
    service manageTtlExpiry(logos:aws-lambda)[HandleTTLExpiry] in manageTTL
    service printTTLExpired(aws:res-amazon-eventbridge-event)[ItemDequeued Event]
 
-   pollEvent:R -- L:manageLambda
-   manageLambda:R -- L:manageDb
-   manageDb:R -- L:ttlStream
-   ttlStream:B -- T:manageTtlExpiry
-   manageTtlExpiry:R -- L:printTTLExpired
+   pollEvent:R --> L:manageLambda
+   manageLambda:R --> L:manageDb
+   manageDb:R --> L:ttlStream
+   ttlStream:B --> T:manageTtlExpiry
+   manageTtlExpiry:R --> L:printTTLExpired
 ```

docs/collections/_diagrams/c4code-printer-sendtoprint.md

@@ -7,23 +7,21 @@ title: c4code-printer-sendtoprint
 
 ```mermaid
 architecture-beta
-    service itemReady(aws:res-amazon-eventbridge-event)[MESHInboxMessageDownloaded Event]
-    service printQueue(logos:aws-sqs)[UploadToPDM Queue] in sendToPrint
+    service itemDequeued(aws:res-amazon-eventbridge-event)[ItemDequeued Event]
+    service printQueue(logos:aws-sqs)[Print Queue] in sendToPrint
     service printLambda(logos:aws-lambda)[Print] in sendToPrint
     service docRefBucket(logos:aws-s3)[DocumentReference] in sendToPrint
     service digLtrsBucket(logos:aws-s3)[DigitalLetters] in sendToPrint
-    service pdmSubmitted(aws:res-amazon-eventbridge-event)[PDMResourceSubmitted Event]
-    service pdmFailed(aws:res-amazon-eventbridge-event)[PDMResourceSubmissionFailed Event]
-    group sendToPrint(cloud)[UploadToPDM]
+    service letterPrepared(aws:res-amazon-eventbridge-event)[LetterPrepared Event]
+    group sendToPrint(cloud)[SendToPrint]
     junction j1
 
 
-    itemReady:R -- L:printQueue
+    itemDequeued:R --> L:printQueue
     printQueue:R --> L:printLambda
     printLambda:B <-- T:docRefBucket
     printLambda:T --> B:digLtrsBucket
-    printLambda:R -- L:j1
-    j1:R --> L:pdmSubmitted
-    j1:B --> L:pdmFailed
+    printLambda:R --> L:letterPrepared
+
 
 ```

docs/collections/_diagrams/c4code-printer-sendtoqueue.md

@@ -1,6 +1,5 @@
 ---
 title: c4code-printer-sendtoqueue
-description: PDM Upload
 ---
 
 ```mermaid

docs/collections/_events/mesh-inbox-message-acknowledged.md

@@ -0,0 +1,10 @@
+---
+title: mesh-inbox-message-acknowledged
+type: uk.nhs.notify.digital.letters.mesh.inbox.message.acknowledged.v1
+nice_name: MESHInboxMessageAcknowledged
+service: MESH Services
+schema_envelope:  https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.mesh.inbox.message.acknowledged.v1.schema.json
+schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-acknowledged-data.schema.json
+---
+
+This event is published when an acknowledgement has been successfully sent to the sender via MESH to indicate that a message request has been accepted.

src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-acknowledged-data.schema.yaml

@@ -0,0 +1,16 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+title: MESHInboxMessageAcknowledged Data
+description: Data payload of the MESHInboxMessageAcknowledged event
+type: object
+additionalProperties: false
+properties:
+  messageReference:
+    $ref: ../defs/requests.schema.yaml#/properties/messageReference
+  senderId:
+    $ref: ../defs/requests.schema.yaml#/properties/senderId
+  meshMailboxId:
+    $ref: ../defs/mesh.schema.yaml#/properties/meshMailboxId
+required:
+  - messageReference
+  - senderId
+  - meshMailboxId

src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-received-data.schema.yaml

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

src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.yaml

@@ -6,5 +6,11 @@ additionalProperties: false
 properties:
   senderId:
     $ref: ../defs/requests.schema.yaml#/properties/senderId
+  reportPeriodStartTime:
+    $ref: ../defs/mesh.schema.yaml#/properties/reportPeriodStartTime
+  reportPeriodEndTime:
+    $ref: ../defs/mesh.schema.yaml#/properties/reportPeriodEndTime
 required:
   - senderId
+  - reportPeriodStartTime
+  - reportPeriodEndTime

src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-reporting-report-sent-data.schema.yaml

@@ -6,8 +6,8 @@ additionalProperties: false
 properties:
   senderId:
     $ref: ../defs/requests.schema.yaml#/properties/senderId
-  meshMailboxId:
-    $ref: ../defs/mesh.schema.yaml#/properties/meshMailboxId
+  meshMailboxReportsId:
+    $ref: ../defs/mesh.schema.yaml#/properties/meshMailboxReportsId
 required:
   - senderId
-  - meshMailboxId
+  - meshMailboxReportsId

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

@@ -12,6 +12,24 @@ properties:
   meshMailboxId:
     type: string
     minLength: 1
-    description: Id of the mailbox
+    description: Id of the mailbox used to submit letter requests and receive acknowledgements
     examples:
       - "MAILBOX01"
+  meshMailboxReportsId:
+    type: string
+    minLength: 1
+    description: Id of the mailbox used to receive daily reports
+    examples:
+      - "MAILBOX02"
+  reportPeriodStartTime:
+    type: string
+    format: date-time
+    description: Start time of the reporting period
+    examples:
+      - "2025-12-03T00:00:00Z"
+  reportPeriodEndTime:
+    type: string
+    format: date-time
+    description: End time of the reporting period
+    examples:
+      - "2025-12-04T23:59:59Z"

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

@@ -0,0 +1,23 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+title: MESHInboxMessageAcknowledged
+type: object
+allOf:
+  - $ref: ../digital-letters-mesh-profile.schema.yaml
+properties:
+  type:
+    type: string
+    const: uk.nhs.notify.digital.letters.mesh.inbox.message.acknowledged.v1
+    description: Concrete versioned event type string for this event (.vN suffix).
+  source:
+    type: string
+    pattern: ^/nhs/england/notify/(production|staging|development|uat)/(primary|secondary|dev-[0-9]+)/data-plane/digitalletters/mesh
+    description: Event source for digital letters.
+
+  dataschema:
+    type: string
+    const: ../data/digital-letters-mesh-inbox-message-acknowledged-data.schema.yaml
+    description: Canonical URI of the event's data schema.
+    examples:
+      - digital-letters-mesh-inbox-message-acknowledged-data.schema.yaml
+  data:
+    $ref: ../data/digital-letters-mesh-inbox-message-acknowledged-data.schema.yaml

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

@@ -7,16 +7,16 @@ properties:
   type:
     type: string
     const: uk.nhs.notify.digital.letters.mesh.inbox.message.downloaded.v1
-    description: Concrete versioned event type string for this example event (.vN suffix).
+    description: Concrete versioned event type string for this event (.vN suffix).
   source:
     type: string
     pattern: ^/nhs/england/notify/(production|staging|development|uat)/(primary|secondary|dev-[0-9]+)/data-plane/digitalletters/mesh
-    description: Event source for digital letters  examples.
+    description: Event source for digital letters.
 
   dataschema:
     type: string
     const: ../data/digital-letters-mesh-inbox-message-downloaded-data.schema.yaml
-    description: Canonical URI of the example event's data schema.
+    description: Canonical URI of the event's data schema.
     examples:
       - digital-letters-mesh-inbox-message-downloaded-data.schema.yaml
   data:

src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.mesh.report.sent.v1.schema.yaml

@@ -1,17 +1,17 @@
 $schema: https://json-schema.org/draft/2020-12/schema
-title: StatusReportSent
+title: ReportSent
 type: object
 allOf:
   - $ref: ../digital-letters-mesh-profile.schema.yaml
 properties:
   type:
     type: string
     const: uk.nhs.notify.digital.letters.mesh.report.sent.v1
-    description: Concrete versioned event type string for this example event (.vN suffix).
+    description: Concrete versioned event type string for this event (.vN suffix).
   source:
     type: string
     pattern: ^/nhs/england/notify/(production|staging|development|uat)/(primary|secondary|dev-[0-9]+)/data-plane/digitalletters/mesh
-    description: Event source for digital letters  examples.
+    description: Event source for digital letters.
 
   dataschema:
     type: string

src/cloudevents/readme-index.yaml

@@ -3,7 +3,7 @@
 # To regenerate, run: make update-readme
 # To customize labels and purposes, edit: readme-metadata.yaml
 
-generated: '2025-11-27T17:20:53.023Z'
+generated: '2025-12-04T16:15:24.075Z'
 common: null
 domains:
   - name: digital-letters