Skip to main content
Multi-SOAP lets you take a single consultation recording and split it into separate SOAP notes — one per patient concern discussed during the visit. You can also merge previously split notes back into a unified summary if the split is no longer needed.

Prerequisites

Before using Multi-SOAP:
  • Complete a consultation using a SOAP template (for example, soap_new_complaint_api).
  • Have the Consultation object returned by startRecording, or the consultation ID so you can reconstruct it.

Split a consultation

Call splitSoap on the Consultation object to divide the consultation into separate SOAP notes. The method is asynchronous and resolves with the updated summary containing one entry per episode.

Merge split notes

If you previously split a consultation and want to consolidate the notes back into a single summary, call mergeSoap:
You can only merge a consultation that has already been split. Calling mergeSoap on an unsplit consultation will result in an error.

Full example

Recover a lost consultation reference

If you no longer hold the Consultation object — for example, after a page refresh or in-app navigation — reconstruct it from the consultation ID using squire.consultation():

Output format

After splitting, the returned summary contains one entry per episode in the data array:
Each episode contains its own independent SOAP sections. For the complete output structure and available fields, see the output documentation.