{
  "$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-assessments-v1-assessment-schema.json",
  "title": "com.august.api.integrations.models.assessments.v1.Assessment",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/august-health-assessments-v1-api-openapi.yml#/components/schemas/com.august.api.integrations.models.assessments.v1.Assessment",
  "properties": {
    "admissionType": {
      "$ref": "#/$defs/com.august.protos.admissions.AdmissionsInformation.AdmissionType",
      "description": "The admission type at the time of assessment"
    },
    "assessmentReason": {
      "$ref": "#/$defs/com.august.api.integrations.models.assessments.v1.AssessmentReason",
      "description": "The reason for this assessment (e.g., Move In, Change of Condition)"
    },
    "assessmentType": {
      "$ref": "#/$defs/com.august.protos.settings.appraisal_settings.AppraisalSettings.AssessmentType",
      "description": "State-specific assessment type (e.g., \"ASSESSMENT_TYPE_PERSONAL_CARE\")"
    },
    "categories": {
      "description": "All assessment categories with their questions and answers",
      "items": {
        "$ref": "#/$defs/com.august.api.integrations.models.assessments.v1.AssessmentCategory",
        "description": "All assessment categories with their questions and answers"
      },
      "type": "array"
    },
    "completedAt": {
      "description": "When the assessment was finalized",
      "format": "date-time",
      "type": "string"
    },
    "id": {
      "description": "The unique identifier for this assessment snapshot",
      "type": "string"
    },
    "personId": {
      "description": "The ID of the person this assessment belongs to",
      "type": "string"
    },
    "scores": {
      "$ref": "#/$defs/com.august.api.integrations.models.assessments.v1.AssessmentScores",
      "description": "Calculated scores from the assessment"
    },
    "status": {
      "$ref": "#/$defs/com.august.protos.snapshot.SnapshotStatus",
      "description": "The assessment status (e.g., \"SNAPSHOT_STATUS_COMPLETE\", \"SNAPSHOT_STATUS_ARCHIVED\")"
    }
  },
  "required": [
    "id",
    "personId",
    "status",
    "categories",
    "scores"
  ],
  "$defs": {
    "com.august.api.integrations.models.assessments.v1.AdditionalScore": {
      "properties": {
        "level": {
          "description": "The level if this score type uses levels",
          "format": "int32",
          "type": "integer"
        },
        "levelName": {
          "description": "Custom level name if configured",
          "type": "string"
        },
        "name": {
          "description": "Human-readable name for this score type",
          "type": "string"
        },
        "score": {
          "description": "The calculated score",
          "format": "int32",
          "type": "integer"
        },
        "scoreTypeId": {
          "description": "The score type identifier",
          "type": "string"
        }
      },
      "required": [
        "scoreTypeId",
        "name",
        "score"
      ]
    },
    "com.august.api.integrations.models.assessments.v1.AssessmentCategory": {
      "properties": {
        "customKey": {
          "description": "For custom categories, the unique identifier",
          "type": "string"
        },
        "key": {
          "$ref": "#/$defs/com.august.protos.service_plan.ServicePlan.PlanCategoryKey",
          "description": "The full category key enum (e.g., \"PLAN_CATEGORY_KEY_BATHING\")"
        },
        "name": {
          "description": "Human-readable category name (e.g., \"Bathing\")",
          "type": "string"
        },
        "notes": {
          "description": "Free-text notes for this category",
          "type": "string"
        },
        "selectedDetails": {
          "description": "Details/options selected for this category with their labels",
          "items": {
            "$ref": "#/$defs/com.august.api.integrations.models.assessments.v1.SelectedDetail",
            "description": "Details/options selected for this category with their labels"
          },
          "type": "array"
        },
        "selectedLevel": {
          "$ref": "#/$defs/com.august.api.integrations.models.assessments.v1.SelectedLevel",
          "description": "The selected assistance level for this category"
        }
      },
      "required": [
        "key",
        "name",
        "selectedDetails"
      ]
    },
    "com.august.api.integrations.models.assessments.v1.AssessmentReason": {
      "properties": {
        "label": {
          "description": "Human-readable label (e.g., \"Move In\")",
          "type": "string"
        },
        "otherReason": {
          "description": "Free text if reason is \"OTHER\"",
          "type": "string"
        },
        "value": {
          "$ref": "#/$defs/com.august.protos.settings.appraisal_settings.AppraisalSettings.AssessmentReason",
          "description": "The reason enum value (e.g., \"ASSESSMENT_REASON_ON_ADMISSION\")"
        }
      },
      "required": [
        "value",
        "label"
      ]
    },
    "com.august.api.integrations.models.assessments.v1.AssessmentScores": {
      "properties": {
        "additionalScores": {
          "description": "Other configured score types (e.g., medication score)",
          "items": {
            "$ref": "#/$defs/com.august.api.integrations.models.assessments.v1.AdditionalScore",
            "description": "Other configured score types (e.g., medication score)"
          },
          "type": "array"
        },
        "levelOfCare": {
          "$ref": "#/$defs/com.august.api.integrations.models.assessments.v1.LevelOfCareScore",
          "description": "The primary level of care determination"
        },
        "totalScore": {
          "description": "The total points from all selections",
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "totalScore",
        "additionalScores"
      ]
    },
    "com.august.api.integrations.models.assessments.v1.LevelOfCareScore": {
      "properties": {
        "level": {
          "description": "The care level number (1-N based on facility configuration)",
          "format": "int32",
          "type": "integer"
        },
        "levelName": {
          "description": "Custom level name if configured (e.g., \"Level 3 - Enhanced Care\")",
          "type": "string"
        },
        "score": {
          "description": "The score that determined this level",
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "level",
        "score"
      ]
    },
    "com.august.api.integrations.models.assessments.v1.SelectedDetail": {
      "properties": {
        "detailType": {
          "description": "The source of this detail: \"assessment\" for assessment-entered data, \"resident\" for auto-populated resident data (August fields)",
          "type": "string"
        },
        "fieldType": {
          "description": "The type of field: \"boolean\" for checkbox/yes-no fields, \"text\" for text input fields",
          "type": "string"
        },
        "group": {
          "description": "Answer group name if this detail belongs to a group",
          "type": "string"
        },
        "id": {
          "description": "The detail identifier - can be a standard detail enum (e.g., \"BATHING_DETAILS_USES_SHOWER_CHAIR\"), a custom field UUID, or an August field enum (e.g., \"AUGUST_FIELD_TYPE_HAS_DEMENTIA\")",
          "type": "string"
        },
        "label": {
          "description": "Human-readable description of this detail",
          "type": "string"
        },
        "score": {
          "description": "Points contributed by this detail selection (None for resident-sourced details)",
          "format": "int32",
          "type": "integer"
        },
        "value": {
          "description": "The value: \"true\" for boolean fields, text content for text fields",
          "type": "string"
        }
      },
      "required": [
        "id",
        "detailType",
        "label",
        "fieldType",
        "value"
      ]
    },
    "com.august.api.integrations.models.assessments.v1.SelectedLevel": {
      "properties": {
        "label": {
          "description": "Human-readable description of this level",
          "type": "string"
        },
        "score": {
          "description": "Points contributed by this level selection",
          "format": "int32",
          "type": "integer"
        },
        "value": {
          "$ref": "#/$defs/com.august.protos.settings.appraisal_settings.AppraisalSettings.Level",
          "description": "The level enum value (e.g., \"LEVEL_MODERATE\")"
        }
      },
      "required": [
        "value",
        "label",
        "score"
      ]
    },
    "com.august.protos.admissions.AdmissionsInformation.AdmissionType": {
      "enum": [
        "ADMISSION_TYPE_ASSISTED_LIVING",
        "ADMISSION_TYPE_MEMORY_CARE",
        "ADMISSION_TYPE_INDEPENDENT_LIVING"
      ],
      "type": "string"
    },
    "com.august.protos.service_plan.ServicePlan.PlanCategoryKey": {
      "enum": [
        "PLAN_CATEGORY_KEY_BATHING",
        "PLAN_CATEGORY_KEY_CARE_COORDINATION",
        "PLAN_CATEGORY_KEY_DRESSING",
        "PLAN_CATEGORY_KEY_GROOMING",
        "PLAN_CATEGORY_KEY_DENTAL",
        "PLAN_CATEGORY_KEY_TOILETING",
        "PLAN_CATEGORY_KEY_TRANSFER_AND_MOBILITY",
        "PLAN_CATEGORY_KEY_HEARING",
        "PLAN_CATEGORY_KEY_VISION",
        "PLAN_CATEGORY_KEY_MEALS_AND_NUTRITION",
        "PLAN_CATEGORY_KEY_SPECIAL_CARE_NEEDS",
        "PLAN_CATEGORY_KEY_COGNITIVE",
        "PLAN_CATEGORY_KEY_WANDERING_AND_ELOPEMENT",
        "PLAN_CATEGORY_KEY_DISPOSITION_AND_BEHAVIORS",
        "PLAN_CATEGORY_KEY_SLEEP",
        "PLAN_CATEGORY_KEY_COMMUNICATION",
        "PLAN_CATEGORY_KEY_PSYCHO_SOCIAL_ENGAGEMENT",
        "PLAN_CATEGORY_KEY_MEDICATION_MANAGEMENT",
        "PLAN_CATEGORY_KEY_TRANSFER",
        "PLAN_CATEGORY_KEY_MOBILITY",
        "PLAN_CATEGORY_KEY_ADDITIONAL_SERVICES",
        "PLAN_CATEGORY_KEY_CUSTOM"
      ],
      "type": "string"
    },
    "com.august.protos.settings.appraisal_settings.AppraisalSettings.AssessmentReason": {
      "enum": [
        "ASSESSMENT_REASON_PRE_ADMISSION",
        "ASSESSMENT_REASON_ON_ADMISSION",
        "ASSESSMENT_REASON_7_DAY",
        "ASSESSMENT_REASON_30_DAY",
        "ASSESSMENT_REASON_RECURRING",
        "ASSESSMENT_REASON_CHANGE_OF_CONDITION",
        "ASSESSMENT_REASON_OTHER",
        "ASSESSMENT_REASON_90_DAY",
        "ASSESSMENT_REASON_ALIGNMENT",
        "ASSESSMENT_REASON_14_DAY",
        "ASSESSMENT_REASON_6_MONTH"
      ],
      "type": "string"
    },
    "com.august.protos.settings.appraisal_settings.AppraisalSettings.AssessmentType": {
      "enum": [
        "ASSESSMENT_TYPE_SUPERVISORY_CARE",
        "ASSESSMENT_TYPE_PERSONAL_CARE",
        "ASSESSMENT_TYPE_DIRECTED_CARE",
        "ASSESSMENT_TYPE_DIRECTED_CARE_MEMORY_SERVICES",
        "ASSESSMENT_TYPE_SPECIAL_CARE_RESIDENT",
        "ASSESSMENT_TYPE_TRADITIONAL_RESIDENT"
      ],
      "type": "string"
    },
    "com.august.protos.settings.appraisal_settings.AppraisalSettings.Level": {
      "enum": [
        "LEVEL_NONE",
        "LEVEL_MINIMAL",
        "LEVEL_MODERATE",
        "LEVEL_MAX"
      ],
      "type": "string"
    },
    "com.august.protos.snapshot.SnapshotStatus": {
      "enum": [
        "SNAPSHOT_STATUS_DRAFT",
        "SNAPSHOT_STATUS_COMPLETE",
        "SNAPSHOT_STATUS_ARCHIVED",
        "SNAPSHOT_STATUS_DISCARDED"
      ],
      "type": "string"
    }
  }
}