Skip to main content
GET
Retrieve Visit Note

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
integer<int64>
required

Response

200 - application/json
bullets
object[]
required
chart_date
string<date-time>
required

Visit note chart date.

document_date
string<date-time>
required

Visit note document date.

patient
integer<int64>
required
physician
integer<int64>
required
template
enum<string>
required
Available options:
Complete H&P (1 col),
Complete H&P (2 col A/P),
Complete H&P (2 col),
Pre-Op,
SOAP,
Simple
amendment_request
object
checklists
object

Dictionary of checklists by type (e.g. 'pe', 'ros'), where each checklist contains a list of fields with name, value and sequence

confidential
boolean
default:false

Whether this note is confidential to the practice and shouldn't be shared automatically with third parties.

created_date
string<date-time> | null
read-only
deleted_date
string<date-time> | null
read-only
edits
object[]
id
integer
read-only
last_modified
string<date-time>
practice
integer<int64>
read-only
signatures
object[]

The list of signatures if co-signing is enabled for the practice. (Requires Special Permission).

signed_by
integer<int64> | null

The user id of the provider who signed the visit note. (Requires special permission).

signed_date
string<date-time> | null

The time at which the visit note was signed. Cannot be in the future. (Requires Special Permission).

tags
integer<int64>[]
type
string
default:Office Visit Note

Visit note type.