Skip to content

DDD: define and document the ubiquitous language glossary #1046

@damacus

Description

@damacus

Problem

There is no single authoritative glossary of domain terms. Concepts are named differently across layers:

Concept Names seen in codebase
Patient/individual person, patient, individual, user
Dose event medication_take, dose, take, administration
Inventory supply, stock, inventory, current_supply
Regimen schedule, plan, routine

Without a shared language, every new contributor must reverse-engineer the intent from inconsistent names.

Goal

  • Create docs/ubiquitous_language.md (or a wiki page) defining canonical terms:
    • Person — the individual receiving medication
    • Schedule — a time-based medication regimen
    • PersonMedication — an ad-hoc medication assignment outside a schedule
    • DoseRecord / MedicationTake — a single administration event
    • Supply — the inventory quantity of a medication
    • Carer — a person with delegated responsibility for another Person
  • Identify and fix any code that uses non-canonical names
  • Reference the glossary in the project README

Metadata

Metadata

Assignees

No one assigned

    Labels

    ddddocumentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions