Skip to main content
GET
Get IPD Admission

Headers

auth
string
required

Path Parameters

admission_id
string
required

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

Response

OK — the requested IPD admission.

id
string

Admission document id.

bid
string

Business id the admission belongs to.

admission_date
string

Admission date-time as an ISO-8601 string.

discharge_date
string

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

ipid
string

Patient IPD case number.

attendee
object
patient
object
insurance
object
procedures
object[]
refer
object
doc
object

The responsible doctor (id + name).

notes
string
stage
enum<string>

Coarse lifecycle stage of the admission.

Available options:
IN,
AD,
DC
status
enum<string>

Granular lifecycle status within the current stage.

Available options:
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
duration
object
bed
string
rateplan
object
docid
string
category
object
date
string
department
object
pid
string
created_at
string

Creation date-time as an ISO-8601 string.

updated_at
string

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

facility
object
facilityid
string
totalbilled
number

Total amount billed for the admission.

totalpaid
number

Total amount paid against the admission.

totalbilled_updated_at
string
totalpaid_updated_at
string
custom_attributes
object

Map of custom attribute keys to arrays of string values.

clearances_summary
object

Denormalized discharge-clearance state.

archived
boolean
actor_oid
string

oid of the actor that last acted on the admission.