lx-data-models
lx-dtypes is the reusable data-model package for Lux Group medical research
projects. It provides typed Pydantic contracts, versioned clinical terminology,
report-template validation, FHIR interoperability, and optional Django host
integration.
Highlights
- Strict, reusable contracts for knowledge-base, ledger, reporting, and host integration boundaries.
- Version-aware YAML knowledge bases and deterministic loaders.
- Report-template graph, structure, coverage, and runtime validation.
- FHIR clinical and terminology conversion contracts.
- Typed package data with Pyright, pytest, and documentation checks in CI.
The package is currently in alpha. Public imports are kept stable where
possible, but releases before 1.0 may contain documented breaking changes.
Installation
lx-dtypes supports Python 3.12.
python -m pip install lx-dtypes
Quick start
Load a knowledge-base module shipped with the package:
from lx_dtypes import load_knowledge_base
knowledge_base = load_knowledge_base("report_template_examples")
print(knowledge_base.config.knowledge_base_identity)
print(sorted(knowledge_base.report_template))
Registry-backed deployments should supply the exact module version. See the knowledge-base authoring guide and graph API guide for the complete workflow.
Provision the packaged catalog before starting a registry-backed host:
export LX_DTYPES_KB_REGISTRY=/var/lib/my-host/terminology/registry.json
lx-dtypes-kb-registry bootstrap
This boundary is strict: invalid registry state or an unloadable packaged identity exits nonzero and must block host startup.
Documentation
Start with the documentation index. Key guides include:
- Package boundaries
- Data-model concept map
- Knowledge-base authoring
- Reproduce versioned classifications
- Report-template infrastructure
- FHIR to LXDM mapping
- Django host integration
Build the documentation locally with:
python -m pip install -e ".[docs]"
make -C docs html
Development
git clone https://github.com/wg-lux/lx-data-models.git
cd lx-data-models
uv sync --extra dev
uv run pyright
uv run pytest -q
uv run make -C docs html
Knowledge-base fixtures and tests must not contain patient data, credentials,
or machine-local paths. Generated output belongs in temp/generated_exports/
or a test-local temporary directory.
See CONTRIBUTING.md for the full contributor and release workflow, CHANGELOG.md for release notes, and SECURITY.md for responsible vulnerability reporting.
License and citation
Distributed under the MIT License. If you use lx-dtypes in
published work, cite the project using CITATION.cff.
Metadata
Release files for lx-dtypes 0.3.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| lx_dtypes-0.3.4.tar.gz | 2.7 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| lx_dtypes-0.3.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 3.6 MB
Release files / lx_dtypes-0.3.4.tar.gz
| Download URL | lx_dtypes-0.3.4.tar.gz |
|---|---|
| Size | 2.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c89a23365f4c04e3c719c53dfebeb5408b3389883413d537be7ab025f72e5598
|
|
BLAKE2b-256 checksum How to use checksums |
e39d8cd0f4bef84b0abfb1aff24222120ae3b3992e10cabf7bc3aabdf88b3670
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.13
|
Release files / lx_dtypes-0.3.4-py3-none-any.whl
| Download URL | lx_dtypes-0.3.4-py3-none-any.whl |
|---|---|
| Size | 892.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
12b5eec49bfc4f2bbd8daa097f8d828add461a4453550f54f5b42741e9aa1509
|
|
BLAKE2b-256 checksum How to use checksums |
9325adfa9b3c3a206a11a2dcbf9d5a3ed313d3b4927175120facb14314b98ba4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.13
|
