Skip to content

VED-000 README documentation updates and removed obsolete dev tools#1181

Merged
dlzhry2nhs merged 2 commits intomasterfrom
feature/VED-000-improve-documentation
Feb 3, 2026
Merged

VED-000 README documentation updates and removed obsolete dev tools#1181
dlzhry2nhs merged 2 commits intomasterfrom
feature/VED-000-improve-documentation

Conversation

@dlzhry2nhs
Copy link
Copy Markdown
Contributor

Summary

  • Routine Change

Reviews Required

  • Dev

Review Checklist

ℹ️ This section is to be filled in by the reviewer.

  • I have reviewed the changes in this PR and they fill all of the acceptance criteria of the ticket.
  • If there were infrastructure, operational, or build changes, I have made sure there is sufficient evidence that the changes will work.
  • If there were changes that are outside of the regular release processes e.g. account infrastructure to setup, manual setup for external API integrations, secrets to set, then I have checked that the developer has flagged this to the Tech Lead as release steps.
  • I have checked that no Personal Identifiable Data (PID) is logged as part of the changes.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Feb 3, 2026

This branch is working on a ticket in the NHS England VED JIRA Project. Here's a handy link to the ticket:

VED-000

Comment thread README.md Outdated
| `delta_backend` | **Imms Sync** – Lambda function that reacts to events in the Immunisation Event Data Store (IEDS). |
| `filenameprocessor` | **Imms Batch** – Validates and processes new batch file events. |
| `id_sync` | **Imms Cross-cutting** – Handles [MNS](https://digital.nhs.uk/developer/api-catalogue/multicast-notification-service) NHS Number Change events and applies updates to affected records. |
| `mesh_processor` | **Imms Batch** – Triggered when new files our received via MESH. Moves them into the Imms Batch processing system. |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be 'are' not 'our'?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should all be done now. Please re-check.

Comment thread lambdas/delta_backend/README.md Outdated
| **`converter.py`** | 🧠 The main brain — applies the schema, runs conversions, handles errors. |
| **`converter.py`** | The main brain — applies the schema, runs conversions, handles errors. |
| **`conversion_layout.py`** | A plain Python list that defines which fields you want, and how they should be formatted (e.g. date format, renaming rules). |
| **`delta.py`** | Holds the function called by AWS Lambda |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hate to be the punctuation police but this is missing a full stop 🙈

Comment thread README.md
Comment thread README.md Outdated
the Apigee proxy and sandbox. The new way to manage and deploy said resources is [Proxygen](https://digital.nhs.uk/developer/api-catalogue/proxy-generator).

In future a migration plan will be provided by the API Management team so we can move to the new process and use purely
GitHub Actions for our entire pipeline
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚓

edhall-nhs
edhall-nhs previously approved these changes Feb 3, 2026
Copy link
Copy Markdown
Contributor

@edhall-nhs edhall-nhs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great. A much clearer read. Only spotted a few superficial things

Comment thread lambdas/recordforwarder/README.md Outdated
Event Data Store. It will receive up to 100 records per batch. Each record will have been processed and formatted as a
FHIR Immunization by the ECS Record Processor in the prior batch step.

The Record Forwarded Lambda will then execute the requested operation (Create, Update or Delete) on the given record.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: 'Record Forwarder'

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should all be resolved now. Please re-check.

Comment thread README.md Outdated
| `delta_backend` | **Imms Sync** – Lambda function that reacts to events in the Immunisation Event Data Store (IEDS). |
| `filenameprocessor` | **Imms Batch** – Validates and processes new batch file events. |
| `id_sync` | **Imms Cross-cutting** – Handles [MNS](https://digital.nhs.uk/developer/api-catalogue/multicast-notification-service) NHS Number Change events and applies updates to affected records. |
| `mesh_processor` | **Imms Batch** – Triggered when new files our received via MESH. Moves them into the Imms Batch processing system. |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: 'our' -> 'are'

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Feb 3, 2026

@dlzhry2nhs dlzhry2nhs temporarily deployed to internal-dev-sandbox February 3, 2026 14:31 — with GitHub Actions Inactive
@dlzhry2nhs dlzhry2nhs temporarily deployed to internal-dev-sandbox February 3, 2026 14:35 — with GitHub Actions Inactive
@dlzhry2nhs dlzhry2nhs temporarily deployed to internal-dev-sandbox February 3, 2026 14:36 — with GitHub Actions Inactive
@dlzhry2nhs dlzhry2nhs merged commit 5e22d5d into master Feb 3, 2026
16 checks passed
@dlzhry2nhs dlzhry2nhs deleted the feature/VED-000-improve-documentation branch February 3, 2026 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants