PortalVersion 1.0 — 202615 min read

Developer Portal

Building Healthcare Applications on Aimedis

Your complete onboarding guide — from creating your first developer account to deploying production healthcare applications using the Aimedis platform.

Sections

Getting StartedAuthentication and IdentityCore Platform APIsInteroperability APIsAI Development ToolsXR Development Platform
01

Getting Started

Getting started with Aimedis development takes just five steps. Follow this checklist to go from registration to your first API call.

01

Create a Developer Account

Register on the Aimedis Developer Portal with your organization details to gain platform access.

02

Register an Application

Provide your app name, description, and redirect URI to receive a unique application identifier.

03

Generate API Credentials

Obtain your CLIENT_ID and CLIENT_SECRET from the application dashboard.

04

Configure Authentication

Implement the OAuth2 client credentials or authorization code flow in your application.

05

Access Developer Sandbox

Test integrations safely using synthetic healthcare data without touching real patient records.

credentials.envENV
CLIENT_ID=aimedis_dev_app_123
CLIENT_SECRET=*************
02

Authentication and Identity

All Aimedis APIs use OAuth2-based authentication. Your application must obtain a valid bearer token before making any API calls.

Supported Auth Methods

OAuth2 client credentials flow for server-to-server apps
OAuth2 authorization code flow for patient-facing applications
JWT bearer token validation on all API endpoints
Refresh token support for long-lived sessions

Authentication Flow

1
User Login
2
Identity Verification
3
Consent Authorization
4
API Token Issued
5
Application Access
03

Core Platform APIs

The Aimedis API exposes five primary domain areas that cover the core functionality of the healthcare platform.

Patient Data APIs

Access structured patient demographic information and manage patient records within your application.

GET/api/patients/{patientId}

Medical Records APIs

Retrieve clinical records, observations, conditions, and medical history for authorized patients.

GET/api/records/{recordId}

Appointment APIs

Create and manage appointments between patients and healthcare providers in your application.

POST/api/appointments

Consent APIs

Read and manage patient consent records governing what data your application can access.

GET/api/consents/{patientId}

Telehealth APIs

Initiate and manage secure telehealth consultation sessions with video and messaging capabilities.

POST/api/telehealth/session
04

Interoperability APIs

Aimedis implements the HL7 FHIR R4 standard and HL7 v2 messaging protocols for full healthcare system interoperability.

FHIR Integration

Supported FHIR R4 resources:

PatientEncounterObservationConditionProcedureMedicationRequestDiagnosticReport
FHIR Request ExampleHTTP
GET /api/fhir/Observation/{id}
Authorization: Bearer {access_token}

HL7 Integration

ADTORUORM
05

AI Development Tools

The Aimedis platform provides AI developers with structured data pipelines and integration hooks for building clinical intelligence features.

AI Capabilities

Clinical data preprocessing pipeline access
Structured FHIR-compliant AI training data schemas
Medical imaging analysis API hooks
Predictive risk model integration endpoints
Natural language processing for clinical note analysis

Future AI Platform Capabilities

Advanced diagnostic AI model marketplace
Federated learning infrastructure for privacy-preserving training
Real-time clinical decision support APIs
Specialized imaging analysis modules
06

XR Development Platform

Build immersive healthcare experiences using the Aimedis XR platform APIs — compatible with all major 3D development engines.

XR Use Cases

3D anatomy education and visualization environments
Surgical simulation and procedural training modules
Virtual clinical consultation spaces
Patient education and treatment visualization
Collaborative remote medical workspaces

Supported Development Engines

UnityUnreal EngineWebXR
07

Data Governance and Compliance

The Aimedis platform enforces platform-level governance controls. All applications built on the platform inherit these protections automatically.

End-to-end encryption enforced on all medical data in transit and at rest
Patient consent verification on every data access request
Immutable audit logs for all API interactions and data access events
GDPR and healthcare privacy standard compliance built into the platform layer
08

SDKs and Development Libraries

Official Aimedis SDKs are available for all major development platforms and languages.

Available SDKs

JavaScriptPythonJavaSwiftKotlin

SDK Utilities Included

Authentication helpers and token management
FHIR resource serialization and deserialization
API client auto-generation from OpenAPI spec
Webhook event handler utilities
09

Developer Sandbox

The Aimedis developer sandbox provides a full-featured testing environment isolated from production patient data.

Synthetic patient data generation

Realistic FHIR-compliant test patient records with no real data.

Test appointment and session creation

Full lifecycle testing of scheduling and telehealth flows.

AI pipeline sandbox environment

Run AI integrations against anonymized test datasets.

Full API parity with production

All production endpoints available — no sandbox-specific limitations.

Sandbox ensures developers can safely build and test healthcare applications before deploying to production.

10

Ecosystem Marketplace

Future Concept

The Aimedis ecosystem marketplace will enable developers to publish, discover, and integrate healthcare applications and services within the platform.

1Build and list independent healthcare applications
2Contribute specialized AI models to the platform model library
3Develop XR training modules for medical education
4Create integrations with third-party healthcare systems
5Publish open-source SDK extensions and platform tools
11

Community and Support

The Aimedis developer community provides resources, collaboration opportunities, and technical support.

Developer Documentation

Comprehensive API reference and integration guides.

GitHub Repositories

Open-source SDKs, code examples, and starter templates.

Developer Community Forum

Ask questions, share solutions, and connect with other developers.

Technical Support Portal

Direct technical assistance for platform integration issues.

12

Building the Future

The Aimedis Developer Portal gives you the foundation to build healthcare applications that can improve patient outcomes at scale.

From secure API access and FHIR-compliant data exchange to AI pipelines and immersive XR environments — the platform provides everything a healthcare developer needs.

Join the Aimedis developer ecosystem and build the next generation of intelligent healthcare applications.

Read Developer GuideRead API Reference