August Health · Schema

com.august.api.integrations.models.incidents.v1.IncidentOrNote

CompanyHealthcareElectronic Health RecordsSenior LivingElder CareeMARBillingWebhook

Properties

Name Type Description
body string
externalMetadata object
id string
incident object
note object
onAlert object
personId string
recorder object
type string
View JSON Schema on GitHub

JSON Schema

august-health-com-august-api-integrations-models-incidents-v1-incident-or-note-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/august-health/json-schema/august-health-com-august-api-integrations-models-incidents-v1-incident-or-note-schema.json",
  "title": "com.august.api.integrations.models.incidents.v1.IncidentOrNote",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/august-health-incidents-v1-api-openapi.yml#/components/schemas/com.august.api.integrations.models.incidents.v1.IncidentOrNote",
  "properties": {
    "body": {
      "type": "string"
    },
    "externalMetadata": {
      "$ref": "#/$defs/com.august.api.integrations.models.incidents.v1.ExternalMetadata"
    },
    "id": {
      "type": "string"
    },
    "incident": {
      "$ref": "#/$defs/com.august.api.integrations.models.incidents.v1.IncidentDetails"
    },
    "note": {
      "$ref": "#/$defs/com.august.api.integrations.models.incidents.v1.NoteDetails"
    },
    "onAlert": {
      "$ref": "#/$defs/com.august.api.integrations.models.incidents.v1.OnAlert"
    },
    "personId": {
      "type": "string"
    },
    "recorder": {
      "oneOf": [
        {
          "$ref": "#/$defs/com.august.api.integrations.models.incidents.v1.Recorder.UserAccountRecorder"
        },
        {
          "$ref": "#/$defs/com.august.api.integrations.models.incidents.v1.Recorder.ExternalEntityStringRecorder"
        }
      ],
      "type": "object"
    },
    "type": {
      "enum": [
        "INCIDENT",
        "NOTE"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "personId"
  ],
  "$defs": {
    "com.august.api.integrations.models.incidents.v1.ExternalMetadata": {
      "properties": {
        "url": {
          "format": "uri",
          "type": "string"
        }
      }
    },
    "com.august.api.integrations.models.incidents.v1.IncidentDetails": {
      "properties": {
        "injuries": {
          "type": "string"
        },
        "location": {
          "$ref": "#/$defs/com.august.protos.incidents.IncidentLocation"
        },
        "occurrenceDate": {
          "format": "date",
          "type": "string"
        },
        "occurrenceTime": {
          "format": "time-local",
          "type": "string"
        },
        "status": {
          "$ref": "#/$defs/com.august.protos.incidents.IncidentStatus"
        },
        "tags": {
          "description": "Tags attached to this incident. Values may be members of the IncidentType enum (see the request schemas) or arbitrary operator-defined custom tag keys.",
          "items": {
            "description": "Tags attached to this incident. Values may be members of the IncidentType enum (see the request schemas) or arbitrary operator-defined custom tag keys.",
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "status",
        "location",
        "tags"
      ]
    },
    "com.august.api.integrations.models.incidents.v1.NoteDetails": {
      "properties": {
        "serviceDate": {
          "format": "date",
          "type": "string"
        },
        "serviceTime": {
          "format": "time-local",
          "type": "string"
        },
        "tags": {
          "description": "Tags attached to this note. Values may be members of the NoteType enum (see the request schemas) or arbitrary operator-defined custom tag keys.",
          "items": {
            "description": "Tags attached to this note. Values may be members of the NoteType enum (see the request schemas) or arbitrary operator-defined custom tag keys.",
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "tags"
      ]
    },
    "com.august.api.integrations.models.incidents.v1.OnAlert": {
      "properties": {
        "alertFrequency": {
          "$ref": "#/$defs/com.august.protos.incidents.AlertFrequency"
        },
        "alertFrequencyInMinutes": {
          "format": "int32",
          "type": "integer"
        },
        "endedAt": {
          "format": "date-time",
          "type": "string"
        },
        "note": {
          "type": "string"
        },
        "startedAt": {
          "format": "date-time",
          "type": "string"
        }
      }
    },
    "com.august.api.integrations.models.incidents.v1.Recorder.ExternalEntityStringRecorder": {
      "properties": {
        "externalEntity": {
          "type": "string"
        }
      },
      "required": [
        "externalEntity"
      ]
    },
    "com.august.api.integrations.models.incidents.v1.Recorder.UserAccountRecorder": {
      "properties": {
        "userAccountId": {
          "type": "string"
        }
      },
      "required": [
        "userAccountId"
      ]
    },
    "com.august.protos.incidents.AlertFrequency": {
      "enum": [
        "ALERT_FREQUENCY_1X_PER_SHIFT",
        "ALERT_FREQUENCY_2X_PER_SHIFT",
        "ALERT_FREQUENCY_3X_PER_SHIFT",
        "ALERT_FREQUENCY_4X_PER_SHIFT",
        "ALERT_FREQUENCY_1X_PER_DAY",
        "ALERT_FREQUENCY_2X_PER_DAY"
      ],
      "type": "string"
    },
    "com.august.protos.incidents.IncidentLocation": {
      "enum": [
        "INCIDENT_LOCATION_OTHER",
        "INCIDENT_LOCATION_ROOM",
        "INCIDENT_LOCATION_BATHROOM",
        "INCIDENT_LOCATION_SHOWER_BATHTUB",
        "INCIDENT_LOCATION_COMMON_AREA",
        "INCIDENT_LOCATION_DINING_ROOM",
        "INCIDENT_LOCATION_ACTIVITY_ROOM",
        "INCIDENT_LOCATION_BEAUTY_SALON",
        "INCIDENT_LOCATION_LOBBY",
        "INCIDENT_LOCATION_HALLWAY"
      ],
      "type": "string"
    },
    "com.august.protos.incidents.IncidentStatus": {
      "enum": [
        "INCIDENT_STATUS_OPEN",
        "INCIDENT_STATUS_COMPLETED"
      ],
      "type": "string"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/august-health-com-august-api-integrations-models-incidents-v1-incident-or-note"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.