v1
latestOpenAPI 3.0.32026-07-26229361630.0 KBCreate IPD Admission
Overview
This API creates a single IPD (In-Patient Department) admission, 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, and the admission's lifecycle state.
The admission id is server-generated and the acting oid (from the auth header) is recorded as actor_oid; neither is accepted in the request body. The billing totals (totalbilled/totalpaid), timestamps (created_at/updated_at) and archived flag are also owned by the server and must not be supplied.
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. When omitted, stage defaults to the active inpatient stage (AD) and status defaults to BED_ASSIGNED.
The admission_date and date fields are optional ISO-8601 date-time strings and default to the server now when omitted. All timestamp fields are returned as ISO-8601 date-time strings.
Not every detail is mandatory: insurance, procedures, notes, medico_legal_case and custom_attributes are all optional.
Headers
Request body
Response
Created — the newly created IPD admission.