SurgicalRecords

patch/SurgicalRecords/{id}

Path parameters

idstring required

Request body

activePhasestring nullable
procedureNamestring nullable
procedureStartTimestring date-time nullable
procedureEndTimestring date-time nullable
anesthesiaDataJsonstring nullable
vitalsSnapshotJsonstring nullable
activeAgentsJsonstring nullable

Response

OK

idstring
appointmentIdstring
patientIdstring
procedureNamestring
surgeonIdstring nullable
procedureStartTimestring date-time nullable
procedureEndTimestring date-time nullable
activePhasestring
anesthesiaDataJsonstring nullable
vitalsSnapshotJsonstring nullable
activeAgentsJsonstring nullable
createdAtstring date-time
updatedAtstring date-time
finalizedAtstring date-time nullable

When the chart was frozen, or null while it is still being written.

finalizedByIdstring nullable
finalizedByNamestring nullable
isFinalizedboolean

Convenience for the client, which gates every write affordance on this rather than re-deriving it from the timestamp. Mirrors IsEditable on the SOAP note DTOs.

Changes

Changed in 2 of the 5 revisions of this API.19

    • added the non-success response with the status 409

      response-non-success-status-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property timelineEvents/items/amendments to the response with the 200 status (media type: text/plain)

      response-optional-property-added

    • added the optional property timelineEvents/items/amendments to the response with the 200 status (media type: application/json)

      response-optional-property-added

    • added the optional property timelineEvents/items/amendments to the response with the 200 status (media type: text/json)

      response-optional-property-added