Skip to content

Conversation

@cbeach47
Copy link
Contributor

@cbeach47 cbeach47 commented Jan 19, 2026

Description of Change

Documents the requirements of the MDR Data Model, specifically the structure and transformations of the models. There is more to document, so the ADR is not in a finished state, but can be merge for a living document.

Related Issues

Closes #792

Checklist
  • commit message follows commit guidelines (see commitlint.config.mjs)
  • tests are included (unit and/or integration tests)
  • all tests are successful
  • documentation is changed or added (in /docs directory)
  • code passes linting checks (uv run ruff check)
  • code passes formatting checks (uv run ruff format)
  • code passes type checking (uv run ty check)
  • pre-commit hooks have been run successfully
  • database schema changes: migration files created and CHANGELOG.md updated
  • API changes: base (Python code) documentation in docs/
    and project README updated
  • configuration changes: relevant folder README updated
  • breaking changes: added to MIGRATION.md with upgrade instructions
    and CHANGELOG.md entry
Type of Change
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality
    to not work as expected)
  • Documentation update
  • Infrastructure/deployment change
  • Performance improvement
  • Code refactoring
Testing
  • Manual testing performed
  • Automated tests added/updated
  • Integration testing completed
Project Area(s) Affected
  • bases/
  • components/
  • orchestrators/
  • frontends/
  • deployments/
  • CloudFormation/SAM templates
  • Database schema
  • API endpoints
  • Documentation
  • Testing
Additional Notes

#### Org LIF

A model specific to the LIF adopter, seeded and reliant on references from the _Base LIF_ model (known as inclusions), and enhancements added directly by the LIF adopter (known as extensions).
A model specific to the LIF adopter, seeded and reliant on references from other _Data Models_ (_Base LIF_ (known as `Inclusions`), _Partner LIF_, or _Source Schema_), and with enhancements added directly by the LIF adopter (known as extensions).

Choose a reason for hiding this comment

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

I think the parenthetical for "(known as Inclusions) is in the wrong place. They're all inclusions regardless of what data model type they're being included from.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

Document MDR Data Model use cases

6 participants