NoteAmendment

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/elation-health/main/json-schema/elation-health-note-amendment-schema.json",
  "title": "NoteAmendment",
  "description": "Full representation of a note amendment fetched from the DB\nNote Amendment is a clone of Note and is analogous to a VisitNoteEdit for a Visit Note 1",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/elation-health-notes-api-openapi.yml#/components/schemas/NoteAmendment",
  "properties": {
    "bill": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "The ID of the bill associated with the note",
      "title": "Bill"
    },
    "category": {
      "description": "Practice-created identifiers for note category.\nA category is a Visit Note Type object.\nSee https://docs.elationhealth.com/reference/visit_note_types_list for API to list all available categories.",
      "title": "Category",
      "type": "integer"
    },
    "content": {
      "anyOf": [
        {
          "$ref": "#/$defs/DocumentNode-Output"
        },
        {
          "type": "null"
        }
      ],
      "description": "An object representing the body of the note."
    },
    "exam_reason": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Exam Reason"
    },
    "id": {
      "title": "Id",
      "type": "integer"
    },
    "is_draft": {
      "title": "Is Draft",
      "type": "boolean"
    },
    "is_outdated": {
      "default": false,
      "title": "Is Outdated",
      "type": "boolean"
    },
    "metadata": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": {},
      "description": "Unstructured data for storing related metadata.",
      "title": "Metadata"
    },
    "note_id": {
      "title": "Note Id",
      "type": "integer"
    },
    "patient": {
      "description": "The ID of the patient for whom the note was created.",
      "title": "Patient",
      "type": "integer"
    },
    "practice": {
      "description": "Authoring practice ID.",
      "title": "Practice",
      "type": "integer"
    },
    "previous_content": {
      "anyOf": [
        {
          "$ref": "#/$defs/DocumentNode-Output"
        },
        {
          "type": "null"
        }
      ]
    },
    "provider": {
      "description": "The ID of the assigned provider.",
      "title": "Provider",
      "type": "integer"
    },
    "serviced_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Serviced At"
    },
    "signatures": {
      "default": [],
      "items": {
        "$ref": "#/$defs/DocumentSignature"
      },
      "title": "Signatures",
      "type": "array"
    }
  },
  "required": [
    "provider",
    "practice",
    "patient",
    "category",
    "serviced_at",
    "id",
    "note_id",
    "is_draft"
  ],
  "type": "object",
  "$defs": {
    "AiGenerationInfo": {
      "properties": {
        "is_finalized": {
          "default": true,
          "title": "Is Finalized",
          "type": "boolean"
        },
        "transcript_source_text": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": "",
          "title": "Transcript Source Text"
        }
      },
      "title": "AiGenerationInfo",
      "type": "object"
    },
    "AnyNodeContent": {
      "additionalProperties": true,
      "description": "Placeholder for node content, eliminating cycles in OpenAPI schema generation.\nThis should be replaced with any node content type when calling the API",
      "properties": {},
      "title": "AnyNodeContent",
      "type": "object"
    },
    "ColumnLayoutNode-Output": {
      "additionalProperties": true,
      "properties": {
        "attrs": {
          "anyOf": [
            {
              "$ref": "#/$defs/el8_note_models__note__content__base_node__Node__NodeAttrs"
            },
            {
              "type": "null"
            }
          ]
        },
        "content": {
          "default": [],
          "items": {
            "$ref": "#/$defs/AnyNodeContent"
          },
          "title": "Content",
          "type": "array"
        },
        "type": {
          "const": "columnLayout",
          "default": "columnLayout",
          "title": "Type",
          "type": "string"
        }
      },
      "title": "ColumnLayoutNode",
      "type": "object"
    },
    "DocumentNode-Output": {
      "additionalProperties": true,
      "properties": {
        "attrs": {
          "anyOf": [
            {
              "$ref": "#/$defs/el8_note_models__note__content__base_node__Node__NodeAttrs"
            },
            {
              "type": "null"
            }
          ]
        },
        "content": {
          "items": {
            "$ref": "#/$defs/DocumentNodeChild-Output"
          },
          "title": "Content",
          "type": "array"
        },
        "type": {
          "const": "document",
          "default": "document",
          "title": "Type",
          "type": "string"
        }
      },
      "title": "DocumentNode",
      "type": "object"
    },
    "DocumentNodeChild-Output": {
      "oneOf": [
        {
          "$ref": "#/$defs/TwoColumnLayoutNode-Output"
        },
        {
          "$ref": "#/$defs/ColumnLayoutNode-Output"
        }
      ]
    },
    "DocumentSignature": {
      "description": "A signature on a document.",
      "properties": {
        "amendment_id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "description": "ID of the note amendment this signature applies to, if any; null for signatures on the base note or legacy records.",
          "title": "Amendment Id"
        },
        "on_behalf_of_user_id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "title": "On Behalf Of User Id"
        },
        "on_behalf_of_user_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "On Behalf Of User Name"
        },
        "signature_comments": {
          "title": "Signature Comments",
          "type": "string"
        },
        "signature_role": {
          "$ref": "#/$defs/DocumentSignatureRole"
        },
        "signed_at": {
          "description": "When the associated document was signed with this signature.",
          "format": "date-time",
          "title": "Signed At",
          "type": "string"
        },
        "user_id": {
          "description": "The ID of the user who authored the signature.",
          "title": "User Id",
          "type": "integer"
        },
        "user_name": {
          "description": "The name of the user who authored the signature.",
          "title": "User Name",
          "type": "string"
        }
      },
      "required": [
        "user_id",
        "user_name",
        "signed_at",
        "signature_role",
        "signature_comments"
      ],
      "title": "DocumentSignature",
      "type": "object"
    },
    "DocumentSignatureRole": {
      "description": "The role the user is performing when adding a signature to a visit note",
      "enum": [
        "amender",
        "cosigner",
        "rendering_provider",
        "staff_autofiler"
      ],
      "title": "DocumentSignatureRole",
      "type": "string"
    },
    "TwoColumnLayoutNode-Output": {
      "additionalProperties": true,
      "properties": {
        "attrs": {
          "anyOf": [
            {
              "$ref": "#/$defs/el8_note_models__note__content__base_node__Node__NodeAttrs"
            },
            {
              "type": "null"
            }
          ]
        },
        "content": {
          "items": {
            "$ref": "#/$defs/ColumnLayoutNode-Output"
          },
          "title": "Content",
          "type": "array"
        },
        "type": {
          "const": "twoColumnLayout",
          "default": "twoColumnLayout",
          "title": "Type",
          "type": "string"
        }
      },
      "title": "TwoColumnLayoutNode",
      "type": "object"
    },
    "el8_note_models__note__content__base_node__Node__NodeAttrs": {
      "properties": {
        "ai_generation_info": {
          "anyOf": [
            {
              "$ref": "#/$defs/AiGenerationInfo"
            },
            {
              "type": "null"
            }
          ]
        },
        "creation_type": {
          "anyOf": [
            {
              "enum": [
                "ai",
                "template"
              ],
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Creation Type"
        },
        "is_new": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "title": "Is New"
        },
        "ref_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Ref Id"
        }
      },
      "title": "NodeAttrs",
      "type": "object"
    }
  }
}