> ## Documentation Index
> Fetch the complete documentation index at: https://docs.medisync.me/llms.txt
> Use this file to discover all available pages before exploring further.

# The MediSync Agent

> A lightweight on-site connector that securely bridges MediSync to practice systems that run only inside the local network.

Many German practice systems (PVS) run only on a server inside the practice and exchange
data through local, file-based interfaces — they have no internet API for MediSync to
call. The **MediSync Agent** bridges that gap.

## What it is

The Agent is a small desktop application that runs on a workstation in the practice
(**Windows**, with macOS and Linux builds available). It sits in the system tray, keeps
a secure connection to MediSync, and translates between MediSync and the practice
software's existing interfaces.

<CardGroup cols={2}>
  <Card title="Outbound-only" icon="shield-check">
    The Agent makes a **secure outbound connection** to MediSync. **No inbound ports**
    and **no firewall changes** are required at the practice.
  </Card>

  <Card title="Uses existing interfaces" icon="plug">
    It speaks the interfaces your PVS already supports — **GDT**, **HL7 v2**, structured
    **XML**, or a local **FHIR** endpoint — so no changes to your core system are needed.
  </Card>

  <Card title="Runs quietly" icon="window-restore">
    One-click install, tray icon, and automatic start at boot. Practice staff don't have
    to launch anything.
  </Card>

  <Card title="Privacy-preserving" icon="lock">
    Transport is encrypted end to end. The Agent never logs patient data, and nothing is
    stored on it beyond the local configuration.
  </Card>
</CardGroup>

## What it bridges

<CardGroup cols={2}>
  <Card title="GDT / HL7 v2 (file-based)" icon="folder-tree">
    Exchanges records through the import/export folders your PVS is configured to use —
    reading patient context the system drops there and writing examination/result records
    back.
  </Card>

  <Card title="Structured XML" icon="file-code">
    For systems that accept a native XML document format, writes documentation in that
    format (one section per clinical block).
  </Card>

  <Card title="Local FHIR (deep link)" icon="link">
    For systems that expose FHIR only on the local machine, the PVS launches MediSync in
    the current patient's context and the Agent relays FHIR calls to that local endpoint.
  </Card>

  <Card title="On-site FHIR / REST" icon="server">
    For a practice or hospital API that is reachable only inside the network, the Agent
    can relay calls to it so MediSync doesn't need a public endpoint.
  </Card>
</CardGroup>

## Install & pairing

Setup is driven entirely from the dashboard and takes a few minutes.

<Steps>
  <Step title="Start from the dashboard">
    In MediSync, open **Settings → MediSync Connect** and choose **Install Agent**. The
    dashboard offers the installer for your platform and shows a verification hash for the
    download.
  </Step>

  <Step title="Run the installer">
    Installers are **code-signed**. On Windows it's a one-click install that needs no
    administrator rights. The Agent launches automatically when the install finishes.
  </Step>

  <Step title="Pair with a one-time code">
    The dashboard shows a **6-digit pairing code**. Enter it in the Agent's window to link
    it to your practice account. The code is single-use and expires after 15 minutes.
  </Step>

  <Step title="Connect your system">
    Add a connection for your PVS in the dashboard and provide the local interface
    configuration (for GDT/HL7, the same import/export folder your PVS admin set up for
    MediSync). The Agent verifies access, and the tray icon shows **Connected**.
  </Step>
</Steps>

<Note>
  For file-based systems, the practice's PVS administrator first configures an interface
  (e.g. a GDT device named "MediSync") pointing at a shared folder. You then enter that
  **same folder path** in the dashboard — there is no auto-detection, because the path is
  an install-time decision made in the PVS.
</Note>

## Security & compliance

<CardGroup cols={2}>
  <Card title="Encrypted, authenticated transport" icon="lock-keyhole">
    All communication runs over TLS with certificate validation enforced. The Agent
    authenticates to MediSync with its own credentials, established during pairing.
  </Card>

  <Card title="Verified, signed installers" icon="badge-check">
    Installers are code-signed, and the dashboard publishes a SHA-256 hash so practice IT
    can verify the binary before running it.
  </Card>

  <Card title="No PII in logs" icon="eye-slash">
    The Agent is built to never write patient-identifying data to its logs.
  </Card>

  <Card title="Full-disk encryption" icon="hard-drive">
    Because it runs on a clinical workstation, the Agent's install guidance requires
    full-disk encryption (BitLocker / FileVault / LUKS), in line with German medical
    confidentiality obligations (§203 StGB).
  </Card>
</CardGroup>

<Warning>
  The Agent is for practices whose systems run on-site. If your system already exposes a
  reachable FHIR/REST endpoint, no agent is needed — see
  [Direct integration](/connect/connectivity-models#direct-integration).
</Warning>

## Next

<CardGroup cols={2}>
  <Card title="Supported systems" icon="network-wired" href="/connect/supported-systems">
    Which systems use the Agent today.
  </Card>

  <Card title="Getting connected" icon="route" href="/connect/getting-connected">
    The full onboarding flow, step by step.
  </Card>
</CardGroup>