CCM-12605 pdm diagrams (#43)

* CCM-12605: Added PDM Component diagrams
* CCM-12605: Added PDM sequence diagrams
* CCM-12605: Changed CommunicationRequest to DocumentReference

Author: tdroza-nhs

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

@@ -5,7 +5,45 @@ parent:  NotiFHIR - C4 Container
 nav_order: 6
 has_children: true
 is_not_draft: false
-last_modified_date: 2024-05-28
-owner: Ross Buggins
-author: Ross Buggins
+last_modified_date: 2024-10-13
+owner: Tom D'Roza
+author: Tom D'Roza
 ---
+
+## MESH Poller
+
+```mermaid
+architecture-beta
+    group meshPoller(cloud)[MeshPoller]
+    service meshDownloaded(logos:aws-eventbridge)[Scheduled Poll Event]
+    service pdmSaved(logos:aws-eventbridge)[MESHFileAvailable Event]
+    service meshPollQueue(logos:aws-sqs)[MeshPoll Queue] in meshPoller
+    service meshPollLambda(logos:aws-lambda)[MeshPoll] in meshPoller
+    service mesh(server)[MESH]
+
+
+    meshDownloaded:R -- L:meshPollQueue
+    meshPollQueue:R --> L:meshPollLambda
+    meshPollLambda:T --> B:mesh
+    meshPollLambda:R --> L:pdmSaved
+```
+
+## MESH Retriever
+
+```mermaid
+architecture-beta
+    group meshRetriever(cloud)[MeshRetriever]
+    service meshDownloaded(logos:aws-eventbridge)[MESHFileAvailable Event]
+    service pdmSaved(logos:aws-eventbridge)[SavedToPDM 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)[S3 Bucket] in meshRetriever
+
+
+    meshDownloaded:R -- L:meshDownloadQueue
+    meshDownloadQueue:R --> L:meshDownloadLambda
+    meshDownloadLambda:T --> B:mesh
+    meshDownloadLambda:B --> T:s3
+    meshDownloadLambda:R --> L:pdmSaved
+```

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

@@ -5,7 +5,7 @@ parent:  MESH - C4 Component
 nav_order: 1
 has_children: true
 is_not_draft: false
-last_modified_date: 2024-05-28
-owner: Ross Buggins
-author: Ross Buggins
+last_modified_date: 2024-10-13
+owner: Tom D'Roza
+author: Tom D'Roza
 ---

docs/architecture/c4/notifhir/pdm/index.md

@@ -5,7 +5,41 @@ parent:  NotiFHIR - C4 Container
 nav_order: 6
 has_children: true
 is_not_draft: false
-last_modified_date: 2024-05-28
-owner: Ross Buggins
-author: Ross Buggins
+last_modified_date: 2024-10-13
+owner: Tom D'Roza
+author: Tom D'Roza
 ---
+
+```mermaid
+architecture-beta
+    service meshDownloaded(logos:aws-eventbridge)[MESHFileDownloaded Event]
+    service pdmSaved(logos:aws-eventbridge)[SavedToPDM 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]
+
+
+    meshDownloaded:R -- L:uploadQueue
+    uploadQueue:R --> L:uploadLambda
+    uploadLambda:B --> T:s3
+    uploadLambda:T --> L:pdmSaved
+    uploadLambda:R --> L:pdm
+
+```
+
+```mermaid
+architecture-beta
+    service eventBus(logos:aws-eventbridge)[SavedToPDM Event]
+    service pdmReady(logos:aws-eventbridge)[PDMDocumentReadyEvent]
+    group checkPdm(cloud)[PDMPoller]
+    service pollPdmQueue(logos:aws-sqs)[PollPDM Queue] in checkPdm
+    service pollPdmLambda(logos:aws-lambda)[PollPDM] in checkPdm
+    service pdm(server)[PDM]
+
+    eventBus:R -- L:pollPdmQueue
+    pollPdmQueue:R --> L:pollPdmLambda
+    pollPdmLambda:B --> L:pdmReady
+    pollPdmLambda:R --> L:pdm
+```

docs/architecture/c4/ttl/manage-ttl.md

@@ -20,7 +20,7 @@ architecture-beta
    service printTTLExpired(logos:aws-eventbridge)[PrintTTLExpired] in manageTTL
 
    manageLambda:R -- L:manageDb
-   manageDb:B -- T:ttlStream
-   ttlStream:R -- L:manageTtlExpiry
+   manageDb:R -- L:ttlStream
+   ttlStream:B -- T:manageTtlExpiry
    manageTtlExpiry:R -- L:printTTLExpired
 ```

docs/diagrams/digital-letters-sequence.md

@@ -20,7 +20,7 @@ author: Tom D'Roza
 ## Decisions
 
 1. Out of scope for MVP: Virus checking of PDF received from Trust
-2. Don't check `CommunicationRequest` filesize. Attempt to upload all `CommunicationRequest`s to PDM. Those exceeding APIM size limit will fail.
+2. Don't check `DocumentReference` filesize. Attempt to upload all `DocumentReference`s to PDM. Those exceeding APIM size limit will fail.
 3. No PDS check by Digital Letters component of Date-of-Death, S-flag, RFR codes. Rely on Trusts having performed these checks.
 
 ```mermaid
@@ -36,22 +36,22 @@ sequenceDiagram
   participant nhsapp as NHSApp
 
 
-  trust ->> notify-letters: MESH (CommunicationRequest)
+  trust ->> notify-letters: MESH (DocumentReference)
   activate notify-letters
       notify-letters ->> trust: MESH Ack
   deactivate notify-letters
-  notify-letters ->> notify-letters: Store CommunicationRequest (S3)
+  notify-letters ->> notify-letters: Store DocumentReference (S3)
   notify-letters ->> notify-letters: Create SendLetter TTL
-  notify-letters ->> pdm: POST /CommunicationRequest
+  notify-letters ->> pdm: POST /DocumentReference
   activate pdm
   pdm -) ndr: SFTP
   pdm -->> notify-letters: 200 OK
   deactivate pdm
   Loop Interval & Duration TBC
-    notify-letters ->> pdm: GET /CommunicationRequest/<id>
-    pdm ->> notify-letters: 200 OK (CommunicationRequest)
+    notify-letters ->> pdm: GET /DocumentReference/<id>
+    pdm ->> notify-letters: 200 OK (DocumentReference)
   end
-  rect rgba(5, 26, 46, 1)
+  rect rgba(92, 145, 196, 0.3)
     note over notify-letters,nhsapp: Existing Notify behaviour
     notify-letters ->> notify-core: post /v1/messages (NHSApp)
     activate notify-core

docs/diagrams/mesh-sequence.md

@@ -22,7 +22,7 @@ sequenceDiagram
   participant meshRetrieve  as Lambda<br/>MESHRetrieve
   participant s3 as S3<br/>DigitalLettersBucket
 
-  trust ->> meshMailbox: MESH (CommunicationRequest)
+  trust ->> meshMailbox: MESH (DocumentReference)
   activate meshMailbox
     meshMailbox ->> trust: MESH Ack
   deactivate meshMailbox

docs/diagrams/pdm-poll.md

@@ -0,0 +1,33 @@
+---
+layout: page
+title: PDM Poll
+nav_order: 5
+parent: Diagrams
+has_children: false
+child_nav_order: reversed
+is_not_draft: false
+last_modified_date: 2025-10-13
+owner: Tom D'Roza
+author: Tom D'Roza
+---
+
+```mermaid
+
+sequenceDiagram
+  participant eventBus as EventBridge
+  participant pdmPollerQueue as Queue<br/>PDMPollerQueue
+  participant pdmPoller as Lambda<br/>PDMPoller
+  participant pdm as PDM
+
+  eventBus -) pdmPollerQueue: SavedToPDM Event(meshFileId)
+  activate pdmPollerQueue
+  pdmPollerQueue ->> pdmPoller:
+  deactivate pdmPollerQueue
+  loop Until resource contains payload
+    pdmPoller ->> pdm: GetSpecificResource(ID)
+    activate pdm
+    pdm -->> pdmPoller: DocumentReference
+    deactivate pdm
+  end
+  pdmPoller -) eventBus: PDMDocumentReadyEvent(meshFileId)
+```

docs/diagrams/pdm-upload.md

@@ -0,0 +1,36 @@
+---
+layout: page
+title: PDM Upload
+nav_order: 4
+parent: Diagrams
+has_children: false
+child_nav_order: reversed
+is_not_draft: false
+last_modified_date: 2025-10-13
+owner: Tom D'Roza
+author: Tom D'Roza
+---
+
+```mermaid
+
+sequenceDiagram
+  participant eventBus as EventBridge
+  participant pdmUploadQueue as Queue<br/>PDMUploadQueue
+  participant pdmUpload as Lambda<br/>PDMUpload
+  participant s3 as S3
+  participant pdm as PDM
+
+  eventBus -) pdmUploadQueue: MESHFileAvailable Event
+  activate pdmUploadQueue
+  pdmUploadQueue ->> pdmUpload:
+  deactivate pdmUploadQueue
+  activate pdmUpload
+  pdmUpload ->> s3: Get file from S3
+  s3 -->> pdmUpload: DocumentReference
+  pdmUpload ->> pdm: CreateResource(DocumentReference)
+  activate pdm
+  pdm -->> pdmUpload: 200 OK
+  deactivate pdm
+  pdmUpload -) eventBus: SavedToPDM Event(meshFileId)
+  deactivate pdmUpload
+```