Skip to content

Commit

Permalink
added logical-data-model.md and updated README.md to reference file (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
aje54 authored Nov 18, 2024
1 parent 168fd8b commit 4d2806c
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
29 changes: 29 additions & 0 deletions docs/logical-data-model.md
Original file line number Diff line number Diff line change
@@ -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"
```

0 comments on commit 4d2806c

Please sign in to comment.