CCM-13475: Added PrintLetterAnalysed data schema

Author: tdroza-nhs

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

@@ -10,11 +10,14 @@ architecture-beta
     service itemDequeued(aws:res-amazon-eventbridge-event)[ItemDequeued Event]
     service analyseQueue(logos:aws-sqs)[Analyse Queue] in printScanner
     service analyseLambda(logos:aws-lambda)[PrintScanner] in printScanner
+    service moveLambda(logos:aws-lambda)[MoveLetters] in printScanner
     service docRefBucket(logos:aws-s3)[DocumentReference] in printScanner
-    service lettersBucket(logos:aws-s3)[DigitalLetters] in printScanner
+    service unscannedBucket(logos:aws-s3)[UnscannedLetters] in printScanner
+    service processingBucket(logos:aws-s3)[ProcessingLetters] in printScanner
     service quarantineBucket(logos:aws-s3)[QuarantinedLetters] in printScanner
     service safeBucket(logos:aws-s3)[SafeLetters] in printScanner
     service guardDuty(aws:arch-amazon-guardduty)[GuardDuty] in printScanner
+    service scanComplete(aws:res-amazon-eventbridge-event)[ScanComplete Event]
     service safeLetter(aws:res-amazon-eventbridge-event)[PrintLetterSafe Event]
     service quarantinedLetter(aws:res-amazon-eventbridge-event)[PrintLetterQuarantined Event]
     junction j1 in printScanner
@@ -24,15 +27,18 @@ architecture-beta
     itemDequeued:R --> L:analyseQueue
     docRefBucket:T --> B:analyseLambda
     analyseQueue:R --> L:analyseLambda
-    analyseLambda:T --> B:lettersBucket
-    lettersBucket:R --> L:guardDuty
-    guardDuty:R -- L:j1
+    analyseLambda:T --> B:unscannedBucket
+    unscannedBucket:R --> L:guardDuty
+    guardDuty:R --> L:processingBucket
+    guardDuty:T --> B:scanComplete
+    scanComplete:R --> L:moveLambda
+    moveLambda:B <--> T:processingBucket
+    moveLambda:R --> L:j1
     j1:T -- B:j2
     j1:B -- T:j3
     j2:R --> L:quarantineBucket
-    quarantineBucket:R --> L:quarantinedLetter
     j3:R --> L:safeBucket
+    quarantineBucket:R --> L:quarantinedLetter
     safeBucket:R --> L:safeLetter
 
-
 ```

docs/collections/_events/print-letter-analysed.md

@@ -0,0 +1,10 @@
+---
+title: print-letter-analysed
+type: uk.nhs.notify.digital.letters.print.letter.analysed.v1
+nice_name: PrintLetterAnalysed
+service: Print Supplier Services
+schema_envelope:  https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.print.letter.analysed.v1.schema.json
+schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-print-letter-analysed-data.schema.json
+---
+
+This event is published when a PDF letter has been analysed in preparation for sending to print. In addition to the standard metadata fields relating to the message request, the event payload also contains a count of the number of pages in the letter and a SHA256 has of the file. This information can be used by the Print Supplier API to verify the integrity of the letter before it is printed.

src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-print-letter-analysed-data.schema.yaml

@@ -0,0 +1,22 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+title: PrintLetterAnalysed Data
+description: Data payload of the PrintLetterAnalysed event
+type: object
+additionalProperties: false
+properties:
+  messageReference:
+    $ref: ../defs/requests.schema.yaml#/properties/messageReference
+  senderId:
+    $ref: ../defs/requests.schema.yaml#/properties/senderId
+  messageUri:
+    $ref: ../defs/requests.schema.yaml#/properties/messageUri
+  pageCount:
+    $ref: ../defs/print.schema.yaml#/properties/pageCount
+  sha256Hash:
+    $ref: ../defs/print.schema.yaml#/properties/sha256Hash
+required:
+  - messageReference
+  - senderId
+  - messageUri
+  - pageCount
+  - sha256Hash

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

@@ -5,16 +5,14 @@ type: object
 properties:
   status:
     type: string
-    minimum: 1
-    description: Number of times that PDM has been polled while waiting for document processing to complete
-    enum: [
-      "ACCEPTED",
-      "REJECTED",
-      "PRINTED",
-      "DISPATCHED",
-      "FAILED",
-      "RETURNED"
-    ]
+    description: Current status of the letter request
+    enum:
+      - "ACCEPTED"
+      - "REJECTED"
+      - "PRINTED"
+      - "DISPATCHED"
+      - "FAILED"
+      - "RETURNED"
     examples:
       - ACCEPTED
       - DISPATCHED
@@ -24,3 +22,16 @@ properties:
     description: Identifier of the print supplier handling the print job
     examples:
       - "supplier-12345"
+  pageCount:
+    type: integer
+    description: The number of pages in the analysed letter PDF.
+    examples:
+      - 1
+      - 3
+  sha256Hash:
+    type: string
+    description: The SHA256 hash of the analysed letter PDF.
+    pattern: '^[A-Fa-f0-9]{64}$'
+    examples:
+      - 3a7bd3e2360a3d80c4d4e8b1e3e5e6e7e8e9e0e1e2e3e4e5e6e7e8e9e0e1e2e3
+        abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890

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

@@ -0,0 +1,23 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+title: PrintLetterAnalysed
+type: object
+allOf:
+  - $ref: ../digital-letters-print-profile.schema.yaml
+properties:
+  type:
+    type: string
+    const: uk.nhs.notify.digital.letters.print.letter.analysed.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/print
+    description: Event source for digital letters.
+
+  dataschema:
+    type: string
+    const: ../data/digital-letters-print-letter-analysed-data.schema.yaml
+    description: Canonical URI of the event's data schema.
+    examples:
+      - digital-letters-print-letter-analysed-data.schema.yaml
+  data:
+    $ref: ../data/digital-letters-print-letter-analysed-data.schema.yaml

src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.print.letter.analysed.v1.schema.yaml

@@ -1,5 +1,6 @@
 $schema: https://json-schema.org/draft/2020-12/schema
 title: PrintLetterTransitioned
+
 type: object
 allOf:
   - $ref: ../digital-letters-print-profile.schema.yaml