Overview
Retrieve notes for a specific appointment in MediSync. This endpoint returns all notes associated with the given appointment ID. If no notes exist for the appointment, an empty array is returned.
Appointment-Based Notes : Notes are organized by appointment ID. Each appointment can have multiple notes, and this endpoint returns all notes for the specified appointment.
Authentication
curl -X GET \
'https://api.medisync.com/notes/apt_abc123?uid=doc_xyz789' \
-H 'Authorization: Bearer YOUR_JWT_TOKEN'
Path Parameters
The appointment ID to retrieve notes for
Query Parameters
The user ID of the healthcare provider requesting the notes
Response
Indicates if the operation was successful
Array of notes objects for the appointment Show notes object properties
Unique identifier for the notes record
The appointment ID these notes belong to
The clinical notes content
Optional feedback score for the notes (if provided)
Optional AI-generated diagnosis prediction (if available) Show diagnosis_prediction properties
Status of the diagnosis prediction: “pending”, “generated”, or “failed”
Main diagnosis (when status is “generated”)
ICD code for the diagnosis (when status is “generated”)
Reasoning for the diagnosis (when status is “generated”)
Error message (when status is “failed”)
ISO timestamp when the notes were created
ISO timestamp when the notes were last updated
Error message if the operation failed
Example Response
Success - Notes Found
Success - No Notes Found
Error
{
"success" : true ,
"data" : [
{
"_id" : "notes_def456" ,
"appointment_id" : "apt_abc123" ,
"notes" : "Patient presented with chest pain. Physical examination revealed no acute distress. EKG normal. Plan: Continue monitoring, follow up in 1 week." ,
"summary" : "Chest pain evaluation - normal findings, continue monitoring" ,
"feedback_score" : 4.5 ,
"diagnosis_prediction" : {
"status" : "generated" ,
"main_diagnosis" : "Atypical chest pain" ,
"icd_code" : "R07.89" ,
"reason" : "Based on presentation and normal EKG findings, most likely non-cardiac chest pain"
},
"createdAt" : "2024-01-15T10:30:00.000Z" ,
"updatedAt" : "2024-01-15T11:15:00.000Z"
}
]
}
Behavior Notes
Multiple Notes : An appointment can have multiple notes. This endpoint returns all notes for the specified appointment.
Empty Results : If no notes exist for the appointment, the response will be successful with an empty data array.
Optional Fields : feedback_score and diagnosis_prediction are optional fields that may not be present in all notes.
Chronological Order : Notes are typically returned in the order they were created in the database.
Status Codes
200 - Notes retrieved successfully (including empty results)
400 - Invalid request or database error