Platform API Overview

These examples explain consent-gated clinical access, FHIR resource patterns, and specialist modules. Confirm the actual interface with the owning service before implementation. Aimedis Wiki reference retrieval has a separate API contract.

What you can build

Platform provides access to

Request clinical API access through the partner program. The examples use patient- or practitioner-scoped Bearer tokens; confirm the actual service origin, credentials, consent checks, and audit guarantees before implementation.

GET /api/consent/grants
Authorization: Bearer {patient_token}

These illustrative operations manage consent grants for clinical access. The partner service defines the corresponding protected record-read contract; grant metadata alone is not a clinical record response.

POST /api/consent/generate
Authorization: Bearer {patient_token}
Content-Type: application/json

{
  "scope": ["vitals", "diagnoses", "medications", "allergies"],
  "duration": "30d",
  "pinType": "multi_use"
}

{
  "patientId": "pat-001",
  "pin": "482917",
  "qrPayload": "aimedis://consent?id=pat-001&token=...",
  "expiresAt": "2026-08-16T23:59:59Z",
  "pinExpiresAt": "2026-07-18T22:00:00Z"
}

POST /api/consent/redeem
Authorization: Bearer {practitioner_token}
Content-Type: application/json

{
  "patientId": "pat-001",
  "pin": "482917"
}

{
  "granted": true,
  "consentId": "consent-xyz",
  "patientId": "pat-001",
  "scope": ["vitals", "diagnoses", "medications", "allergies"],
  "expiresAt": "2026-08-16T23:59:59Z"
}

{ "granted": false, "reason": "invalid_pin" }

GET /api/consent/grants
Authorization: Bearer {patient_token}

[
  {
    "consentId": "consent-xyz",
    "scope": ["vitals", "diagnoses", "medications", "allergies"],
    "grantedAt": "2026-07-16T14:30:00Z",
    "expiresAt": "2026-08-16T23:59:59Z",
    "status": "active"
  }
]

DELETE /api/consent/grants/consent-xyz
Authorization: Bearer {patient_token}

{
  "consentId": "consent-xyz",
  "status": "revoked",
  "revokedAt": "2026-07-16T15:02:00Z"
}

Mechanics

Compliance

FHIR R4 resource types provide the clinical data model illustrated below. The consent examples above return grant metadata only. The partner service supplies the protected record-read endpoint and its response schema; confirm how the grant is applied before retrieving any patient data.

Resource types by consent scope

Sensitive categories can use the same FHIR resource types with additional classification and authorization rules. Confirm the service’s actual tags, scopes, and explicit-consent requirements.

The following examples outline specialist clinical and operational integration areas. Each owning service must confirm its actual endpoints, credentials, permissions, consent requirements, and audit behavior. Wiki reference retrieval follows its separately documented contract.

Aimedis Rehab — Neurorehabilitation

AI + XR neurorehabilitation: validated clinical scales with automatic scoring, immersive XR training environments, wearable integrations, and the clinician benchmark radar.

{
  "patientId": "12345",
  "scale": "BergBalance",
  "score": 42,
  "maxScore": 56,
  "interpretationBand": "moderate-fall-risk",
  "scoredAt": "2026-06-30T10:15:00Z"
}

{
  "patientId": "12345",
  "environmentId": "balance-garden",
  "platform": "meta-quest",
  "adaptiveDifficulty": true,
  "maxParticipants": 8
}

Aimedis Insur — Insurance Engagement

White-label health-insurance engagement: the proprietary 7-dimension benchmark score, a five-tier premium rewards engine, AI-recommended daily tasks, and the bidirectional Care Pro EHR connector.

{
  "memberId": "M-4471",
  "benchmarkScore": 742,
  "dimensions": {
    "activity": 84,
    "nutrition": 71,
    "sleep": 66
  }
}

{
  "memberId": "M-4471",
  "verificationType": "device",
  "source": "withings",
  "value": 8200
}

Aimedis Decision Pro — Clinical Decision Support

Clinical decision support assists patient-professional communication and remains non-binding. A licensed clinician reviews the result. Confirm Decision Pro’s accepted authorization and the separate protected record-read contract; PIN redemption alone does not prove record access.

{
  "careLevel": "specialist",
  "suggestedSpecialty": "neurology",
  "icd10gm": ["G43.9"],
  "selfReportedConfidence": 0.71,
  "binding": false,
  "disclaimer": "Non-binding decision support. The licensed clinician decides."
}

{
  "patientId": "12345",
  "pin": "480913",
  "scope": "care-record"
}

Aimedis Support — Support & Feedback Command Center

Unified support and feedback: the AVA support assistant, a community support board with a six-stage resolution workflow, polls and multi-page surveys, NPS campaigns, and governance moderation.

{
  "surveyId": "srv-2026-q3",
  "answers": [
    { "questionId": "q1", "type": "nps", "value": 9 }
  ],
  "anonymous": true
}

The platform family uses integration patterns for account linking, booking handoffs, intake, and professional verification. Confirm which services participate and how authorization is enforced in your deployment.

AVA appears in product-specific assistant surfaces, with advertised support for 30+ conversational languages. Capabilities and language coverage depend on the application. The following Support endpoint is illustrative; confirm partner availability and authentication with the service owner: /api/support/ava/chat Confirm the approved service contract before connecting.

Roadmap items do not establish availability or delivery dates. Confirm the production API and audit guarantees with the owning service during partner onboarding.