CCM-13475 PrintLetterAnalysed data schema

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

@@ -9,7 +9,7 @@ last_modified_date: 2025-12-22
 owner: Ross Buggins
 author: Tom D'Roza
 diagrams: [c4code-printer-analyser]
-events-raised: [print-letter-analysed]
-events-consumed: [print-letter-safe]
+events-raised: [pdf-analysed]
+events-consumed: [file-safe]
 c4type: code
 ---

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

@@ -5,11 +5,11 @@ parent:  Print Supplier Services
 nav_order: 1
 has_children: false
 is_not_draft: false
-last_modified_date: 2025-12-22
+last_modified_date: 2026-01-06
 owner: Ross Buggins
 author: Tom D'Roza
-diagrams: [c4code-printer-scanner]
-events-raised: [print-letter-safe]
+diagrams: [c4code-file-scanner]
+events-raised: [file-safe, file-quarantined]
 events-consumed: [queue-item-dequeued]
 c4type: code
 ---

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

@@ -10,6 +10,6 @@ owner: Ross Buggins
 author: Tom D'Roza
 diagrams: [c4code-printer-sender]
 events-raised: [external-supplier-api-letter-prepared]
-events-consumed: [print-letter-analysed]
+events-consumed: [pdf-analysed]
 c4type: code
 ---

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

@@ -0,0 +1,41 @@
+---
+
+title: c4code-file-scanner
+---
+
+
+```mermaid
+architecture-beta
+    group fileScanner(cloud)[FileScanner]
+    service itemDequeued(aws:res-amazon-eventbridge-event)[ItemDequeued Event]
+    service scannerQueue(logos:aws-sqs)[Scanner Queue] in fileScanner
+    service scannerLambda(logos:aws-lambda)[File Scanner] in fileScanner
+    service moveLambda(logos:aws-lambda)[Move Scanned Files] in fileScanner
+    service docRefBucket(logos:aws-s3)[DocumentReference] in fileScanner
+    service unscannedBucket(logos:aws-s3)[UnscannedFiles] in fileScanner
+    service quarantineBucket(logos:aws-s3)[QuarantinedFiles] in fileScanner
+    service safeBucket(logos:aws-s3)[SafeFiles] in fileScanner
+    service guardDuty(aws:arch-amazon-guardduty)[GuardDuty] in fileScanner
+    service scanComplete(aws:res-amazon-eventbridge-event)[ScanResult Event]
+    service safeFile(aws:res-amazon-eventbridge-event)[FileSafe Event]
+    service quarantinedFile(aws:res-amazon-eventbridge-event)[FileQuarantined Event]
+    junction j1 in fileScanner
+    junction j2 in fileScanner
+    junction j3 in fileScanner
+
+    itemDequeued:R --> L:scannerQueue
+    docRefBucket:B --> T:scannerLambda
+    scannerQueue:R --> L:scannerLambda
+    scannerLambda:B --> T:unscannedBucket
+    unscannedBucket:R --> L:guardDuty
+    guardDuty:R --> L:scanComplete
+    scanComplete:R --> L:moveLambda
+    moveLambda:R -- L:j1
+    j1:T -- B:j2
+    j1:B -- T:j3
+    j2:R --> L:quarantineBucket
+    j3:R --> L:safeBucket
+    quarantineBucket:R --> L:quarantinedFile
+    safeBucket:R --> L:safeFile
+
+```

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

@@ -6,17 +6,17 @@ title: c4code-printer-analyser
 
 ```mermaid
 architecture-beta
-    service letterSafe(aws:res-amazon-eventbridge-event)[PrintLetterSafe Event]
+    service fileSafe(aws:res-amazon-eventbridge-event)[FileSafe Event]
     service analyseQueue(logos:aws-sqs)[Analyse Queue] in printAnalyser
     service analyseLambda(logos:aws-lambda)[PrintAnalyser] in printAnalyser
     service safeBucket(logos:aws-s3)[SafeLetters] in printAnalyser
-    service letterAnalysed(aws:res-amazon-eventbridge-event)[PrintLetterAnalysed Event]
+    service pdfAnalysed(aws:res-amazon-eventbridge-event)[PDFAnalysed Event]
     group printAnalyser(cloud)[PrintAnalyser]
 
-    letterSafe:R --> L:analyseQueue
+    fileSafe:R --> L:analyseQueue
     analyseQueue:R --> L:analyseLambda
     safeBucket:B --> T:analyseLambda
-    analyseLambda:R --> L:letterAnalysed
+    analyseLambda:R --> L:pdfAnalysed
 
 
 ```

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

@@ -7,13 +7,13 @@ title: c4code-printer-sender
 
 ```mermaid
 architecture-beta
-    service letterAnalysed(aws:res-amazon-eventbridge-event)[PrintLetterAnalysed Event]
+    service pdfAnalysed(aws:res-amazon-eventbridge-event)[PDFAnalysed Event]
     service printQueue(logos:aws-sqs)[PrintSender Queue] in printSender
     service printLambda(logos:aws-lambda)[PrintSender] in printSender
     service letterPrepared(aws:res-amazon-eventbridge-event)[letterPREPARED Event]
     group printSender(cloud)[PrintSender]
 
-    letterAnalysed:R --> L:printQueue
+    pdfAnalysed:R --> L:printQueue
     printQueue:R --> L:printLambda
     printLambda:R --> L:letterPrepared
 

docs/collections/_diagrams/c4code-printer-sendtoqueue.md → docs/collections/_diagrams/c4code-queue-adder.md

@@ -10,12 +10,12 @@ title: c4code-printer-sendtoqueue
     service clientConfig(aws:res-aws-systems-manager-parameter-store)[Client Configuration] in queueAdder
     service createLambda(logos:aws-lambda)[CreateTTL] in queueAdder
     service queue(logos:aws-sqs)[SQS] in queueAdder
-    service storedEvent(aws:res-amazon-eventbridge-event)[MESHInboxMessageDownloaded event]
-    service scheduledEvent(aws:res-amazon-eventbridge-event) [ItemEnqueued event]
+    service downloadedEvent(aws:res-amazon-eventbridge-event)[MESHInboxMessageDownloaded event]
+    service enqueuedEvent(aws:res-amazon-eventbridge-event) [ItemEnqueued event]
 
-    storedEvent:R --> L:queue
+    downloadedEvent:R --> L:queue
     queue:R --> L:createLambda
     clientConfig:B --> T:createLambda
-    createLambda:R --> L:db
-    createLambda:B --> L:scheduledEvent
+    createLambda:R --> L:enqueuedEvent
+    createLambda:B --> T:db
 ```

docs/collections/_events/file-quarantined.md

@@ -0,0 +1,10 @@
+---
+title: file-quarantined
+type: uk.nhs.notify.digital.letters.print.file.quarantined.v1
+nice_name: FileQuarantined
+service: Print Supplier Services
+schema_envelope:  https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.print.file.quarantined.v1.schema.json
+schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-print-file-quarantined-data.schema.json
+---
+
+This event is published when a file has been virus scanned and found to contain potentially harmful content, resulting in it being quarantined.

docs/collections/_events/file-safe.md

@@ -0,0 +1,10 @@
+---
+title: file-safe
+type: uk.nhs.notify.digital.letters.print.file.safe.v1
+nice_name: FileSafe
+service: Print Supplier Services
+schema_envelope:  https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.print.file.safe.v1.schema.json
+schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-print-file-safe-data.schema.json
+---
+
+This event is published when a file has been virus scanned and found to be free of harmful content, allowing it to be safely sent to print.

docs/collections/_events/pdf-analysed.md

@@ -0,0 +1,10 @@
+---
+title: pdf-analysed
+type: uk.nhs.notify.digital.letters.print.pdf.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.pdf.analysed.v1.schema.json
+schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-print-pdf-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 hash 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-file-quarantined-data.schema.yaml

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

src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-print-file-safe-data.schema.yaml

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