com.august.api.integrations.models.census.v1.CensusPerson

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/august-health/main/json-schema/august-health-com-august-api-integrations-models-census-v1-census-person-schema.json",
  "title": "com.august.api.integrations.models.census.v1.CensusPerson",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/august-health-integrations-api-openapi.yml#/components/schemas/com.august.api.integrations.models.census.v1.CensusPerson",
  "properties": {
    "address": {
      "$ref": "#/$defs/com.august.api.integrations.models.common_metadata.v1.Address",
      "description": "The person's address (prior to admission)"
    },
    "admissionType": {
      "$ref": "#/$defs/com.august.protos.admissions.AdmissionsInformation.AdmissionType",
      "description": "The type of care the resident is admitted for"
    },
    "bed": {
      "$ref": "#/$defs/com.august.api.integrations.models.common.Bed",
      "description": "The person's current bed assignment"
    },
    "birthdate": {
      "format": "date",
      "type": "string"
    },
    "cprCode": {
      "$ref": "#/$defs/com.august.protos.snapshot.Polst.CPR",
      "description": "The person's CPR code (permission-gated; only included when the caller has the census CPR code read permission)"
    },
    "email": {
      "description": "The person's email address",
      "type": "string"
    },
    "externalFields": {
      "$ref": "#/$defs/com.august.api.integrations.models.people.v1.ExternalFields",
      "description": "The person's IDs in external systems"
    },
    "facilityId": {
      "description": "The facility ID",
      "type": "string"
    },
    "financialMoveOutDate": {
      "format": "date",
      "type": "string"
    },
    "financialStartDate": {
      "format": "date",
      "type": "string"
    },
    "futureBedAssignment": {
      "$ref": "#/$defs/com.august.api.integrations.models.census.v1.FutureBedAssignment",
      "description": "The person's scheduled future room/bed transfer, if one exists"
    },
    "gender": {
      "$ref": "#/$defs/com.august.protos.gender.Gender",
      "description": "The person's gender"
    },
    "id": {
      "description": "The person's ID",
      "type": "string"
    },
    "levelOfCare": {
      "$ref": "#/$defs/com.august.api.integrations.models.census.v1.CensusLevelOfCare",
      "description": "The person's level of care (permission-gated; only included when the caller has the census care level read permission)"
    },
    "maritalStatus": {
      "$ref": "#/$defs/com.august.protos.person.Person.MaritalStatus",
      "description": "The person's marital status"
    },
    "moveInStartDate": {
      "format": "date",
      "type": "string"
    },
    "moveOutDate": {
      "format": "date",
      "type": "string"
    },
    "name": {
      "$ref": "#/$defs/com.august.api.integrations.models.common_metadata.v1.HumanName",
      "description": "The person's name"
    },
    "orgId": {
      "description": "The organization ID",
      "type": "string"
    },
    "outOfFacility": {
      "$ref": "#/$defs/com.august.api.integrations.models.census.v1.CensusOutOfFacility",
      "description": "Present when the resident is currently away from the facility (e.g., hospitalized, on leave). Absent when the resident is in-facility. The reason is intentionally omitted as protected health information; use the person endpoint to retrieve it."
    },
    "phone": {
      "description": "The person's primary phone number",
      "type": "string"
    },
    "religiousPreference": {
      "description": "The person's religious preference",
      "type": "string"
    },
    "residentStatus": {
      "$ref": "#/$defs/com.august.protos.person.ResidentStatus",
      "description": "The person's resident status"
    },
    "room": {
      "$ref": "#/$defs/com.august.api.integrations.models.census.v1.CensusRoom",
      "description": "The person's current room assignment"
    }
  },
  "required": [
    "id",
    "orgId",
    "facilityId",
    "name",
    "residentStatus"
  ],
  "$defs": {
    "com.august.api.integrations.models.census.v1.CensusLevelOfCare": {
      "properties": {
        "assessmentType": {
          "$ref": "#/$defs/com.august.protos.settings.appraisal_settings.AppraisalSettings.AssessmentType"
        },
        "levelName": {
          "type": "string"
        },
        "score": {
          "format": "int32",
          "type": "integer"
        },
        "value": {
          "format": "int32",
          "type": "integer"
        }
      }
    },
    "com.august.api.integrations.models.census.v1.CensusOutOfFacility": {
      "properties": {
        "start": {
          "description": "When the resident left the facility",
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "start"
      ]
    },
    "com.august.api.integrations.models.census.v1.CensusRoom": {
      "properties": {
        "externalId": {
          "description": "The room's ID in the external system that manages the facility's rooms",
          "type": "string"
        },
        "id": {
          "description": "The room ID",
          "type": "string"
        },
        "name": {
          "description": "The room name",
          "type": "string"
        }
      },
      "required": [
        "id"
      ]
    },
    "com.august.api.integrations.models.census.v1.FutureBedAssignment": {
      "properties": {
        "bed": {
          "$ref": "#/$defs/com.august.api.integrations.models.common.Bed",
          "description": "The bed the resident will move to"
        },
        "effectiveDate": {
          "format": "date",
          "type": "string"
        },
        "room": {
          "$ref": "#/$defs/com.august.api.integrations.models.census.v1.CensusRoom",
          "description": "The room the resident will move to"
        }
      },
      "required": [
        "effectiveDate",
        "room"
      ]
    },
    "com.august.api.integrations.models.common.Bed": {
      "properties": {
        "externalId": {
          "description": "The bed's ID in the external system that manages the facility's rooms and beds.",
          "type": "string"
        },
        "id": {
          "description": "The bed's unique identifier.",
          "type": "string"
        },
        "name": {
          "description": "The bed's display name. Empty for single-occupancy rooms; only populated when the room's occupancy is greater than 1.",
          "type": "string"
        }
      },
      "required": [
        "id"
      ]
    },
    "com.august.api.integrations.models.common_metadata.v1.Address": {
      "properties": {
        "city": {
          "type": "string"
        },
        "line": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "postalCode": {
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "text": {
          "type": "string"
        },
        "use": {
          "$ref": "#/$defs/com.august.protos.address.Address.AddressUse"
        }
      },
      "required": [
        "line"
      ]
    },
    "com.august.api.integrations.models.common_metadata.v1.HumanName": {
      "properties": {
        "family": {
          "type": "string"
        },
        "given": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "maiden": {
          "type": "string"
        },
        "preferredName": {
          "type": "string"
        },
        "prefix": {
          "type": "string"
        },
        "pronouns": {
          "$ref": "#/$defs/com.august.protos.human_name.HumanName.Pronouns"
        },
        "suffix": {
          "type": "string"
        }
      },
      "required": [
        "given"
      ]
    },
    "com.august.api.integrations.models.people.v1.ExternalFields": {
      "properties": {
        "caregroveResidentId": {
          "description": "The person's resident ID in CareGrove",
          "type": "string"
        },
        "eldermarkResidentId": {
          "description": "The person's resident ID in Eldermark",
          "type": "string"
        },
        "realpageResidentId": {
          "description": "The person's resident ID in RealPage",
          "type": "string"
        },
        "welcomeHomeResidentId": {
          "description": "The person's resident ID in WelcomeHome",
          "type": "string"
        },
        "yardiResidentId": {
          "description": "The person's resident ID in Yardi",
          "type": "string"
        }
      }
    },
    "com.august.protos.address.Address.AddressUse": {
      "enum": [
        "ADDRESS_USE_HOME",
        "ADDRESS_USE_WORK",
        "ADDRESS_USE_TEMP",
        "ADDRESS_USE_OLD",
        "ADDRESS_USE_BILLING"
      ],
      "type": "string"
    },
    "com.august.protos.admissions.AdmissionsInformation.AdmissionType": {
      "enum": [
        "ADMISSION_TYPE_ASSISTED_LIVING",
        "ADMISSION_TYPE_MEMORY_CARE",
        "ADMISSION_TYPE_INDEPENDENT_LIVING"
      ],
      "type": "string"
    },
    "com.august.protos.gender.Gender": {
      "enum": [
        "GENDER_NON_BINARY",
        "GENDER_FEMALE",
        "GENDER_MALE"
      ],
      "type": "string"
    },
    "com.august.protos.human_name.HumanName.Pronouns": {
      "enum": [
        "PRONOUNS_SHE_HER",
        "PRONOUNS_HE_HIM",
        "PRONOUNS_THEY_THEM",
        "PRONOUNS_SHE_THEY",
        "PRONOUNS_HE_THEY",
        "PRONOUNS_ZE_HIR"
      ],
      "type": "string"
    },
    "com.august.protos.person.Person.MaritalStatus": {
      "enum": [
        "MARITAL_STATUS_MARRIED",
        "MARITAL_STATUS_DIVORCED",
        "MARITAL_STATUS_WIDOWED",
        "MARITAL_STATUS_SINGLE",
        "MARITAL_STATUS_SEPARATED",
        "MARITAL_STATUS_DOMESTIC_PARTNER"
      ],
      "type": "string"
    },
    "com.august.protos.person.ResidentStatus": {
      "enum": [
        "RESIDENT_STATUS_PROSPECT",
        "RESIDENT_STATUS_CURRENT_RESIDENT",
        "RESIDENT_STATUS_CLOSED",
        "RESIDENT_STATUS_DISCHARGED",
        "RESIDENT_STATUS_ENTERED_IN_ERROR"
      ],
      "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.snapshot.Polst.CPR": {
      "enum": [
        "CPR_ATTEMPT_RESUSCITATION",
        "CPR_DO_NOT_ATTEMPT_RESUSCITATION"
      ],
      "type": "string"
    }
  }
}