Update clinical note

Updates an existing clinical note with AI-generated content, feedback, or metadata. Used to store AI-generated clinical documentation, link to conversation threads, and capture user feedback for quality improvement.

PATCH /v1/clinical-notes/{id}

Update clinical note

cURL

curl --request PATCH \
  --url https://{your-prod-endpoint}/v1/clinical-notes/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-doctor: <x-doctor>' \
  --data '
{
  "template": "SOAP",
  "ai_generated_content": {
    "subjective": "Patient reports chest pain radiating to left arm",
    "objective": "BP 140/90, HR 88, RR 18, O2 sat 98% on RA",
    "assessment": "R/O myocardial infarction",
    "plan": "Admit to CCU, serial troponins, cardiology consult"
  },
  "feedback": "Well structured note",
  "report_thread_id": "thread_xyz789",
  "report_run_id": [
    "run_001",
    "run_002"
  ]
}
'

200

{
  "id": "note_def456ghi",
  "user_id": "usr_123456789",
  "group_id": "grp_987654321",
  "transcription_id": "trans_abc123xyz",
  "template": "SOAP",
  "ai_generated_content": {
    "subjective": "Patient reports chest pain radiating to left arm",
    "objective": "BP 140/90, HR 88, RR 18, O2 sat 98% on RA",
    "assessment": "R/O myocardial infarction",
    "plan": "Admit to CCU, serial troponins, cardiology consult"
  },
  "feedback": "Well structured note",
  "report_thread_id": "thread_xyz789",
  "report_run_id": [
    "run_001",
    "run_002"
  ],
  "created_at": "2023-10-09T10:00:00.000Z",
  "updated_at": "2023-10-09T10:05:00.000Z"
}

Authorizations

Authorization · string · header · required

Bearer token for API authentication

Headers

x-doctor · string · required

Doctor identifier for tracking and auditing

x-patient · string

Patient identifier for tracking and auditing

Path Parameters

id · string<uuid> · required

The clinical note UUID

Body

application/json

template · string

Clinical note format template (e.g., SOAP, BIRP, DAP, GIRP)

Example:

"SOAP"

ai_generated_content · object

Structured clinical data generated by AI (schema varies by template)

Example:

{
  "subjective": "Patient reports chest pain radiating to left arm",
  "objective": "BP 140/90, HR 88, RR 18, O2 sat 98% on RA",
  "assessment": "R/O myocardial infarction",
  "plan": "Admit to CCU, serial troponins, cardiology consult"
}

feedback · string

User comments or feedback on the clinical note

Example:

"Well structured note"

report_thread_id · string

Thread ID that generated this content

Example:

"thread_xyz789"

report_run_id · string[]

Array of run IDs involved in generating this content

Example:

["run_001", "run_002"]

Response

200

application/json

Clinical note updated successfully

id · string<uuid> · required

Clinical note unique identifier

Example:

"note_def456ghi"

user_id · string · required

User identifier

Example:

"usr_123456789"

group_id · string · required

Group/organization identifier

Example:

"grp_987654321"

created_at · string<date-time> · required

Timestamp when note was created

Example:

"2023-10-09T10:00:00.000Z"

updated_at · string<date-time> · required

Timestamp when note was last updated

Example:

"2023-10-09T10:05:00.000Z"

transcription_id · string

Associated transcription identifier

Example:

"trans_abc123xyz"

template · string

Clinical note format template

Example:

"SOAP"

ai_generated_content · object

Structured clinical data

Example:

{
  "subjective": "Patient reports chest pain radiating to left arm",
  "objective": "BP 140/90, HR 88, RR 18, O2 sat 98% on RA",
  "assessment": "R/O myocardial infarction",
  "plan": "Admit to CCU, serial troponins, cardiology consult"
}

feedback · string

User feedback

Example:

"Well structured note"

report_thread_id · string

Associated thread ID

Example:

"thread_xyz789"

report_run_id · string[]

Associated run IDs

Example:

["run_001", "run_002"]