Sign in

v1

latestOpenAPI 3.1.02026-07-24447622848.7 KB
Visit Notes

Create Visit Note

post/api/2.0/visit_notes/

Request body

chart_datestring date-time required

Visit note chart date.

checklistsobject

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

clinical_summary_linkstring uri
confidentialboolean

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

created_datestring date-time nullable
deleted_datestring date-time nullable
document_datestring date-time required

Visit note document date.

idinteger
last_modifiedstring date-time
patientinteger required
physicianinteger required
practiceinteger
signed_byinteger nullable

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

signed_datestring date-time nullable

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

template'Complete H&P (1 col)' | 'Complete H&P (2 col A/P)' | 'Complete H&P (2 col)' | 'Pre-Op' | 'SOAP' | 'Simple' required
typestring

Visit note type.

visit_summary_linkstring uri

Response

chart_datestring date-time required

Visit note chart date.

checklistsobject

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

clinical_summary_linkstring uri
confidentialboolean

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

created_datestring date-time nullable
deleted_datestring date-time nullable
document_datestring date-time required

Visit note document date.

idinteger
last_modifiedstring date-time
patientinteger required
physicianinteger required
practiceinteger
signed_byinteger nullable

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

signed_datestring date-time nullable

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

template'Complete H&P (1 col)' | 'Complete H&P (2 col A/P)' | 'Complete H&P (2 col)' | 'Pre-Op' | 'SOAP' | 'Simple' required
typestring

Visit note type.

visit_summary_linkstring uri