Skip to content

End-user install

Step-by-step guide for analysts loading the connector on a personal Windows workstation. For gateway installs, see Gateway admin install.

What you need

  • Windows 10 or 11 with local admin rights.
  • Power BI Desktop (Win32 installer build — the Microsoft Store build does not load custom connectors).
  • Network access to your Clinical Data Repository — default EHRbase base URL is http://<host>:8080/ehrbase/rest/openehr/v1.

The flow at a glance

flowchart TD
    A[Download<br/>OpenEHR.pqx + dev-cert.cer] --> B[Import cert<br/>LocalMachine\Root + TrustedPublisher]
    B --> C[Copy .pqx to<br/>Documents\Power BI Desktop\Custom Connectors]
    C --> D[Restart Power BI Desktop]
    D --> E["Get Data → Other → openEHR (Beta)"]
    E --> F[Enter CDR base URL<br/>+ sign in]

1. Download the release

From the latest GitHub Release grab:

File Purpose
OpenEHR.pqx The signed connector.
dev-cert.cer The public cert — trust this once.
SHA256SUMS.txt Verify integrity before installing.

Verify checksums in an elevated PowerShell prompt:

Get-FileHash .\OpenEHR.pqx -Algorithm SHA256
Get-Content .\SHA256SUMS.txt | Select-String OpenEHR.pqx

2. Trust the publisher (one-time)

v0.1.0 ships with a self-signed cert. Full rationale + future plan on Self-signed cert install.

Import-Certificate -FilePath .\dev-cert.cer -CertStoreLocation Cert:\LocalMachine\Root
Import-Certificate -FilePath .\dev-cert.cer -CertStoreLocation Cert:\LocalMachine\TrustedPublisher

3. Install the connector

$dest = "$env:USERPROFILE\Documents\Power BI Desktop\Custom Connectors"
New-Item -ItemType Directory -Force -Path $dest | Out-Null
Copy-Item .\OpenEHR.pqx -Destination $dest -Force

4. Power BI Desktop settings

File → Options → Security → Data Extensions must be set to:

(Recommended) Allow any extension to load without validation or warning

If your IT policy blocks that, use the fully-validated self-signed path from install-self-signed.md — no setting change required.

5. First sign-in

  1. Fully quit and relaunch Power BI Desktop.
  2. Get Data → Other → openEHR (Beta) → Connect.
  3. Enter your CDR base URL, e.g. http://localhost:8080/ehrbase/rest/openehr/v1.
  4. Choose an authentication method:
  5. The Navigator opens with four folders: Ad-hoc AQL, Stored Queries, Templates, EHRs.

Uninstalling

Remove-Item "$env:USERPROFILE\Documents\Power BI Desktop\Custom Connectors\OpenEHR.pqx"
# Optional: also remove cached credentials in Power BI Desktop
# File → Options → Data source settings → Global permissions → Clear

Next steps

← Back to Home