Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 26 additions & 33 deletions README.md

Large diffs are not rendered by default.

10 changes: 7 additions & 3 deletions docs/collections/_diagrams/c4code-core-notifier.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,20 @@ architecture-beta
group coreNotifier(cloud)[CoreNotifier]
service meshDownloaded(aws:res-amazon-eventbridge-event)[PDMResourceAvailable Event]
service sqs(logos:aws-sqs)[CoreNotifier Queue] in coreNotifier
service clientConfig(aws:res-aws-systems-manager-parameter-store)[Client Configuration] in coreNotifier
service coreNotified(aws:res-amazon-eventbridge-event)[MessageRequestSubmitted Event]
service coreFailed(aws:res-amazon-eventbridge-event)[MessageRequestFailed Event]
service coreFailed(aws:res-amazon-eventbridge-event)[MessageRequestRejected Event]
service coreSkipped(aws:res-amazon-eventbridge-event)[MessageRequestSkipped Event]
service notifier(logos:aws-lambda)[CoreNotifier] in coreNotifier
service notify(server)[NHS Notify Core]
junction j1

meshDownloaded:R --> L:sqs
sqs:R --> L:notifier
clientConfig:B --> T:notifier
notifier:B --> T:notify
notifier:R --> L:j1
j1:R -- L:coreNotified
notifier:R -- L:j1
j1:T --> L:coreNotified
j1:R -- L:coreSkipped
j1:B --> L:coreFailed
```
4 changes: 3 additions & 1 deletion docs/collections/_diagrams/c4code-printer-sendtoqueue.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,15 @@ description: PDM Upload
group createTtl(cloud)[QueueAdder]

service db(aws:arch-amazon-dynamodb)[ItemsWithTTL] in createTtl
service clientConfig(aws:res-aws-systems-manager-parameter-store)[Client Configuration] in createTtl
service createLambda(logos:aws-lambda)[CreateTTL] in createTtl
service queue(logos:aws-sqs)[SQS] in createTtl
service storedEvent(aws:res-amazon-eventbridge-event)[MESHInboxMessageDownloaded event]
service scheduledEvent(aws:res-amazon-eventbridge-event) [ItemEnqueued event]

storedEvent:R --> L:queue
queue:R --> L:createLambda
clientConfig:B --> T:createLambda
createLambda:R --> L:db
createLambda:T --> L:scheduledEvent
createLambda:B --> L:scheduledEvent
```
5 changes: 4 additions & 1 deletion docs/collections/_diagrams/sequence-create-print-ttl.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,13 @@ sequenceDiagram
participant eb as Event Bridge
participant sqs as SQS<br/>CreateTTLQueue
participant createTTL as Lambda<br/>CreateTTL
participant ssm as SSM<br/>Parameter Store
participant dynamo as DynamoDB


eb ->> sqs: MESHInboxMessageDownloaded event
sqs ->> createTTL:
createTTL ->> dynamo: Insert (24h TTL)
createTTL ->> ssm: Get FallbackWaitTime
ssm -->> createTTL:
createTTL ->> dynamo: Insert (FallbackWaitTime TTL)
```
10 changes: 0 additions & 10 deletions docs/collections/_events/event-bus-timer-time-expired.md

This file was deleted.

12 changes: 0 additions & 12 deletions docs/collections/_events/fhir-attachment-extracted.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/collections/_events/letter-available.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/collections/_events/mesh-inbox-message-downloaded.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ type: uk.nhs.notify.digital.letters.mesh.inbox.message.downloaded.v1
nice_name: MESHInboxMessageDownloaded
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.downloaded.v1.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-downloaded-data.schema.json
---

This is an event.
2 changes: 1 addition & 1 deletion docs/collections/_events/mesh-inbox-message-received.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ type: uk.nhs.notify.digital.letters.mesh.inbox.message.received.v1
nice_name: MESHInboxMessageReceived
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.received.v1.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-received-data.schema.json
---

This is an event.
10 changes: 0 additions & 10 deletions docs/collections/_events/mesh-poller-timer-expired.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/collections/_events/mesh-status-report-sent.md

This file was deleted.

12 changes: 12 additions & 0 deletions docs/collections/_events/messages-request-rejected.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: messages-request-rejected
type: uk.nhs.notify.digital.letters.messages.request.rejected.v1
nice_name: MessageRequestRejected
service: Messages Client
schema_envelope: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.messages.request.rejected.v1.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/messages.status.rejected-data.v1.schema.json
---

This is an event.

uk.nhs.notify.digital.letters.core.request.rejected.v1.schema
12 changes: 0 additions & 12 deletions docs/collections/_events/messages-request-sent.md

This file was deleted.

12 changes: 12 additions & 0 deletions docs/collections/_events/messages-request-skipped.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: messages-request-skipped
type: uk.nhs.notify.digital.letters.messages.request.skipped.v1
nice_name: MessageRequestSkipped
service: Messages Client
schema_envelope: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.messages.request.skipped.v1.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/messages.request.skipped-data.v1.schema.json
---

This event is published when the request to Notify Core (to send an NHS App message) is intentionally skipped. In normal operation this can happen if the requesting client has not configured a Routing Plan during onboarding to DigitalLetters.

uk.nhs.notify.digital.letters.core.request.skipped.v1.schema
4 changes: 2 additions & 2 deletions docs/collections/_events/messages-request-submitted.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ 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/messages.request.submitted-data.v1.schema.json
---

This is an event.
This event indicates that a request has been submitted to Notify Core for the sending of a digital message to a patient.

uk.nhs.notify.digital.letters.core.request.submitted.v1.schema
uk.nhs.notify.digital.letters.messages.request.submitted.v1.schema
2 changes: 1 addition & 1 deletion docs/collections/_events/pdm-resource-available.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ type: uk.nhs.notify.digital.letters.pdm.resource.available.v1
nice_name: PDMResourceAvailable
service: PDM Services
schema_envelope: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.pdm.resource.available.v1.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-available-data.schema.json
---

This is an event.
4 changes: 2 additions & 2 deletions docs/collections/_events/pdm-resource-retries-exceeded.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ type: uk.nhs.notify.digital.letters.pdm.resource.retries.exceeded.v1
nice_name: PDMResourceRetriesExceeded
service: PDM Services
schema_envelope: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.pdm.resource.retries.exceeded.v1.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-retries-exceeded-data.schema.json
---

This is an event.
This event indicates that after reaching the maximum configured retries, the FHIR resource was not available for download from PDM. No further attempts will be made to retrieve the resource from PDM.
4 changes: 2 additions & 2 deletions docs/collections/_events/pdm-resource-submitted.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ type: uk.nhs.notify.digital.letters.pdm.resource.submitted.v1
nice_name: PDMResourceSubmitted
service: PDM Services
schema_envelope: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.pdm.resource.submitted.v1.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-submitted-data.schema.json
---

This is an event.
This event indicates that a FHIR resource has been submitted to PDM. It will not be available for use until PDM have completed processing of the resource (indicated by a PDMResourceAvailable event).
4 changes: 2 additions & 2 deletions docs/collections/_events/pdm-resource-unavailable.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ type: uk.nhs.notify.digital.letters.pdm.resource.unavailable.v1
nice_name: PDMResourceUnavailable
service: PDM Services
schema_envelope: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.pdm.resource.unavailable.v1.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-unavailable-data.schema.json
---

This is an event.
This event indicates that when DigitalLetters polled PDM to check whether a FHIR resource was available, PDM indicated that the resource was not ready yet. Digital Letters will continue polling PDM until the maximum retries is reached (indicated by a PDMResourceRetriesExceeded event).
4 changes: 2 additions & 2 deletions docs/collections/_events/queue-item-dequeued.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ type: uk.nhs.notify.digital.letters.queue.item.dequeued.v1
nice_name: ItemDequeued
service: Queue Services
schema_envelope: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.dequeued.v1.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-queue-item-dequeued-data.schema.json
---

This is an event.
This event indicates that a TTL record has been dequeued due to exceeding its expiry time. This suggests that a letter was not read digitally within the configured fallback time, and that the letter will now proceed to printing.
4 changes: 2 additions & 2 deletions docs/collections/_events/queue-item-enqueued.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ type: uk.nhs.notify.digital.letters.queue.item.enqueued.v1
nice_name: ItemEnqueued
service: Queue Services
schema_envelope: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.enqueued.v1.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.json
---

This is an event.
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.
4 changes: 2 additions & 2 deletions docs/collections/_events/queue-item-removed.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ type: uk.nhs.notify.digital.letters.queue.item.removed.v1
nice_name: ItemRemoved
service: Queue Services
schema_envelope: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.removed.v1.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-queue-item-removed-data.schema.json
---

This is an event.
This event indicates that a TTL record has been intentionally removed before its expiry time (likely due to the letter being read digitally).
10 changes: 0 additions & 10 deletions docs/collections/_events/queue-timer-expired.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/collections/_events/reporting-daily-report-generated.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/collections/_events/reporting-daily-report-timer-expired.md

This file was deleted.

10 changes: 10 additions & 0 deletions docs/collections/_events/reporting-generate-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: reporting-generate-report
nice_name: GenerateReport
service: Reporting
type: uk.nhs.notify.digital.letters.reporting.generate.report.v1
schema_envelope: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.generate.report.v1.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.json
---

This event indicates that a daily status report should be generated for the DigitalLetters client indicated in the event payload.
10 changes: 10 additions & 0 deletions docs/collections/_events/reporting-report-generated.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: reporting-report-generated
nice_name: ReportGenerated
service: Reporting
type: uk.nhs.notify.digital.letters.reporting.report.generated.v1
schema_envelope: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.generated.v1.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-reporting-report-generated-data.schema.json
---

This event indicates that a daily status report has been generated for the DigitalLetters client indicated in the event payload. The status report is now ready to be sent to the client.
10 changes: 10 additions & 0 deletions docs/collections/_events/reporting-report-sent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: reporting-report-sent
nice_name: ReportSent
service: Reporting
type: uk.nhs.notify.digital.letters.reporting.report.sent.v1
schema_envelope: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.sent.v1.schema.json
schema_data: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-reporting-report-sent-data.schema.json
---

This event indicates that a daily status report has been sent to the DigitalLetters client indicated in the event payload.
Loading
Loading