mkdocs.yml

site_name: OpenMed
site_description: "Local-first OpenMed documentation for clinical NLP, de-identification, model discovery, and on-device or self-hosted healthcare workflows."
site_url: https://openmed.life/docs/
site_dir: site/docs
repo_url: http://github.com/maziyarpanahi/openmed
repo_name: maziyarpanahi/openmed
edit_uri: edit/master/docs/
copyright: "© {year} Maziyar Panahi — OpenMed SDK: Apache-2.0"
strict: true

nav:
  - Overview:
      - Welcome: index.md
      - Feature Map: feature-map.md
      - OpenMed 2.5.0 Release Notes: release/v2.5.0.md
      - OpenMed 2.2.0 Release Notes: release/v2.2.0.md
      - OpenMed 2.2 Tested Standards Matrix: release/v2.2-standards-matrix.md
      - OpenMed 2.1.0 Release Notes: release/v2.1.0.md
      - OpenMed 2.0.0 Release Notes: release/v2.0.0.md
      - v1.6-v1.7 Feature Coverage: release/v1.6-v1.7-feature-coverage.md
      - Quick Start: getting-started.md
      - African Developer Onboarding: africa-onboarding.md
      - Low-Bandwidth & Proxy Install: low-bandwidth-install.md
      - Persona Quickstarts: quickstarts.md
      - Project Scaffold CLI: cli/openmed-init.md
      - CLI Result Envelope: cli/result-envelope.md
      - CLI Help-Surface Drift: cli/help-drift.md
      - Machine-readable CLI Contract: cli/machine-contract.md
      - China Onboarding: onboarding-china.md
      - India Onboarding: onboarding-india.md
  - Governed Agents:
      - Overview: agent/index.md
      - Migrate from 3.0 to 3.1: migration/3.0-to-3.1.md
      - Authority and Minimum Data:
          - Runtime Authority Revocation: agent/runtime-revocation.md
          - SMART Token Custody: interop/smart-token-custody.md
          - Signed Agent Capability Grants: agent/capability-grants.md
          - Agent Capability Validity: agent/capability-validity.md
          - Purpose-bound Agent Data Access: agent/purpose-bound-access.md
          - Non-amplifying Agent Delegation: agent/non-amplifying-delegation.md
          - Agent Governance Identifiers: agent/governance-identifiers.md
          - Minimum-data Agent Tool Contracts: agent/minimum-data-contracts.md
          - Minimum-data Agent Tool Projections: agent/minimum-data-projections.md
          - Tool Argument Classification: agent/tool-argument-classification.md
          - PHI-safe Agent Tool Inventory: agent/tool-inventory.md
          - Agent Exchange Record JSON Schemas: agent/exchange-record-schemas.md
          - Agent Tool Inventory JSON Schema: agent/tool-inventory-schema.md
          - Content-free Agent Tool Catalog Diffs: agent/tool-catalog-diffs.md
      - Approvals and Previews:
          - Clinical Side-Effect Previews: agent/side-effect-previews.md
          - Reviewer Handoff Packets: agent/reviewer-handoffs.md
          - Agent Policy Decision Matrices: agent/policy-decision-matrices.md
          - Single-use Human Approval Tokens: agent/human-approval-tokens.md
          - Human-approval Receipt Failures: agent/human-approval-receipts.md
      - Write-back and Execution:
          - Guarded Workflow Dispatch: agent/guarded-dispatch.md
          - Effect Admission and Emergency Stop: agent/effect-admission.md
          - Per-run Agent Resource Budgets: agent/resource-budgets.md
          - Governed Clinical Reference Workflow: agent/governed-reference-workflow.md
          - Bounded Approved FHIR Transactions: interop/fhir-transactions.md
          - FHIR Conditional Write Plans: interop/fhir-conditional-writes.md
          - FHIR Optimistic Concurrency: interop/fhir-concurrency.md
          - Bounded Agent Scheduling: agent/bounded-scheduling.md
          - Agent Action Graphs: agent/action-graphs.md
          - Agent Action Execution Phases: agent/action-phases.md
          - FHIR Write Capability Preflight: interop/fhir-write-preflight.md
          - SMART Scope Audit Examples: interop/smart-scope-audit.md
          - Staged OMOP Mutations: interop/omop-staged-mutations.md
          - OMOP Vocabulary Write Gates: interop/omop-vocabulary-write-gates.md
          - FHIR-to-OMOP Write Lineage: interop/fhir-omop-write-lineage.md
      - Evidence:
          - Agent Governance JSON Schemas: agent/json-schemas.md
          - Agent Run Completion Invariants: agent/run-invariants.md
          - Agent Action Ledger: agent/action-ledger.md
          - FHIR Write Provenance Gate: interop/fhir-write-provenance.md
          - FHIR Write Origin Labels: interop/fhir-write-labels.md
          - Agent Artifact References: agent/artifact-references.md
          - Agent Event Correlation: agent/event-correlation.md
          - Agent Event Attributes: agent/event-attributes.md
          - Agent Event Sequences: agent/event-sequences.md
          - Agent Outcome Reason Codes: agent/outcome-reasons.md
          - Agent Error Envelopes: agent/error-envelopes.md
          - Agent Timing Metadata: agent/timing-metadata.md
          - Privacy-safe Agent Run Summaries: agent/run-summaries.md
          - Deterministic Agent Run Commitments: agent/run-commitments.md
          - Privacy-safe Agent Run Diffs: agent/run-diffs.md
          - Workflow Run Rollups: agent/workflow-rollups.md
          - Agent Schema Compatibility: agent/schema-compatibility.md
          - Evidence-grounded Query Planner: agent/evidence-query-planner.md
          - Clinical Chart-Abstraction Evidence: agent/chart-abstraction-evidence.md
          - Prior-Authorization Evidence Completeness: agent/prior-auth-completeness.md
          - Cohort Membership Explanations: agent/cohort-explanations.md
          - Quality-Measure Evidence: agent/quality-measure-evidence.md
          - Trial-Eligibility Disagreement Review: agent/trial-eligibility-review.md
      - Recovery:
          - Escalation Circuit Breakers: agent/escalation-circuit-breakers.md
          - Deterministic Agent Replay: agent/deterministic-replay.md
          - FHIR Transaction Compensation: interop/fhir-transaction-compensation.md
          - FHIR Subscription Checkpoints: interop/fhir-subscription-checkpoints.md
          - Durable Workflow Recovery: agent/workflow-recovery.md
          - OMOP Rollback Manifests: interop/omop-rollback-manifests.md
          - OMOP Rollback Manifest Schema: interop/omop-rollback-schema.md
      - Evaluation:
          - Governed-agent Trace Fixtures: evaluation/governed-agent-fixtures.md
          - Synthetic FHIR Capability Fixtures: interop/fhir-capability-fixtures.md
          - Sealed Workflow Manifests: evaluation/sealed-workflow-manifests.md
          - v3.1 Agent Release Gates: evaluation/v3.1-agent-gates.md
      - Assurance:
          - Offline Agent Governance Self-check: agent/self-check.md
          - Agent Boundary Threat Model: security/agent-threat-model.md
          - v3.1 Agent Deployment Assurance: compliance/v3.1-agent-assurance.md
  - Core Guides:
      - Building with an Agent: agent-usage.md
      - Agent Skill Installation: agent-skills/install.md
      - Agent Skill Validation: agent-skills/validation.md
      - De-identification Policy Setup: agent-skills/setup.md
      - Agent Skill Packs: agent-skills/packs.md
      - Agent Skill Router: agent-skills/router.md
      - Local Trace-Store Discovery: guides/trace-discovery.md
      - JSONL Trace Content Walker: reference/trace-jsonl.md
      - Structure-aware Tool-call Redaction: reference/trace-tool-calls.md
      - Analyze Text Helper: analyze-text.md
      - Async Python API: async-api.md
      - REST Service (MVP): rest-service.md
      - Self-hosted Redaction Service: service/self-hosted-redaction.md
      - Inbound Placeholder Restoration: service/inbound-restoration.md
      - Local Privacy Proxy: service/privacy-proxy.md
      - MCP Client Connections: mcp-clients.md
      - MCP Clinical Gateway Threat Model: security/mcp-threat-model.md
      - REST API Recipes: rest-recipes.md
      - REST Tracing: serving/tracing.md
      - Parallel Trace Shards: guides/parallel-traces.md
      - Streaming Trace Redaction: guides/streaming-traces.md
      - Read-only Trace Scan Report: guides/trace-audit.md
      - Trace Replay Fidelity: reference/trace-fidelity.md
      - Session-end Trace Scrub Hook: guides/session-end-hook.md
      - Serving Resilience: serving/resilience.md
      - Serving Backpressure: serving/backpressure.md
      - KServe & Triton Model Repositories: serving/kserve-triton.md
      - Hardened Service Image: deploy/hardened-image.md
      - Self-hosted Compose Deployment: deploy/self-hosted-compose.md
      - Offline & Air-Gapped Installation: offline-install.md
      - Standalone Local Redactor Manifest: install/standalone.md
      - Offline Install Smoke Check: install/smoke-check.md
      - Async REST Jobs & Webhooks: serving/async-jobs.md
      - HMAC Request Signing: serving/request-signing.md
      - gRPC Service: serving/grpc.md
      - GraphQL Service: serving/graphql.md
      - REST Authentication: serving/authentication.md
      - Service Load Testing & Latency SLOs: serving/load-testing.md
      - Mutual TLS Authentication: serving/mtls.md
      - Helm Deployment: deploy/helm.md
      - Kubernetes Autoscaling: deploy/autoscaling.md
      - Kubernetes Model Operator: deploy/operator.md
      - OpenHIM De-identification Mediator: deploy/openhim-mediator.md
      - African Facility-to-HMIS Reference: deploy/africa-reference-deployment.md
      - Multi-Arch Containers: deploy/multi-arch.md
      - ModelLoader & Pipelines: model-loader.md
      - Bundled Offline Model Bootstrap: models/bundled-offline.md
      - Guarded Clinical Intelligence:
          - Brief and Summarization:
              - Guarded Clinical Brief: clinical/clinical-brief.md
              - Local Backends and Typed Outcomes: clinical/local-backends.md
              - Deterministic Summary Output Normalization: clinical/summary-output-normalization.md
              - Section-Preserving Summary Planning: clinical/summary-section-planning.md
              - Synthetic Brief Walkthrough: demo/clinical-brief.md
              - Versioned Summary Template Profiles: clinical/summary-template-profiles.md
              - Deterministic Summary Length Budgets: clinical/summary-length-budgets.md
              - Empty-evidence Summary Refusal: clinical/summary-empty-evidence.md
              - Atomic Summary Claim Segmentation: clinical/summary-claim-segmentation.md
              - Summary Temporal-order Validation: clinical/summary-temporal-order.md
              - Medication-change Summary Views: clinical/summary-medication-changes.md
              - Laboratory Sequence Summary Views: clinical/summary-lab-trends.md
              - Guarded Summary Input Contract: clinical/summary-input-contract.md
              - Summary Safety Envelope: clinical/summary-safety.md
              - Summary Citation Consistency: clinical/summary-citations.md
              - Summary Fact Coverage: evaluation/summary-coverage.md
              - Post-de-identification Summarization: clinical/summarization.md
              - Unsupported Claim Rates: evaluation/summary-unsupported-claims.md
              - Summary omission budgets: clinical/summary-omission-budgets.md
              - Summary demographic minimization: clinical/summary-demographic-minimization.md
              - Bounded local-summary retries: clinical/summary-retry-control.md
          - Context, Grounding and Journey:
              - Longitudinal Journey Contracts: clinical/journey-contracts.md
              - Terminology Resolution Cascades: clinical/terminology-resolution.md
              - Point-in-Time Longitudinal Journey: clinical/longitudinal-journey.md
              - Clinical Context & Extraction Depth: clinical/context-and-extraction.md
              - Concept Grounding & Interoperability Export: clinical/concept-grounding.md
              - Clinical Data-quality Profiler: clinical/data-quality-profiler.md
              - FHIR ValueSet and ECL Expansion: clinical/valueset-ecl-expansion.md
              - ICD-10-CM and SNOMED CT Crosswalks: clinical/code-crosswalk.md
              - Terminology Conflict Resolution: clinical/terminology-conflicts.md
              - Clinical Abbreviation Disambiguation: clinical/abbreviation-disambiguation.md
              - Clinical Coreference Resolution: clinical/coreference.md
              - Terminology Snapshot Provenance: clinical/terminology-provenance.md
              - Local Extensions to the Status Vocabulary: clinical/status-vocabulary.md
              - Consent Cache Invalidation: clinical/consent-cache.md
              - Chinese Terminology Grounding: clinical/chinese-terminology-grounding.md
              - Language Route Health Matrix: clinical/language-matrix.md
              - Experiencer Refinement: clinical/experiencer-refinement.md
              - Clinical Context Analysis: clinical/context-analysis.md
          - Clinical NLI:
              - Clinical NLI Label Contract: clinical/nli-label-contract.md
              - Assertion-aware Clinical NLI Pairs: clinical/nli-assertion-pairs.md
              - Experiencer-aware Clinical NLI Pairs: clinical/nli-experiencer-pairs.md
              - Clinical NLI Verification: clinical/nli-verification.md
              - Temporality-aware Clinical NLI Pairs: clinical/nli-temporal-pairs.md
              - Numeric NLI Contradiction Precheck: clinical/nli-numeric-precheck.md
              - Medication-status NLI Precheck: clinical/nli-medication-status.md
              - Minimal Clinical NLI Premise Windows: clinical/nli-premise-windows.md
              - Clinical NLI Hypothesis Guard: clinical/nli-hypothesis-guard.md
              - Clinical NLI Batch Planning: clinical/nli-batch-planning.md
              - Clinical NLI Cascade: clinical/nli-cascade.md
              - Clinical NLI abstention gate: clinical/nli-abstention.md
              - Clinical NLI Checkpoints: models/clinical-nli.md
          - Social Determinants:
              - SDOH Extraction: clinical/sdoh-extraction.md
              - SDOH Temporal Qualifiers: clinical/sdoh-temporal-qualifiers.md
              - Strict SDOH Section Scope: clinical/sdoh-section-scope.md
              - SDOH Evidence Deduplication: clinical/sdoh-evidence-deduplication.md
              - SDOH Longitudinal Status Resolution: clinical/sdoh-longitudinal-resolution.md
              - SDOH Sensitive-Use Labels: clinical/sdoh-sensitive-use-labels.md
              - SDOH Review Routing: clinical/sdoh-review-routing.md
              - SDOH Category Completeness: clinical/sdoh-category-completeness.md
              - SDOH Experiencer Filtering: clinical/sdoh-experiencer-filtering.md
              - SDOH Negated-Need Resolution: clinical/sdoh-negated-needs.md
              - Social-determinant evidence contract: clinical/sdoh-evidence.md
              - Synthetic SDOH Counterfactuals: evaluation/sdoh-counterfactuals.md
              - Synthetic SDOH False-positive Stress: evaluation/sdoh-false-positive-stress.md
              - SDOH Extraction Benchmark: evaluation/sdoh-extraction.md
          - Guarded Relations:
              - Medication-change Relation Candidates: clinical/medication-change-relations.md
              - Laboratory-result Relation Candidates: clinical/laboratory-result-relations.md
              - Procedure-to-indication Relation Candidates: clinical/procedure-indication-relations.md
              - Diagnosis-to-treatment Relation Candidates: clinical/diagnosis-treatment-relations.md
              - Relation Review Priority Policy: clinical/relation-review-priority.md
              - Relation Evidence Binding: clinical/relation-evidence-binding.md
              - Clinical Relation Duplicate Collapse: clinical/relation-deduplication.md
              - Multilingual Clinical Relations: clinical/multilingual-relations.md
              - Guarded Relation Directionality: clinical/relation-directionality.md
              - Quantitative Relation Unit Compatibility: clinical/relation-unit-compatibility.md
              - Guarded Clinical Relation Review Yield: evaluation/relation-review-yield.md
              - Relation-candidate audit report: evaluation/relation-audit.md
          - Timelines and Measurements:
              - Temporal Normalization: clinical/temporal-normalization.md
              - Medication Reconciliation: clinical/medication-reconciliation.md
              - Clinical Event Timeline Assembler: clinical/event-timeline.md
              - Evidence-linked Clinical Timeline Graph: clinical/timeline-evidence.md
              - Serial Measurement Trends: clinical/measurement-trends.md
              - Clinical Timeline Provenance: clinical/timeline-provenance.md
              - Medication Sig Parser: clinical/sig-parser.md
              - Typed laboratory reference-range provenance: clinical/lab-reference-ranges.md
              - Lab Measurement Normalization: clinical/lab-measurements.md
              - Unit-display normalization audit: clinical/unit-display-audit.md
              - Clinical event contradiction reports: clinical/event-contradictions.md
              - Conservative Temporal Intervals: clinical/temporal-intervals.md
              - Bucketed Clinical Timelines: clinical/timeline-buckets.md
          - Note Routing and Document Profiles:
              - Clinical Task Router and Model Packs: clinical/model-packs.md
              - Section-aware note routing: clinical/note-routing.md
              - Radiology Finding Profile: clinical/radiology-profile.md
              - Pathology result profile: clinical/pathology-profile.md
              - Structured discharge-summary profile: clinical/discharge-profile.md
          - Evidence, Citations and Human Review:
              - Clinical Section-Boundary Provenance: clinical/section-provenance.md
              - Guarded Clinical-Output Provenance: clinical/guarded-output-provenance.md
              - Deterministic Citation Ordering: clinical/citation-ordering.md
              - Citation Minimality Checks: clinical/citation-minimality.md
              - Citation Boundary Validation: clinical/citation-boundary-validation.md
              - Clinical Evidence Tables: clinical/evidence-tables.md
              - Typed Clinical Uncertainty Sources: clinical/uncertainty-source-types.md
              - Structured Review Override Reasons: clinical/review-override-reasons.md
              - Clinical Review Packet Privacy: clinical/review-packet-privacy.md
              - Clinical Review Packet Migrations: clinical/review-packet-migrations.md
              - Evidence Recency Labels: clinical/evidence-recency-labels.md
              - Guarded evidence packets: clinical/evidence-packets.md
              - Guarded review-state transitions: clinical/review-transitions.md
              - Evidence-claim contradiction review: clinical/claim-conflicts.md
              - Human-review queue SLA reports: clinical/review-sla.md
              - Clinical Evidence-Span Overlap Audit: clinical/evidence-span-audit.md
              - Clinical Output Use Policy: clinical/output-use-policy.md
              - Value-free Evidence Coverage: clinical/evidence-coverage.md
              - Human-review packets: clinical/human-review-packets.md
              - Uncertainty-disclosure completeness audit: clinical/uncertainty-disclosure.md
              - Clinical claim-packet integrity: clinical/claim-integrity.md
              - Clinical Refusal Reason Taxonomy: clinical/refusal-taxonomy.md
          - Clinical SLM Admission:
              - Clinical SLM Artifact Manifest: models/clinical-slm-manifest.md
              - Clinical SLM Capability Probes: models/clinical-slm-capabilities.md
              - Clinical SLM Memory Preflight: models/clinical-slm-memory-preflight.md
              - Clinical SLM Prompt-Template Digests: models/clinical-slm-template-digests.md
      - Offline Bootstrap Diagnostics: models/bootstrap-diagnostics.md
      - Local Model-Cache Quotas: models/cache-quotas.md
      - Registry Rollback Compatibility: models/rollback-compatibility.md
      - Journey Specialist Pack: models/journey-specialist-pack.md
      - Model Registry: model-registry.md
      - NER Families: ner-families.md
      - Model Manifest: model-manifest.md
      - Indic Encoder Backbones: indic-encoders.md
      - Indic NER Checkpoint Compatibility: indic-ner-checkpoints.md
      - Tokenizer Script Coverage: model-tokenizer-script-coverage.md
      - Advanced NER & Output Formatting: output-formatting.md
      - Cross-format Offset Properties: structured/offset-properties.md
      - Schema Snapshot Compatibility: structured/schema-snapshots.md
      - Durable Local Journey Storage: structured/local-journey-store.md
      - PostgreSQL and Object-backed Journey Storage: structured/postgres-object-journey-store.md
      - Resumable Ingestion Control Plane: interop/resumable-ingestion.md
      - Patient and Encounter Identity Resolution: interop/identity-resolution.md
      - Structured Source Evidence Adapters: interop/structured-evidence-adapters.md
      - Multimodal Evidence Coordinates: interop/multimodal-evidence-coordinates.md
      - Ingestion-to-Fact Pipeline: interop/ingestion-to-fact-pipeline.md
      - Annotation Interchange and Pipeline Migration: interop/annotation-interchange.md
      - V3 Five-source Golden Journey: interop/v3-golden-journey.md
      - V3 Journey Release Gate: release/v3.0-journey-release-gate.md
      - Clinical Fact Normalization: structured/clinical-fact-normalization.md
      - Fact Reconciliation and Correction History: structured/fact-reconciliation.md
      - Provenance-aware Terminology Cache: structured/terminology-cache.md
      - Nested Resource Redaction Contract: structured/redaction-contract.md
      - Offline Terminology Grounding: grounding.md
      - SNOMED CT Terminology Bridge: interop/snomed-terminology-bridge.md
      - Chinese Segmentation Operations: chinese-segmentation-operations.md
      - Schema-Guided JSON Extraction: structured/schema-guided-extraction.md
      - Medical Tokenizer: medical-tokenizer.md
      - Indic Unicode Normalization: indic-normalization.md
      - Configuration & Validation: configuration.md
      - Configuration Precedence Audit: configuration/precedence-audit.md
      - Configuration Profiles: profiles.md
      - Extension Plugin SDK: plugin-sdk.md
      - Skill Bundle Integrity: skills/bundle-integrity.md
      - Plugin Quarantine Preflight: plugins/quarantine-report.md
      - Batch Processing: batch-processing.md
      - Batch Processing How-To: batch-howto.md
      - Offline File Shard Plans: processing/shard-plans.md
      - Legacy Indic Encoding: legacy-indic-encoding.md
      - Performance Profiling: profiling.md
      - Core Pipeline Observability: core-observability.md
      - No-PHI Telemetry: operations/no-phi-telemetry.md
      - Low-resource Benchmark: benchmarks/low-resource.md
      - Synthetic SHIELD-Schema Baseline: benchmarks/shield-synthetic.md
      - Chinese and Indic Throughput: benchmarks/i18n-throughput.md
      - Cost vs Cloud: benchmarks/cost-vs-cloud.md
      - Zero-shot NER How-to: zero-shot-howto.md
      - Zero-shot Toolkit: zero-shot-ner.md
      - Task-oriented Cookbook: cookbook.md
      - Examples & Copy/Paste Recipes: examples.md
      - Example Notebooks Gallery: examples/notebook-gallery.md
      - Document Adapter Provenance: document-adapter-provenance.md
      - Chat Message Schema: reference/chat-schema.md
      - Training Schema Registry: reference/training-schemas.md
      - Federated Round Lifecycle: training/federated-round-lifecycle.md
      - Federated Aggregate Metrics: training/federated-metrics.md
      - Federated Round Status: training/federated-round-status.md
      - Federated Round Scheduling: training/federated-scheduling.md
      - Federated Update Metadata: training/federated-update-metadata.md
      - Private-Training JSON Schemas: training/private-training-schemas.md
      - Federated Schema Fingerprints: training/federated-schema-fingerprints.md
      - SPDX License Identifiers: training/synthetic/license-identifiers.md
      - Preference Pair Schema: reference/preference-schema.md
      - BMP Header Preflight: multimodal/bmp-header-preflight.md
      - GIF Header Preflight: multimodal/gif-header-preflight.md
      - PNG and JPEG Header Preflight: multimodal/image-header-preflight.md
      - WebP Header Preflight: multimodal/webp-header-preflight.md
      - Image Orientation Preflight: multimodal/image-orientation-preflight.md
      - TIFF Header Preflight: multimodal/tiff-preflight.md
      - Audio Format Summaries: multimodal/audio-format-summaries.md
      - Frame-Sampling Manifests: multimodal/frame-sampling-manifests.md
      - Audio Resampling Plans: multimodal/audio-resampling-plans.md
      - Image Geometry Derivation: multimodal/image-geometry.md
      - Locale Tag Normalization: i18n/locale-tags.md
      - Bounded Media Type Detection: multimodal/media-type-detection.md
      - PDF Reading Order: multimodal/pdf-reading-order.md
      - PDF Page Geometry Preflight: multimodal/pdf-geometry-preflight.md
      - OCR Through Memory: multimodal/ocr-streaming.md
      - Bounded Asset Digests: multimodal/asset-digests.md
      - Privacy-safe Asset Manifests: multimodal/asset-manifests.md
      - Multimodal Manifest Profiles: multimodal/manifest-profiles.md
      - Multimodal Asset Limit Profiles: multimodal/asset-limits.md
      - Multimodal Batch Memory Estimates: multimodal/batch-memory-estimates.md
      - Multimodal Preflight Report: multimodal/preflight.md
      - Document Page Batches: multimodal/page-batches.md
      - Privacy-safe Asset Batches: multimodal/asset-batches.md
      - Content-free Multimodal Cache Keys: multimodal/cache-keys.md
      - Processing Summaries: multimodal/processing-summaries.md
      - Processing Summary Diffs: multimodal/processing-diffs.md
      - Content-free Provider Results: multimodal/provider-results.md
      - Streaming Audio Windows: multimodal/audio-windows.md
      - WAV Metadata Preflight: multimodal/wav-preflight.md
      - WAV Metadata and RF64: multimodal/wav-metadata.md
      - ASR Audio Profiles: multimodal/asr-audio-profiles.md
      - Redacted PDF Rendering And Fidelity: multimodal/pdf-redaction-fidelity.md
      - Multimodal Abstention Reasons: multimodal/abstention-reasons.md
      - Email Ingestion and Redaction: multimodal/email-ingestion.md
      - EPUB Extraction: multimodal/epub-extraction.md
      - XLSX Cell Redaction: multimodal/xlsx-cell-redaction.md
      - ODT/ODF Text Extraction: multimodal/odt-extraction.md
      - PPTX Redaction: multimodal/pptx-redaction.md
      - RTF Extraction: multimodal/rtf-extraction.md
      - Testing & QA: testing.md
      - Eval Harness & Metrics: eval-harness.md
      - Cross-lingual Extraction Scorecard: evaluation/crosslingual-scorecard.md
      - Claim-level Citation Support: evaluation/citation-support-metrics.md
      - Comparator Reports: evaluation/comparator-reports.md
      - Comparator Benchmark Harness: evaluation/comparator-harness.md
      - Clinical NLI Error Slices: evaluation/nli-error-slices.md
      - Synthetic Clinical NLI Negation Challenge: evaluation/nli-negation-challenge.md
      - Agent Run-summary Golden Fixtures: evaluation/agent-run-summary-fixtures.md
      - Offline Planner Qualification: evaluation/planner-qualification.md
      - Synthetic Privacy Regression Corpus: evaluation/privacy-corpus.md
      - OpenMed Synthetic PHI Corpus: datasets/openmed-synth-phi.md
      - Mixed-script Span Integrity: evaluation/mixed-script-integrity.md
      - Document-type Calibration: evaluation/doctype-calibration.md
      - Sealed Holdout Commitments: evaluation/holdout-commitments.md
      - Adaptive Benchmark Feedback Budgets: evaluation/feedback-budgets.md
      - Benchmark Overlap Forensics: evaluation/overlap-forensics.md
      - Blinded Clinician Adjudication: evaluation/blinded-adjudication.md
      - Chart Abstraction Scoring: evaluation/chart-abstraction.md
      - Reviewer Disagreement: evaluation/reviewer-disagreement.md
      - Local Generation Guardrail-Bypass: evaluation/local-guardrail-bypass.md
      - Clinical Validation Protocol: clinical-validation-protocol.md
      - Public Benchmark Leaderboard: eval/leaderboard.md
      - ARM SMS Latency Budget: benchmarks/arm-latency.md
      - Raspberry Pi & Jetson Edge Benchmark: runtimes/edge-sbc.md
      - CPU INT8 Classification Fast Path: runtimes/cpu-fastpath.md
      - OpenVINO Runtime: runtimes/openvino.md
      - TensorRT Runtime: runtimes/tensorrt.md
      - WebGPU Token-Classification Runtime: runtimes/webgpu.md
      - AWQ Grounding Embedder: runtimes/awq-grounding.md
      - GGUF Grounding Runtime: runtimes/gguf-grounding.md
      - Device Tiers & SLOs: tiers.md
      - AWQ Export: export-awq.md
      - GPTQ Export: export-gptq.md
      - GGUF Embedding Export: export-gguf.md
      - Synthetic Clinical Fixtures: evaluation/clinical-fixtures.md
      - OCR box-coordinate normalization: multimodal/box-normalization.md
      - OCR page-rotation transforms: multimodal/page-rotation.md
      - OCR document-routing evaluation: evaluation/ocr-routing.md
      - DICOM-SR provenance mapping: multimodal/dicom-sr-provenance.md
      - Model-provenance diff reports: evaluation/model-provenance-diff.md
      - Clinical NLI threshold calibration: evaluation/nli-calibration.md
      - Outbound request privacy filter: service/outbound-privacy-filter.md
  - PII & De-identification:
      - De-identification API: api/deidentification.md
      - Structured Public Errors: api/errors.md
      - Service API Compatibility Gate: api/compatibility-gate.md
      - Fixed-option Decision API: api/fixed-option-decisions.md
      - Versioned Journey Resources: api/journey-resources.md
      - Offline File Redaction CLI: guides/file-redaction.md
      - Structured Release Risk & Expert Review: reidentification-risk.md
      - Minimum-necessary Field Selection: security/minimum-necessary.md
      - Structured Privacy and Re-identification Risk Lab: privacy/structured-risk-lab.md
      - Deletion Impact Plans: security/deletion-plans.md
      - Surrogate-map Referential-integrity Audit: security/surrogate-audit.md
      - Nested Redaction Idempotence: security/redaction-idempotence.md
      - Privacy Evidence Replay: security/evidence-replay.md
      - SMS Short-Text De-identification: sms-short-text-deid.md
      - PII Anonymization: anonymization.md
      - Dataset Upload Privacy Guard: guides/dataset-upload-guard.md
      - CHW Form Export De-identification: chw-form-deid.md
      - Indic Name Matching: indic-name-matching.md
      - Per-Language De-identification: languages.md
      - Language Pack Plugins: language-packs.md
      - Browser Extension PHI Guard: runtimes/browser-extension.md
      - India Health-ID De-identification: india-health-id-deidentification.md
      - Privacy Policy as Data: security/policy-as-data.md
      - Smart Entity Merging: pii-smart-merging.md
      - No-Raw-PHI Logging: security/no-raw-phi-logging.md
      - Pre-push Privacy Scanner: security/pre-push-privacy.md
      - Counts-only Trace Audit: security/trace-audit-artifact.md
      - Agent Context PHI Preflight: security/preflight-phi-gate.md
      - CI Privacy Scan: security/ci-privacy-scan.md
      - Secret Token Detection: security/secret-detection.md
      - In-place Trace Redaction: guides/in-place-redaction.md
      - Transactional Trace Recovery: privacy/trace-recovery.md
      - Tamper-evident Audit Log: security/tamper-evident-audit-log.md
      - Audit-artifact Retention: security/audit-retention.md
      - Policy-aware Redaction Diffs: security/redaction-diff.md
      - Privacy Policy Composition: security/policy-composition.md
      - Evidence-bundle Integrity: security/evidence-integrity.md
      - Tabular Schema Drift Gates: security/tabular-schema-gates.md
      - Key Management and Rotation: security/key-management.md
      - Key Custody Metadata: security/key-custody-metadata.md
      - Audit-report Signing Key Rotation: security/audit-key-rotation.md
      - Encrypted Surrogate Mappings: security/encrypted-surrogate-vault.md
      - Structured Access Review: security/access-review.md
      - Surrogate-key Providers: security/surrogate-key-providers.md
      - LangChain Redaction Wrapper: integrations-langchain.md
      - LangChain Redaction Node: integrations/langchain.md
      - Arrow Flight De-identification: integrations/arrow-flight.md
      - Haystack Redaction Component: integrations-haystack.md
      - OpenSearch Ingest Redaction Processor: integrations/opensearch.md
      - LlamaIndex Redaction Transform: integrations/llamaindex.md
      - Columnar Redactor: integrations/columnar-redactor.md
      - Notebook Cell Redaction: integrations/notebook-redaction.md
      - Columnar Trace Dataset Adapter: reference/columnar-traces.md
      - Lakehouse Table Redaction: integrations/lakehouse-redaction.md
      - Dask DataFrame De-identification: integrations/dask.md
      - Elasticsearch Ingest Redaction: integrations/elasticsearch.md
      - Apache Beam Redaction Transform: integrations/beam.md
      - Local Capability Probes: integrations/capability-probes.md
      - Integration Capability Matrix: integrations/matrix.md
      - dbt Privacy-Safe Text Projection: integrations/dbt.md
      - Spark Redaction Transform: integrations/spark.md
      - PostgreSQL Redaction Adapter: integrations/postgres.md
      - Pandas-on-Spark De-identification: integrations/pandas-on-spark.md
      - Ray Data Batch De-identification: integrations/ray-map-batches.md
      - SQLAlchemy Write-time Redaction: integrations/sqlalchemy.md
      - OMOP Cohort Export Validation: integrations/omop-cohort-check.md
      - DuckDB De-identification UDFs: duckdb-deidentification.md
      - Distributed SQL De-identification UDF: integrations/distributed-sql-udf.md
      - Warehouse Remote-Function Handler: integrations/warehouse-remote-function.md
      - PySpark De-identification UDFs: spark-deidentification.md
      - Snowflake Python De-identification UDFs: snowflake-udf.md
      - Prefect Batch De-identification: prefect-integration.md
      - Airflow Redaction Operator: integrations/airflow.md
      - spaCy Pipeline Component: spacy-component.md
      - HL7 v2 De-identification: hl7v2-deidentification.md
      - HL7 v2 Narrative Extraction: interop/hl7v2-narrative-extraction.md
      - X12 837 Claim Redaction: interop/x12-837-redaction.md
      - Offline Artifact Inventory: interop/artifact-inventory.md
      - Compliance Posture: compliance.md
      - Audit-envelope Metadata: compliance/audit-envelopes.md
      - Privacy Report Cardinality Budgets: compliance/report-cardinality.md
      - Privacy Report Field Linting: compliance/report-lint.md
      - Privacy-policy Coverage Matrix: compliance/policy-coverage.md
      - 21 CFR Part 11 Audit Trail: compliance/21-cfr-part-11-audit-trail.md
      - Reproducible Release Provenance: compliance/reproducible-release.md
      - v3.1 Clinician Review Protocol: compliance/v3.1-clinician-review.md
      - Access-scope Minimization Evidence: compliance/access-scope.md
      - Audit Artifact Size Budgets: compliance/artifact-size-budgets.md
      - Privacy Evidence Freshness Gate: compliance/evidence-freshness.md
      - Privacy-Artifact Lineage Manifests: compliance/artifact-lineage.md
      - Public API Deprecation Policy: compliance/api-deprecation-policy.md
      - Pan-African Malabo Baseline: compliance/africa-malabo-baseline.md
      - Egypt PDPL & Morocco Law 09-08: compliance/north-africa-pdpl-0908-checklist.md
      - Africa Data-Residency Guide: compliance/africa-data-residency-guide.md
      - Africa Attestation Review Template: compliance/templates/africa-data-residency-attestation.md
      - African Context-sensitive Attributes: compliance/africa-context-sensitive-attributes.md
      - HIPAA Safe Harbor Attestation: compliance/hipaa-safe-harbor-attestation.md
      - ISO 27701/27001 Evidence Pack: compliance/iso-27701-control-evidence.md
      - Consent and Data-Use Tags: compliance/consent-data-use-tags.md
      - Separated Projection Boundaries: compliance/separated-projections.md
      - Breach Notification Runbook: compliance/breach-notification-runbook.md
      - Breach Report Template: compliance/templates/breach-report-template.md
      - Privacy Release-Gate Aggregator: compliance/privacy-release-gate.md
      - FHIR and OMOP Interoperability: guides/fhir-omop-interoperability.md
      - Archive Extraction Safety: interop/archive-safety.md
      - FHIR Interop Helpers: fhir-interop.md
      - FHIR R5 Round-trip Fidelity: integrations/fhir-r5-fidelity.md
      - FHIR Profile Declarations: fhir/profile-declarations.md
      - Observation Extension Validation: fhir/observation-extensions.md
      - FHIR Bulk Data Privacy Gateway: interop/fhir-bulk-data.md
      - FHIR Subscription Notification Intake: interop/fhir-subscription-notifications.md
      - FHIR-to-OMOP Round-trip Conformance: interop/fhir-omop-matrix.md
      - Clinical Fact Projection to OMOP 5.4: interop/omop-fact-projection.md
      - OMOP Quality Bridge and Synthetic Reconciliation: interop/omop-quality-bridge.md
      - FHIR Journey and Cohort-definition Round Trips: interop/fhir-cohort-roundtrip.md
      - Saved Cohorts and Membership Evidence: structured/saved-cohorts.md
      - Governed Dataset Snapshots: structured/governed-datasets.md
      - Governed Clinical Registries: structured/clinical-registries.md
      - Deterministic Clinical Measures: clinical/measures.md
      - Evidence-bound Care Gaps: clinical/care-gaps.md
      - Versioned Public Trial Records: clinical/trial-records.md
      - Reviewable Trial Eligibility: clinical/trial-eligibility.md
      - Evidence-bound Drug-safety Signals: clinical/drug-safety-signals.md
      - FHIR Reference Integrity Reports: fhir/reference-integrity.md
      - FHIR Reference Target-Type Checks: fhir/reference-target-types.md
      - FHIR Bulk Data Checkpoints: fhir/bulk-checkpoints.md
      - FHIR DiagnosticReport Export: fhir/diagnostic-report-export.md
      - FHIR OperationOutcome Reports: fhir/operation-outcome.md
      - FHIR SDC Privacy Projection: fhir/sdc-privacy.md
      - Document Intake Quarantine: fhir/document-intake-quarantine.md
      - De-identified DHIS2 Export: dhis2-export.md
      - OpenMRS Adapter: openmrs-adapter.md
      - WHO SMART Guidelines Profiles: fhir-smart-guidelines.md
      - FHIR Clinical Exchange Workbench: interop/fhir-profiles.md
      - ICD-11 Offline Grounding: icd11-grounding.md
  - Apple Silicon & Mobile:
      - Export Format Support Matrix: export-matrix.md
      - Maple Preview on Device: maple-on-device.md
      - MLX Backend: mlx-backend.md
      - Torch MPS Performance: performance-mps.md
      - MLX Quantized Export: export-mlx-quant.md
      - ONNX and WebGPU Export: export-onnx-webgpu.md
      - Transformers.js Export: export-transformersjs.md
      - ONNX Runtime Web Loader: runtimes/onnxruntime-web.md
      - Electron In-Process De-identification: runtimes/electron.md
      - Low-RAM Sharded Weight Loading: runtimes/low-ram-loading.md
      - Android Quickstart: android-quickstart.md
      - Android Integration & Model Catalog: android-integration.md
      - Android ONNX Export: export-onnx-android.md
      - Android QNN and NNAPI: runtimes/android-accelerators.md
      - Android Tokenization: android-tokenization.md
      - Android Span Parity: android-parity.md
      - On-device Segmenters: on-device-segmenters.md
      - CoreML Packaging: coreml-export.md
      - Swift Package (OpenMedKit): swift-openmedkit.md
      - OpenMedKit Apple Platforms: runtimes/apple-platforms.md
      - iOS Share and Action Extensions: runtimes/ios-share-extension.md
      - Swift-Kotlin API Parity: swift-kotlin-parity.md
  - Project:
      - FAQ: faq.md
      - Troubleshooting & Common Errors: troubleshooting.md
      - Onboarding: onboarding.md
      - v1 to v2 Migration: migration.md
      - Contributing & Releases: contributing.md
      - Local Model Release Queue: model-release-queue.md
      - Development Workflow: development.md
      - Reproducible Dependencies: contributing/reproducible-dependencies.md
      - Policy-impact Digest: security/policy-impact.md
      - Dependency License Inventory: security/license-inventory.md
      - No-PHI Exception Taxonomy: security/exception-taxonomy.md
      - Differential-Privacy Budget Migrations: security/budget-migrations.md
      - Privacy-policy Simulation Matrix: security/policy-simulation.md
      - Privacy Exception Budgets: security/exception-budgets.md
      - Export Filename Policy: security/export-naming.md
      - Security & Disclosure: security/disclosure-policy.md
      - Redactor Threat Model: security/threat-model.md
      - Clinical Brief Threat Model: security/clinical-brief-threat-model.md
      - V3 Journey Threat Model: security/journey-threat-model.md
      - Multilingual Ingestion Threat Model: security/threat-model-multilingual-ingestion.md
      - Adversarial PHI Red-Team Corpus: security/red-team-corpus.md
      - No-Telemetry Guarantee: security/no-telemetry.md
      - Policy Migration Reviews: security/policy-migrations.md
      - MCP Prompt Injection Guard: security/prompt-injection-guard.md
      - MCP Consent Receipts: security/mcp-consent-receipts.md
      - MCP Authorization Matrix: security/mcp-authorization-matrix.md
      - MCP Upstream Endpoint Policy: security/mcp-upstream-policy.md
      - Manual HF Model Publication: security/hf-token-policy.md
      - Supply Chain Controls: security/supply-chain.md
      - Resource Path Portability Audit: security/path-portability.md
      - Tabular Re-identification Risk Report: security/tabular-risk-report.md
      - Aggregate Release Privacy Budgets: security/privacy-budget.md
      - Sensitive Artifact Deletion Verification: security/deletion-verification.md
      - Vulnerability Scanning: supply-chain/vulnerability-scanning.md
      - Offline Dependency Risk Report: security/dependency-risk.md
      - Software Bill of Materials: security/sbom.md
      - SLSA Build Provenance: supply-chain/provenance.md
      - Container Image SBOM: supply-chain/sbom.md
      - Container Image Signing: supply-chain/image-signing.md
      - Release Streams & Channels: release/semver-and-channels.md
      - Migrate from 2.5 to 3.0: migration/2.5-to-3.0.md
      - Migrate from 2.3 to 2.5: migration/2.3-to-2.5.md
      - Migrate from 2.2 to 2.3: migration/2.2-to-2.3.md
      - Migrate from 2.1 to 2.2: migration/2.1-to-2.2.md
      - Migrate from 2.0 to 2.1: migration/2.0-to-2.1.md
      - Migrate from 1.9 to 2.0: migration/1.9-to-2.0.md
      - Migrate from 1.8 to 1.9: migration/1.8-to-1.9.md
      - PyPI Publishing: release/trusted-publishing.md
      - OpenMed 2.3.0 Release Notes: release/v2.3.0.md
      - OpenMed 1.9.1 Release Notes: release/v1.9.1.md
      - OpenMed 1.9.0 Release Notes: release/v1.9.0.md
      - OpenMed 1.8.0 Release Notes: release/v1.8.0.md
      - OpenMed 1.7.0 Release Notes: release/v1.7.0.md
      - Generative Model Policy: generative-model-policy.md
      - API Reference: api-reference.md

extra_css:
  - stylesheets/openmed-system.css
  - stylesheets/openmed-brand.css

extra_javascript:
  - javascripts/openmed-docs.js

theme:
  name: material
  custom_dir: docs/overrides
  language: en
  logo: assets/openmed-mark.svg
  favicon: assets/openmed-favicon.svg
  font: false
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.prune
    - navigation.tabs
    - navigation.tracking
    - navigation.footer
    - navigation.top
    - toc.integrate
    - content.action.edit
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - announce.dismiss

extra:
  social_image: https://openmed.life/og.png
  social:
    - icon: fontawesome/brands/github
      link: http://github.com/maziyarpanahi/openmed
      name: GitHub
    - icon: simple/huggingface
      link: https://huggingface.co/OpenMed
      name: Hugging Face
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/OpenMed_AI
      name: OpenMed on X
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/openmed-ai/
      name: LinkedIn

plugins:
  - search
  - i18n:
      docs_structure: suffix
      fallback_to_default: false
      reconfigure_material: true
      languages:
        - locale: en
          name: English
          default: true
          build: true
        - locale: zh
          name: 简体中文
          build: true
          nav:
            - Overview:
                - Welcome: index.md
                - Quick Start: getting-started.md
                - China Onboarding: onboarding-china.md
          nav_translations:
            Overview: 概览
            Welcome: 欢迎
            Quick Start: 快速开始
            China Onboarding: 中国用户上手指南
            Core Guides: 核心指南
            PII & De-identification: PII 与去标识化
            Apple Silicon & Mobile: Apple Silicon 与移动端
            Project: 项目
        - locale: hi
          name: हिन्दी
          build: true
          nav:
            - Overview:
                - Welcome: index.md
                - Quick Start: getting-started.md
                - India Onboarding: onboarding-india.md
          nav_translations:
            Overview: अवलोकन
            Welcome: स्वागत
            Quick Start: त्वरित शुरुआत
            India Onboarding: भारत के उपयोगकर्ताओं के लिए गाइड
            Core Guides: मुख्य गाइड
            PII & De-identification: PII और डी-आइडेंटिफिकेशन
            Apple Silicon & Mobile: Apple Silicon और मोबाइल
            Project: परियोजना
  - llmstxt:
      markdown_description: >
        OpenMed is a local-first healthcare NLP toolkit for clinical entity
        extraction, de-identification, model discovery, and on-device or
        self-hosted integrations.
      full_output: llms-full.txt
      sections:
        Getting started:
          - index.md: OpenMed documentation overview
          - getting-started.md: Installation and first local workflow
          - quickstarts.md: Persona quickstarts, including AI agent usage over MCP
        APIs and de-identification:
          - analyze-text.md: Top-level text analysis API
          - api-reference.md: Public Python API reference
          - api/deidentification.md: De-identification API reference
          - output-formatting.md: Output formats and agent-facing tool schemas
        Agents and tool surfaces:
          - agent-usage.md: Consumer API map, privacy invariants, and repository skills
          - mcp-clients.md: MCP client setup and transport guidance
          - rest-service.md: REST service endpoints and deployment
          - rest-recipes.md: Copy-ready REST API recipes
          - plugin-sdk.md: Detector plugin interfaces
  - git-revision-date-localized:
      enable_creation_date: true
      fallback_to_build_date: true
  - minify:
      minify_html: true
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false

hooks:
  - docs/_hooks.py

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      permalink_title: Link to this section
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

watch:
  - openmed
  - openmed/zero_shot

exclude_docs: |
  _hooks.py
  __pycache__/**
  overrides/**
  demo/web/README.md
  demo/web/models/**
  demo/web/vendor/**
  website/**
  brand/**