Skip to main content

​
Overview

Retrieve the summary for notes associated with a specific appointment in MediSync. This endpoint returns only the summary field from the notes, providing a quick overview of the clinical documentation.
Summary Only: This endpoint returns only the summary field from the notes, not the full clinical content. Use the regular notes endpoint to get complete notes.

​
Authentication

curl -X GET \
  'https://api.medisync.com/notes/summary/apt_abc123?uid=doc_xyz789' \
  -H 'Authorization: Bearer YOUR_JWT_TOKEN'

​
Path Parameters

​
id
string
required
The appointment ID to retrieve the notes summary for

​
Query Parameters

​
uid
string
required
The user ID of the healthcare provider requesting the summary

​
Response

​
success
boolean
Indicates if the operation was successful
​
data
object
Object containing the summary data
​
error
string
Error message if the operation failed

​
Example Response

{
  "success": true,
  "data": {
    "summary": "Chest pain evaluation - normal findings, continue monitoring"
  }
}

​
Behavior Notes

  • Single Summary: This endpoint returns the summary from the first notes record found for the appointment
  • Appointment-Based: The lookup is performed using the appointment ID to find associated notes
  • Summary Only: Only the summary field is returned, not the full notes content
  • Required Notes: If no notes exist for the appointment, a 404 error is returned

​
Status Codes

  • 200 - Summary retrieved successfully
  • 400 - Invalid request or database error
  • 404 - Notes not found for the specified appointment