Skip to main content

Soap

The Soap struct represents a detailed consultation summary, which includes subjective, objective, assessment, and plan components. This data is typically generated from a machine learning model based on consultation analysis.

Fields​

  • summary: (Summary?) - Contains the entire SOAP note, including the following:
    • subjective: (Subjective?) - Patient-reported symptoms and concerns.
    • objective: (Objective?) - Clinician-observed physical findings and lab results.
    • assessment: (Assessment?) - Diagnosis and differential diagnoses.
    • plan: (Plan?) - Treatment plan, medications, and follow-up instructions.

Parameters​

  • consultation_id: (number) - The ID of the consultation for which the SOAP summary is being fetched.

Returns​

  • Promise<ResponseType<Soap>>: A promise that resolves with a Soap object containing the SOAP summary for the consultation.

Example Usage​

const soapSummary = await getSoapSummary(12345);
console.log(soapSummary.data.summary.subjective.symptoms);  // Output: "Cough, Fever"