# List progress notes Returns a paginated list of progress notes with optional filtering Endpoint: GET /v1/progress-notes Version: 1.0.0 Security: bearerAuth ## Query parameters: - `patient_id` (integer) Filter notes by patient ID - `per_page` (integer) Number of items per page (1-100) - `sort_by` (string) Sort order for results Enum: "latest", "oldest" ## Response 200 fields (application/json): - `data` (array) - `data.id` (integer, required) Unique identifier for the progress note Example: 123 - `data.name` (string, required) Name or title of the progress note Example: "Follow-up Visit - Jane Doe" - `data.transcription` (string) Transcribed content of the audio recording Example: "Patient reports improvement in symptoms since last visit..." - `data.analysis` (string) AI-generated analysis of the transcription Example: "Patient's condition has improved with current treatment regimen..." - `data.template` (object) - `data.template.id` (integer) Template ID used for this note Example: 5 - `data.template.name` (string) Name of the template Example: "Standard Follow-up" - `data.template.description` (string) Description of the template Example: "Standard template for routine follow-up visits" - `data.patient` (object) Associated patient information - `data.patient.id` (integer, required) Unique identifier for the patient Example: 789 - `data.patient.uuid` (string, required) UUID for the patient Example: "550e8400-e29b-41d4-a716-446655440000" - `data.patient.first_name` (string, required) Patient's first name Example: "Jane" - `data.patient.middle_name` (string,null) Patient's middle name Example: "Marie" - `data.patient.last_name` (string, required) Patient's last name Example: "Doe" - `data.patient.gender` (string,null) Patient's gender (when demographics are loaded) Example: "female" - `data.patient.date_of_birth` (string, required) Patient's date of birth Example: "1985-03-15" - `data.patient.notes` (string,null) Clinical notes about the patient Example: "Patient has a history of anxiety. Prefers afternoon appointments." - `data.patient.latest_medications` (array) List of current medications (when loaded) Example: ["Sertraline 50mg","Lorazepam 0.5mg PRN"] - `data.patient.user` (object) User who created the patient (when loaded) - `data.patient.user.id` (integer, required) Unique identifier for the user Example: 12345 - `data.patient.user.name` (string, required) Full name of the user Example: "Dr. Sarah Johnson" - `data.patient.user.email` (string, required) Email address of the user Example: "sarah.johnson@nextvisit.ai" - `data.patient.user.created_at` (string, required) Timestamp when the user was created Example: "2023-03-15T09:12:34Z" - `data.patient.user.updated_at` (string, required) Timestamp when the user was last updated Example: "2023-05-22T14:07:53Z" - `data.patient.timeline` (array) Patient timeline events (when loaded) - `data.patient.encounters` (array) Recent encounters/progress notes (when loaded) - `data.patient.meta` (object,null) Additional metadata - `data.patient.created_at` (string, required) When the patient was created Example: "2024-01-15T10:30:00Z" - `data.patient.updated_at` (string, required) When the patient was last updated Example: "2024-06-20T14:45:00Z" - `data.audio` (object) - `data.audio.duration` (number) Duration of the audio in seconds Example: 480 - `data.audio.bitrate` (integer) Bitrate of the audio file Example: 128000 - `data.audio.size` (integer) Size of the audio file in bytes Example: 7680000 - `data.audio.uploaded_at` (string) When the audio was uploaded Example: "2023-04-10T15:30:00Z" - `data.audio.expires_at` (string) When the audio file will expire Example: "2023-05-10T15:30:00Z" - `data.audio.file_url` (string) Temporary URL to access the audio file Example: "https://storage.nextvisit.app/encounters/abc123.mp3?token=xyz" - `data.has` (object) - `data.has.content` (boolean) Whether analysis has been completed Example: true - `data.has.transcription` (boolean) Whether transcription has been completed Example: true - `data.has.signed` (boolean) Whether the note has been reviewed and signed - `data.team_id` (integer, required) ID of the team this note belongs to Example: 5 - `data.user_id` (integer, required) ID of the user who created this note Example: 42 - `data.user` (object) Information about the user who created the note - `data.transcription_started_at` (string) When transcription process started Example: "2023-04-10T15:35:00Z" - `data.transcription_completed_at` (string) When transcription was completed Example: "2023-04-10T15:40:00Z" - `data.analysis_started_at` (string) When analysis process started Example: "2023-04-10T15:40:00Z" - `data.analysis_completed_at` (string) When analysis was completed Example: "2023-04-10T15:45:00Z" - `data.error_state` (string,null) Any error state during processing - `data.created_at` (string, required) When the progress note was created Example: "2023-04-10T15:30:00Z" - `data.updated_at` (string, required) When the progress note was last updated Example: "2023-04-10T15:45:00Z" - `links` (object) Pagination links - `meta` (object) Pagination metadata ## Response 401 fields (application/json): - `message` (string, required) Error message Example: "Validation failed" - `errors` (object) Detailed validation errors by field Example: {"email":["The email must be a valid email address","The email has already been taken"],"password":["The password must be at least 8 characters"],"template_name":["This field is required"]} ## Response 403 fields