--- title: "Update Note Amendment By Id V2" method: PATCH path: "/v2/notes/{note_id}/amendments/{amendment_id}" tags: ["Notes v2"] --- # Update Note Amendment By Id V2 `PATCH /v2/notes/{note_id}/amendments/{amendment_id}` Update a draft EN2.1 note amendment. ## Path parameters - `note_id` integer, required - `amendment_id` integer, required ## Request body - ElationNoteAmendmentUpdate — Request body for updating a sections-based note amendment. All fields optional. `content_map` replaces the full stored content_map. Amendment updates do not support `confidential` (parity with `NoteAmendmentUpdate`). Field order: content-update fields (`content_map`, `snapshot_id`) first, then mutable fields in the same order as ``ElationNoteCreate`` (``provider`` through ``metadata``; create-only ``layout_name``, ``practice``, ``patient`` omitted). - `bill` integer, nullable — The ID of the bill associated with the note. - `category` integer, nullable — Practice-created identifier for note category (Visit Note Type). - `content_map` ContentMapInput — Typed map from section type to its content. All sections are optional. Keys match section ``type`` wire values (``NodeType``): lowercase single words (e.g. ``narrative``, ``vitals``) or camelCase for multi-word nodes (e.g. ``followUp``). - `followUp` FollowupSectionInput - `content` union[] - union - FollowupParagraphInput - `attrs` FollowupParagraphAttrs - … - `content` union[] - … - `type` 'followUpParagraph' - FollowupUnorderedListInput - `attrs` AttrsWithRefId — Base attrs for any node that carries a stable change-tracking ref_id. - … - `content` FollowupListItemInput[] - … - `type` 'followUpUnorderedList' - FollowupOrderedListInput - `attrs` AttrsWithRefId — Base attrs for any node that carries a stable change-tracking ref_id. - … - `content` FollowupListItemInput[] - … - `type` 'followUpOrderedList' - `type` 'followUp' - `instructions` InstructionsSectionInput - `content` union[] - union - InstructionsParagraphInput - `attrs` InstructionParagraphAttrs - … - `content` union[] - … - `type` 'instructionsParagraph' - InstructionsUnorderedListInput - `attrs` AttrsWithRefId — Base attrs for any node that carries a stable change-tracking ref_id. - … - `content` InstructionsListItemInput[] - … - `type` 'instructionsUnorderedList' - InstructionsOrderedListInput - `attrs` AttrsWithRefId — Base attrs for any node that carries a stable change-tracking ref_id. - … - `content` InstructionsListItemInput[] - … - `type` 'instructionsOrderedList' - `type` 'instructions' - `narrative` NarrativeSectionInput - `content` union[] - union - NarrativeParagraphInput - `attrs` NarrativeParagraphAttrs - … - `content` union[] - … - `type` 'narrativeParagraph' - NarrativeUnorderedListInput - `attrs` AttrsWithRefId — Base attrs for any node that carries a stable change-tracking ref_id. - … - `content` NarrativeListItemInput[] - … - `type` 'narrativeUnorderedList' - NarrativeOrderedListInput - `attrs` AttrsWithRefId — Base attrs for any node that carries a stable change-tracking ref_id. - … - `content` NarrativeListItemInput[] - … - `type` 'narrativeOrderedList' - `type` 'narrative' - `orders` OrdersSectionInput - `content` union[] - union - PrescriptionBlockInput - `attrs` PrescriptionBlockAttrs, required - … - `type` 'prescription' - LabOrderBlockInput - `attrs` LabOrderBlockAttrsInput, required - … - `type` 'labOrder' - ImagingOrderBlockInput - `attrs` ImagingOrderBlockAttrsInput, required - … - `type` 'imagingOrder' - ReferralBlockInput - `attrs` ReferralBlockAttrs, required - … - `type` 'referral' - CardiacOrderBlockInput - `attrs` CardiacOrderBlockAttrsInput, required - … - `type` 'cardiacOrder' - PulmonaryOrderBlockInput - `attrs` PulmonaryOrderBlockAttrsInput, required - … - `type` 'pulmonaryOrder' - SleepOrderBlockInput - `attrs` SleepOrderBlockAttrsInput, required - … - `type` 'sleepOrder' - PatientImmunizationBlockInput - `attrs` PatientImmunizationAttrsInput, required - … - `type` 'patientImmunization' - InjectionBlockInput - `attrs` InjectionBlockAttrsInput, required - … - `type` 'injection' - HandoutBlockInput - `attrs` HandoutBlockAttrsInput, required - … - `type` 'handout' - `type` 'orders' - `procedures` ProcedureSectionInput - `content` union[] - union - ProcedureInput - `attrs` ProcedureAttrs, required - … - `type` 'procedure' - ProcedureParagraphInput - `attrs` ProcedureParagraphAttrs - … - `content` union[] - … - `type` 'proceduresParagraph' - ProcedureUnorderedListInput - `attrs` AttrsWithRefId — Base attrs for any node that carries a stable change-tracking ref_id. - … - `content` ProcedureListItemInput[] - … - `type` 'proceduresUnorderedList' - ProcedureOrderedListInput - `attrs` AttrsWithRefId — Base attrs for any node that carries a stable change-tracking ref_id. - … - `content` ProcedureListItemInput[] - … - `type` 'proceduresOrderedList' - `type` 'procedures' - `referencedDocuments` ReferencedDocumentsSectionInput - `content` ReferencedDocumentInput[] - `attrs` ReferencedDocumentAttrs, required - `document` ReferencedDocumentData, required — Structured reference to a hippo document (e.g. a lab/imaging report). Mirrors the VN1 reference-bullet payload: ``id`` is the report/document id, ``lab_result_id`` identifies an individual lab result within a lab report, ``summary`` is the link text shown in the UI, and ``summary_formatting`` carries optional VN1-style decoration offsets (kept for backport parity). - `id` integer, required - `lab_result_id` integer, nullable - `summary` string - `summary_formatting` unknown[] - … - `ref_id` string - `type` 'referencedDocument' - `type` 'referencedDocuments' - `vitals` VitalsSectionInput — Tier-1 vitals section; attrs mirror VN2 ``VitalsNode``. - `attrs` VitalsSectionAttrsInput - `ref_id` string - `vitals` El8NoteModelsNoteSectionsVitalsSectionVitals - `bmi` VitalBMI[] - `bmi` string, nullable - `edited_by_scribe` boolean - `bp` VitalBP[] - `bp_d` string - `bp_s` string - `edited_by_scribe` boolean - `extra_note` string - `id` integer, nullable - `fio2` VitalFiO2[] - `edited_by_scribe` boolean - `extra_note` string - `id` integer, nullable - `percent` string - `hc` VitalHC[] - `edited_by_scribe` boolean - `extra_note` string - `hc` string - `id` integer, nullable - `height` VitalHeight[] - `edited_by_scribe` boolean - `extra_note` string - `height` string - `id` integer, nullable - `hr` VitalHR[] - `edited_by_scribe` boolean - `extra_note` string - `hr` string - `id` integer, nullable - `oxygen` VitalOxygen[] - `edited_by_scribe` boolean - `extra_note` string - `id` integer, nullable - `percent` string - `pain` VitalPain[] - `edited_by_scribe` boolean - `extra_note` string - `id` integer, nullable - `pain` string - `rr` VitalRR[] - `edited_by_scribe` boolean - `extra_note` string - `id` integer, nullable - `rr` string - `temperature` VitalTemperature[] - `edited_by_scribe` boolean - `extra_note` string - `id` integer, nullable - `temperature` string - `weight` VitalWeight[] - `edited_by_scribe` boolean - `extra_note` string - `id` integer, nullable - `weight` string - `vitals_collection_id` integer, nullable - `type` 'vitals' - `exam_reason` string, nullable - `metadata` object, nullable - `provider` integer, nullable — The ID of the assigned provider. - `serviced_at` string, date-time, nullable - `snapshot_id` integer, nullable ## Response `200` Successful Response - ElationNoteAmendment — Full representation of an EN2.1 sections-based note amendment. Analogous to NoteAmendment for legacy DocumentNode notes. `previous_content` is populated after the amendment is signed and captures the parent note state at signing time. - `bill` integer, nullable - `category` integer, required - `content` SectionsContent, required — The sections-based note content: layout description + typed section content. - `content_map` ContentMapOutput, required — Typed map from section type to its content. All sections are optional. Keys match section ``type`` wire values (``NodeType``): lowercase single words (e.g. ``narrative``, ``vitals``) or camelCase for multi-word nodes (e.g. ``followUp``). - `followUp` FollowupSectionOutput - `content` union[] - union - FollowupParagraphOutput - … - FollowupUnorderedListOutput - … - FollowupOrderedListOutput - … - `type` 'followUp' - `instructions` InstructionsSectionOutput - `content` union[] - union - InstructionsParagraphOutput - … - InstructionsUnorderedListOutput - … - InstructionsOrderedListOutput - … - `type` 'instructions' - `narrative` NarrativeSectionOutput - `content` union[] - union - NarrativeParagraphOutput - … - NarrativeUnorderedListOutput - … - NarrativeOrderedListOutput - … - `type` 'narrative' - `orders` OrdersSectionOutput - `content` union[] - union - PrescriptionBlockOutput - … - LabOrderBlockOutput - … - ImagingOrderBlockOutput - … - ReferralBlockOutput - … - CardiacOrderBlockOutput - … - PulmonaryOrderBlockOutput - … - SleepOrderBlockOutput - … - PatientImmunizationBlockOutput - … - InjectionBlockOutput - … - HandoutBlockOutput - … - `type` 'orders' - `procedures` ProcedureSectionOutput - `content` union[] - union - ProcedureOutput - … - ProcedureParagraphOutput - … - ProcedureUnorderedListOutput - … - ProcedureOrderedListOutput - … - `type` 'procedures' - `referencedDocuments` ReferencedDocumentsSectionOutput - `content` ReferencedDocumentOutput[] - `attrs` ReferencedDocumentAttrs, required - `document` ReferencedDocumentData, required — Structured reference to a hippo document (e.g. a lab/imaging report). Mirrors the VN1 reference-bullet payload: ``id`` is the report/document id, ``lab_result_id`` identifies an individual lab result within a lab report, ``summary`` is the link text shown in the UI, and ``summary_formatting`` carries optional VN1-style decoration offsets (kept for backport parity). - … - `ref_id` string - `type` 'referencedDocument' - `type` 'referencedDocuments' - `vitals` VitalsSectionOutput — Tier-1 vitals section; attrs mirror VN2 ``VitalsNode``. - `attrs` VitalsSectionAttrsOutput - `ref_id` string - `vitals` El8NoteModelsNoteSectionsVitalsSectionVitals - `bmi` VitalBMI[] - … - `bp` VitalBP[] - … - `fio2` VitalFiO2[] - … - `hc` VitalHC[] - … - `height` VitalHeight[] - … - `hr` VitalHR[] - … - `oxygen` VitalOxygen[] - … - `pain` VitalPain[] - … - `rr` VitalRR[] - … - `temperature` VitalTemperature[] - … - `weight` VitalWeight[] - … - `vitals_collection_id` integer, nullable - `type` 'vitals' - `layout` Layout, required — Structural description of a note. `name` identifies the template (e.g. "simple_note", "soap"). `content` lists columns (1 for single-column, 2 for two-column). Each column's `content` list defines both which section blocks are permitted and their display order. Headers are decorative dividers. - `content` NoteLayoutColumn[] - `content` union[] - union - NoteLayoutHeader — Decorative section divider — display text only, no clinical meaning. - … - NoteLayoutBlock — A section slot in the layout. `type` is the section identifier. - … - `type` 'column' - `name` string, required - `exam_reason` string, nullable - `id` integer, required - `is_draft` boolean, required - `is_outdated` boolean - `metadata` object, nullable - `note_id` integer, required - `patient` integer, required - `practice` integer, required - `previous_content` SectionsContent — The sections-based note content: layout description + typed section content. - `content_map` ContentMapOutput, required — Typed map from section type to its content. All sections are optional. Keys match section ``type`` wire values (``NodeType``): lowercase single words (e.g. ``narrative``, ``vitals``) or camelCase for multi-word nodes (e.g. ``followUp``). - `followUp` FollowupSectionOutput - `content` union[] - union - FollowupParagraphOutput - … - FollowupUnorderedListOutput - … - FollowupOrderedListOutput - … - `type` 'followUp' - `instructions` InstructionsSectionOutput - `content` union[] - union - InstructionsParagraphOutput - … - InstructionsUnorderedListOutput - … - InstructionsOrderedListOutput - … - `type` 'instructions' - `narrative` NarrativeSectionOutput - `content` union[] - union - NarrativeParagraphOutput - … - NarrativeUnorderedListOutput - … - NarrativeOrderedListOutput - … - `type` 'narrative' - `orders` OrdersSectionOutput - `content` union[] - union - PrescriptionBlockOutput - … - LabOrderBlockOutput - … - ImagingOrderBlockOutput - … - ReferralBlockOutput - … - CardiacOrderBlockOutput - … - PulmonaryOrderBlockOutput - … - SleepOrderBlockOutput - … - PatientImmunizationBlockOutput - … - InjectionBlockOutput - … - HandoutBlockOutput - … - `type` 'orders' - `procedures` ProcedureSectionOutput - `content` union[] - union - ProcedureOutput - … - ProcedureParagraphOutput - … - ProcedureUnorderedListOutput - … - ProcedureOrderedListOutput - … - `type` 'procedures' - `referencedDocuments` ReferencedDocumentsSectionOutput - `content` ReferencedDocumentOutput[] - `attrs` ReferencedDocumentAttrs, required - `document` ReferencedDocumentData, required — Structured reference to a hippo document (e.g. a lab/imaging report). Mirrors the VN1 reference-bullet payload: ``id`` is the report/document id, ``lab_result_id`` identifies an individual lab result within a lab report, ``summary`` is the link text shown in the UI, and ``summary_formatting`` carries optional VN1-style decoration offsets (kept for backport parity). - … - `ref_id` string - `type` 'referencedDocument' - `type` 'referencedDocuments' - `vitals` VitalsSectionOutput — Tier-1 vitals section; attrs mirror VN2 ``VitalsNode``. - `attrs` VitalsSectionAttrsOutput - `ref_id` string - `vitals` El8NoteModelsNoteSectionsVitalsSectionVitals - `bmi` VitalBMI[] - … - `bp` VitalBP[] - … - `fio2` VitalFiO2[] - … - `hc` VitalHC[] - … - `height` VitalHeight[] - … - `hr` VitalHR[] - … - `oxygen` VitalOxygen[] - … - `pain` VitalPain[] - … - `rr` VitalRR[] - … - `temperature` VitalTemperature[] - … - `weight` VitalWeight[] - … - `vitals_collection_id` integer, nullable - `type` 'vitals' - `layout` Layout, required — Structural description of a note. `name` identifies the template (e.g. "simple_note", "soap"). `content` lists columns (1 for single-column, 2 for two-column). Each column's `content` list defines both which section blocks are permitted and their display order. Headers are decorative dividers. - `content` NoteLayoutColumn[] - `content` union[] - union - NoteLayoutHeader — Decorative section divider — display text only, no clinical meaning. - … - NoteLayoutBlock — A section slot in the layout. `type` is the section identifier. - … - `type` 'column' - `name` string, required - `provider` integer, required - `serviced_at` string, date-time, required - `signatures` DocumentSignature[] - `amendment_id` integer, nullable — ID of the note amendment this signature applies to, if any; null for signatures on the base note or legacy records. - `on_behalf_of_user_id` integer, nullable - `on_behalf_of_user_name` string, nullable - `signature_comments` string, required - `signature_role` 'amender' | 'cosigner' | 'rendering_provider' | 'staff_autofiler', required — The role the user is performing when adding a signature to a visit note - `signed_at` string, date-time, required — When the associated document was signed with this signature. - `user_id` integer, required — The ID of the user who authored the signature. - `user_name` string, required — The name of the user who authored the signature. ## Other responses - `422` — Validation Error --- [API](https://skmtc.net/elationhealth/apis/api-authentication.md) · [All operations](https://skmtc.net/elationhealth/apis/api-authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elationhealth/api-authentication/versions/c060f89d4de7/schema)