{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/elation-health/main/json-schema/elation-health-visit-note-schema.json",
  "title": "VisitNote",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/elation-health-visit-notes-api-openapi.yml#/components/schemas/VisitNote",
  "properties": {
    "amendment_request": {
      "allOf": [
        {
          "$ref": "#/$defs/AmendmentRequest"
        }
      ],
      "readOnly": true
    },
    "bullets": {
      "description": "The bullets of the visit note.",
      "items": {
        "$ref": "#/$defs/BulletWithMeta"
      },
      "type": "array"
    },
    "chart_date": {
      "description": "Visit note chart date.",
      "format": "date-time",
      "type": "string"
    },
    "checklists": {
      "additionalProperties": {
        "items": {
          "properties": {
            "name": {
              "description": "Name of the checklist field",
              "type": "string"
            },
            "sequence": {
              "description": "Order of the field in the checklist",
              "type": "integer"
            },
            "value": {
              "description": "Value of the checklist field",
              "type": "string"
            }
          },
          "required": [
            "name",
            "value",
            "sequence"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "description": "Dictionary of checklists by type (e.g. 'pe', 'ros'), where each checklist contains a list of fields with name, value and sequence",
      "type": "object"
    },
    "clinical_summary_link": {
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "confidential": {
      "default": false,
      "description": "Whether this note is confidential to the practice and shouldn't be shared automatically with third parties.",
      "type": "boolean"
    },
    "created_date": {
      "format": "date-time",
      "readOnly": true,
      "type": [
        "string",
        "null"
      ]
    },
    "deleted_date": {
      "format": "date-time",
      "readOnly": true,
      "type": [
        "string",
        "null"
      ]
    },
    "document_date": {
      "description": "Visit note document date.",
      "format": "date-time",
      "type": "string"
    },
    "edits": {
      "items": {
        "$ref": "#/$defs/VisitNoteEdit"
      },
      "type": "array"
    },
    "id": {
      "readOnly": true,
      "type": "integer"
    },
    "last_modified": {
      "format": "date-time",
      "type": "string"
    },
    "patient": {
      "format": "int64",
      "type": "integer"
    },
    "physician": {
      "format": "int64",
      "type": "integer"
    },
    "practice": {
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "signatures": {
      "allOf": [
        {
          "$ref": "#/$defs/VisitNoteSignatureList"
        }
      ],
      "description": "The list of signatures if co-signing is enabled for the practice. (Requires Special Permission)."
    },
    "signed_by": {
      "description": "The user id of the provider who signed the visit note. (Requires special permission).",
      "format": "int64",
      "type": [
        "integer",
        "null"
      ]
    },
    "signed_date": {
      "description": "The time at which the visit note was signed. Cannot be in the future. (Requires Special Permission).",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "template": {
      "$ref": "#/$defs/TemplateEnum"
    },
    "type": {
      "default": "Office Visit Note",
      "description": "Visit note type.",
      "type": "string"
    },
    "visit_summary_link": {
      "format": "uri",
      "readOnly": true,
      "type": "string"
    }
  },
  "required": [
    "bullets",
    "chart_date",
    "document_date",
    "patient",
    "physician",
    "template"
  ],
  "type": "object",
  "$defs": {
    "AmendmentRequest": {
      "properties": {
        "amendment_source": {
          "$ref": "#/$defs/AmendmentSourceEnum"
        },
        "request_date": {
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "request_description": {
          "type": "string"
        },
        "status": {
          "$ref": "#/$defs/AmendmentRequestStatusEnum"
        },
        "status_updated_date": {
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "amendment_source",
        "request_description",
        "status"
      ],
      "type": "object"
    },
    "AmendmentRequestStatusEnum": {
      "enum": [
        "accepted",
        "denied"
      ],
      "type": "string"
    },
    "AmendmentSourceEnum": {
      "enum": [
        "Patient",
        "Provider or Organization"
      ],
      "type": "string"
    },
    "BulletWithMeta": {
      "properties": {
        "author": {
          "description": "The author of the bullet.",
          "type": "integer"
        },
        "category": {
          "allOf": [
            {
              "$ref": "#/$defs/CategoryEnum"
            }
          ],
          "description": "The category of the bullet."
        },
        "deleted_date": {
          "format": "date-time",
          "readOnly": true,
          "type": [
            "string",
            "null"
          ]
        },
        "edit": {
          "format": "int64",
          "type": [
            "integer",
            "null"
          ]
        },
        "note_document": {
          "description": "A document referenced by the bullet.",
          "oneOf": [
            {
              "$ref": "#/$defs/VisitNoteDocument"
            },
            {
              "type": "null"
            }
          ]
        },
        "replaced_by": {
          "format": "int64",
          "type": [
            "integer",
            "null"
          ]
        },
        "replaced_by_edit": {
          "format": "int64",
          "type": [
            "integer",
            "null"
          ]
        },
        "sequence": {
          "description": "The sequence number of the bullet.",
          "minimum": 0,
          "type": "integer"
        },
        "text": {
          "description": "The text of the bullet.",
          "type": "string"
        },
        "updated_date": {
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "version": {
          "maximum": 65535,
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "category",
        "text"
      ],
      "type": "object"
    },
    "CategoryEnum": {
      "enum": [
        "Allergies",
        "Assessment",
        "Assessplan",
        "Attending",
        "Consultant",
        "Data",
        "Dateprocedure",
        "ElationNoteColOne",
        "ElationNoteColTwo",
        "ElationNoteCustomBlock",
        "ElationNoteOtherData",
        "Family",
        "Followup",
        "Habits",
        "Hpi",
        "Instr",
        "Med",
        "Narrative",
        "Objective",
        "Orders",
        "PE",
        "Past",
        "Plan",
        "Problem",
        "Procedure",
        "ROS",
        "Reason",
        "Referenced",
        "Social",
        "Surgical",
        "Test",
        "Tx"
      ],
      "type": "string"
    },
    "Document": {
      "properties": {
        "authoring_practice": {
          "format": "int64",
          "type": "integer"
        },
        "chart_date": {
          "description": "The creation date of the patient chart.",
          "format": "date-time",
          "type": "string"
        },
        "created_date": {
          "description": "The creation date of the document.",
          "format": "date-time",
          "readOnly": true,
          "type": [
            "string",
            "null"
          ]
        },
        "deleted_date": {
          "description": "The deleted date of the document.",
          "format": "date-time",
          "readOnly": true,
          "type": [
            "string",
            "null"
          ]
        },
        "document_date": {
          "description": "The date of the document. In most cases it's the same as the creation date. For some documents, like visit notes, it's the date of the visit note.",
          "format": "date-time",
          "type": "string"
        },
        "document_type": {
          "readOnly": true,
          "type": [
            "integer",
            "null"
          ]
        },
        "id": {
          "format": "int64",
          "type": "integer"
        },
        "last_modified": {
          "format": "date-time",
          "type": "string"
        },
        "patient": {
          "format": "int64",
          "type": "integer"
        },
        "sign_date": {
          "description": "The date of when the document was signed (if signed).",
          "format": "date-time",
          "readOnly": true,
          "type": [
            "string",
            "null"
          ]
        },
        "signed_by": {
          "description": "The id of whoever signed the document (if signed).",
          "readOnly": true,
          "type": "integer"
        }
      },
      "required": [
        "authoring_practice",
        "chart_date",
        "document_date",
        "id",
        "patient"
      ],
      "type": "object"
    },
    "TemplateEnum": {
      "enum": [
        "Complete H&P (1 col)",
        "Complete H&P (2 col A/P)",
        "Complete H&P (2 col)",
        "Pre-Op",
        "SOAP",
        "Simple"
      ],
      "type": "string"
    },
    "VisitNoteDocument": {
      "properties": {
        "document": {
          "allOf": [
            {
              "$ref": "#/$defs/Document"
            }
          ],
          "description": "The id of the document, e.g. the id of the report or order."
        },
        "id": {
          "readOnly": true,
          "type": "integer"
        },
        "summary": {
          "description": "A textual summary of the document. Will show up in the visit note editor view, while the bullet text will be used in views outside the editor.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "document"
      ],
      "type": "object"
    },
    "VisitNoteEdit": {
      "properties": {
        "create_user": {
          "type": "integer"
        },
        "created_date": {
          "format": "date-time",
          "readOnly": true,
          "type": [
            "string",
            "null"
          ]
        },
        "new_bmi": {
          "format": "double",
          "type": "number"
        },
        "new_note_time": {
          "format": "date-time",
          "type": "string"
        },
        "new_note_type": {
          "type": "string"
        },
        "new_prev_bmi": {
          "format": "double",
          "type": "number"
        },
        "new_prev_time": {
          "format": "date-time",
          "type": "string"
        },
        "new_prev_weight": {
          "maxLength": 10,
          "type": "string"
        },
        "previous_bmi": {
          "format": "double",
          "type": "number"
        },
        "previous_note_time": {
          "format": "date-time",
          "type": "string"
        },
        "previous_note_type": {
          "type": "string"
        },
        "previous_prev_bmi": {
          "format": "double",
          "type": "number"
        },
        "previous_prev_time": {
          "format": "date-time",
          "type": "string"
        },
        "previous_prev_weight": {
          "maxLength": 10,
          "type": "string"
        },
        "visit_note": {
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "visit_note"
      ],
      "type": "object"
    },
    "VisitNoteSignatureList": {
      "items": {
        "properties": {
          "comments": {
            "description": "Any comments the signer made about the signature.",
            "type": "string"
          },
          "role": {
            "description": "The function of the signer.",
            "type": "string"
          },
          "signed_date": {
            "description": "Date-time timestamp for when this signature occurred.",
            "format": "date-time",
            "type": "string"
          },
          "user": {
            "description": "ID of the user whose signature this represents.",
            "type": "string"
          },
          "user_name": {
            "description": "The full name and title of the user whose signature this represents.",
            "type": "string"
          }
        },
        "required": [
          "comments",
          "role",
          "signed_date",
          "user",
          "user_name"
        ],
        "type": "object"
      },
      "type": "array"
    }
  }
}