Sign in
Notes v1

Update Note By Id V1

Update a legacy Note. Returns HTTP 400 if the note uses the EN2.1 schema (pass content_map and use the /v2/ endpoint instead).

patch/v1/notes/{note_id}

Path parameters

note_idinteger required

Request body

billinteger nullable
categoryinteger nullable
close_snapshotboolean nullable
confidentialboolean
exam_reasonstring nullable
{"stackTrail":"components:schemas:NoteUpdate:properties:metadata:anyOf","oasType":"schema","type":"unknown","title":"Metadata","nullable":true}
providerinteger nullable
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 identifiers for note category. A category is a Visit Note Type object. See https://docs.elationhealth.com/reference/visit_note_types_list for API to list all available categories.

confidentialboolean

Whether the note is marked as confidential.

exam_reasonstring nullable
idinteger required
is_draftboolean required
is_outdatedboolean
metadataobject nullable

Unstructured data for storing related metadata.

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 nullable required
snapshot_idinteger nullable
summarystring nullable

Changes

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