CCM-13304: Handle digital letter read event and deletion of item removed

event

Author: nhsd-angel-pastor

README.md

@@ -110,7 +110,7 @@ _No common schemas defined yet._
 | ----------- | ------------- | ---------------- | ------------- |
 | **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) |
 | **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) |
-| **Digital Letters Digital Letter Read Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.md) |
+| **Digital Letters Digital Letter Read Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-queue-digital-letter-read-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-queue-digital-letter-read-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-queue-digital-letter-read-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-queue-digital-letter-read-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-queue-digital-letter-read-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-queue-digital-letter-read-data.schema.md) |
 | **Digital Letters Mesh Inbox Message Acknowledged Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-acknowledged-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-acknowledged-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-acknowledged-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-acknowledged-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-acknowledged-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-acknowledged-data.schema.md) |
 | **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) |
 | **Digital Letters Mesh Inbox Message Invalid Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-invalid-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-invalid-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-invalid-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-invalid-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-invalid-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-invalid-data.schema.md) |
@@ -129,7 +129,6 @@ _No common schemas defined yet._
 | **Digital Letters Print Pdf Analysed Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-print-pdf-analysed-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-print-pdf-analysed-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-print-pdf-analysed-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-print-pdf-analysed-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-print-pdf-analysed-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-print-pdf-analysed-data.schema.md) |
 | **Digital Letters Queue Item Dequeued Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-queue-item-dequeued-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-queue-item-dequeued-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-queue-item-dequeued-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-queue-item-dequeued-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-queue-item-dequeued-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-queue-item-dequeued-data.schema.md) |
 | **Digital Letters Queue Item Enqueued Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.md) |
-| **Digital Letters Queue Item Removed Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-queue-item-removed-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-queue-item-removed-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-queue-item-removed-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-queue-item-removed-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-queue-item-removed-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-queue-item-removed-data.schema.md) |
 | **Digital Letters Reporting Generate Report Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.md) |
 | **Digital Letters Reporting Report Generated Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-reporting-report-generated-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-reporting-report-generated-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-reporting-report-generated-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-reporting-report-generated-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-reporting-report-generated-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-reporting-report-generated-data.schema.md) |
 | **Digital Letters Reporting Report Sent Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-reporting-report-sent-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-reporting-report-sent-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-reporting-report-sent-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-reporting-report-sent-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-reporting-report-sent-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-reporting-report-sent-data.schema.md) |
@@ -203,7 +202,6 @@ _No common schemas defined yet._
 | **Uk.nhs.notify.digital.letters.print.printed.v1** | [`../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.print.printed.v1-event.json`](../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.print.printed.v1-event.json) | [`../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.print.printed.v1-event.md`](../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.print.printed.v1-event.md) |
 | **Uk.nhs.notify.digital.letters.queue.item.dequeued.v1** | [`../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.item.dequeued.v1-event.json`](../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.item.dequeued.v1-event.json) | [`../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.item.dequeued.v1-event.md`](../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.item.dequeued.v1-event.md) |
 | **Uk.nhs.notify.digital.letters.queue.item.enqueued.v1** | [`../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.item.enqueued.v1-event.json`](../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.item.enqueued.v1-event.json) | [`../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.item.enqueued.v1-event.md`](../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.item.enqueued.v1-event.md) |
-| **Uk.nhs.notify.digital.letters.queue.item.removed.v1** | [`../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.item.removed.v1-event.json`](../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.item.removed.v1-event.json) | [`../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.item.removed.v1-event.md`](../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.item.removed.v1-event.md) |
 | **Uk.nhs.notify.digital.letters.reporting.generate.report.v1** | [`../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.generate.report.v1-event.json`](../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.generate.report.v1-event.json) | [`../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.generate.report.v1-event.md`](../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.generate.report.v1-event.md) |
 | **Uk.nhs.notify.digital.letters.reporting.report.generated.v1** | [`../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.generated.v1-event.json`](../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.generated.v1-event.json) | [`../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.generated.v1-event.md`](../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.generated.v1-event.md) |
 | **Uk.nhs.notify.digital.letters.reporting.report.sent.v1** | [`../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.sent.v1-event.json`](../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.sent.v1-event.json) | [`../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.sent.v1-event.md`](../../output/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.sent.v1-event.md) |

docs/collections/_events/queue-item-enqueued.md

@@ -7,4 +7,4 @@ schema_envelope:  https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025
 schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.json
 ---
 
-This event indicates that a TTL record has been queued for a given letter. The TTL record will either be intentionally removed before its expiry if the letter is read digitally (indicated by an ItemRemoved event) or will be dequeued after the fallback wait time (indicated by a ItemDequeued event) to trigger printing.
+This event indicates that a TTL record has been queued for a given letter. The TTL record will either be intentionally removed before its expiry if the letter is read digitally (indicated by a DigitalLetterRead event) or will be dequeued after the fallback wait time (indicated by a ItemDequeued event) to trigger printing.

docs/collections/_events/queue-item-removed.md

@@ -7,12 +7,12 @@ WITH vars AS (
         e.time,
         CASE
             WHEN e.type LIKE '%.item.dequeued.%'
-            OR e.type LIKE '%.item.removed.%' THEN 'Digital'
+            OR e.type LIKE '%.queue.digital.letter.read.%' THEN 'Digital'
             WHEN e.type LIKE '%.print.letter.transitioned.%' THEN 'Print' ELSE NULL
         END as communicationtype,
         CASE
             WHEN e.type LIKE '%.item.dequeued.%' THEN 'Unread'
-            WHEN e.type LIKE '%.item.removed.%' THEN 'Read'
+            WHEN e.type LIKE '%.queue.digital.letter.read.%' THEN 'Read'
             WHEN e.letterstatus = 'RETURNED' THEN 'Returned'
             WHEN e.letterstatus = 'FAILED' THEN 'Failed'
             WHEN e.letterstatus = 'DISPATCHED' THEN 'Dispatched'

lambdas/report-generator/src/queries/report.sql

@@ -1,12 +1,12 @@
 $schema: https://json-schema.org/draft/2020-12/schema
-title: ItemRemoved
+title: DigitalLetterRead
 type: object
 allOf:
   - $ref: ../digital-letters-queue-profile.schema.yaml
 properties:
   type:
     type: string
-    const: uk.nhs.notify.digital.letters.queue.item.removed.v1
+    const: uk.nhs.notify.digital.letters.queue.digital.letter.read.v1
     description: Concrete versioned event type string for this event (.vN suffix).
   source:
     type: string
@@ -15,9 +15,9 @@ properties:
 
   dataschema:
     type: string
-    const: ../data/digital-letters-queue-item-removed-data.schema.yaml
+    const: ../data/digital-letters-queue-digital-letter-read-data.schema.yaml
     description: Canonical URI of the event's data schema.
     examples:
-      - digital-letters-queue-item-removed-data.schema.yaml
+      - digital-letters-queue-digital-letter-read-data.schema.yaml
   data:
-    $ref: ../data/digital-letters-queue-item-removed-data.schema.yaml
+    $ref: ../data/digital-letters-queue-digital-letter-read-data.schema.yaml

…ers-digital-letter-read-data.schema.yaml …eue-digital-letter-read-data.schema.yamlsrc/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.yaml renamed to src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-queue-digital-letter-read-data.schema.yaml src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.yaml renamed to src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-queue-digital-letter-read-data.schema.yaml

@@ -24,9 +24,9 @@ domains:
             docs: ../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.md
           - type: Digital Letters Digital Letter Read Data
             category: data
-            source: src/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.yaml
-            published: schemas/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.json
-            docs: ../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.md
+            source: src/digital-letters/2025-10-draft/data/digital-letters-queue-digital-letter-read-data.schema.yaml
+            published: schemas/digital-letters/2025-10-draft/data/digital-letters-queue-digital-letter-read-data.schema.json
+            docs: ../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-queue-digital-letter-read-data.schema.md
           - type: Digital Letters Mesh Inbox Message Acknowledged Data
             category: data
             source: src/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-acknowledged-data.schema.yaml
@@ -117,11 +117,6 @@ domains:
             source: src/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.yaml
             published: schemas/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.json
             docs: ../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.md
-          - type: Digital Letters Queue Item Removed Data
-            category: data
-            source: src/digital-letters/2025-10-draft/data/digital-letters-queue-item-removed-data.schema.yaml
-            published: schemas/digital-letters/2025-10-draft/data/digital-letters-queue-item-removed-data.schema.json
-            docs: ../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-queue-item-removed-data.schema.md
           - type: Digital Letters Reporting Generate Report Data
             category: data
             source: src/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.yaml