Get Encounter Notes

GET /v1.0/appointments/encounters/notes

Retrieves a list of clinical notes for a given encounter or patient.

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

encounter_id

query

string

ID of the encounter.

No

encounter_start_date_time

query

string

Start date/time of the encounter (ISO 8601).

No

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

include_raw

query

boolean

Include raw data in the response. If set to true, raw EHR data is included.

No

include_fhir

query

boolean

Include FHIR format in the response.

No

Responses

200: List of clinical notes retrieved successfully (application/json)

404: Appointment not found (application/json)

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

Last updated