event-models

Event Models

As described in Data Flow, the FutureNHS platform publishes events for everything that happens (e.g. user uploaded file, left a comment or viewed a page). The event models here contain:

• A centralized schema for all events published by the platform.
• Types for Rust and TypeScript, which make it easy to both publish and consume events from different parts of the platform.

The centralized schema is written as a JSON Schema and follows the Azure EventGrid schema for events.

Update schema

If you need to update the schema, e.g. to add a new event, follow these steps:

1. Edit the schema.json file
2. Update the TypeScript and Rust types by running yarn generate in this folder.