CLclinicos
HospitalStays

Edit an order. Any schedule field that changes re-materializes future occurrences (ITE-701).

Changed on
put/hospitalstays/{id}/orders/{orderId}

Request

Path parameters

idstring required
orderIdstring required

Request body

kind'medication' | 'fluid' | 'diagnostic' | 'monitoring' | 'procedure' | 'nursing' | 'nutrition' | 'communication' | 'task'

What kind of thing a treatment order is. Mirrors the prototype's TreatmentOrderKind so the web mirror can map one-to-one.

titlestring nullable
subtitlestring nullable
priority'routine' | 'important' | 'critical'

Clinical urgency of an order. Distinct from Priority, which is a task concept.

scheduleType'once' | 'interval' | 'times' | 'continuous' | 'prn'

How an order recurs. The occurrence rows themselves are materialized by the scheduling engine (ITE-701); this enum is only the declaration of intent.

scheduleLabelstring nullable
startAtstring date-time nullable
endAtstring date-time nullable
timesstring[] nullable
instructionsstring nullable
resultUnitstring nullable
serviceCatalogItemIdstring nullable
inventoryItemIdstring nullable
billableItemIdstring nullable

Response

OK

idstring
stayIdstring
kind'medication' | 'fluid' | 'diagnostic' | 'monitoring' | 'procedure' | 'nursing' | 'nutrition' | 'communication' | 'task'

What kind of thing a treatment order is. Mirrors the prototype's TreatmentOrderKind so the web mirror can map one-to-one.

titlestring
subtitlestring nullable
state'active' | 'held' | 'discontinued' | 'completed'

Workflow state of an order. Completed is reached when the schedule runs out (or every occurrence is resolved); Discontinued is a clinician stopping it early. Both are terminal — an order is never hard-deleted, so the audit trail survives.

priority'routine' | 'important' | 'critical'

Clinical urgency of an order. Distinct from Priority, which is a task concept.

scheduleType'once' | 'interval' | 'times' | 'continuous' | 'prn'

How an order recurs. The occurrence rows themselves are materialized by the scheduling engine (ITE-701); this enum is only the declaration of intent.

scheduleLabelstring nullable
startAtstring date-time nullable
endAtstring date-time nullable
timesstring[]

Explicit due times for times schedules, stored exactly as the client sent them.

instructionsstring nullable
resultUnitstring nullable
serviceCatalogItemIdstring nullable
inventoryItemIdstring nullable
billableItemIdstring nullable
createdBystring

Display name of the author; falls back to the user id, never null.

createdByIdstring nullable
createdAtstring date-time
updatedAtstring date-time
heldAtstring date-time nullable
discontinuedAtstring date-time nullable
completedAtstring date-time nullable

Changes