Integration overview
Developer Guide
How the platforms connect: patient record shares, bookings, intake, professional status and the interfaces of each product.
Read document Developer GuideDeveloper resources
Build with Aimedis. Start with the right API.
Connect your AI to reviewed Wiki evidence and terminology, or connect a system to the Aimedis care platforms. Each interface has its own credential, issued by the owner of the data.
Aimedis Wiki · AI integration
Your model. Traceable evidence.
Retrieve reviewed reference excerpts from Wiki over HTTP, research the four sources every AVA uses, or look up ICD-10 and ICD-11 codes, then pass the evidence to your chosen AI. Preserve the source, version and licence with every answer.
POST https://wiki.aimedis.com
Arrange access
Ask a Wiki administrator to issue an API key (awr_…) for your application in Integrations, and store it only on your server.
Retrieve evidence
Send a general knowledge query from your application server.
Ground your answer
Give excerpts to your AI and show citations or insufficient evidence.
Authenticate with Authorization: Bearer <awr_ key>. A Wiki administrator issues each key once in Integrations, bound to one application; administrator sessions and browser cookies are not accepted by this API. Keys can be issued for any Aimedis application or a custom application ID; each key reads the published, reviewed reference sources open to its application, within 120 requests per minute.
Care platform integrations
Understand the platform before you connect.
These guides document the interfaces the Aimedis care platforms offer other systems today: patient-granted FHIR R4 access in Aimedis Care, the practice-software interface of Aimedis Pro (FHIR R4 and HL7 v2.5.1), and the files people can download or upload. They also say plainly what is not offered.Reference documents follow your selected language.
- Access & onboarding
Access and Credentials
Who issues each credential, a patient record share step by step, and a checklist before going live.
Read document Access and Credentials - API reference
Platform API Overview
Endpoints, parameters, example requests and responses, errors and limits of the care-platform interfaces.
Read document Platform API Overview - Architecture
System Architecture
How care applications, consent and the separate Wiki reference library fit together.
Read document System Architecture
Planning a platform integration?
Tell us which product, workflow and data you need, especially if the interfaces documented here do not cover it.