Skip to main content
PATCH
Edit SOAP note fields

Authorizations

Authorization
string
header
required

Marketplace API key

Headers

X-Organization-Id
string
required

Target clinic organization ID

Path Parameters

noteId
string
required

Note ID (stable root ID or any version ID)

Query Parameters

providerId
string
required

Body

application/json
additionalHpiComments
string

Additional HPI comments text (use empty string to clear)

Example:

"Patient reports improvement since last visit."

impressionsPlansComments
string

Impressions & Plans additional comments text (use empty string to clear)

Example:

"Continue current treatment plan for 3 months."

otherExamComments
string

Other physical exam comments text (use empty string to clear)

Example:

"No new lesions noted on re-examination."

stickyNoteDescription
string

Patient sticky note description (patient-level, not note-level; use empty string to clear)

Example:

"Patient prefers morning appointments."

Response

Success

code
string
required

Response code

Example:

"success"

data
object
required