iClinic Developers

Versioning & changelog

The version of the iClinic Integration API is part of the URL path (/v1). Within one version, changes are only additions: a new response field, a new enum value or a new optional parameter. A change that breaks compatibility ships as a new version (/v2).

For this reason, your client should ignore fields it does not recognize and should not assume that the list of status values is fixed.

Changelog

1.1.0
Added read scopes for API keys. Added GET /patients, /appointments, /receipts, /therapy-plans and GET …/{id} for each type, with incremental sync through updatedSince and a cursor. /encounters now returns patientId, followUpDate and updatedAt. The version is still /v1, and existing keys keep their encounters:read scope.
1.0.0
First release: GET /encounters, authenticated with a fixed API key, with paging and a rate limit. It replaces Medi's encounter API, which is no longer in service.
OpenAPI 3.1Download
https://iclinic.phongkhamhieploi.vn/developers/openapi.en.json

# Import into Postman, Insomnia or a code generator:
npx @openapitools/openapi-generator-cli generate \
  -i https://iclinic.phongkhamhieploi.vn/developers/openapi.en.json \
  -g typescript-fetch -o ./iclinic-client