Sign in

v2

latestOpenAPI 3.1.12026-08-078549932.4 MB
Estimates

Mark an estimate line performed. For an undispensed inventory line this runs the in-visit dispense (stamping `InventoryTransactionId` on the line; no Invoice involvement until convert). Gas items have no transaction.

post/Estimates/{id}/items/{lineId}/perform

Path parameters

idstring required
lineIdstring required

Request body

dispenseTypestring nullable

InHouse (administered now) or Prescription (take-home). Defaults to InHouse.

dispositionstring nullable

Explicit dispense disposition (InHouse | TakeHomeLabelNow | TakeHomeLabelLater). When supplied it is persisted on the line and drives the convert gate (take-home requires the SIG filled; in-house never blocks). Falls back to a mapping from string? PerformEstimateItemRequest.DispenseType when omitted.

overrideValidationboolean
overrideReasonstring nullable
lotIdstring nullable

ITE-157: the confirmed lot/container for a plain inventory line (null = FEFO/auto).

containerIdstring nullable
witnessUserIdstring nullable

Real witness for a controlled-substance dispense — replaces the appointment self-witness when supplied.

componentOverrideReasonstring nullable

Required when the charge's dispensed component set deviates from the catalog default (skip / substitute / quantity change / addition).

Response

OK

idstring
serviceCatalogItemIdstring nullable
retailItemIdstring nullable
inventoryItemIdstring nullable
billableItemIdstring nullable

Source BillableItem ("Charge") id when this line is a charge.

codestring
descriptionstring
qtyModestring
isTaxableboolean
notestring nullable
serviceTypestring

"Procedure" | "Inventory" | "Retail" — derived from the source FK.

inventoryItemCategorystring nullable

InventoryItemCategory ("Vaccine", "Medication", …) for an inventory-backed line; routes the perform flow (e.g. vaccine administration).

executionStatusstring

Pending | Performed | Declined.

dispositionstring nullable

Persisted dispense disposition: InHouse | TakeHomeLabelNow | TakeHomeLabelLater (null for non-dispensing lines).

requiresSigboolean

True when this performed take-home line still needs its SIG / medication details filled (blocks convert). Drives the per-line "Fill instructions" affordance. In-house lines are never required.

markedForBillingboolean
inventoryTransactionIdstring nullable

Set once an inventory line is dispensed in-visit. The void reversal anchors on this.

performedByIdstring nullable
performedByNamestring nullable
performedAtstring date-time nullable
declinedReasonstring nullable
declinedAtstring date-time nullable
isControlledSubstanceboolean

True for a controlled-substance inventory line (gates the void-reason requirement).