Module letter

Source
Expand description

Clinical letter on-disk paths.

This module defines the relative filesystem structure for clinical letters stored within a VPR patient repository.

It contains no I/O, no Git logic, and no clinical semantics. Its sole responsibility is to provide typed, canonical paths so that path invariants are defined in exactly one place.

§Path Structure

Each letter is stored under:

correspondence/
    letter/
        <timestamp-id>/
            composition.yaml
            body.md
            attachments/

Where <timestamp-id> is a TimestampId in the format: YYYYMMDDTHHMMSS.mmmZ-<uuid>

§Usage

Use LetterPaths::new to create relative paths, then resolve them against a patient repository root before performing filesystem operations.

Structs§

AttachmentsDir
Letter attachments subdirectory.
BodyMd
Canonical clinical letter content file.
CompositionYaml
OpenEHR composition metadata file.
LetterDir
Letter-based correspondence subdirectory.
LetterPaths
Relative on-disk paths for a single clinical letter.