Sign in
Notes v2

Get Note For Edit V2

Fetch an EN2.1 note for editing. Creates a snapshot and returns snapshot_id for collaborative PATCH updates.

get/v2/notes/{note_id}/edit

Path parameters

note_idinteger required

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

Changes

No recorded changes to this endpoint across all 1 revision of this API.