List SOAP Notes¶

Retrieve a paginated list of SOAP notes (contexts) for a patient, ordered by service date.

Endpoint¶

GET /apis/v1/soap-context

Query Parameters¶

Parameter	Type	Required	Description
`patient_id`	integer	Yes	The patient's ID
`page`	integer	No	Page number (default: `1`)
`size`	integer	No	Number of records per page (default: `10`)
`sort_direction`	string	No	Sort order by `service_date_time`: `ASC` or `DESC` (default: `DESC`)

Request¶

curl --location '{base_url}/apis/v1/soap-context?patient_id=1172416&page=1&size=10' \
  --header 'Authorization: Bearer JWT_TOKEN'

Response¶

Success Response¶

Code: 200 OK

{
  "code": 2000,
  "data": {
    "current": 1,
    "pages": 3,
    "no_of_records": 10,
    "total": 28,
    "contexts": [
      {
        "context_id": "abc123def456",
        "patient_id": 1172416,
        "organisation_id": 638,
        "clinic_id": 412,
        "spry_case_id": "SPRY_CASE_69cd0c97e7562d613ea89bc7",
        "case_title": "Stable Burst Fracture",
        "appointment_id": 990812,
        "type": "FOLLOWUP_SOAP",
        "category": "SOAP",
        "service_date_time": "2026-05-12T10:00:00",
        "status": "COMPLETED",
        "completed": true,
        "completed_at": "2026-05-12T11:34:22",
        "submit_for_billing": true,
        "summary_doc_url": "soap_summary/1172416/d3f8a2bc-11e4-4c9b-9f1a-abc123456789.pdf",
        "short_summary_url": "soap_short_summary/1172416/e7c1b3ad-22f5-5d0c-af2b-bcd234567890.pdf",
        "billing_status": "BILLED",
        "is_soap_note_editable": false,
        "rendering_physician": 50112,
        "supervising_physician": null,
        "payment_mode": "INSURANCE_PAY",
        "soap_without_appointment": false,
        "tags": [],
        "created_at": "2026-05-12T09:55:00",
        "updated_at": "2026-05-12T11:34:22"
      }
    ]
  },
  "message": "Success"
}

Response Fields¶

Pagination envelope (data)

Field	Type	Description
`current`	integer	Current page number
`pages`	integer	Total number of pages
`no_of_records`	integer	Number of records on the current page
`total`	integer	Total number of SOAP notes across all pages
`contexts`	array	List of SOAP note objects (see below)

SOAP note object (contexts[])

Field	Type	Description
`context_id`	string	Unique SOAP note identifier
`patient_id`	integer	Patient ID
`organisation_id`	integer	Organization ID
`clinic_id`	integer	Clinic ID
`spry_case_id`	string	Associated case ID (format: `SPRY_CASE_<id>`)
`case_title`	string	Title of the associated case
`appointment_id`	integer	Associated appointment ID, or `null` for appointment-free notes
`type`	string	SOAP note type (see Note Types)
`category`	string	Note category
`service_date_time`	string	Date and time of the clinical service
`status`	string	Signature status — `INCOMPLETED`, `COSIGN`, `REVISION`, or `COMPLETED`
`completed`	boolean	`true` when the note has been fully signed and completed
`completed_at`	string	Timestamp when the note was completed, or `null`
`submit_for_billing`	boolean	`true` if the note has been submitted for billing
`summary_doc_url`	string	S3 key for the completed SOAP summary PDF, or `null` if not yet generated
`short_summary_url`	string	S3 key for the short summary PDF, or `null` if not yet generated
`billing_status`	string	Billing state for the note
`is_soap_note_editable`	boolean	Whether the note can still be edited
`rendering_physician`	integer	ID of the rendering (treating) physician
`supervising_physician`	integer	ID of the supervising physician, or `null`
`payment_mode`	string	Payment mode: `INSURANCE_PAY`, `SELF_PAY`, `CASH`, `CARD`, or `null`
`soap_without_appointment`	boolean	`true` for notes created without an appointment
`tags`	array	Custom tags attached to the note
`created_at`	string	Timestamp when the note was created
`updated_at`	string	Timestamp of the last update

Note Types¶

Value	Description
`INITIAL_SOAP`	Initial evaluation note
`FOLLOWUP_SOAP`	Follow-up visit note
`PROGRESS_NOTE`	Progress note
`DISCHARGE_NOTE`	Discharge note
`ADDENDUM`	Addendum to an existing note
`WEEKLY_NOTE`	Weekly summary note
`SIMPLE_DISCHARGE_NOTE`	Simplified discharge note
`RE_EVALUATION`	Re-evaluation note

Notes¶

The first page combines any legacy SOAP notes (pre-migration) with active notes. Legacy note stubs have context_id set to a placeholder and no associated PDF URLs.
summary_doc_url and short_summary_url are S3 object keys, not pre-signed URLs. Resolve them through your document download service to obtain a downloadable link.
To filter by case or date range, use the Search SOAP Notes endpoint.