Skip to main content

getSoapSummary

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.
      • symptoms: (string?) - Symptoms described by the patient.
      • concerns: (string?) - Patient's concerns or complaints.
    • objective: (Objective) - Clinician-observed physical findings and lab results.
      • laboratory_results: (string?) - Relevant laboratory test results.
      • physical_examination_findings: (string?) - Findings from physical examination.
    • assessment: (Assessment) - Diagnosis and differential diagnoses.
      • diagnosis: (string?) - The primary diagnosis.
      • differential_diagnosis: (string?) - Alternative possible diagnoses.
    • plan: (Plan) - Treatment plan, medications, and follow-up instructions.
      • non_pharmacological_intervention: (string?) - Non-drug treatment recommendations.
      • medications: (string?) - Prescribed medications.
      • referrals: (string?) - Referrals to other specialists.
      • follow_up_instructions: (string?) - Instructions for follow-up care.

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​

import { getSoapSummary } from 'altibbi-react-native';

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