iClinic Developers

iClinic Integration API · v1 · read-only

Read clinic data with a read-only API key.

The iClinic Integration API gives read-only access to a clinic's encounters (visits), patients, appointments, receipts and therapy plans. Each key reads only the data a clinic admin has granted it, and a key does not expire automatically.

Quickstart Endpoints
Base URL https://iclinic.phongkhamhieploi.vn/api/integration/v1

Try it now

Example
GET /api/integration/v1/encounters
The key stays in this browser and is sent only to iclinic.phongkhamhieploi.vn.
Showing sample data. Paste your API key to see real data.
{
  "requestId": "req_7c1f3a",
  "from": "2026-09-14",
  "to": "2026-09-19",
  "page": 0,
  "pageSize": 200,
  "total": 1,
  "encounters": [
    {
      "id": "BA-000123",
      "encounterUuid": "3f0c9a52-6d1b-4e7a-9b1e-2a4c8d5e7f10",
      "patientName": "Nguyễn Văn A",
      "phone": "0900000001",
      "visitDate": "2026-09-19",
      "checkedInAt": "2026-09-19T02:14:05.000Z",
      "completedAt": null,
      "status": "ONGOING",
      "patientType": "OLD",
      "diagnosis": "Tăng huyết áp",
      "icd10Code": "I10",
      "patientId": "5b0d6a38-3f5a-4a52-8f7c-1d2e9c4b7a10",
      "followUpDate": "2026-09-26",
      "updatedAt": "2026-09-19T03:02:40.000Z"
    }
  ]
}

Quickstart

Three steps to your first data.

  1. Ask a clinic admin to create an API key

    Go to Quản trị (Admin) → Kết nối ngoài (API) (External connections) → Tạo key (Create key), give the key a name you will recognize (for example Tele-sale) and choose the data the key can read. The key, in the form ick_…, is shown only once. Copy it and store it in a safe place immediately.

  2. Make a test call

    Send the key in the Authorization: Bearer header. Use the “Try it now” panel at the top of the page, or run the command shown beside the steps.

  3. Match and store encounters by encounterUuid

    Each encounter has a fixed encounterUuid that never changes. Use it as the deduplication key when you save encounters in your own system.

curl
curl -sS "https://iclinic.phongkhamhieploi.vn/api/integration/v1/encounters?from=2026-09-14&to=2026-09-19&status=all" \
  -H "Authorization: Bearer $ICLINIC_API_KEY"

Read next

You want toGo to
Learn how to send a key and what each key can readAuthentication & scopes
See which endpoints are availableEndpoints
Look up the parameters and response of an endpointEncounters, Patients, Appointments, Receipts, Therapy plans
Fetch a full list that spans many pagesPagination
Fetch only what changed since your last callIncremental sync
Understand an error code, or handle a rate limitErrors & rate limits
Follow a ready-made exampleRecipes
See how dates, times, money and phone numbers are returnedData formats
See the latest changeVersioning & changelog