Get SOAP Note¶

Retrieve a single SOAP note (context) by its unique context ID.

Endpoint¶

GET /apis/v1/soap-context/{context_id}

Path Parameters¶

Parameter	Type	Required	Description
`context_id`	string	Yes	The unique identifier of the SOAP note

Request¶

curl --location '{base_url}/apis/v1/soap-context/abc123def456' \
  --header 'Authorization: Bearer JWT_TOKEN'

Response¶

Success Response¶

Code: 200 OK

{
  "code": 2000,
  "data": {
    "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",
    "entry_date_time": "2026-05-12T09:58:00",
    "status": "COMPLETED",
    "completed": true,
    "completed_at": "2026-05-12T11:34:22",
    "rendering_signature_date": "2026-05-12T11:34:22",
    "rendering_physician": 50112,
    "supervising_physician": null,
    "is_supervising_manually_changed": false,
    "billing_provider_id": 50112,
    "subjective_submission_id": "sub_78abc",
    "objective_submission_id": "obj_78abc",
    "assessment_submission_id": "asm_78abc",
    "summary_submission_id": "sum_78abc",
    "treatment_sheet_id": 33902,
    "plan_of_care_id": "poc_9xy12",
    "submit_for_billing": true,
    "sent_for_billing_at": "2026-05-13T08:00:00",
    "billing_status": "BILLED",
    "billing_claim_submitted_date": "2026-05-14",
    "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",
    "is_soap_note_editable": false,
    "is_fax_summary_sent": false,
    "payment_mode": "INSURANCE_PAY",
    "soap_without_appointment": false,
    "soap_auto_completed_after": null,
    "soap_auto_submit_for_billing_after": null,
    "checked_in_at": "2026-05-12T09:55:00",
    "tags": [],
    "attributes": {},
    "points_for_revision": [],
    "errors": [],
    "modification_rule_applied": false,
    "is_patient_created": false,
    "is_form_patching_completed": true,
    "created_by_role": "THERAPIST",
    "parent": null,
    "data_carry_forward_from": null,
    "created_at": "2026-05-12T09:55:00",
    "updated_at": "2026-05-12T11:34:22"
  },
  "message": "Success"
}

Response Fields¶

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
`entry_date_time`	string	Date and time the note entry was started
`status`	string	Signature status — `INCOMPLETED`, `COSIGN`, `REVISION`, or `COMPLETED` (see Signature Status Values)
`completed`	boolean	`true` when the note is fully signed and locked
`completed_at`	string	Timestamp when the note was completed, or `null`
`rendering_signature_date`	string	Timestamp of the rendering physician's signature, or `null`
`rendering_physician`	integer	ID of the rendering (treating) physician
`supervising_physician`	integer	ID of the supervising physician, or `null`
`is_supervising_manually_changed`	boolean	`true` if the supervising physician was overridden manually
`billing_provider_id`	integer	Billing provider ID used for claim submission
`subjective_submission_id`	string	Form submission ID for the Subjective section
`objective_submission_id`	string	Form submission ID for the Objective section
`assessment_submission_id`	string	Form submission ID for the Assessment section
`summary_submission_id`	string	Form submission ID for the Summary section
`treatment_sheet_id`	integer	Associated treatment sheet ID
`plan_of_care_id`	string	Associated Plan of Care ID, or `null`
`submit_for_billing`	boolean	`true` if the note has been submitted for billing
`sent_for_billing_at`	string	Timestamp when the note was sent to billing, or `null`
`billing_status`	string	Current billing state of the note
`billing_claim_submitted_date`	string	Date the billing claim was submitted (`YYYY-MM-DD`), or `null`
`summary_doc_url`	string	S3 key for the completed SOAP summary PDF — `null` until PDF generation completes
`short_summary_url`	string	S3 key for the short summary PDF — `null` until PDF generation completes
`is_soap_note_editable`	boolean	Whether the note can still be edited
`is_fax_summary_sent`	boolean	`true` if the summary has been sent by fax
`payment_mode`	string	Payment mode: `INSURANCE_PAY`, `SELF_PAY`, `CASH`, `CARD`, or `null`
`soap_without_appointment`	boolean	`true` for notes created without an appointment
`soap_auto_completed_after`	string	Scheduled auto-completion datetime, or `null`
`soap_auto_submit_for_billing_after`	string	Scheduled auto-billing submission datetime, or `null`
`checked_in_at`	string	Timestamp when the patient checked in, or `null`
`tags`	array	Custom tags attached to the note
`attributes`	object	Free-form attributes object (e.g. sub-type for re-evaluations)
`points_for_revision`	array	Revision feedback items when `status` is `REVISION`
`errors`	array	Validation errors preventing billing submission
`modification_rule_applied`	boolean	`true` if a billing modification rule was applied
`is_patient_created`	boolean	`true` if the note was initiated from the patient portal
`is_form_patching_completed`	boolean	`true` when all form template sections have been populated
`created_by_role`	string	Role of the user who created the note (e.g. `THERAPIST`)
`parent`	string	`context_id` of the parent note for addendums, or `null`
`data_carry_forward_from`	string	`context_id` of the note whose data was carried forward, or `null`
`created_at`	string	Note creation timestamp
`updated_at`	string	Timestamp of the last update

Error Response¶

Code: 200 OK

{
  "code": 4004,
  "data": null,
  "message": "Soap context not found"
}

Notes¶

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. Both fields are null until after the note is completed and the PDF generation job runs.
For an addendum, parent contains the context_id of the original note.
points_for_revision is populated when status is REVISION and contains the clinician's feedback requiring changes before the note can be completed.
To list all notes for a patient, use List SOAP Notes. To filter by date or case, use Search SOAP Notes.