SOAP Notes

The SOAP Notes API allows you to retrieve SOAP notes for completed calls in your organization. SOAP notes provide structured clinical documentation generated from call transcripts.

SOAP Note Properties

Endpoint

Get Call SOAP Note

Retrieve the SOAP note for a specific call.

GET /api/external/organization_users/{organization_user_id}/calls/{call_id}/soap_note

Parameters

Example Request

curl -X GET "https://api.kismethealth.com/api/external/organization_users/101/calls/5/soap_note" \
  -H "X-Client-ID: your-client-id" \
  -H "X-Client-Secret: your-client-secret" \
  -H "Content-Type: application/json"

Example Response

{
  "id": 1,
  "text": "SUBJECTIVE:\nPatient reports feeling much better since last visit. Energy levels have significantly improved. No new complaints.\n\nOBJECTIVE:\nBlood pressure: Improved with current medication regimen\nRecent lab results reviewed and discussed\n\nASSESSMENT:\nPatient responding well to current treatment plan. Blood pressure control achieved.\n\nPLAN:\nContinue current medication dosage\nFollow-up appointment scheduled for next month\nMonitor blood pressure readings at home",
  "is_final": true
}

Error Responses

• 404 Not Found: Returned when:
  • The organization user does not exist or is not accessible
  • The call does not exist or is not accessible
  • No SOAP note exists for the specified call

SOAP Note Generation

Processing Timeline

• SOAP notes are generated automatically from call transcripts
• Initial SOAP notes may have is_final: false while processing continues
• Final SOAP notes are marked with is_final: true when processing is complete
• SOAP notes are created after transcript processing is complete

Content Structure

• The text field contains the complete SOAP note
• SOAP notes follow the standard medical documentation format:
  • Subjective: Patient’s reported symptoms and concerns
  • Objective: Observable and measurable findings
  • Assessment: Clinical interpretation and diagnosis
  • Plan: Treatment plan and follow-up actions

Access Control

Permissions

• Users can only access SOAP notes for calls within their organization
• The authenticated user must have access to the specified organization user
• API clients are authenticated via X-Client-ID and X-Client-Secret headers

Availability

• SOAP notes are only available after the call has ended and transcript processing is complete
• Not all calls may have SOAP notes (e.g., very short calls, technical issues, incomplete transcripts)
• Check for 404 errors to determine if a SOAP note is available