Sign in

v1

latestOpenAPI 3.1.02026-07-24447622848.7 KB
Notes v2

Update Note By Id V2

Update an EN2.1 sections-based Note.

patch/v2/notes/{note_id}

Path parameters

note_idinteger required

Request body

billinteger nullable

The ID of the bill associated with the note.

categoryinteger nullable

Practice-created identifier for note category (Visit Note Type).

confidentialboolean nullable
exam_reasonstring nullable
metadataobject nullable
providerinteger nullable

The ID of the assigned provider.

serviced_atstring date-time nullable
snapshot_idinteger nullable

Response

Successful Response

billinteger nullable

The ID of the bill associated with the note.

categoryinteger required

Practice-created identifier for note category (Visit Note Type).

confidentialboolean
exam_reasonstring nullable
idinteger required
is_draftboolean required
is_outdatedboolean
layout_namestring required

Name of the pre-defined layout, e.g. 'simple_note'.

metadataobject nullable
patientinteger required

The ID of the patient for whom the note was created.

practiceinteger required

Authoring practice ID.

providerinteger required

The ID of the assigned provider.

serviced_atstring date-time required
snapshot_idinteger nullable
summarystring nullable