"Docs" values
1 row is stored for this page
| Field | Field type | Value |
|---|
| Title | String | Booking |
| DocType | String | reference |
| Domain | String | scheduling |
| Summary | Text | |
| SidebarOrder | Integer | 2 |
| IntroducedIn | String | 3.0 |
| DeprecatedIn | String | |
| FHIRResource | String | |
| Model | String | Booking |
| SourceFile | String | |
| Status | String | current |
14 rows are stored for this page
| Field | Field type | Value |
|---|
| Model | String | Booking |
| Section | String | TokenBooking fields |
| Field | String | token_slot |
| FieldType | String | FK → TokenSlot (PROTECT) |
| Notes | Text | The slot this appointment occupies; required. PROTECT prevents deleting a slot that has bookings |
| Field | Field type | Value |
|---|
| Model | String | Booking |
| Section | String | TokenBooking fields |
| Field | String | patient |
| FieldType | String | FK → emr.Patient (CASCADE) |
| Notes | Text | The booked patient; required |
| Field | Field type | Value |
|---|
| Model | String | Booking |
| Section | String | TokenBooking fields |
| Field | String | booked_on |
| FieldType | String | DateTimeField |
| Notes | Text | <code>auto_now_add</code> — stamped once at creation, never accepted from clients |
| Field | Field type | Value |
|---|
| Model | String | Booking |
| Section | String | TokenBooking fields |
| Field | String | booked_by |
| FieldType | String | FK → User (CASCADE) |
| Notes | Text | User who created the booking; nullable for self-service or system-created bookings |
| Field | Field type | Value |
|---|
| Model | String | Booking |
| Section | String | TokenBooking fields |
| Field | String | note |
| FieldType | String | TextField |
| Notes | Text | Free-text note; nullable in storage but required (<code>str</code>) on write |
| Field | Field type | Value |
|---|
| Model | String | Booking |
| Section | String | TokenBooking fields |
| Field | String | tags |
| FieldType | String | ArrayField[int] |
| Notes | Text | Tag IDs, default empty list. Managed via <code>SingleFacilityTagManager</code>; reads return rendered tag objects, not raw IDs |
| Field | Field type | Value |
|---|
| Model | String | Booking |
| Section | String | TokenBooking fields |
| Field | String | associated_encounter |
| FieldType | String | FK → emr.Encounter (PROTECT) |
| Notes | Text | Encounter linked to the appointment; nullable, defaults to <code>None</code>. Surfaced only by <code>TokenBookingRetrieveSpec</code> |
| Field | Field type | Value |
|---|
| Model | String | Booking |
| Section | String | TokenBooking fields |
| Field | String | token |
| FieldType | String | FK → emr.Token (PROTECT) |
| Notes | Text | Queue token issued for this booking; nullable, defaults to <code>None</code>, <code>related_name="token_booking"</code>. Created by the <code>generate_token</code> action |
| Field | Field type | Value |
|---|
| Model | String | Booking |
| Section | String | TokenBooking fields |
| Field | String | charge_item |
| FieldType | String | FK → emr.ChargeItem (CASCADE) |
| Notes | Text | Billing charge item for the appointment; nullable. Auto-created on booking when the schedule has a <code>charge_item_definition</code> |
| Field | Field type | Value |
|---|
| Model | String | Booking |
| Section | String | TokenSlot |
| Field | String | resource |
| FieldType | String | FK → SchedulableResource (CASCADE) |
| Notes | Text | The schedulable resource — practitioner, location, or healthcare service — the slot belongs to; required |
| Field | Field type | Value |
|---|
| Model | String | Booking |
| Section | String | TokenSlot |
| Field | String | availability |
| FieldType | String | FK → Availability (CASCADE) |
| Notes | Text | The availability rule that generated this slot; nullable |
| Field | Field type | Value |
|---|
| Model | String | Booking |
| Section | String | TokenSlot |
| Field | String | start_datetime |
| FieldType | String | DateTimeField |
| Notes | Text | Slot start; required, tz-aware |
| Field | Field type | Value |
|---|
| Model | String | Booking |
| Section | String | TokenSlot |
| Field | String | end_datetime |
| FieldType | String | DateTimeField |
| Notes | Text | Slot end; required, tz-aware |
| Field | Field type | Value |
|---|
| Model | String | Booking |
| Section | String | TokenSlot |
| Field | String | allocated |
| FieldType | String | IntegerField |
| Notes | Text | Count of bookings currently allocated to the slot, used to enforce capacity. Defaults to <code>0</code>. Platform-maintained — never written by clients |