report.toml

# A funder outcome report for a housing program. Every {placeholder} in the
# template names a metric below; the drafter substitutes the metric's computed,
# receipted figure, and the grounding gate refuses to export if any number in the
# rendered narrative does not trace to a receipt.
#
#   receipts run --config examples/housing-demo/report.toml --out out

schema_version = "1.0"

[data]
path = "services.csv"

[report]
title = "Housing Program Outcome Report"
template = """
In the reporting period, our housing program served {clients_served} clients. \
Of the {exits} who exited the program, {exits_permanent} moved into permanent \
housing, a permanent-housing rate of {pct_permanent}.
"""

[metrics.clients_served]
description = "Distinct clients with any enrollment in the period."
definition = "Each person enrolled in the housing program during the reporting period, counted once by client_id even if they enrolled more than once. The unit is the person, not the enrollment."
kind = "output"
indicator = "Number of unduplicated individuals served"
data_source = "HMIS enrollment records"
collection_frequency = "Continuous, reported quarterly"
caveat = "Client records missing a client_id are dropped before counting, so this figure may slightly undercount clients with incomplete intake data."
unit = "count"
value_sql = "SELECT COUNT(DISTINCT client_id) FROM data"
slice_sql = "SELECT client_id FROM data"

[metrics.exits]
description = "Enrollments that exited the program (an exit date is present)."
definition = "Enrollments with a recorded exit date. The unit is the enrollment, so a client who exited two enrollments counts twice. A blank exit date is treated as still enrolled, not as an exit."
kind = "output"
unit = "count"
value_sql = "SELECT COUNT(*) FROM data WHERE exit_date != ''"
slice_sql = "SELECT * FROM data WHERE exit_date != ''"

[metrics.exits_permanent]
description = "Exits whose destination was permanent housing."
definition = "Exits whose exit_destination is 'permanent'. Destination categories are taken as recorded; an unrecorded destination is not counted as permanent."
kind = "output"
unit = "count"
value_sql = "SELECT COUNT(*) FROM data WHERE exit_destination = 'permanent'"
slice_sql = "SELECT * FROM data WHERE exit_destination = 'permanent'"

[metrics.pct_permanent]
description = "Share of exits that went to permanent housing."
definition = "Permanent-housing exits divided by all exits in the period, as a whole-number percent. The denominator is exits, not all enrolled clients, so a client still enrolled is not in it."
kind = "outcome"
unit = "percent"
decimals = 0
value_sql = "SELECT ROUND(100.0 * SUM(CASE WHEN exit_destination = 'permanent' THEN 1 ELSE 0 END) / COUNT(*)) FROM data WHERE exit_date != ''"
slice_sql = "SELECT * FROM data WHERE exit_date != ''"