Note

This SDK is unofficial and not affiliated with the vendor. Use at your own risk.

Welcome to imednet’s documentation!

This documentation is organized according to the Diátaxis framework into four main sections.

Tutorials:

• Quick Start
  • Installation
  • Basic Usage
  • Synchronous Example
  • Asynchronous Example
• Async Quick Start
• Examples
  • Quick start
  • Basic endpoints
  • Advanced

How-to Guides:

• Command Line Interface (CLI)
  • Positional Arguments
  • Named Arguments
  • Sub-commands
• Logging and Tracing
  • Contract Drift Telemetry
  • Request Lifecycle
• Pagination guarantees
  • Cursor model
  • Iteration and memory behavior
  • Error handling
• Form Builder
  • Core Concepts
  • Usage
  • Presets
  • API Reference
• Register Subjects Workflow
  • Example
• Caching Behavior
  • Endpoint Caching
  • Schema Cache
• Retry Policy and Error Handling
  • Handling exceptions
  • Custom strategies
  • Logging and exponential backoff
  • Example script
• Job Polling Mechanism
  • Using the SDK
• Airflow Integration
  • Installation
  • Production Reference DAG
  • Connections
  • Operators and Sensors
  • Testing with Airflow
• UAT Workflow Guide
  • Visual Workflow
  • Usage Example
  • Detailed Steps
• Bulk Submission Guide
  • Two-Phase Process
  • Visual Workflow
  • Usage Example
  • Error Handling
• Export Destinations
  • Installation
  • Destination decision matrix
  • SDK examples
  • Runnable examples
• DuckDB Integration
  • Installation
  • export_to_duckdb quickstart
  • export_to_duckdb_by_form
  • Hive-partitioned Parquet for multi-study workloads
  • DuckDBIngestionWorkflow
  • CLI duckdb subcommand reference
  • Performance notes
  • Out of scope
• Snowflake Export
  • Overview
  • Installation
  • Quickstart — export_to_snowflake
  • Advanced usage — SnowflakeExportSink directly
  • Manifest output
  • Idempotency
  • Error handling and retries
  • Stage lifecycle and cleanup
  • CLI reference
  • Configuration reference
  • Out of scope
• Orchestration
  • Quick start
  • Public API
  • Errors
  • MultiStudyOrchestrator
  • OrchestratorResult
  • StudyContextLogAdapter
  • StudyWorkerCallable
  • make_study_logger()
  • MultiStudyOrchestrator
  • StudyContextLogAdapter
  • OrchestratorResult
  • StudyWorkerCallable
  • Orchestration Errors
• Record Mapping Process
• Streamlit Dashboard Installation and Usage
  • Installation
  • Authentication
  • Deployment
• Verification Loop

Explanation:

• Architecture Overview
  • Components
  • Core Client
  • HTTP Transport Contract
  • Async Client
  • Endpoints
  • Workflows
  • Caching
  • CLI
  • Data Flow
  • Extension Points
  • Adding New Endpoints
  • Adding New Workflows
  • Export Sink Architecture
• API Overview
  • Lifecycle Management
  • Base URL
  • Authentication
  • HTTP methods and errors
  • Filtering
  • Filter helper
  • Error responses
  • Integrations and analytical exports
• Model Parsing
  • Overview
  • Strategy Pattern
  • API Reference
  • Usage Examples
  • Integration with Endpoints
  • Best Practices
• Schema Validation Flow
  • Offline Example
• Plugin Authoring Guide
  • Streamlit Dashboard Plugin (imednet-streamlit)
  • Plugin authoring reference
  • How it works
  • Plugin contract
  • Minimal working example
  • Registering the entry point
  • Error handling
  • API reference
• Workflow Interactions
  • Data Extraction
  • Record Update
  • Subject Data
  • Query Management
  • Background Sync Worker
• Refactoring Patterns
  • Executive Summary
  • Endpoint Composition Standard
  • 1. Code Duplication & DRY Violations
  • 2. SOLID Principle Violations
  • 3. Architectural Improvements
  • 4. Code Quality Issues

Reference:

• Mednet EDC REST API Reference
  • Overview
  • Base URL
  • Security
  • Headers
  • HTTP verbs
  • Status codes
  • Filtering
  • Error responses
• Configuration
  • Environment Variables
  • Using a .env File
  • Parsing Values
  • Troubleshooting
• Agent and Contributor Rules
  • Stack Identification
  • Immutable Constraints
• Refactoring Roadmaps
  • Implementation Roadmap
  • Testing Strategy
  • Risks & Mitigation
  • Success Metrics
  • References
• Streamlit Dashboard Reference
  • Dashboard Pages
  • Configuration Reference
  • Architecture Notes
• Test Skip Conditions
  • End-to-End Tests
  • Unit Test Exceptions
• Live Test Charter
  • 1. Purpose
  • 2. Scope
  • 3. Mutation policy
  • 4. Environment prerequisites
  • 5. Discovery rules
  • 6. Pass / skip / fail semantics
  • 7. Observability expectations
  • 8. Maintainer runbook
• Live (End-to-End) Test Plan
  • Endpoints
  • SDK Utilities
  • Workflow Helpers
  • CLI Commands
  • Integrations
• Live Test Overview
  • CLI Tests (test_cli_live.py)
  • Endpoint Tests
  • Schema Validation (test_schema_validator_live.py)
  • SDK Utility Helpers (test_sdk_utilities_live.py)
  • Integration Helpers (test_integrations_live.py)
  • Workflow Tests (test_workflows_live.py)
  • Fake Data Utilities
  • Expected Results
• Contributing
  • Issue Management
  • Project Standards
  • Triage Playbook
  • Public API stability
  • Issue reporting and triage
  • HTTP transport mocking
• Issue Management
  • Goals
  • Issue hierarchy
  • Title convention
  • Label taxonomy
  • Required issue content
  • Definition of Ready
  • Definition of Done
  • Epic requirements
  • Implementation issue requirements
  • PR linkage
  • Migration guidance for existing issues
• Project Standards
  • Dependency policy
  • Verification loop
  • Architecture boundaries
  • Credential handling
  • Testing standards
  • Docs standards
  • PR and release standards
  • Issue metadata expectations
• Triage Playbook
  • Triage objectives
  • New issue workflow
  • Required maintainer checks
  • How to rewrite weak issues
  • Prioritization rubric
  • Epic and sub-issue management
  • Duplicates and overlap
  • Blocked and stale issues
  • Definition of done for triage
• Governance — Trust, Traceability & Audit Trail
  • Configuration Version Control
  • Publisher Wizard (Streamlit page)
  • Data Lineage Explorer (Streamlit page)
• Verification Reports
  • Unified Verification Model
  • Extending the Report Schema
  • Writing Reports in CI
• imednet
  • imednet package
• imednet_sinks
  • imednet_sinks package
• imednet_streamlit
  • imednet_streamlit package
• imednet_workflows
  • imednet_workflows package
• apache_airflow_providers_imednet
  • apache_airflow_providers_imednet package

Indices and tables

• Index

• Module Index

• Search Page