From 4d2806c1b7b239ca5c2df31c455f137563983f3f Mon Sep 17 00:00:00 2001 From: aje <33416927+aje54@users.noreply.github.com> Date: Mon, 18 Nov 2024 09:12:58 +0000 Subject: [PATCH] added logical-data-model.md and updated README.md to reference file (#1682) --- README.md | 1 + docs/logical-data-model.md | 29 +++++++++++++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 docs/logical-data-model.md diff --git a/README.md b/README.md index e45353bf9..7ab4e1376 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ Provides an API over the Database of Qualified Teachers (DQT). Provides the core # High level architecture (showing one of the citizen facing services that make use of the TRS API) * [Teaching Record System High Level Architecture (just showing core components)](docs/c4-diagrams-as-code/trs-core-containers.jpg) +* [Logical Data Model](docs/logical-data-model.md) # Data Integrations ** TRS provides the the core teaching record data to a number of internal and external facing digital services: diff --git a/docs/logical-data-model.md b/docs/logical-data-model.md new file mode 100644 index 000000000..dfbc4daa7 --- /dev/null +++ b/docs/logical-data-model.md @@ -0,0 +1,29 @@ +# Logical Data Model + +Logical representation of the key data entities and their relationships held within the Teaching Record System (TRS). To note, this does not represent how the data is stored physically. +```mermaid +--- +title: Teaching Record System (TRS) Logical Data Model +--- +erDiagram + Person ||--|{ Professional-Status : "Can Hold" + Person ||--|{ Route-To-Professional-Status : "Could Take a" + Person ||--|{ Teaching-Qualifications : "Can Hold" + Person ||--|{ Teacher-training : "Can Take" + Person ||--|{ Teacher-Pension-Eligibility : "Normally has" + Teacher-Pension-Eligibility ||--|{ Employment : "Could be in" + Employment ||--|{ Educational-Establishment : "at a" + Educational-Establishment ||--|{ Provider : "Can be a" + Professional-Status }o--o{ Teaching-Qualifications : "Can be a" + Route-To-Professional-Status ||--o{ Teacher-training : "Might Require" + Route-To-Professional-Status ||--o{ Induction : "Might Need To Complete an" + Route-To-Professional-Status ||--o{ Equivelence : "Might apply for" + Equivelence ||--o{ Professional-Status : "And be awarded" + Teacher-training ||--o{ Provider : "With a" + Induction||--o{ Professional-Status : "Before They are Awarded" + Teacher-training ||--o{ Teaching-Qualifications : "Can Lead To" + Teacher-training ||--o{ Teaching-Training-Type : "is a" + Provider ||--o{ Provider-Type : "is a" + Person ||--|{ Teaching-Alerts : "Can Have" + Teaching-Alerts ||--|{ Teaching-Sanction-Prohibition : "Can Result In" +```