Aimedis API Reference

The Aimedis API provides consent-checked access to a FHIR R4-native healthcare platform. This reference covers the Consent & Access API, FHIR resource patterns, platform module endpoints, and the integration patterns that connect the Aimedis family.

What you can build

Platform provides access to

Access to the Aimedis API is granted through the Aimedis partner program. Consent-gated record access uses Bearer tokens scoped to the patient or the practitioner — every call is consent-checked and written to a tamper-evident audit log.

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

This is the flagship of the Aimedis API — the consent-gated path every platform and specialist product uses to read a patient’s record. Access is a pull model: a professional never sees patient data without an active, valid consent grant.

Authorization: Bearer {patient_token}

{
  "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"
}

Authorization: Bearer {practitioner_token}

{
  "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" }
{ "granted": false, "reason": "pin_expired" }
{ "granted": false, "reason": "patient_not_found" }
{ "granted": false, "reason": "already_granted" }

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"
  }
]

Authorization: Bearer {patient_token}

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

Mechanics

Compliance

Aimedis records are FHIR R4-native: every clinical record — a vital sign, a diagnosis, a medication, an allergy, a lab result, a clinical note — is represented as a standard FHIR R4 resource, exchanged through the consent-checked access API above. There is no separate records endpoint; if a grant covers a scope, the resources for that scope are what the consent API returns.

Resource types by consent scope

Sensitive categories (mental health, HIV/sexual health, substance use) map to the same resource types, tagged and gated behind an explicit opt-in — never included in a default “full record” share.

Beyond the Consent & Access API, four Aimedis specialist products expose their own domain APIs. Every module builds on the shared Aimedis Patient ID + PIN consent model (FHIR R4 Consent, patient-controlled pull), the HL7 FHIR data model, and audit-logged access — so integration patterns stay identical across modules.

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 that cross-functions with — and never replaces — patient-doctor communication. Triage is always non-binding decision support with AVA guideline-cited assistance; the licensed clinician decides. Consent PINs are generated by the patient in the core Consent & Access API — Decision Pro redeems them.

{
  "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 Aimedis family behaves as one system on a single shared account. These are the integration patterns that connect its platforms.

AVA is Aimedis’s AI assistant — one assistant, appearing as a product surface inside Care Pro, Connect, Pro, Rehab, Insur, and Support, in 30+ conversational languages. There is no standalone public AVA API today: AVA is reached through each product’s own surface — for example, the Support module’s /api/support/ava/chat endpoint above.

Clearly labeled roadmap items — not implied live today. The hash-chained audit log referenced throughout this reference is a live capability, not a roadmap item.