v2

latestOpenAPI 3.1.12026-08-078549932.4 MB

Appointments

Update a dispensed item's dispense type and prescription details

patch/Appointments/{id}/dispensed-items/{transactionId}

idstring required

The appointment ID

transactionIdstring required

The inventory transaction ID

dispenseTypestring

Type of dispense: InHouse or Prescription

dosagestring nullable

frequencystring nullable

durationstring nullable

instructionsstring nullable

transactionIdstring

inventoryItemIdstring

itemNamestring

skustring nullable

categorystring

pricePolicystring

isTaxableboolean

lotNumberstring nullable

transactionDatestring date-time

notesstring nullable

markedForBillingboolean

Whether this item is marked for billing (should appear on invoice). User-controlled toggle for samples, comped items, etc.

isOnInvoiceboolean

Whether this item has already been added to an invoice (InvoiceLineItem exists).

invoiceLineItemIdstring nullable

dispenseTypestring

Type of dispense: InHouse (administered now) or Prescription (take-home).

prescriptionIdstring nullable

dosagestring nullable

frequencystring nullable

appointmentIdstring nullable

The appointment this dispense is tied to, if any. Null for walk-in/OTC dispenses made outside an appointment context.

patientIdstring nullable