Hospital systems

Patients, appointments, encounters and invoices for a hospital that runs its own HIS.
OpenAPI file

Base URL: https://api.shwaash.mytmakaan.com/v1 · 40 operations

MethodPathWhat it does
GET/api-clientsList api clients
POST/api-clientsCreate api clients
GET/api-clients/{apiclientId}/webhook-endpointsList webhook endpoints
POST/api-clients/{apiclientId}/webhook-endpointsCreate webhook endpoints
GET/api-clients/{id}Get one of api clients
PATCH/api-clients/{id}Edit api clients
POST/api-clients/{id}/rotate-keyRotate a partner access key; the response shows the new key once
GET/api-docs/{scope}Partner API documentation (OpenAPI) for one scope: labs, insurers, devices, hospital app, mytmakaan
POST/auth/logoutEnd this session
POST/auth/otp/requestSend a login OTP to a mobile number (SMS with DLT template, or WhatsApp)
POST/auth/otp/verifyVerify the OTP. Consumers get a session; staff and partners must also pass the second factor
POST/auth/passwordStaff and partner login with password; returns a second-factor challenge
POST/auth/refreshRotate the session tokens
POST/auth/second-factor/enrolEnrol an authenticator app as second factor
POST/auth/second-factor/verifyVerify the second factor (TOTP or OTP) and start the session
POST/auth/sso/mytmakaanSingle sign-on from mytmakaan (OIDC). Exact scope waits for Q-02
POST/checkins/qrQR self check-in from the poster: short form, UPI payment if unpaid, then join the live queue
GET/files/{id}/download-urlExpiring signed download link, only if the caller may view the record the file belongs to. The view is written to the audit log
POST/files/upload-urlSigned upload URL on India object storage; creates the files row
GET/hospitalsList hospitals
GET/hospitals/{id}Get one of hospitals
GET/i18n/{languageCode}Translation bundle for an app and language. A new language is data, not a release
GET/invoicesList invoices
GET/invoices/{id}Get one of invoices
GET/invoices/{id}/pdfBranded GST invoice PDF with batch and expiry where relevant
GET/invoices/{id}/transitionsNext Invoice payment status steps the caller may take now
POST/invoices/{id}/transitionsMove one of invoices through its lifecycle (Invoice payment status)
GET/languagesList languages
GET/languages/{id}Get one of languages
GET/meThe signed-in account: profiles it acts for, staff memberships and partner memberships
GET/permissionsList permissions
GET/permissions/{id}Get one of permissions
GET/persons/{id}/emergency-cardEmergency medical ID as shown on the lock screen and sent to the crew on SOS
GET/queues/{departmentId}/boardWaiting-room display: current, next and expected waits
GET/second-opinions/specialistsSpecialists who accept second opinions, with fee and turnaround
POST/uhi/callbacks/{action}UHI (Beckn) callbacks: search, select, init, confirm, status, cancel for our doctors and ambulances
GET/webhook-endpoints/{id}Get one of webhook endpoints
PATCH/webhook-endpoints/{id}Edit webhook endpoints
DELETE/webhook-endpoints/{id}Delete webhook endpoints
POST/webhook-endpoints/{id}/testSend a signed test delivery to a partner webhook