Appearance
Integrations
Medipal is built to be extended and connected. This section is for people who work with the platform from the outside: developers integrating other systems, developers building plugins, teams connecting an electronic health record, and partners who run their own Medipal instance.
Who this section is for
| Audience | Goal | Start with |
|---|---|---|
| API integrators | Read and write Medipal data from another system | API Access, Events & Webhooks |
| Plugin developers | Add new actions to workflows or new panels to the web application | Server Plugins, Frontend Plugins |
| EHR integrators | Link Medipal patients to hospital records and show clinical data next to questionnaires | EHR Connectors |
| Deploying partners | Run a Medipal instance for an organisation | Deploying an Instance |
| Questionnaire builders | Create custom questionnaire engines and question components | Questionnaire Engine |
Shared concepts
- Instance — one deployment of Medipal serving one organisation. Every instance has its own web application address, API address, users, data and configuration.
- API key — a long-lived credential created by an administrator for a specific integration, carrying a chosen subset of permissions. See API Keys.
- Scopes — fine-grained permissions of the form
resource:actionthat every API call is checked against. See Users, Roles & Scopes. - Vault — encrypted storage for secrets such as tokens and passwords, referenced from configuration instead of being pasted into it. See Vault.
- Private registry — Medipal's SDKs, client packages, container images and charts are distributed through a private registry. Access is granted during partner onboarding.
What you need
| Need | API integrator | Plugin developer | EHR integrator | Deploying partner |
|---|---|---|---|---|
| An instance to work against | ✓ | ✓ | ✓ | provides one |
| An API key with the right scopes | ✓ | for host access | ✓ | |
| Access to the private package registry | for the TypeScript client | ✓ | ✓ | |
| Access to the private container registry | ✓ | |||
| A Kubernetes cluster | ✓ |
Reading order
- Core Concepts if you are new to the platform.
- Security Model to understand authentication and permissions.
- The page for your audience from the table above.
- Troubleshooting for the problems administrators see most often.