SurgicalRecords

POST /SurgicalRecords/{id}/events

Changed on

Request

Path parameters

idstring required

Request body

titlestring required
detailsstring nullable
typestring required
colorstring nullable
isPinnedboolean
occurredAtstring date-time nullable

When the step actually happened, UTC. Omit to stamp "now" (the common live-charting case). Setting it at create time does NOT append an amendment — the amendment trail records corrections to a stamp, not the stamp itself. Validated against the same window as a correction.

createdByAiboolean

True when the event was proposed by AI transcript extraction and accepted by the user.

milestoneKindstring nullable

Marks this event as a surgical-record milestone rather than a log entry: "cut_start" or "cut_end" (ITE-785). Stamping one mirrors its time onto the matching column on the record. If a marker of that kind already exists, it is MOVED to the new time as an audited correction (returned with its amendments), never replaced. Null for an ordinary event; an unrecognised value is rejected.

implicitboolean

ITE-1330 PR2: the stamp comes from an existing console signal (entering Induction, a checklist tick, the Intubation gas entry) rather than a deliberate press. An implicit stamp only ever CREATES a marker: when one of the kind exists it is returned unchanged (200), so a repeated signal can never overwrite a time a human corrected (ITE-792). Ignored without string? CreateSurgicalTimelineEventRequest.MilestoneKind.

inventoryItemIdstring nullable

Drug events only (ignored on any other type): the inventory item administered. An id that does not resolve is dropped rather than refused — the chart entry is kept.

doseUnitstring nullable

Drug events only: unit of decimal? CreateSurgicalTimelineEventRequest.DoseAmount ("mg", "mL", "tablet"). Max 20 chars.

routestring nullable

Drug events only: route as charted ("IV", "IM", "SQ", "CRI", "PO"). Max 20 chars.

Response

Created

idstring
surgicalRecordIdstring
titlestring
detailsstring nullable
typestring
colorstring nullable
isPinnedboolean
occurredAtstring date-time
createdByAiboolean

True when the event came from AI transcript extraction (human-accepted).

milestoneKindstring nullable

"cut_start" / "cut_end" when this event IS a surgical milestone, else null (ITE-785). The console draws a distinct marker on these rather than the ordinary event card, and the record's cut columns mirror their stamps.

inventoryItemIdstring nullable

Drug events: the administered inventory item, when the entry named one (ITE-870).

doseUnitstring nullable
routestring nullable

Drug events: route of administration as charted.

createdAtstring date-time

Changes

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)