__init__.py

# SPDX-License-Identifier: AGPL-3.0-or-later
# Copyright (C) 2026 MessageFoundry Organization and contributors
"""HL7 v2 parsing & validation.

Two-tier strategy (see docs/ARCHITECTURE.md):

* **Tolerant tier** — :class:`~messagefoundry.parsing.peek.Peek` (``python-hl7``) parses
  any reasonably-formed message and lets us *peek* at fields (e.g. MSH-9 trigger) for
  routing without choking on conformance issues. This is the hot path; every message
  goes through it.
* **Strict tier** — :func:`~messagefoundry.parsing.validate.validate` (``hl7apy``) runs
  version-aware, structure-based validation only when a channel asks for it
  (``validation.strict = true``). Slower and stricter, so it is opt-in and off the hot
  path.
"""

from __future__ import annotations

from messagefoundry.parsing.binary import (
    BinaryCarriageError,
    embed_obx_document,
    extract_obx_document,
)
from messagefoundry.parsing.compression import (
    CompressionError,
    deflate_compress,
    deflate_decompress,
    gzip_compress,
    gzip_decompress,
    zip_compress,
    zip_decompress,
)
from messagefoundry.parsing.dicom import DicomDataset, DicomPeek, DicomPeekError
from messagefoundry.parsing.fhir import FhirPeek, FhirPeekError, FhirResource
from messagefoundry.parsing.groups import SegmentGroup
from messagefoundry.parsing.message import Message, RawMessage
from messagefoundry.parsing.peek import HL7PeekError, Peek, normalize, parse_path
from messagefoundry.parsing.split import encode_batch, split_batch, split_by_obr
from messagefoundry.parsing.summary import summarize
from messagefoundry.parsing.tree import TreeNode, parse_tree
from messagefoundry.parsing.validate import ValidationResult, validate
from messagefoundry.parsing.x12 import (
    X12FrameReader,
    X12Group,
    X12Message,
    X12Peek,
    X12PeekError,
    X12SegmentError,
    X12ValidationError,
    X12ValidationResult,
)
from messagefoundry.parsing.x12 import validate as validate_x12
from messagefoundry.parsing.xml import (
    XmlError,
    XmlMessage,
    XmlParseError,
    XmlPathError,
    XmlSecurityError,
    XmlValidationError,
)
from messagefoundry.timezone import (
    age_from_dob,
    convert_hl7_timestamp,
    hl7_now,
    length_of_stay,
    parse_hl7_timestamp,
    to_zone,
)

__all__ = [
    "Peek",
    "Message",
    "RawMessage",
    "SegmentGroup",
    "HL7PeekError",
    "normalize",
    "parse_path",
    "parse_tree",
    "TreeNode",
    "validate",
    "ValidationResult",
    "summarize",
    "encode_batch",
    "split_batch",
    "split_by_obr",
    # X12 EDI codec (ADR 0012) — full surface under messagefoundry.parsing.x12.
    "X12Peek",
    "X12Group",
    "X12Message",
    "X12FrameReader",
    "X12PeekError",
    # X12 strict validation (ADR 0012, opt-in [x12] extra) — re-exported as `validate_x12` to avoid
    # colliding with the HL7 `validate`; full surface under messagefoundry.parsing.x12.validate.
    "validate_x12",
    "X12ValidationResult",
    "X12SegmentError",
    "X12ValidationError",
    # XML/SOAP codec (BACKLOG #31) — headline types; full surface (schema/signature helpers) under
    # messagefoundry.parsing.xml. Hardened lxml (XXE/DTD-locked) behind the optional [xml] extra.
    "XmlMessage",
    "XmlError",
    "XmlParseError",
    "XmlPathError",
    "XmlValidationError",
    "XmlSecurityError",
    # FHIR codec (ADR 0022) — headline types; full surface under messagefoundry.parsing.fhir.
    "FhirPeek",
    "FhirResource",
    "FhirPeekError",
    # DICOM codec (ADR 0025) — headline types; full surface (SrMeasurement, hl7_map helpers,
    # DicomError) under messagefoundry.parsing.dicom.
    "DicomPeek",
    "DicomDataset",
    "DicomPeekError",
    # Binary carriage codec (ADR 0028) — the mfb64:v1: substrate marker (use it via
    # RawMessage.from_bytes/.raw_bytes) + OBX-5 ED embed/extract; full surface under
    # messagefoundry.parsing.binary.
    "BinaryCarriageError",
    "embed_obx_document",
    "extract_obx_document",
    # Compression codec (ADR 0123) — pure gzip/zlib-deflate/zip, bytes in → bytes out. Deterministic
    # compress (re-run pure) + incremental decompression-bomb ceiling. Full surface under
    # messagefoundry.parsing.compression.
    "CompressionError",
    "gzip_compress",
    "gzip_decompress",
    "deflate_compress",
    "deflate_decompress",
    "zip_compress",
    "zip_decompress",
    # HL7 v2 timestamp helpers (messagefoundry.timezone) — tolerant TS parse, DST-aware zone
    # conversion, and the derived-value helpers (age / length-of-stay / now). Pure; console-importable.
    "convert_hl7_timestamp",
    "to_zone",
    "parse_hl7_timestamp",
    "hl7_now",
    "age_from_dob",
    "length_of_stay",
]

# Defense-in-depth for review finding C-1: python-hl7 logs raw field values at ERROR on
# benign-but-unmapped escape sequences (hl7/util.py unescape), a PHI leak hit on every message via
# summarize(). Silence its loggers the moment the parsing layer — the only thing that triggers
# unescape — is imported, so CLI/embedded paths that never call configure_logging() are covered too.
# Idempotent; configure_logging() also calls it for the serve path.
from messagefoundry.logging_setup import silence_phi_prone_dependency_loggers as _silence_hl7

_silence_hl7()