Developers & API
An EHR that's actually programmable.
REST + FHIR R4 APIs. OpenAPI specs. Webhooks. OAuth 2.0 / SMART-on-FHIR. Sandbox tenants on request.
- FHIR R4
- OpenAPI 3.1
- OAuth 2.0
- SMART-on-FHIR
- HL7 v2
- resourceType
- "Patient"
- identifier.system
- "abha"
- identifier.value
- "91-1234-5678-9012"
- name
- "Priya Ramachandran"
Quick start
From sandbox to your first FHIR call.
-
1
Request a sandbox tenant.
We set it up for you, pre-seeded with synthetic patient data.
-
2
Create an API client.
OAuth 2.0
client_credentialsflow. Scopes are FHIR-style. -
3
Make your first request.
Read a Patient, search Observations, post an Encounter.
# Get a token
curl -X POST "https://api.carexaos.com/oauth/token" \
-d "grant_type=client_credentials" \
-d "client_id=$CARE_ID" \
-d "client_secret=$CARE_SECRET" \
-d "scope=patient/*.read"
# Read a Patient resource (FHIR R4)
curl -H "Authorization: Bearer $TOKEN" \
"https://api.carexaos.com/fhir/r4/Patient/abha-91-1234"
# Response (truncated)
{
"resourceType": "Patient",
"id": "abha-91-1234",
"identifier": [{ "system": "abha", "value": "91-1234-5678-9012" }],
"name": [{ "given": ["Priya"], "family": "Ramachandran" }]
}
FHIR R4 resources
Every clinical write speaks FHIR over the wire.
- PatientDemographics · ABHA · contact
- EncounterOPD · IPD · ED · OT
- ObservationVitals · labs (LOINC)
- ConditionProblem list (ICD-10 / SNOMED)
- MedicationRequestRx (RxNorm)
- ServiceRequestLab / radiology orders
- DiagnosticReportLab / imaging results
- ImmunizationVaccine records
- AppointmentScheduling
- AllergyIntoleranceAllergies
- ProcedureOperative records
- BundleABDM-ready exchanges
Developer resources
Everything you need.
API documentation is provided to customers and integration partners on request. Here is what it covers.
API reference
OpenAPI 3.1 specification, with request and response examples.
FHIR R4 capability statement
Resources, search params, profiles, ABDM bundles.
Webhooks
Events · signatures · retry policy · dead-letter queue.
OAuth + SMART-on-FHIR
Scopes, launch context, EHR-launch & standalone flows.
Data export
Your records as FHIR Bundles plus a full database export, so your data stays yours.
HL7 v2 listener
For lab analyser and PACS integration in older networks.
ABDM exchanges
ABHA lookup, consent requests and FHIR bundles for consent-based record sharing.
Integration support
Our engineers work with your team or integration partner on each connection.
Scoped and logged
Every API client is scoped by role, and every write lands in the append-only audit log.
Build against a sandbox tenant.
Pre-seeded with synthetic patient data, so you can read a Patient, search Observations and post an Encounter from day one.