---
title: "IPD Admission"
method: POST
path: "/registered_url_for_ipd_admissions_events"
tags: ["IPD Webhooks"]
---

# IPD Admission

`POST /registered_url_for_ipd_admissions_events`

When an IPD (In-Patient Department) admission is created or updated, a webhook event is sent to registered webhooks with the full admission details, including the patient, attending doctor, facility, department, bed, category, rate plan, insurance and billing information.

**Field Definitions**

• **service**: string - The type of service. For IPD events, this will be `ipd`.

• **event**: string - The type of event. For admissions, this will be `ipd_admissions.created` or `ipd_admissions.updated`.

• **event_time**: integer - Event occurrence timestamp (epoch seconds).

• **transaction_id**: string - Unique transaction identifier for the event.

• **timestamp**: integer - Timestamp of the event (epoch seconds).

• **business_id**: string - The eka ID of the business.

• **client_id**: string - Client ID associated with the event.

• **data**: object - Contains detailed information about the admission.

• **id** / **ipid**: string - Unique identifiers for the admission.

• **stage** / **status**: string - Current stage and status of the admission (e.g. `AD`, `BED_ASSIGNED`).

• **patient** / **doc** / **attendee**: object - Patient, attending doctor and attendee details.

• **facility** / **department** / **bed** / **category**: Location and allocation details for the admission.

• **rateplan** / **insurance** / **totalbilled** / **totalpaid**: Billing, package and insurance details.

**Example Webhook Request**

**Endpoint:** [https://your-registered-webhook-url.com](https://your-registered-webhook-url.com)

**Method:** POST

## Request body

- object
  - `service` string, required — Type of service
  - `event` 'ipd_admissions.created' | 'ipd_admissions.updated', required — Type of event
  - `event_time` integer, required — Event occurred timestamp
  - `transaction_id` string — Unique transaction identifier for the event
  - `timestamp` integer, required — Timestamp of the event
  - `business_id` string, required — Business ID for the admission
  - `client_id` string — Client ID for the admission
  - `data` object, required
    - `actor_oid` string — Identifier of the actor who triggered the event
    - `admission_date` string — Date and time of admission
    - `attendee` object — Attendee accompanying the patient
      - `id` string — Attendee identifier
      - `name` string — Attendee name
      - `phone` object
        - `c` string — Country code
        - `n` string — Phone number
      - `relation` object
        - `id` string — Relation identifier
        - `label` string — Relation label
    - `bed` string — Bed identifier assigned to the patient
    - `bid` string — Business identifier
    - `category` object — Bed/room category details
      - `id` string — Category identifier
      - `name` string — Category name
    - `created_at` string — Creation timestamp
    - `custom_attributes` object — Custom attributes for the admission
    - `date` string — Admission date
    - `department` object — Department details
      - `id` string — Department identifier
      - `name` string — Department name
    - `doc` object — Attending doctor details
      - `id` string — Doctor identifier
      - `name` string — Doctor name
    - `docid` string, required — Identifier for the attending doctor
    - `duration` object — Expected duration of stay
      - `unit` string — Unit of duration
      - `value` integer — Duration value
    - `facility` object — Facility details
      - `id` string — Facility identifier
      - `name` string — Facility name
    - `facilityid` string, required — Identifier for the facility
    - `id` string, required — Unique identifier for the admission
    - `insurance` object — Insurance details for the admission
      - `coverage_type` string[] — Coverage types
      - `payment_type` string — Payment type
      - `pre_approved` boolean — Whether the claim is pre-approved
      - `pre_approved_amount` number — Pre-approved amount
      - `type` string — Insurance type
    - `ipid` string, required — Human-readable IPD identifier
    - `medico_legal_case` boolean — Whether this is a medico-legal case
    - `patient` object — Patient details
      - `formData` object[] — Patient form data
      - `id` string — Patient identifier in Eka
      - `poid` string — Partner patient identifier
      - `profile` object
        - `personal` object
          - `age` object
            - `dob` string — Date of birth
          - `gender` string — Patient gender
          - `name` string — Patient name
          - `phone` object
            - `c` string — Country code
            - `n` string — Phone number
      - `uuid` string — Patient UUID
    - `pid` string, required — Identifier for the patient
    - `procedures` object[] — Procedures associated with the admission
    - `rateplan` object — Rate plan / package details
      - `id` string — Rate plan identifier
      - `inclusions` object[] — List of inclusions in the rate plan
        - `id` string — Inclusion identifier
        - `name` string — Inclusion name
        - `rate` number — Inclusion rate
      - `name` string — Rate plan name
    - `refer` object — Referral details
      - `id` string — Referrer identifier
      - `name` string — Referrer name
    - `stage` string, required — Current stage of the admission
    - `status` string, required — Current status of the admission
    - `totalbilled` number — Total amount billed
    - `totalbilled_updated_at` string — Timestamp when total billed was last updated
    - `totalpaid` number — Total amount paid
    - `totalpaid_updated_at` string — Timestamp when total paid was last updated
    - `updated_at` string — Last update timestamp

## Response `200`

---

[API](https://skmtc.net/eka/apis/eka-developer-apis.md) · [All operations](https://skmtc.net/eka/apis/eka-developer-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eka/eka-developer-apis/revisions/9ea23456f722/schema)