Update Appointment Pre-Visit Notes

PUT /v1.0/appointments/pre-visit/notes

Updates pre-visit notes for a specific patient appointment.

Parameters

Name

In

Type

Description

Required

x-sully-organization-id

header

string

Organization ID for multi-tenant support.

Yes

x-sully-transaction-id

header

string

Transaction ID for tracking purposes.

Yes

patient_first_name

query

string

Patient’s first name (required if phone_number is not provided).

Conditional

patient_last_name

query

string

Patient’s last name (required if phone_number is not provided).

Conditional

patient_date_of_birth

query

string

Patient’s date of birth in YYYY-MM-DD format (required if phone_number is not provided).

Conditional

patient_phone_number

query

string

Patient’s phone number (required if first_name, last_name, and date_of_birth are not all provided).

Conditional

patient_email

query

string

Patient’s email address (required if first_name, last_name, and date_of_birth are not all provided).

No

appointment_date_time

query

string

Appointment date and time in ISO 8601 format for which to update pre-visit notes

Yes

include_raw

query

boolean

Include raw data in the response.

No

include_fhir

query

boolean

Include FHIR format in the response.

No

Request Body (
application/json
)
"string"

Responses

  • 200: Pre-visit notes updated successfully (application/json)

  • 400: Bad request due to invalid input (application/json)

  • 404: Patient does not exist in the system (application/json)

Last updated