Contract snapshot

meta:
  version: 1.0
  info: |
    Individuals currently under Florida Department of Corrections community supervision. The cohort includes
    bacis information, aliases and current community supervision.

  version: 1
  category: crime-justice
  tags:
    - Corrections
    - Incarceration
    - Florida

###########################################################################
# TABLE DEFINITIONS (Read by schema.py)
###########################################################################

tables:

  OFFENDER_ROOT:
    display_name: Community Supervision Offenders - Basic Information.
    columns:
      DCNumber:
        rename_to: person_id
        cast_to: string
        meta:
          description: |
            Florida DOC identifier (DCNumber) for joining to other tables across inmates, offenders, released inmates.
      LastName: 
        rename_to: last_name
        cast_to: string
        case: title
        meta:
          description: | 
            Person last name as reported.
      FirstName:
        rename_to: first_name
        cast_to: string
        case: title
        meta:
          description: |
            Person first name.
      MiddleName: 
        rename_to: middle_name
        cast_to: string
        case: title
        meta:
          description: |
            Person middle name  or middle initial (maybe null).
      NameSuffix:
        rename_to: name_suffix
        cast_to: string
        case: title
        meta:
          description: |
            Name suffix such as  JR, SR, III (maybe null).
      Race:
        rename_to: race_code
        cast_to: string
        case: upper
        meta:
          description: |
            Race code as provided by the source. Use with race_name for the human-readable label.
      race_descr:
        rename_to: race_name
        cast_to: string
        case: title
        meta:
          description: |
            Human-readable race label corresponding to race code.
      Sex:
        rename_to: sex_code
        cast_to: string
        case: upper
        meta:
          description: |
            Sex code as provided by the source (e.g., M, F).
      BirthDate:
        rename_to: birth_date
        cast_to: date
        format_in: "%m/%d/%Y"
        meta:
          description: |
            Date of birth
      ReceiptDate:
        rename_to: supervision_start_date
        cast_to: date
        format_in: "%m/%d/%Y"
        meta:
          description: |
            Date the offender began the current supervision period (e.g., probation, parole).
      SupervisionTerminationDate:
        rename_to: supervision_end_date
        cast_to: date
        format_in: "%m/%d/%Y"
        meta:
          description: |
            Date the supervision period is scheduled to end or was terminated. Maybe null for ongoing suprevision.
      supvtype_description:
        rename_to: supervision_type
        cast_to: string
        case: title
        meta:
          description: |
            Type of suprevision (e.g., Probation Felony, Parole State, Conditional Release).
      facility_description:
        rename_to: supervision_office
        cast_to: string
        case: title
        meta:
          description: |
            Supervising office or location responsible for oversight (often city or office name).
      supvstatus_description:
        rename_to: supervision_status
        cast_to: string
        case: title
        meta:
          description: |
            Current supervision status(e.g., Acticve, Active Suspense, Absconder/Fugitive).

    canonical_order:
      - person_id
      - birth_date
      - supervision_end_date
      - supervision_start_date
      - race_code
      - race_name
      - sex_code
      - supervision_office
      - supervision_status
      - supervision_type
      - last_name
      - first_name
      - middle_name
      - name_suffix


  OFFENDER_OFFENSES_CCS:
    display_name: Community Supervision Offenders - Current Supervision Offenses
    columns:
      DCNumber:
        rename_to: person_id
        cast_to: string
        meta:
          description: |
            Florida DOC inmate identifier (DCNumber) for joining to other tables.
      Sequence:
        rename_to: sequence
        cast_to: int
        meta:
          description: |
            Sequence number used by the source system to order multiple offenses asscociated with 
            the same person and case. Primarly used to preserve original ordering rather than 
            to convey legal hierarchy.
      OffenseDate:
        rename_to: offense_date
        cast_to: date
        format_in: "%m/%d/%Y"
        meta:
          description: |
            Date on which the offense was reported to have occured. This reflects the offense
            event date, not the adjudication or sentencing.
      DateAdjudicated:
        rename_to: adjudication_date
        cast_to: date
        format_in: "%m/%d/%Y"
        meta:
          description: |
            Date on which the offense was adjudicated by the court (i.e., legal resolution date).
            May occure significantly after the offense date.
              
      County_of_Conviction:
        rename_to: county_of_conviction
        cast_to: string
        case: title
        meta:
          description: |
            County in which the offense was convicted (i.e., the court with jurisdiction over the conviction),
            such as Duval or Broward County. This reflects the jurisdiction of conviction, not the location
            of incarceration.
      CaseNumber:
        rename_to: case_number
        cast_to: string
        meta:
          description: |
            Court case number associated with the offense. Multiple offenses may share the same case number 
            when charged or adjudicated together.
      adjudicationcharge_descr:
        rename_to: charge_description
        cast_to: string
        case: title
        meta:
          description: |
            Text description of the adjudicated charge associated with the offense. This is a human-readable
            label and may contain abbreviations or truncated legal terminology.

      ProbationTerm:
        rename_to: probation_term
        cast_to: string
        format_in: YYYMMDD
        meta:
          description: |
            Encoded representation of the probation term associated with the offense as provided by the source
            system. The format is non-standard and requires parsing to derive duration or sentencing details.
      ParoleTerm:
        rename_to: parole_term
        cast_to: string
        format_in: YYYMMDD
        meta:
          description: |
            Encoded representation of the parole term associated with the offense as provided by the source
            system. The format is non-standard and requires parsing to derive duration or sentencing details.
    
    canonical_order:
      - person_id
      - sequence
      - offense_date
      - adjudication_date
      - parole_term
      - probation_term
      - county_of_conviction
      - case_number
      - charge_description

  OFFENDER_RESIDENCE:
    columns:
      DCNumber:
        rename_to: person_id
        cast_to: string
        meta:
          description: |
            Florida DOC inmate identifier (DCNumber) for joining to other tables.
      AddressLine1:
        rename_to: address_line_1
        cast_to: string
        meta:
          description: |
            Primsry street address or location descriptor for the offender's reported 
            residence. May contain non-standard values such as facility names or county-
            level placeholders when a precise street address is not available.
      AddressLine2:
        rename_to: address_line_2
        cast_to: string
        meta:
          description: |
            Secondary address information such as unit number, apartment building, or
            facility descriptor. May be blank.
      City:
        rename_to: city
        cast_to: string
        meta:
          description: |
            City associated with the reported residence. In some cases, this may 
            reflect the name of a facility location rather than a residential
            municipality.
      State:
        rename_to: state_code
        cast_to: string
        meta:
          description: |
            Two-letter state or territory code associated with the residence 
            location (e.g., FL).
      ZipCode:
        rename_to: postal_code
        cast_to: string
        meta:
          description: |
            Postal (ZIP) code associated with the residence. May be missing or 
            incomplete for non-standard addresses such as correctional facilities.
      Country:
        rename_to: country_code
        cast_to: string
        meta:
          description: |
            Country code asscociated with the residence location (e.g., US).
            Typically constant with this dataset.

    canonical_order:
      - person_id
      - state_code
      - postal_code
      - country_code
      - address_line_1
      - address_line_2
      - city

  OFFENDER_ALIASES:
    display_name: Florida Offenders Aliases
    info: |
      Aliases for offenders.
    columns:
      DCNumber:
        rename_to: person_id
        cast_to: string
        meta:
          description: |
            Florida DOC identifier (DCNumber) for joining to other tables across inmates, offenders, released inmates.
      LastName: 
        rename_to: last_name
        cast_to: string
        case: title
        meta:
          description: | 
            Person last name as reported.
      FirstName:
        rename_to: first_name
        cast_to: string
        case: title
        meta:
          description: |
            Person first name.
      MiddleName: 
        rename_to: middle_name
        cast_to: string
        case: title
        meta:
          description: |
            Person middle name  or middle initial (maybe null).
      NameSuffix:
        rename_to: name_suffix
        cast_to: string
        case: title
        meta:
          description: |
            Name suffix such as  JR, SR, III (maybe null).

    canonical_order:
      - person_id
      - last_name
      - first_name
      - middle_name
      - name_suffix