API ReferenceVersion 1.0 — 202625 min read

Aimedis API Reference

Unified Developer Documentation — Complete Platform Integration Guide

The complete API reference unifying the Developer Guide and Portal — with code examples, request/response schemas, auth flows, and full integration patterns for all platform capabilities.

Sections

IntroductionPlatform ArchitectureGetting StartedAuthentication & IdentityPatients APIHealthcare Data APIs
01

Introduction

The Aimedis API provides comprehensive access to a secure, FHIR-compliant healthcare platform infrastructure. This reference covers all endpoints, authentication flows, and integration patterns.

What you can build

Patient-facing health management applications
Clinical decision support tools
AI-powered diagnostic assistants
XR medical training environments
Telehealth consultation platforms
Healthcare research analytics systems
FHIR-compliant data exchange services

Platform provides access to

Authenticated REST API access to healthcare data
FHIR R4 compliant resource endpoints
OAuth2 identity and consent management
AI data pipeline infrastructure
XR development platform APIs
02

Platform Architecture

The Aimedis platform is organized into six layers. Understanding this architecture helps you identify which APIs to use for each integration scenario.

1

Identity & Access Layer

Authentication, user identity, consent management and session governance.

2

Healthcare Data Infrastructure

Encrypted storage, audit logging, and consent-driven access to all medical records.

3

Interoperability Layer

FHIR R4, HL7 v2 messaging, and REST healthcare APIs for system integration.

4

Application Services Layer

Patient portal, telehealth infrastructure, and developer API access surface.

5

AI Services Layer

Medical data pipelines, predictive analytics engines, and clinical AI tools.

6

XR Layer

Immersive healthcare environments, medical training simulations, and XR collaboration.

03

Getting Started

1

Create a Developer Account

Register at the Aimedis Developer Portal with your organization details.

2

Register an Application

App nameDescriptionRedirect URIOrganization
3

Obtain API Keys

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

Authenticate

HTTP
POST /oauth/token
5

Access APIs

Use your bearer token to call any platform API endpoint with the Authorization header.

04

Authentication & Identity

All API access uses OAuth2 bearer tokens. Tokens expire after 3600 seconds and must be refreshed.

1
Application Authenticates
2
Token Issued by Auth Server
3
Bearer Token Added to Requests
4
API Validates Token
5
Data Returned
Authentication RequestJSON
POST /oauth/token
Content-Type: application/json

{
  "client_id": "app_id",
  "client_secret": "secret",
  "grant_type": "client_credentials"
}
ResponseJSON
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR...",
  "token_type": "Bearer",
  "expires_in": 3600
}
05

Patients API

The Patients API provides access to patient demographic information. All requests require a valid access token and active patient consent.

GET
/api/patients/{patientId}

Retrieve patient demographic information and consent status.

ResponseJSON
{
  "patientId": "12345",
  "name": "Jane Doe",
  "dateOfBirth": "1984-05-20",
  "consentStatus": "active"
}
06

Healthcare Data APIs (FHIR/HL7)

Access clinical data using FHIR R4 compliant endpoints. All clinical resources are returned in the standard FHIR JSON format.

Supported FHIR Resources

PatientEncounterObservationConditionProcedureMedicationRequestDiagnosticReportAllergyIntolerance
GET
/api/fhir/Patient/{id}

Retrieve a FHIR Patient resource by identifier.

FHIR Patient ResponseJSON
{
  "resourceType": "Patient",
  "id": "123",
  "name": [
    {
      "family": "Doe",
      "given": ["Jane"]
    }
  ],
  "birthDate": "1984-05-20"
}

HL7 v2 Messaging

ADTORUORM
HL7
MSH|^~\&|HOSPITAL|LAB|AIMEDIS
PID|1||123456||DOE^JANE
OBR|1||ORDER123
07

Telehealth APIs

Integrate virtual care capabilities into your application using the Aimedis Telehealth API.

Secure encrypted video consultation sessions
Real-time clinical chat and messaging
Digital prescription and referral workflows
Remote patient monitoring integration
POST
/api/telehealth/session

Create a new secure telehealth consultation session.

GET
/api/appointments

List all appointments for an authenticated patient or provider.

POST
/api/appointments

Create a new appointment between a patient and provider.

Request BodyJSON
{
  "patientId": "12345",
  "providerId": "9876",
  "time": "2026-04-10T09:00:00",
  "type": "video"
}
08

AI Integration Framework

The Aimedis AI framework provides structured pipelines for building clinical intelligence features on top of the platform's healthcare data.

AI Use Cases

1Diagnostic image analysis assistance
2Predictive risk scoring for patient populations
3Automated clinical note and summary generation
4Drug interaction and medication safety verification
5Clinical trial patient matching algorithms
6Natural language processing for medical records

AI Data Pipeline

1
Data Collection
2
Anonymization
3
AI Model Training
4
Model Deployment
5
Clinical Integration

AI results must always remain clinician-assisted tools, not autonomous medical decision systems.

09

XR Development

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

XR Use Cases

Anatomy education and 3D medical visualization
Surgical simulation and procedural training
Virtual clinical consultation environments
Patient education and treatment visualization

Supported Engines

UnityUnreal EngineWebXR

Platform API Access

Patient identity lookupMedical record retrievalAI model inference APIsReal-time collaboration sessions
10

SDKs

Official Aimedis SDKs reduce integration complexity across all supported platforms.

JavaScriptPythonJavaSwiftKotlin

SDK Utilities

OAuth2 token management and auto-refresh
FHIR resource serialization / deserialization
Webhook event listener utilities
OpenAPI auto-generated client stubs
11

Data Governance & Compliance

All platform applications inherit Aimedis governance controls automatically, reducing individual developer compliance burden.

End-to-end encryption on all medical data
Patient consent verification on every data request
Immutable audit logs for all API interactions

Compliance Regulations

GDPRHIPAA-Inspired PrivacyHL7 FHIR R4ISO 27001
12

Developer Sandbox

The developer sandbox provides a safe environment for building and testing your integration before going live.

Synthetic FHIR patient data

Realistic test records conforming to the FHIR R4 spec.

Full API endpoint parity

All production endpoints available in the sandbox environment.

AI pipeline test environment

Run AI integrations against anonymized synthetic datasets.

Telehealth session simulation

Test full appointment booking and video session flows.

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

13

Ecosystem Development

The Aimedis ecosystem supports a diverse range of healthcare application types. All applications share the same secure infrastructure foundation.

1

Clinical Decision Support Applications

AI-assisted diagnostic and treatment recommendation tools.

2

Telehealth Platforms

Virtual care delivery platforms for remote consultations.

3

Patient Engagement Apps

Portals and mobile apps for health management and education.

4

Research & Analytics Systems

Population health analytics and clinical research platforms.

5

XR Medical Training Modules

Immersive educational content for healthcare professionals.

14

Future Platform Capabilities

Roadmap

The following capabilities are planned for future platform releases.

Federated Learning APIs

Privacy-preserving AI model training across institutions.

Wearable Device Integration

Real-time health monitoring data from IoT medical devices.

Global Health Network

Cross-border healthcare data exchange infrastructure.

AI Model Marketplace

Publishable specialized AI models within the ecosystem.

Blockchain Audit Layer

Immutable compliance records for regulated environments.

Aimedis provides the infrastructure required to build intelligent, interoperable healthcare applications.

Read PortalRead Architecture