"Docs" values
1 row is stored for this page
| Field | Field type | Value |
|---|
| Title | String | Supply Delivery |
| DocType | String | reference |
| Domain | String | supply |
| Summary | Text | |
| SidebarOrder | Integer | 5 |
| IntroducedIn | String | 3.0 |
| DeprecatedIn | String | |
| FHIRResource | String | |
| Model | String | SupplyDelivery |
| SourceFile | String | |
| Status | String | current |
21 rows are stored for this page
| Field | Field type | Value |
|---|
| Model | String | SupplyDelivery |
| Section | String | Delivered item & quantity |
| Field | String | supplied_item |
| FieldType | String | FK → Product (CASCADE) |
| Notes | Text | Nullable. The product delivered. Required at the API layer only when the order has no <code>origin</code> (external delivery); scoped to <code>order.destination.facility</code> on write |
| Field | Field type | Value |
|---|
| Model | String | SupplyDelivery |
| Section | String | Delivered item & quantity |
| Field | String | supplied_inventory_item |
| FieldType | String | FK → InventoryItem (CASCADE) |
| Notes | Text | Nullable. Specific inventory item (batch/lot) drawn from. Required at the API layer when the order has an <code>origin</code> (intra-facility move); scoped to <code>order.origin.facility</code> |
| Field | Field type | Value |
|---|
| Model | String | SupplyDelivery |
| Section | String | Delivered item & quantity |
| Field | String | supplied_item_quantity |
| FieldType | String | DecimalField(max_digits=20, decimal_places=6) |
| Notes | Text | Nullable in DB. On write a <code>Decimal</code> with <code>decimal_places=0</code> (whole units); on read serialized as <code>int</code>. Auto-derived as <code>pack_quantity × pack_size</code> when both are given |
| Field | Field type | Value |
|---|
| Model | String | SupplyDelivery |
| Section | String | Delivered item & quantity |
| Field | String | supplied_item_pack_quantity |
| FieldType | String | IntegerField |
| Notes | Text | Nullable; default <code>None</code>. Number of packs delivered |
| Field | Field type | Value |
|---|
| Model | String | SupplyDelivery |
| Section | String | Delivered item & quantity |
| Field | String | supplied_item_pack_size |
| FieldType | String | IntegerField |
| Notes | Text | Nullable; default <code>None</code>. Units per pack |
| Field | Field type | Value |
|---|
| Model | String | SupplyDelivery |
| Section | String | Delivered item & quantity |
| Field | String | supplied_item_condition |
| FieldType | String | CharField(255) |
| Notes | Text | Optional. Condition of the delivered item — enum <code>SupplyDeliveryConditionOptions</code> (see below) |
| Field | Field type | Value |
|---|
| Model | String | SupplyDelivery |
| Section | String | Status & classification |
| Field | String | status |
| FieldType | String | CharField(255) |
| Notes | Text | Required. Lifecycle state — enum <code>SupplyDeliveryStatusOptions</code> (see below) |
| Field | Field type | Value |
|---|
| Model | String | SupplyDelivery |
| Section | String | Status & classification |
| Field | String | delivery_type |
| FieldType | String | CharField(255) |
| Notes | Text | Enum <code>SupplyDeliveryTypeOptions</code> (<code>product</code> / <code>device</code>). Stored on the model but not exposed on the current Create/Update specs, so it can't be set through the API |
| Field | Field type | Value |
|---|
| Model | String | SupplyDelivery |
| Section | String | Links & pricing |
| Field | String | supply_request |
| FieldType | String | FK → SupplyRequest (CASCADE) |
| Notes | Text | Nullable. Request this delivery fulfils. Set by <code>external_id</code> on write |
| Field | Field type | Value |
|---|
| Model | String | SupplyDelivery |
| Section | String | Links & pricing |
| Field | String | order |
| FieldType | String | FK → DeliveryOrder (CASCADE) |
| Notes | Text | Nullable in DB, but '''required on create''' (referenced by <code>external_id</code>). Optional on update |
| Field | Field type | Value |
|---|
| Model | String | SupplyDelivery |
| Section | String | Links & pricing |
| Field | String | total_purchase_price |
| FieldType | String | DecimalField(max_digits=20, decimal_places=6) |
| Notes | Text | Nullable. Total purchase cost. Spec: <code>Decimal</code> <code>max_digits=20, decimal_places=6</code> |
| Field | Field type | Value |
|---|
| Model | String | SupplyDelivery |
| Section | String | DeliveryOrder |
| Field | String | name |
| FieldType | String | CharField(255) |
| Notes | Text | Required. Human-readable order name |
| Field | Field type | Value |
|---|
| Model | String | SupplyDelivery |
| Section | String | DeliveryOrder |
| Field | String | status |
| FieldType | String | CharField(255) |
| Notes | Text | Required. Order lifecycle — enum <code>SupplyDeliveryOrderStatusOptions</code> (see below) |
| Field | Field type | Value |
|---|
| Model | String | SupplyDelivery |
| Section | String | DeliveryOrder |
| Field | String | note |
| FieldType | String | TextField |
| Notes | Text | Nullable. Free-text note |
| Field | Field type | Value |
|---|
| Model | String | SupplyDelivery |
| Section | String | DeliveryOrder |
| Field | String | tags |
| FieldType | String | ArrayField[int] |
| Notes | Text | Default <code>[]</code>. Tag IDs; rendered via <code>SingleFacilityTagManager</code> on read |
| Field | Field type | Value |
|---|
| Model | String | SupplyDelivery |
| Section | String | DeliveryOrder |
| Field | String | supplier |
| FieldType | String | FK → Organization (CASCADE) |
| Notes | Text | Nullable. On write must be an Organization with <code>org_type = product_supplier</code> |
| Field | Field type | Value |
|---|
| Model | String | SupplyDelivery |
| Section | String | DeliveryOrder |
| Field | String | origin |
| FieldType | String | FK → FacilityLocation (CASCADE) |
| Notes | Text | Nullable. Source location; absence means stock is entering from an external <code>supplier</code> |
| Field | Field type | Value |
|---|
| Model | String | SupplyDelivery |
| Section | String | DeliveryOrder |
| Field | String | destination |
| FieldType | String | FK → FacilityLocation (CASCADE) |
| Notes | Text | '''Required.''' Receiving location |
| Field | Field type | Value |
|---|
| Model | String | SupplyDelivery |
| Section | String | DeliveryOrder |
| Field | String | patient |
| FieldType | String | FK → Patient (PROTECT) |
| Notes | Text | Nullable. Patient the order is dispensed to. Cannot be set together with <code>origin</code> |
| Field | Field type | Value |
|---|
| Model | String | SupplyDelivery |
| Section | String | DeliveryOrder |
| Field | String | patient_invoice |
| FieldType | String | FK → Invoice (PROTECT) |
| Notes | Text | Nullable. Linked billing invoice; serialized as <code>patient_invoice_id</code> on read |
| Field | Field type | Value |
|---|
| Model | String | SupplyDelivery |
| Section | String | DeliveryOrder |
| Field | String | extensions |
| FieldType | String | JSONField |
| Notes | Text | Default <code>{}</code>. Validated for <code>ExtensionResource.supply_delivery_order</code> |