Get IPD Admission
Overview
This API fetches a single IPD (In-Patient Department) admission by its id, scoped to the caller’s business (b-id). An admission document captures the full in-patient episode — the patient, their attendee, insurance, bed and rateplan, the responsible doctor/department/facility, billing totals, and the admission’s lifecycle state.
The admission’s lifecycle is tracked with two fields: a coarse stage (IN → Recommended Admission, AD → active Admission, DC → Discharged) and a granular status within that stage (for example ADMISSION_CONFIRMED, BED_ASSIGNED, UNDER_CARE, DISCHARGED).
The admission_id path param is the admission id. All timestamp fields are returned as ISO-8601 date-time strings.
Headers
Path Parameters
Id of the IPD admission to fetch (document id under ipd/{b-id}/admissions).
Response
OK — the requested IPD admission.
Admission document id.
Business id the admission belongs to.
Admission date-time as an ISO-8601 string.
Discharge date-time as an ISO-8601 string. Present once discharged.
Patient IPD case number.
The responsible doctor (id + name).
Coarse lifecycle stage of the admission.
IN, AD, DC Granular lifecycle status within the current stage.
ADMISSION_RECOMMENDED, ADMISSION_ON_HOLD, ADMISSION_CONFIRMED, ADMISSION_CANCELLED, BED_ASSIGNED, UNDER_CARE, NOT_RECEIVED, FIT_FOR_DISCHARGE, DISCHARGE_INITIATED, REFERRAL_INITIATED, LAMA_IN_PROGRESS, DAMA_IN_PROGRESS, DEATH_BEING_RECORDED, PATIENT_MISSING, DISCHARGED, LAMA_COMPLETED, DAMA_COMPLETED, REFERRED, DECEASED, ABSCONDED Creation date-time as an ISO-8601 string.
Last-update date-time as an ISO-8601 string.
Total amount billed for the admission.
Total amount paid against the admission.
Map of custom attribute keys to arrays of string values.
Denormalized discharge-clearance state.
oid of the actor that last acted on the admission.

