Integration Guide
Many providers already run an EMR or EHR they are happy with. Elix does not ask them to replace it. A facility can keep its record system and use Elix for the services it lacks, such as the lab, the pharmacy, the blood bank, billing or maternal care, with patients and results passing between the two systems.
This guide covers three things:
- Authentication: how a partner system signs in and which headers every call carries.
- FHIR exchange: what Elix reads and writes as HL7 FHIR R4, and how signed callbacks work.
- Connect your EMR: the steps to link an external record system, from credentials to go-live.
Three ways to exchange data
| Method | Direction | Use it for |
|---|---|---|
| REST API | Your system calls Elix | Finding patients, keeping a copy of the register, reading results |
| FHIR R4 | Both | Standard resources: Encounter, ServiceRequest, Observation, DiagnosticReport, Patient |
| Signed callbacks | The other system calls Elix | Confirming that a record Elix sent was accepted, and status changes |
Base address
All partner calls go through the Elix API gateway:
https://api.app.elix.ng/api/v1
Each service sits under its own prefix, for example /api/v1/patients or /api/v1/encounters. The API reference lists every endpoint documented for partners.
Ground rules
- One tenant per credential. A credential belongs to one Elix tenant and only ever sees that tenant's data. A record in another tenant answers as not found.
- Least privilege. A partner account holds only the permissions its integration needs. Elix refuses anything else with
403. - Purpose of use. Every patient-identifiable read states why it is being made. The read is checked against the patient's privacy setting and written to their access log.
- Signed, not trusted. Anything that calls Elix without a bearer token, such as a callback, must sign its request. Unsigned or wrongly signed requests are refused.
Getting access
API access is set up per tenant. To start, write to sales@elix.ng with the facility you are integrating, the system you run, and the data you need to exchange. We will agree the scope with you and the facility, then issue credentials.