Sign in

v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
IPD API

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.

get/appointments/v1/ipd/admission/{admission_id}

Path parameters

admission_idstring required

Id of the IPD admission to fetch (document id under ipd/{b-id}/admissions).

Headers

authstring required

Response

OK — the requested IPD admission.

idstring

Admission document id.

bidstring

Business id the admission belongs to.

admission_datestring

Admission date-time as an ISO-8601 string.

discharge_datestring

Discharge date-time as an ISO-8601 string. Present once discharged.

ipidstring

Patient IPD case number.

notesstring
medico_legal_caseboolean
stage'IN' | 'AD' | 'DC'

Coarse lifecycle stage of the admission.

status'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'

Granular lifecycle status within the current stage.

bedstring
docidstring
datestring
pidstring
created_atstring

Creation date-time as an ISO-8601 string.

updated_atstring

Last-update date-time as an ISO-8601 string.

facilityidstring
totalbillednumber

Total amount billed for the admission.

totalpaidnumber

Total amount paid against the admission.

totalbilled_updated_atstring
totalpaid_updated_atstring
custom_attributesobject

Map of custom attribute keys to arrays of string values.

archivedboolean
actor_oidstring

oid of the actor that last acted on the admission.