Sign in

v2

latestOpenAPI 3.1.12026-08-078549932.4 MB
AppointmentTypes

put/appointment-types/{id}

Path parameters

idstring required

Request body

namestring nullable
descriptionstring nullable
colorstring nullable
isActiveboolean nullable
requiresSurgeryRoomboolean nullable
isGroupVisitboolean nullable
isCompassionCareboolean nullable
defaultFlowIdstring nullable

Chronicle workflow id. Send an empty string to clear the override; omit to leave unchanged. Null is treated as omitted.

examTemplateIdstring nullable

Exam template override for the chronicle exam step (PAW-741). Send an empty string to clear the override; omit to leave unchanged. Null is treated as omitted.

noteFormatstring nullable

Generated-note format (PAW-744). Must be a known SoapNoteFormats id. Send an empty string to clear back to the standard SOAP note; omit to leave unchanged. Null is treated as omitted.

autoGenerateSoapboolean nullable

Auto-start SOAP generation on treatment-plan-to-invoice conversion (PAW-675). Omit/null = unchanged.

autoGenerateDischargeboolean nullable

Auto-start discharge generation on SOAP approval (PAW-675). Omit/null = unchanged.

locationIdsstring[] nullable

Location IDs that can accommodate this appointment type (Location Intents). If provided, replaces all existing location mappings.

Response

OK

idstring
namestring
descriptionstring nullable
colorstring nullable
isActiveboolean
requiresSurgeryRoomboolean
isGroupVisitboolean
isCompassionCareboolean
defaultFlowIdstring nullable

Id of the chronicle workflow to start when an appointment of this type is opened. Null falls back to the entity default (appointment-default).

examTemplateIdstring nullable

Id of the exam template the chronicle exam step renders for this type (PAW-741). Overrides the provider's personal default; null falls through to that default, then to the standard 7-system view.

noteFormatstring nullable

Generated-note format for visits of this type (PAW-744). Null = standard four-section SOAP note. Ids come from the code-defined SoapNoteFormats registry (e.g. "quick-visit").

autoGenerateSoapboolean

Auto-start SOAP generation when the treatment plan is converted to an invoice (PAW-675).

autoGenerateDischargeboolean

Auto-start discharge generation when the SOAP note is approved (PAW-675).

createdAtstring date-time
updatedAtstring date-time
locationIdsstring[]

Location IDs that can accommodate this appointment type (Location Intents).