v2

latestOpenAPI 3.1.12026-08-078549932.4 MB
GroupVisits

patch/GroupVisits/{appointmentId}/soap/{soapId}

Path parameters

appointmentIdstring required
soapIdstring required

Request body

subjectivestring nullable
objectivestring nullable
assessmentstring nullable
planstring nullable
cohortLabelstring nullable

Response

OK

idstring
subjectivestring
objectivestring
assessmentstring
planstring
cohortLabelstring nullable
statusstring
formatstring

Note-format discriminator (PAW-744). A group visit's AI-generated note comes from the same generation path as a patient visit's, so it inherits the appointment type's note format — including single-section formats, whose whole body lives in Subjective. The editor needs this to avoid labelling that body "Subjective" beside three empty boxes.

createdAtstring date-time
updatedAtstring date-time