ORCA: Object-Relationship Content Attributes

ORCA is a methodology for organizing and presenting data models in a way that's intuitive for designers. This reference documents the Safety Net API data model—the standardized fields, types, and relationships used across benefit program applications. Use this reference to understand what data exists, how it's structured, and what values are valid for each field.

Data Domains

The data model is organized into these domains:

Text Type indicator
✓ Required field
→ Links to another object
Intake

Application

What is Application?

Application schema for public assistance programs. Supports applying for SNAP, Cash Programs, and/or Medical Assistance simultaneously.

Key Characteristics

  • Total fields: 13
  • Required fields: 4
  • Read-only fields: 3
  • Nested objects: 8

No relationships found for this object.

Action Method Path Notes
List GET /applications Paginated, searchable
Create POST /applications Required: household
Get GET /applications/{applicationId} By ID
Update PATCH /applications/{applicationId} Partial updates
Read-Only Fields

These fields are managed by the system and cannot be modified:

  • id - ID
  • createdAt - Date & Time
  • updatedAt - Date & Time
Fields
Field Type Req Notes
state Text Two-letter state code where the application is being submitted (e.g., CO, CA, NY).
status Dropdown Options: draft, submitted, under review, approved, denied, pending information, withdrawn
System
Field Type Req Notes
id read-only ID ✓ Unique identifier for the application.
createdAt read-only Date & Time ✓ Timestamp when the application was created.
updatedAt read-only Date & Time ✓ Timestamp when the application was last updated.
Intake

Household

What is Household?

Represents a household unit with multiple members.

Key Characteristics

  • Total fields: 7
  • Required fields: 5
  • Read-only fields: 3
  • Nested objects: 3
Belongs To
  • Person via members[].personId
Action Method Path Notes
List GET /households Paginated, searchable
Create POST /households Required: homeAddress, members
Get GET /households/{householdId} By ID
Update PATCH /households/{householdId} Partial updates
Read-Only Fields

These fields are managed by the system and cannot be modified:

  • id - ID
  • createdAt - Date & Time
  • updatedAt - Date & Time
Fields
Field Type Req Notes
phoneNumber Phone Primary phone number for the household.
System
Field Type Req Notes
id read-only ID ✓ Unique identifier for the household.
createdAt read-only Date & Time ✓ Timestamp when the household record was created.
updatedAt read-only Date & Time ✓ Timestamp when the household record was last updated.
Intake

HouseholdMember

What is HouseholdMember?

Key Characteristics

  • Total fields: 42
  • Required fields: 3
  • Read-only fields: 2
  • Nested objects: 30

No relationships found for this object.

No CRUD operations defined for this object.

Read-Only Fields

These fields are managed by the system and cannot be modified:

  • createdAt - Date & Time
  • updatedAt - Date & Time
Fields
Field Type Req Notes
dateOfBirth Date ✓ Birth date of the person.
socialSecurityNumber SSN Social Security Number for identity verification.
phoneNumber Phone Phone number for the person.
email Email Email address of the person.
consentToShareInformation Yes/No Consent to share information with partner agencies.
relationship Dropdown ✓ Options: self, spouse, child, parent, sibling, other relative, non relative
programsApplyingFor Multi-select Options: snap, tanf, adult financial, medical assistance
hasLegalClaim Yes/No Whether this person has a legal claim related to medical care.
absentParents List of → AbsentParent Absent parents for this child.
System
Field Type Req Notes
id ID Unique identifier for the person. When creating an application, clients may provide a temporary ID for linking related records (e.g., linking an absent parent to a child). The server replaces client-provided IDs with server-generated UUIDs upon submission.
createdAt read-only Date & Time Timestamp when the person record was created.
updatedAt read-only Date & Time Timestamp when the person record was last updated.
Intake

Income

What is Income?

A single item of income, which may be earned or unearned.

Key Characteristics

  • Total fields: 16
  • Required fields: 7
  • Read-only fields: 1
  • Nested objects: 0
Belongs To
Action Method Path Notes
List GET /incomes Paginated, searchable
Create POST /incomes Required: personId, type, amount...
Get GET /incomes/{incomeId} By ID
Update PATCH /incomes/{incomeId} Partial updates
Read-Only Fields

These fields are managed by the system and cannot be modified:

  • id - ID
Fields
Field Type Req Notes
personId ID ✓ Foreign key reference to the person who has this income.
employerId ID Optional foreign key reference to the employer, third-party or self related to this income.
type Dropdown ✓ Options: employed, self employed, unearned
unearnedType Dropdown Options: unemployment, kinship payment, veterans programs, adoption and refugee services, ssi or ssdi, private disability, workers compensation, disability from veterans programs, legal form or settlement, scholarship, educational grant, work study, spousal support, child support, retirement or pension plan, investment interest and dividends, social security retirement, renting home, renting room, renting equipment, gambling lottery or other winnings, donations or gifts, income from loan or mortgage, payment for participating in research, other money not reported
incomeBasis Dropdown Options: net, gross
amount Number ✓ The amount of income this item represents.
frequency Dropdown ✓ Options: hourly, daily, weekly, every 2 weeks, twice a month, monthly, yearly
reportedOn Date ✓ The date the income was reported on.
source Dropdown ✓ Options: client, authorized assister, county worker
startDate Date ✓ When did the applicant first receive this income?
endDate Date Does applicant expect this income to end soon or has it already ended?
isVerified Yes/No Whether the income has been verified.
verifiedDate Date The date the income was verified.
verifiedBy ID The county worker who verified the income.
verificationSourceIds List of ID Array of verification sources related to this income.
System
Field Type Req Notes
id read-only ID Unique identifier for the income.
Intake

CitizenshipInfo

Citizenship and immigration status information.

Fields
Field Type Req Notes
status Dropdown Options: citizen, permanent resident, qualified non citizen, undocumented, other
certificateNumber Text Certificate number if naturalized or derived citizen.
Intake

ContactInfo

Contact information and communication preferences.

Fields
Field Type Req Notes
otherPhoneNumber Phone Alternative phone number.
isHomeless Yes/No Whether the person is currently homeless.
preferredNoticeMethod Dropdown Options: paper, email, both
preferredContactMethod Dropdown Options: phone, email, mail, sms
Intake

DemographicInfo

Demographic information for a person.

Fields
Field Type Req Notes
sex Dropdown Options: male, female, unknown
maritalStatus Dropdown Options: single, married, divorced, separated, widowed, civil union, domestic partnership
isHispanicOrLatino Yes/No Whether the person identifies as Hispanic or Latino.
race Multi-select Options: american indian alaskan native, asian, black african american, native hawaiian pacific islander, white
Intake

DisabilityInfo

Disability and SSI/SSDI information for eligibility determination.

Fields
Field Type Req Notes
hasDisability Yes/No Whether this person has a disability.
needsHelpWithSelfCare Yes/No Whether this person needs help with self-care activities.
hasMedicalOrDevelopmentalCondition Yes/No Whether this person has a medical or developmental condition.
hasReceivedSsiOrSsdi Yes/No Whether this person has ever received SSI or SSDI (if not currently applied).
ssiOrSsdiEndDate Date Date SSI or SSDI benefits ended for this person (if applicable).
Intake

EducationInfo

Education and enrollment information.

Fields
Field Type Req Notes
lastGradeCompleted Text Last grade level completed.
isCurrentlyEnrolled Yes/No Whether this person is currently enrolled in school.
schoolName Text Name of the school or educational institution (if currently enrolled).
startDate Date Date enrollment started (if currently enrolled).
isFullTimeStudent Yes/No Whether the person is a full-time student (if currently enrolled).
expectedGraduationDate Date Expected graduation date (if currently enrolled).
Intake

EmploymentInfo

Basic employment information (employers and dates only).

Fields
Field Type Req Notes
Intake

ExpenseInfo

Expenses paid by or for this person.

Fields
Field Type Req Notes
Intake

FamilyPlanningInfo

Family planning and pregnancy information.

Fields
Field Type Req Notes
wantsFamilyPlanningBenefits Yes/No Whether this person wants family planning benefits.
dueDate Date Expected due date if pregnant.
numberOfBabiesExpected Number Number of babies expected if pregnant.
fatherName Text Name of the father.
wantsGoodCauseFromChildSupport Yes/No Whether this person wants good cause exemption from child support cooperation.
Intake

FinancialAidInfo

Financial aid information for eligibility determination.

Fields
Field Type Req Notes
hasFinancialAid Yes/No Whether this person receives financial aid as a student.
grantsScholarshipsWorkStudyForLivingExpenses Number Amount of grants/scholarships/work-study used for living expenses.
taxableGrantsScholarshipsWorkStudy Number Amount of taxable grants/scholarships/work-study.
Intake

FinancialResource

Financial resource or asset.

Fields
Field Type Req Notes
resourceType Dropdown Options: cash on hand, checking account, savings account, stocks, bonds, mutual funds, 401k, ira, trusts, cds, annuities, college funds, pass accounts, idas, promissory notes, education accounts, other
financialInstitutionName Text
accountNumber Text
currentValue Number
Intake

HealthInfo

Health and insurance coverage information for eligibility determination.

Fields
Field Type Req Notes
Intake

HealthInsuranceEnrollment

A household member's enrollment or eligibility for a health insurance plan.

Fields
Field Type Req Notes
planName Text References a plan by name in the household's healthInsurancePlans map.
status Dropdown Options: eligible, enrolled
coverageStartDate Date Date coverage started.
coverageEndDate Date Date coverage ended or will end.
couldStartCoverageDate Date Date when coverage could start if not yet enrolled.
lostCoverageDate Date Date coverage was lost.
premiumAmount Number Premium amount this person pays.
premiumAmountUnknown Yes/No Whether the premium amount is unknown.
premiumFrequency Dropdown Options: weekly, every two weeks, twice monthly, monthly, yearly
Intake

ImmigrationInfo

Immigration document information for a non-citizen.

Fields
Field Type Req Notes
status Text
documentType Text
documentNumber Text
alienOrI94Number Text
documentExpirationDate Date
countryOfIssuance Text
hasSponsor Yes/No
Intake

IncomeChangeInfo

Income change information for health insurance eligibility determination.

Fields
Field Type Req Notes
changeReason Dropdown Options: stopped working, hours changed, employment change, marriage or divorce, other
expectedAnnualIncome Number Expected annual income.
expectedIncomeChange Dropdown Options: same, lower, higher, unknown
pastIncomeAmount Number Past income amount for the relevant period.
pastDeductionsAmount Number Past deductions amount for the relevant period.
deductionsChangeMonthly Yes/No Whether deductions change from month to month.
Intake

InstitutionalizedInfo

Information about institutionalization if a person is temporarily in an institution.

Fields
Field Type Req Notes
isInstitutionalized Yes/No Whether this person is temporarily in an institution.
dateEntered Date Date the person entered the institution.
facilityName Text Name of the facility.
facilityType Dropdown Options: nursing home, hospital, mental health institution, incarceration, other
isPendingDisposition Yes/No Whether pending disposition of charges (for incarceration).
mealsProvided Yes/No Whether meals are provided by the facility.
Intake

InsurancePolicy

Life or burial insurance policy.

Fields
Field Type Req Notes
policyType Dropdown Options: life insurance, burial insurance
company Text
policyNumber Text
revocableOrIrrevocable Dropdown Options: revocable, irrevocable
faceValue Number
cashSurrenderValue Number
Intake

Job

Basic employment record (employer and dates only).

Fields
Field Type Req Notes
startDate Date Date employment started.
endDate Date Date employment ended (omit if current job).
Intake

LumpSumPayment

One-time lump sum payment received.

Fields
Field Type Req Notes
dateReceived Date
type Dropdown Options: lawsuit settlement, insurance settlement, social security ssi ssdi payment, veterans, inheritance, surrender of annuity, life insurance payout, lottery gambling winnings, other
amount Number
Intake

MilitaryInfo

Military and veteran status information.

Fields
Field Type Req Notes
isMilitaryServiceMember Yes/No Whether this person is a military service member.
veteranStatus Yes/No Indicates whether the person has served in the armed forces.
Intake

NonCitizenApplicationInfo

Application-specific information for non-citizens.

Fields
Field Type Req Notes
wantsEmergencyMedicaid Yes/No Whether this person wants emergency Medicaid.
wantsReproductiveBenefits Yes/No Whether this person wants reproductive benefits.
hasBeenAbandonedMistreatedOrAbused Yes/No Whether this person has been abandoned, mistreated, or abused.
isPregnantOr20OrYounger Yes/No Whether this person is pregnant or 20 years old or younger.
livesWithSponsor Yes/No Whether this person lives with their sponsor.
receivesFreeRoomAndBoardFromSponsor Yes/No Whether this person receives free room and board from their sponsor.
receivesSupportFromSponsor Yes/No Whether this person receives support from their sponsor.
Intake

ResourceInfo

Financial resources and assets.

Fields
Field Type Req Notes
Intake

StrikeInfo

Strike information for a person on strike.

Fields
Field Type Req Notes
strikeBeginDate Date
lastPaycheckDate Date
lastPaycheckAmount Number
Intake

TransferredAsset

Asset that was transferred.

Fields
Field Type Req Notes
dateOfTransfer Date
assetDescription Text
amountReceived Number
fairMarketValue Number
Intake

TribalInfo

American Indian or Alaska Native tribal membership information.

Fields
Field Type Req Notes
tribeName Text
tribeState Text
hasReceivedServiceFromIndianHealthService Yes/No
isEligibleForIndianHealthService Yes/No
Intake

UnearnedIncomeSource

Unearned income source.

Fields
Field Type Req Notes
incomeType Dropdown Options: unemployment benefits, SSI, veterans benefits, widow benefits, workers comp, railroad retirement, child support, survivors benefits, dividends interest, rental income, money from boarder, disability benefits, retirement pension, SSDI, alimony, in kind income, social security benefits, public assistance, plasma donations, gifts, loans, foster care payments, tribal benefits, other
monthlyAmount Number
Intake

Vehicle

Vehicle owned by a person.

Fields
Field Type Req Notes
year Number
make Text
model Text
currentValue Number

Client Management

Persistent identity and relationships across programs

Person
Client Management

Person

What is Person?

Key Characteristics

  • Total fields: 17
  • Required fields: 2
  • Read-only fields: 2
  • Nested objects: 9
Referenced By
Action Method Path Notes
List GET /persons Paginated, searchable
Create POST /persons Required: name, dateOfBirth
Get GET /persons/{personId} By ID
Update PATCH /persons/{personId} Partial updates
Read-Only Fields

These fields are managed by the system and cannot be modified:

  • createdAt - Date & Time
  • updatedAt - Date & Time
Fields
Field Type Req Notes
dateOfBirth Date ✓ Birth date of the person.
socialSecurityNumber SSN Social Security Number for identity verification.
phoneNumber Phone Phone number for the person.
email Email Email address of the person.
consentToShareInformation Yes/No Consent to share information with partner agencies.
System
Field Type Req Notes
id ID Unique identifier for the person. When creating an application, clients may provide a temporary ID for linking related records (e.g., linking an absent parent to a child). The server replaces client-provided IDs with server-generated UUIDs upon submission.
createdAt read-only Date & Time Timestamp when the person record was created.
updatedAt read-only Date & Time Timestamp when the person record was last updated.

Eligibility

Program-specific interpretation and determination

Coming soon - this domain is part of the architecture but not yet implemented.

Case Management

Ongoing client relationships and staff assignments

Case CaseStatus
Case Management

Case

A case represents the ongoing relationship with a client or household. It spans years, multiple applications, and multiple programs.

Fields
Field Type Req Notes
status Dropdown ✓ Options: active, closed
effectiveStartDate Date Date when coverage or the case relationship begins.
effectiveEndDate Date Date when the case was closed. Null while active.
primaryApplicantId ID ✓ Reference to the Person record for the primary applicant.
assignedToId ID Reference to the User record for the assigned case worker.
System
Field Type Req Notes
id read-only ID ✓ Unique identifier (server-generated).
createdAt read-only Date & Time ✓ Timestamp when the case was created.
updatedAt read-only Date & Time ✓ Timestamp when the case was last updated.
Case Management

CaseStatus

Current status of the case.

Workflow

Work items, tasks, SLAs, and verification

Queue Task
Workflow

Queue

A routing queue that organizes tasks by team, program, or skill.

Fields
Field Type Req Notes
name Text ✓ Machine-readable name for the queue (e.g., snap-intake).
description Text Human-readable description of the queue's purpose.
System
Field Type Req Notes
id read-only ID ✓ Unique identifier for the queue.
createdAt read-only Date & Time ✓ Timestamp when the queue was created.
updatedAt read-only Date & Time ✓ Timestamp when the queue was last updated.
Workflow

Task

A workflow task representing a unit of work in a safety net benefits program.

Fields
Field Type Req Notes
name Text ✓ Human-readable label for the task.
description Text Detailed information about the task.
status Text ✓ Current lifecycle state. Valid values are injected at resolve time from workflow-state-machine.yaml.
subjectType Dropdown Options: application, case, document, appointment
subjectId ID Reference to the entity this task is associated with. The target entity type is determined by subjectType. Resolution is conditional on subjectType — consumers must resolve by type; no automatic expansion is performed.
programType Dropdown Options: snap, tanf, adult financial, medical assistance
isExpedited Yes/No Whether this task requires expedited processing. SNAP-specific concept tied to the 7-day regulatory deadline. Candidate for removal once context enrichment (#203) provides a generic alternative.
queueId ID Reference to the Queue this task is routed to.
priority Dropdown Options: expedited, high, normal, low
startedAt Date & Time When work began (status transitioned to in_progress).
completedAt Date & Time When work finished.
escalatedAt Date & Time When the task was escalated.
cancelledAt Date & Time When the task was cancelled.
blockedAt Date & Time When the task entered a waiting state (awaiting_client or awaiting_verification).
assignedToId ID Reference to the User assigned to this task.
outcome Text Completion outcome recorded when the task was completed (e.g., approved, denied).
completionNotes Text Optional notes recorded when the task was completed.
System
Field Type Req Notes
id read-only ID ✓ Unique identifier for the task.
createdAt read-only Date & Time ✓ Timestamp when the task was created.
updatedAt read-only Date & Time ✓ Timestamp when the task was last updated.

Scheduling

Time-based coordination and appointments

Appointment
Scheduling

Appointment

A scheduled interaction between a staff member and a person at a given time.

Fields
Field Type Req Notes
startAt Date & Time ✓ When the appointment begins.
endAt Date & Time ✓ When the appointment ends.
appointmentType Text ✓ Type of appointment (e.g., interview, recertification, orientation). Free-text, not enum — states define their own types.
status Dropdown ✓ Options: scheduled, completed, canceled, no show
personId ID ✓ Reference to the Person record (the subject of the appointment).
assignedToId ID Reference to the User record (staff member conducting the appointment).
notes Text Free-text notes about the appointment.
System
Field Type Req Notes
id read-only ID ✓ Unique identifier (server-generated).
createdAt read-only Date & Time ✓ Timestamp when the appointment was created.
updatedAt read-only Date & Time ✓ Timestamp when the appointment was last updated.

Document Management

Files, uploads, and document tracking

Coming soon - this domain is part of the architecture but not yet implemented.

Cross-cutting

Concerns that span all domains

Metric
Cross-cutting

Metric

A computed metric value with definition metadata.

Fields
Field Type Req Notes
name read-only Text ✓ Human-readable metric name.
aggregate read-only Dropdown ✓ Options: count, ratio, duration
value read-only Number ✓ Computed scalar value. count: total matching records. ratio: 0–1. duration: median seconds between paired events. null when groupBy is specified.
computedAt read-only Date & Time ✓ Timestamp when the value was computed.
System
Field Type Req Notes
id read-only Text ✓ Unique metric identifier, from the domain's *-metrics.yaml.

AbsentParent

Fields
Field Type Req Notes
dateOfBirth Date Birth date of the person.
socialSecurityNumber SSN Social Security Number for identity verification.
phoneNumber Phone Phone number for the person.
email Email Email address of the person.
triedToGetMedicalSupport Yes/No Whether applicant tried to get medical support from this absent parent.

AdditionalExpense

Additional expense item (childcare, medical, child support, etc.).

Fields
Field Type Req Notes
expenseType Dropdown Options: child daycare, adult daycare, legally obligated child support, child support arrears, medical expenses, student loan interest, alimony
monthOfExpense Date
amountPaid Number
legallyObligatedAmount Number

ApplicationAssister

Fields
Field Type Req Notes
dateOfBirth Date Birth date of the person.
socialSecurityNumber SSN Social Security Number for identity verification.
phoneNumber Phone Phone number for the person.
email Email Email address of the person.

ApplicationPreferences

Application preferences and consents.

Fields
Field Type Req Notes
givesPermissionToValidateIncome Yes/No Whether the applicant gives permission to validate income.
wantsToRegisterToVote Yes/No Whether the applicant wants to register to vote.
burialPreference Dropdown Options: cremation, burial, no preference
ebtCardDeliveryMethod Dropdown Options: postal mail, in person

ApplicationScreeningFlags

Flags indicating screening criteria relevant to this application, organized by domain. Presence of a flag in an array indicates the condition is true.

Fields
Field Type Req Notes
familyPlanning Multi-select Options: family planning needs, pregnancy, wants reproductive benefits, child under 19, absent parent, wants family violence waiver
disability Multi-select Options: disability, received ssi or ssdi
citizenship Multi-select Options: non citizens, wants emergency medicaid
medicalCoverage Multi-select Options: has health insurance, legal claim, wants retroactive medical
tribal Multi-select Options: american indian or alaska native, received indian health service, eligible for indian health service
fosterCareAndBenefitsHistory Multi-select Options: foster care history, received benefits other state
jobs Multi-select Options: has employment, has self employment, has job changes, expected income change, income differences, is anyone on strike
otherIncome Multi-select Options: has other income, has lump sum payments, deductions change monthly
expenses Multi-select Options: has rent expenses, has mortgage expenses, has additional expenses
education Multi-select Options: has students, has financial aid
resources Multi-select Options: has resources, has vehicles, has life or burial insurance, owns property, has transferred assets
priorConvictions Multi-select Options: has prior convictions
military Multi-select Options: has military service

AppointmentStatus

Current status of the appointment.

AuthorizedRepresentative

Fields
Field Type Req Notes
dateOfBirth Date Birth date of the person.
socialSecurityNumber SSN Social Security Number for identity verification.
phoneNumber Phone Phone number for the person.
email Email Email address of the person.
isIndividual Yes/No Whether the representative is an individual (vs organization).
organizationId Text Organization identifier if not an individual.
inCareOf Text Care of line for address.
receiveNotices Yes/No Whether this representative should receive official notices.

CaseMember

A person associated with a case and their relationship to the primary applicant.

Fields
Field Type Req Notes
personId ID ✓ Reference to the Person record.
relationship Text ✓ Relationship to the primary applicant.

DeductionItem

A deduction that affects income for health insurance eligibility.

Fields
Field Type Req Notes
deductionType Dropdown Options: alimony paid, capital losses, early withdrawal penalty, student loan interest, domestic production activities, reimbursement of expenses, hsa deduction, moving expenses, traditional ira contribution, reservist performing artist government official expenses, other
deductionTypeOther Text Description if deductionType is 'other'.
frequency Dropdown Options: one time only, weekly, every two weeks, twice monthly, monthly, yearly
currentAmount Number Current deduction amount.
actualAnnualAmount Number Actual annual deduction amount.

DomainEvent

An immutable record of a state transition or significant lifecycle event. Emitted by the state machine engine whenever a transition fires or an object is first created.

Fields
Field Type Req Notes
domain Text ✓ Domain that owns the event (e.g., workflow).
resource Text ✓ Resource type the event relates to (e.g., task).
action Text ✓ The action that occurred (e.g., created, claimed, completed).
resourceId ID ✓ Identifier of the resource that generated the event.
performedById ID ✓ User who triggered the event.
occurredAt Date & Time ✓ When the event occurred.
System
Field Type Req Notes
id read-only ID ✓ Unique identifier for the event.
createdAt read-only Date & Time ✓ Timestamp when the event record was created.
updatedAt read-only Date & Time ✓ Timestamp when the event record was last updated.

Employer

An employer of one or more people.

ExpeditedSNAPInfo

Expedited SNAP screening information for faster processing.

Fields
Field Type Req Notes
householdSize Number Number of people in the home who purchase and prepare food together.
isMigrantOrSeasonalFarmWorker Yes/No Whether any household member is a migrant or seasonal farm worker.
totalExpectedIncomeThisMonth Number Total money household expects to get this month (before deductions).
totalCashOnHand Number Total cash on hand and money in checking/savings account.
monthlyMortgage Number Monthly mortgage payment amount.
monthlyRent Number Monthly rent payment amount.

ExternalPerson

Fields
Field Type Req Notes
dateOfBirth Date Birth date of the person.
socialSecurityNumber SSN Social Security Number for identity verification.
phoneNumber Phone Phone number for the person.
email Email Email address of the person.

FederalHealthBenefit

Federal health benefit program enrollment.

Fields
Field Type Req Notes
programTypeOrName Text
insuranceCompanyName Text
policyNumber Text

FosterCareHistory

Foster care history for a person.

Fields
Field Type Req Notes
nameUsedInOutOfStateFosterCare Text Name used in out-of-state foster care, if different from current name.
dateLeftFosterCare Date Date the person left foster care, if known.
wasAdopted Yes/No Whether the person was adopted.
returnedToFosterCareAfterAdoption Yes/No If adopted, whether the person returned to foster care after adoption.
dateReturnedToFosterCare Date Date the person returned to foster care after adoption, if applicable.
dateOfStateResidency Date Date the person became a resident of the state.
needsHelpPayingMedicalBills Yes/No Whether the person needs help paying medical bills.
medicalBillsMonths List of Date Months for which the person needs help paying medical bills.

FrontendAuthContext

Authorization context for frontend applications. Extends BackendAuthContext with UI permissions and user preferences. Used in enriched JWTs for frontends (via BFF/gateway) or returned by GET /users/me. States can customize this independently from BackendAuthContext.

Fields
Field Type Req Notes
userId ID ✓ User Service identifier.

HealthCoverageDetail

Health insurance coverage detail.

Fields
Field Type Req Notes
typeOfCoverage Dropdown Options: medicare, tricare, va health care, peace corps, cobra, retiree health plan, current employer sponsored, railroad retirement insurance
coverageStartDate Date
coverageEndDate Date
enrollmentStatus Dropdown Options: eligible, enrolled

HealthInsurancePlan

A health insurance plan available to household members, keyed by plan name.

Fields
Field Type Req Notes
planName Text ✓ Unique name for this plan within the application (used as map key).
planType Dropdown ✓ Options: medicare, tricare, va health care, peace corps, cobra, retiree health plan, employer sponsored, railroad retirement
contactAboutCoverage Text Contact person for questions about coverage (for employer_sponsored plans).
hasEmployeeOnlyPlanMeetingMinimumValue Yes/No Whether an employee-only plan meeting minimum value is available.
lowestCostPlanName Text Name of the lowest cost plan available.
lowestCostPlanUnknown Yes/No Whether the lowest cost plan is unknown.
noPlansMeetMinimumValue Yes/No Whether no plans meet minimum value requirements.
insuranceCompanyName Text Name of the insurance company (for non-employer plans).
policyNumber Text Policy number (for non-employer plans).

HouseholdExpenses

Household-level expense information.

Fields
Field Type Req Notes

HouseholdOccupant

Fields
Field Type Req Notes
dateOfBirth Date Birth date of the person.
socialSecurityNumber SSN Social Security Number for identity verification.
phoneNumber Phone Phone number for the person.
email Email Email address of the person.
occupantType Dropdown Options: roomer, boarder, other
rentPaidToHousehold Number Amount paid for rent per month to the household.
mealsIncluded Yes/No Whether meals are included with the rent.

HousingExpenseItem

Housing expense item (shared by rent and mortgage).

Fields
Field Type Req Notes
expenseType Dropdown Options: rent, renters insurance, pet fee, washer dryer fee, condo fee, maintenance fee, mortgage, homeowners insurance, property taxes, hoa fees, other
whoPays Text Name of the person who pays this expense.
isPayerInHome Yes/No Whether the person who pays lives in the home.
expenseFor Text Who the expense is for.
expenseMonth Date Month of the expense.
amountPaid Number Amount paid for this expense.

JobIncomeInfo

Employment income information for eligibility determination.

Fields
Field Type Req Notes
startDate Date Date employment started.
endDate Date Date employment ended (omit if current job).
monthlyWagesBeforeTaxes Number Monthly wages before taxes.
hourlyWage Number Hourly wage rate.
averageHoursPerWeek Number Average hours worked per week.
payFrequency Dropdown Options: hourly, weekly, every two weeks, twice monthly, monthly, yearly, daily
isTemporaryJob Yes/No Whether this is a temporary job.
incomeType Dropdown Options: seasonal employment, commission based employment, regular employment
lastPaycheckDate Date Date of last paycheck (for ended jobs).
lastPaycheckAmount Number Amount of last paycheck (for ended jobs).

MedicareInfo

Medicare coverage information for eligibility determination.

Fields
Field Type Req Notes

MetricTarget

A threshold or goal for the metric.

Fields
Field Type Req Notes
stat Text Statistic type (e.g., p50, ratio, trend).
operator Dropdown Options: <, <=, >, >=, ==
amount Number Machine-readable threshold value.
unit Dropdown Options: hours, minutes, days, percent, count
label Text Human-readable target label (e.g., "4h", "10%").
direction Dropdown Options: up, down

MortgageExpense

Mortgage expense item.

Fields
Field Type Req Notes
expenseType Dropdown Options: mortgage, homeowners insurance, property taxes, hoa fees
expenseMonth Date
amountPaid Number

MortgageExpenses

Mortgage expenses and settings.

Fields
Field Type Req Notes
receivesSection8OrPublicHousing Yes/No Whether receiving Section 8 or public housing assistance.
housingAssistanceType Dropdown Options: section8, public housing

PastBenefitsFromOtherStates

Information about SNAP or cash benefits received in another state in the last 30 days.

Fields
Field Type Req Notes
dateReceived Date Date benefits were received.
city Text City where benefits were received.
county Text County where benefits were received.
state Text Two-letter state code where benefits were received.

PersonIdentity

Basic identity and contact information for a person.

Fields
Field Type Req Notes
dateOfBirth Date Birth date of the person.
socialSecurityNumber SSN Social Security Number for identity verification.
phoneNumber Phone Phone number for the person.
email Email Email address of the person.

PriorConvictionsInfo

Prior convictions information for a person.

Fields
Field Type Req Notes
convictedOfDuplicateSNAPBenefits Yes/No
hidingFromLaw Yes/No
convictedOfDrugFelony Yes/No
convictedOfSNAPTrafficking Yes/No
convictedOfTradingSNAPForWeapons Yes/No
disqualifiedForIPVOrWelfareFraud Yes/No
convictedOfViolentCrime Yes/No

Property

Real estate property.

Fields
Field Type Req Notes
propertyType Text
primaryPropertyUse Multi-select Options: primary home, rental income, business self employment, other
primaryPropertyUseOther Text
currentValue Number

RentExpense

Rent expense item.

Fields
Field Type Req Notes
expenseType Dropdown Options: rent, renters insurance, pet fee, washer dryer fee, condo fee, maintenance fee, other
expenseMonth Date
amountPaid Number

RentExpenses

Rent expenses and settings.

Fields
Field Type Req Notes
utilitiesIncludedInRent Yes/No Whether utilities are included in rent.
receivesSection8OrPublicHousing Yes/No Whether receiving Section 8 or public housing assistance.
housingAssistanceType Dropdown Options: section8, public housing

RetroactiveMedicalRequest

Request for retroactive medical coverage.

Fields
Field Type Req Notes
months List of Date
householdIncomeInThoseMonths Number

RoleType

Authorization roles that determine base permissions and data scoping. - applicant: Self-service access to own applications (scoped by personId) - case_worker: Process applications for assigned county - supervisor: Oversee case workers, approve determinations (may span counties) - county_admin: Administer county staff and configuration - state_admin: Statewide oversight and administration (all counties) - partner_readonly: External partner with limited read access

SearchFacet

A result count for a single resource type, enabling UI to show type-based filtering.

Fields
Field Type Req Notes
type Dropdown ✓ Options: person, case, application, task, appointment
count Number ✓ Number of matching results for this type.

SearchResult

A single search result with a uniform shape regardless of the underlying resource type. Attributes provide typed key-value pairs for consistent client rendering.

Fields
Field Type Req Notes
type Dropdown ✓ Options: person, case, application, task, appointment
title Text ✓ Display title for the result (e.g., person name, case number).
url URL ✓ Canonical API URL of the matched resource.
score Number Relevance score between 0 and 1. Higher is more relevant.
System
Field Type Req Notes
id ID ✓ Unique identifier of the matched resource.
createdAt Date & Time ✓ When the matched resource was created.
updatedAt Date & Time ✓ When the matched resource was last updated.

SearchResultAttribute

A typed key-value pair for rendering search result details.

Fields
Field Type Req Notes
field Text ✓ Machine-readable field key (e.g., "dob", "status", "caseNumber").
label Text Human-readable display label (e.g., "Date of Birth", "Status", "Case Number").
value Text ✓ Display value, pre-formatted as a string regardless of type.
type Dropdown ✓ Options: string, date, currency

SearchResultType

The type of resource matched by the search.

SelfEmploymentRecord

Self-employment business record for eligibility determination.

Fields
Field Type Req Notes
businessName Text
oneMonthsGrossIncome Number
monthOfIncome Date
selfEmploymentType Dropdown Options: sole proprietor, llc, s corp, independent contractor
utilitiesPaidForBusiness Number
businessTaxesPaid Number
interestPaidForBusiness Number
grossBusinessLaborCosts Number
costOfMerchandise Number
totalNetIncome Number

SocialSecurityApplication

SSI/SSDI application record.

Fields
Field Type Req Notes
program Dropdown Options: SSI, SSDI, other
otherProgramName Text
applicationDate Date
status Dropdown Options: pending, approved, denied, appealed

TaskApprovedEvent

Fields
Field Type Req Notes
outcome Text ✓ The outcome recorded at approval.

TaskAssignedEvent

Fields
Field Type Req Notes
assignedToId ID Caseworker the task was assigned to, if any.
queueId ID Queue the task was assigned to, if any.

TaskAwaitingClientEvent

TaskAwaitingVerificationEvent

TaskCancelledEvent

Fields
Field Type Req Notes
reason Text ✓ Why the task was cancelled.

TaskClaimedEvent

TaskCompletedEvent

Fields
Field Type Req Notes
outcome Text ✓ The outcome recorded at completion.

TaskCreatedEvent

TaskDeEscalatedEvent

TaskEscalatedEvent

Fields
Field Type Req Notes
reason Text ✓ Why the task was escalated.

TaskPriorityChangedEvent

Fields
Field Type Req Notes
priority Text ✓ The new priority value.
reason Text Why the priority was changed.

TaskReleasedEvent

Fields
Field Type Req Notes
reason Text ✓ Why the task was released.

TaskReopenedEvent

Fields
Field Type Req Notes
reason Text ✓ Why the task was reopened.

TaskResumedEvent

TaskReturnedToWorkerEvent

Fields
Field Type Req Notes
reason Text ✓ Why the task was returned for revision.

TaskSlaBreachedEvent

Fields
Field Type Req Notes
reason Dropdown ✓ Options: sla deadline exceeded

TaskSubmittedForReviewEvent

TaskSystemResumedEvent

Fields
Field Type Req Notes
source Text ✓ System that triggered the automated resumption.
result Text ✓ Result of the verification or external check.

TaskWritable

Client-writable task fields. Base schema for TaskCreate and TaskUpdate.

Fields
Field Type Req Notes
name Text Human-readable label for the task.
description Text Detailed information about the task.
status Text Current lifecycle state. Valid values are injected at resolve time from workflow-state-machine.yaml.
subjectType Dropdown Options: application, case, document, appointment
subjectId ID Reference to the entity this task is associated with. The target entity type is determined by subjectType. Resolution is conditional on subjectType — consumers must resolve by type; no automatic expansion is performed.
programType Dropdown Options: snap, tanf, adult financial, medical assistance
isExpedited Yes/No Whether this task requires expedited processing. SNAP-specific concept tied to the 7-day regulatory deadline. Candidate for removal once context enrichment (#203) provides a generic alternative.
queueId ID Reference to the Queue this task is routed to.
priority Dropdown Options: expedited, high, normal, low
startedAt Date & Time When work began (status transitioned to in_progress).
completedAt Date & Time When work finished.
escalatedAt Date & Time When the task was escalated.
cancelledAt Date & Time When the task was cancelled.
blockedAt Date & Time When the task entered a waiting state (awaiting_client or awaiting_verification).
assignedToId ID Reference to the User assigned to this task.
outcome Text Completion outcome recorded when the task was completed (e.g., approved, denied).
completionNotes Text Optional notes recorded when the task was completed.

TaxFilingInfo

Tax filing information for a person.

Fields
Field Type Req Notes
willFileTaxes Yes/No
filingJointlyWithSpouse Yes/No
spouseName Text
willClaimDependents Yes/No
dependentsToClaim List of Text
expectsToBeClaimedAsDependent Yes/No
isClaimedAsDependent Yes/No
nameOfPersonClaiming Text
isPersonClaimingListedOnApplication Yes/No
isPersonClaimingNonCustodialParent Yes/No
marriedFilingSeparatelyWithExceptionalCircumstances Yes/No

TokenClaims

Minimal authorization context for backend API authorization. Stored in the User Service and embedded in JWT tokens during login. Domain APIs read these claims for authorization decisions without runtime calls to the User Service. For frontend tokens that include UI permissions and preferences, see FrontendAuthContext in user.yaml.

Fields
Field Type Req Notes
userId ID ✓ User Service identifier.

UiPermissions

Computed UI permissions and display data for frontend feature toggling. Backend computes these from role and permissions to provide a UI-friendly interface for showing/hiding features. Structure is flexible - states define their own fields via overlays. Example fields: name, availableModules, canApproveApplications, etc.

User

User account for authentication and authorization. Links an IdP identity to roles, permissions, and county assignments. Note: Job function details (skills, team, workload) are not stored here. Staff users link to a CaseWorker record in the Case Management domain.

Fields
Field Type Req Notes
userId ID ✓ User Service identifier.
idpSubject Text ✓ Subject identifier from the Identity Provider. Immutable after creation. Format varies by IdP (e.g., "auth0|507f1f77bcf86cd799439011").
email Email ✓ User's email address (from IdP or manually set).
status Dropdown ✓ Options: active, inactive, pending, suspended
System
Field Type Req Notes
id read-only ID ✓ Unique identifier for the user (same as userId in JWT claims).
createdAt read-only Date & Time ✓ Timestamp when the user was created.
updatedAt read-only Date & Time ✓ Timestamp when the user was last updated.

UserPreferences

User preferences for the application. Structure is flexible - states define their own fields via overlays. Example fields: timezone, dateFormat, itemsPerPage, language, theme, etc.

UserStatus

User account status.

UtilityExpense

Utility expense item.

Fields
Field Type Req Notes
utilityType Dropdown Options: electricity, gas, water, phone, trash, sewer, firewood, propane, other
expenseMonth Date
amountPaid Number

VerificationSource

A source of verification, which may be an external API or document.

System
Field Type Req Notes
id read-only ID Unique identifier for the verification source.
Intake Nested in Application

Programs

Programs being applied for in this application. At least one program must be selected. - snap: SNAP (food assistance) - cashPrograms: TANF and/or Adult Financial Assistance - medicalAssistance: Medicaid/Medical Assistance

Fields
Field Type Req Notes
snap Yes/No Whether applying for SNAP (food assistance).
medicalAssistance Yes/No Whether applying for Medical Assistance (Medicaid).
Intake Nested in Application

ScreeningFlags

Flags indicating screening criteria relevant to this application.

Fields
Field Type Req Notes
familyPlanning Multi-select Options: family planning needs, pregnancy, wants reproductive benefits, child under 19, absent parent, wants family violence waiver
disability Multi-select Options: disability, received ssi or ssdi
citizenship Multi-select Options: non citizens, wants emergency medicaid
medicalCoverage Multi-select Options: has health insurance, legal claim, wants retroactive medical
tribal Multi-select Options: american indian or alaska native, received indian health service, eligible for indian health service
fosterCareAndBenefitsHistory Multi-select Options: foster care history, received benefits other state
jobs Multi-select Options: has employment, has self employment, has job changes, expected income change, income differences, is anyone on strike
otherIncome Multi-select Options: has other income, has lump sum payments, deductions change monthly
expenses Multi-select Options: has rent expenses, has mortgage expenses, has additional expenses
education Multi-select Options: has students, has financial aid
resources Multi-select Options: has resources, has vehicles, has life or burial insurance, owns property, has transferred assets
priorConvictions Multi-select Options: has prior convictions
military Multi-select Options: has military service
Intake Nested in Application

Preferences

Application preferences and consents.

Fields
Field Type Req Notes
givesPermissionToValidateIncome Yes/No Whether the applicant gives permission to validate income.
wantsToRegisterToVote Yes/No Whether the applicant wants to register to vote.
burialPreference Dropdown Options: cremation, burial, no preference
ebtCardDeliveryMethod Dropdown Options: postal mail, in person
Intake Nested in Application

Household

Household information including members, occupants, expenses, and related data.

Fields
Field Type Req Notes
members List of → Member ✓ IRS-recognized household members for benefits eligibility, including the primary applicant (relationship=self). At least one member with relationship=self is required.
otherOccupants List of → OtherOccupant Other people living at the address who are not part of the household unit for benefits purposes (e.g., boarders, roomers).
Intake Nested in Application

ExpeditedSNAPInfo

Expedited SNAP screening information.

Fields
Field Type Req Notes
householdSize Number Number of people in the home who purchase and prepare food together.
isMigrantOrSeasonalFarmWorker Yes/No Whether any household member is a migrant or seasonal farm worker.
totalExpectedIncomeThisMonth Number Total money household expects to get this month (before deductions).
totalCashOnHand Number Total cash on hand and money in checking/savings account.
monthlyMortgage Number Monthly mortgage payment amount.
monthlyRent Number Monthly rent payment amount.
Intake Nested in Application

Signatures

Application signatures.

Fields
Field Type Req Notes
Intake Nested in HouseholdMember

Name

Legal name of the person.

Fields
Field Type Req Notes
firstName Text ✓ First name.
middleInitial Text Middle initial.
middleName Text Middle name.
lastName Text ✓ Last name.
maidenName Text Maiden name if applicable.
suffix Text Name suffix such as Jr., Sr., III, etc.
Intake Nested in HouseholdMember

Address

Address of the person.

Fields
Field Type Req Notes
addressLine1 Text ✓ Primary street address line.
addressLine2 Text Secondary address line such as apartment or unit.
city Text ✓ City or locality of residence.
stateProvince Text ✓ State, province, or region of residence.
postalCode Text ✓ Postal or ZIP code.
county Text County or equivalent administrative region.
Intake Nested in HouseholdMember

DemographicInfo

Demographic information including sex, marital status, and race.

Fields
Field Type Req Notes
sex Dropdown Options: male, female, unknown
maritalStatus Dropdown Options: single, married, divorced, separated, widowed, civil union, domestic partnership
isHispanicOrLatino Yes/No Whether the person identifies as Hispanic or Latino.
race Multi-select Options: american indian alaskan native, asian, black african american, native hawaiian pacific islander, white
Intake Nested in HouseholdMember

EmploymentInfo

Employment and self-employment information.

Fields
Field Type Req Notes
Intake Nested in HouseholdMember

EducationInfo

Student enrollment information for this person.

Fields
Field Type Req Notes
lastGradeCompleted Text Last grade level completed.
isCurrentlyEnrolled Yes/No Whether this person is currently enrolled in school.
schoolName Text Name of the school or educational institution (if currently enrolled).
startDate Date Date enrollment started (if currently enrolled).
isFullTimeStudent Yes/No Whether the person is a full-time student (if currently enrolled).
expectedGraduationDate Date Expected graduation date (if currently enrolled).
Intake Nested in HouseholdMember

MilitaryInfo

Military and veteran status information.

Fields
Field Type Req Notes
isMilitaryServiceMember Yes/No Whether this person is a military service member.
veteranStatus Yes/No Indicates whether the person has served in the armed forces.
Intake Nested in HouseholdMember

InstitutionalizedInfo

Information about institutionalization if this person is temporarily in an institution.

Fields
Field Type Req Notes
isInstitutionalized Yes/No Whether this person is temporarily in an institution.
dateEntered Date Date the person entered the institution.
facilityName Text Name of the facility.
facilityType Dropdown Options: nursing home, hospital, mental health institution, incarceration, other
isPendingDisposition Yes/No Whether pending disposition of charges (for incarceration).
mealsProvided Yes/No Whether meals are provided by the facility.
Intake Nested in HouseholdMember

DisabilityInfo

Disability and SSI/SSDI information for this person.

Fields
Field Type Req Notes
hasDisability Yes/No Whether this person has a disability.
needsHelpWithSelfCare Yes/No Whether this person needs help with self-care activities.
hasMedicalOrDevelopmentalCondition Yes/No Whether this person has a medical or developmental condition.
hasReceivedSsiOrSsdi Yes/No Whether this person has ever received SSI or SSDI (if not currently applied).
ssiOrSsdiEndDate Date Date SSI or SSDI benefits ended for this person (if applicable).
Intake Nested in HouseholdMember

Expenses

Expenses paid by or for this person.

Fields
Field Type Req Notes
Intake Nested in HouseholdMember

IncomeChangeInfo

Income change information for health insurance eligibility.

Fields
Field Type Req Notes
changeReason Dropdown Options: stopped working, hours changed, employment change, marriage or divorce, other
expectedAnnualIncome Number Expected annual income.
expectedIncomeChange Dropdown Options: same, lower, higher, unknown
pastIncomeAmount Number Past income amount for the relevant period.
pastDeductionsAmount Number Past deductions amount for the relevant period.
deductionsChangeMonthly Yes/No Whether deductions change from month to month.
Intake Nested in HouseholdMember

FosterCareInfo

Foster care history for this person.

Fields
Field Type Req Notes
nameUsedInOutOfStateFosterCare Text Name used in out-of-state foster care, if different from current name.
dateLeftFosterCare Date Date the person left foster care, if known.
wasAdopted Yes/No Whether the person was adopted.
returnedToFosterCareAfterAdoption Yes/No If adopted, whether the person returned to foster care after adoption.
dateReturnedToFosterCare Date Date the person returned to foster care after adoption, if applicable.
dateOfStateResidency Date Date the person became a resident of the state.
needsHelpPayingMedicalBills Yes/No Whether the person needs help paying medical bills.
medicalBillsMonths List of Date Months for which the person needs help paying medical bills.
Intake Nested in HouseholdMember

EmploymentHistory

Employment income information for eligibility determination.

Fields
Field Type Req Notes
startDate Date Date employment started.
endDate Date Date employment ended (omit if current job).
monthlyWagesBeforeTaxes Number Monthly wages before taxes.
hourlyWage Number Hourly wage rate.
averageHoursPerWeek Number Average hours worked per week.
payFrequency Dropdown Options: hourly, weekly, every two weeks, twice monthly, monthly, yearly, daily
isTemporaryJob Yes/No Whether this is a temporary job.
incomeType Dropdown Options: seasonal employment, commission based employment, regular employment
lastPaycheckDate Date Date of last paycheck (for ended jobs).
lastPaycheckAmount Number Amount of last paycheck (for ended jobs).
Intake Nested in HouseholdMember

SelfEmployment

Self-employment business record for eligibility determination.

Fields
Field Type Req Notes
businessName Text
oneMonthsGrossIncome Number
monthOfIncome Date
selfEmploymentType Dropdown Options: sole proprietor, llc, s corp, independent contractor
utilitiesPaidForBusiness Number
businessTaxesPaid Number
interestPaidForBusiness Number
grossBusinessLaborCosts Number
costOfMerchandise Number
totalNetIncome Number
Intake Nested in HouseholdMember

UnearnedIncomeSource

Unearned income source.

Fields
Field Type Req Notes
incomeType Dropdown Options: unemployment benefits, SSI, veterans benefits, widow benefits, workers comp, railroad retirement, child support, survivors benefits, dividends interest, rental income, money from boarder, disability benefits, retirement pension, SSDI, alimony, in kind income, social security benefits, public assistance, plasma donations, gifts, loans, foster care payments, tribal benefits, other
monthlyAmount Number
Intake Nested in HouseholdMember

LumpSumPayment

One-time lump sum payment received.

Fields
Field Type Req Notes
dateReceived Date
type Dropdown Options: lawsuit settlement, insurance settlement, social security ssi ssdi payment, veterans, inheritance, surrender of annuity, life insurance payout, lottery gambling winnings, other
amount Number
Intake Nested in HouseholdMember

StrikeInfo

Strike information if this person is on strike.

Fields
Field Type Req Notes
strikeBeginDate Date
lastPaycheckDate Date
lastPaycheckAmount Number
Intake Nested in HouseholdMember

NonCitizenApplicationInfo

Application-specific information for non-citizens.

Fields
Field Type Req Notes
wantsEmergencyMedicaid Yes/No Whether this person wants emergency Medicaid.
wantsReproductiveBenefits Yes/No Whether this person wants reproductive benefits.
hasBeenAbandonedMistreatedOrAbused Yes/No Whether this person has been abandoned, mistreated, or abused.
isPregnantOr20OrYounger Yes/No Whether this person is pregnant or 20 years old or younger.
livesWithSponsor Yes/No Whether this person lives with their sponsor.
receivesFreeRoomAndBoardFromSponsor Yes/No Whether this person receives free room and board from their sponsor.
receivesSupportFromSponsor Yes/No Whether this person receives support from their sponsor.
Intake Nested in HouseholdMember

FamilyPlanningInfo

Family planning and pregnancy information for this person.

Fields
Field Type Req Notes
wantsFamilyPlanningBenefits Yes/No Whether this person wants family planning benefits.
dueDate Date Expected due date if pregnant.
numberOfBabiesExpected Number Number of babies expected if pregnant.
fatherName Text Name of the father.
wantsGoodCauseFromChildSupport Yes/No Whether this person wants good cause exemption from child support cooperation.
Intake Nested in HouseholdMember

FinancialAidInfo

Financial aid information for this person.

Fields
Field Type Req Notes
hasFinancialAid Yes/No Whether this person receives financial aid as a student.
grantsScholarshipsWorkStudyForLivingExpenses Number Amount of grants/scholarships/work-study used for living expenses.
taxableGrantsScholarshipsWorkStudy Number Amount of taxable grants/scholarships/work-study.
Intake Nested in HouseholdMember

PriorConvictions

Prior convictions information for this person.

Fields
Field Type Req Notes
convictedOfDuplicateSNAPBenefits Yes/No
hidingFromLaw Yes/No
convictedOfDrugFelony Yes/No
convictedOfSNAPTrafficking Yes/No
convictedOfTradingSNAPForWeapons Yes/No
disqualifiedForIPVOrWelfareFraud Yes/No
convictedOfViolentCrime Yes/No
Intake Nested in HouseholdMember

TaxFilingInfo

Tax filing information for this person.

Fields
Field Type Req Notes
willFileTaxes Yes/No
filingJointlyWithSpouse Yes/No
spouseName Text
willClaimDependents Yes/No
dependentsToClaim List of Text
expectsToBeClaimedAsDependent Yes/No
isClaimedAsDependent Yes/No
nameOfPersonClaiming Text
isPersonClaimingListedOnApplication Yes/No
isPersonClaimingNonCustodialParent Yes/No
marriedFilingSeparatelyWithExceptionalCircumstances Yes/No
Intake Nested in HouseholdMember

ResourceInfo

Financial resources and assets for this person.

Fields
Field Type Req Notes
Intake Nested in HouseholdMember

TransferredAsset

Asset that was transferred.

Fields
Field Type Req Notes
dateOfTransfer Date
assetDescription Text
amountReceived Number
fairMarketValue Number
Intake Nested in HouseholdMember

RetroactiveMedicalRequest

Request for retroactive medical coverage for this person.

Fields
Field Type Req Notes
months List of Date
householdIncomeInThoseMonths Number
Intake Nested in HouseholdMember

HealthInfo

Health and insurance coverage information for eligibility determination.

Fields
Field Type Req Notes
Intake Nested in HouseholdMember

HealthInsuranceEnrollment

A household member's enrollment or eligibility for a health insurance plan.

Fields
Field Type Req Notes
planName Text References a plan by name in the household's healthInsurancePlans map.
status Dropdown Options: eligible, enrolled
coverageStartDate Date Date coverage started.
coverageEndDate Date Date coverage ended or will end.
couldStartCoverageDate Date Date when coverage could start if not yet enrolled.
lostCoverageDate Date Date coverage was lost.
premiumAmount Number Premium amount this person pays.
premiumAmountUnknown Yes/No Whether the premium amount is unknown.
premiumFrequency Dropdown Options: weekly, every two weeks, twice monthly, monthly, yearly
Intake Nested in HouseholdMember

PastBenefitsFromOtherStates

Information about SNAP or cash benefits received in another state in the last 30 days.

Fields
Field Type Req Notes
dateReceived Date Date benefits were received.
city Text City where benefits were received.
county Text County where benefits were received.
state Text Two-letter state code where benefits were received.
Nested in AuthorizedRepresentative

ApplicantSignature

Applicant's signature authorizing this representative.

Fields
Field Type Req Notes
signature Text ✓ Signature or signature indicator.
signatureDate Date ✓ Date the signature was made.
Nested in AuthorizedRepresentative

AuthorizedRepresentativeSignature

The authorized representative's signature.

Fields
Field Type Req Notes
signature Text ✓ Signature or signature indicator.
signatureDate Date ✓ Date the signature was made.
Intake Nested in CitizenshipInfo

ImmigrationInfo

Immigration information for this person (if non-citizen).

Fields
Field Type Req Notes
status Text
documentType Text
documentNumber Text
alienOrI94Number Text
documentExpirationDate Date
countryOfIssuance Text
hasSponsor Yes/No
Intake Nested in ContactInfo

MailingAddress

Mailing address if different from residential address.

Fields
Field Type Req Notes
addressLine1 Text ✓ Primary street address line.
addressLine2 Text Secondary address line such as apartment or unit.
city Text ✓ City or locality of residence.
stateProvince Text ✓ State, province, or region of residence.
postalCode Text ✓ Postal or ZIP code.
county Text County or equivalent administrative region.
Intake Nested in ContactInfo

LanguagePreference

Language preferences for communications.

Fields
Field Type Req Notes
written Text Preferred language for written communications (BCP 47 language tag).
spoken Text Preferred language for spoken communications (BCP 47 language tag).
Intake Nested in DisabilityInfo

SocialSecurityApplication

SSI/SSDI application record.

Fields
Field Type Req Notes
program Dropdown Options: SSI, SSDI, other
otherProgramName Text
applicationDate Date
status Dropdown Options: pending, approved, denied, appealed
Intake Nested in ExpenseInfo

Rent

Rent expense item.

Fields
Field Type Req Notes
expenseType Dropdown Options: rent, renters insurance, pet fee, washer dryer fee, condo fee, maintenance fee, other
expenseMonth Date
amountPaid Number
Intake Nested in ExpenseInfo

Mortgage

Mortgage expense item.

Fields
Field Type Req Notes
expenseType Dropdown Options: mortgage, homeowners insurance, property taxes, hoa fees
expenseMonth Date
amountPaid Number
Intake Nested in ExpenseInfo

Utilitie

Utility expense item.

Fields
Field Type Req Notes
utilityType Dropdown Options: electricity, gas, water, phone, trash, sewer, firewood, propane, other
expenseMonth Date
amountPaid Number
Intake Nested in ExpenseInfo

AdditionalExpense

Additional expense item (childcare, medical, child support, etc.).

Fields
Field Type Req Notes
expenseType Dropdown Options: child daycare, adult daycare, legally obligated child support, child support arrears, medical expenses, student loan interest, alimony
monthOfExpense Date
amountPaid Number
legallyObligatedAmount Number
Nested in ExpeditedSNAPInfo

UtilityCosts

Monthly utility costs.

Fields
Field Type Req Notes
electricity Number
water Number
phone Number
trash Number
sewer Number
other Number
Nested in HouseholdExpenses

Utilities

Utility-related settings for the household.

Fields
Field Type Req Notes
heatingCoolingMethod Multi-select Options: electric, gas, firewood, propane, swamp cooler, other
otherHeatingCoolingType Text Description of other heating/cooling method if selected.
receivedLEAP Yes/No Whether household received Low-Income Energy Assistance Program benefits.
Intake Nested in HealthInfo

HealthCoverage

Health insurance coverage detail.

Fields
Field Type Req Notes
typeOfCoverage Dropdown Options: medicare, tricare, va health care, peace corps, cobra, retiree health plan, current employer sponsored, railroad retirement insurance
coverageStartDate Date
coverageEndDate Date
enrollmentStatus Dropdown Options: eligible, enrolled
Intake Nested in HealthInfo

Medicare

Medicare coverage information for this person.

Fields
Field Type Req Notes
Intake Nested in HealthInfo

FederalHealthBenefit

Federal health benefit program enrollment.

Fields
Field Type Req Notes
programTypeOrName Text
insuranceCompanyName Text
policyNumber Text
Nested in HealthInsurancePlan

Employer

Employer offering the coverage (for employer_sponsored plans).

Fields
Field Type Req Notes
name Text Employer or business name.
phone Phone Employer phone number.
identificationNumber Text Employer Identification Number (EIN).
Intake Nested in IncomeChangeInfo

Deduction

A deduction that affects income for health insurance eligibility.

Fields
Field Type Req Notes
deductionType Dropdown Options: alimony paid, capital losses, early withdrawal penalty, student loan interest, domestic production activities, reimbursement of expenses, hsa deduction, moving expenses, traditional ira contribution, reservist performing artist government official expenses, other
deductionTypeOther Text Description if deductionType is 'other'.
frequency Dropdown Options: one time only, weekly, every two weeks, twice monthly, monthly, yearly
currentAmount Number Current deduction amount.
actualAnnualAmount Number Actual annual deduction amount.
Nested in MedicareInfo

PartA

Nested object within MedicareInfo.partA

Fields
Field Type Req Notes
isEntitledOrReceiving Yes/No
startDate Date
isCurrentlyEnrolled Yes/No
whoPaysPremium Text
isPremiumFree Yes/No
Nested in MedicareInfo

PartB

Nested object within MedicareInfo.partB

Fields
Field Type Req Notes
isEntitledOrReceiving Yes/No
startDate Date
premiumAmount Number
whoPaysPremium Text
Nested in MedicareInfo

PartC

Nested object within MedicareInfo.partC

Fields
Field Type Req Notes
isEntitledOrReceiving Yes/No
startDate Date
Nested in MedicareInfo

PartD

Nested object within MedicareInfo.partD

Fields
Field Type Req Notes
isEntitledOrReceiving Yes/No
startDate Date
premiumAmount Number
whoPaysPremium Text
Nested in MortgageExpenses

Item

Housing expense item (shared by rent and mortgage).

Fields
Field Type Req Notes
expenseType Dropdown Options: rent, renters insurance, pet fee, washer dryer fee, condo fee, maintenance fee, mortgage, homeowners insurance, property taxes, hoa fees, other
whoPays Text Name of the person who pays this expense.
isPayerInHome Yes/No Whether the person who pays lives in the home.
expenseFor Text Who the expense is for.
expenseMonth Date Month of the expense.
amountPaid Number Amount paid for this expense.
Nested in Property

PropertyAddress

Residential or mailing address used to determine eligibility.

Fields
Field Type Req Notes
addressLine1 Text ✓ Primary street address line.
addressLine2 Text Secondary address line such as apartment or unit.
city Text ✓ City or locality of residence.
stateProvince Text ✓ State, province, or region of residence.
postalCode Text ✓ Postal or ZIP code.
county Text County or equivalent administrative region.
Intake Nested in ResourceInfo

FinancialResource

Financial resource or asset.

Fields
Field Type Req Notes
resourceType Dropdown Options: cash on hand, checking account, savings account, stocks, bonds, mutual funds, 401k, ira, trusts, cds, annuities, college funds, pass accounts, idas, promissory notes, education accounts, other
financialInstitutionName Text
accountNumber Text
currentValue Number
Intake Nested in ResourceInfo

Vehicle

Vehicle owned by a person.

Fields
Field Type Req Notes
year Number
make Text
model Text
currentValue Number
Intake Nested in ResourceInfo

InsurancePolicie

Life or burial insurance policy.

Fields
Field Type Req Notes
policyType Dropdown Options: life insurance, burial insurance
company Text
policyNumber Text
revocableOrIrrevocable Dropdown Options: revocable, irrevocable
faceValue Number
cashSurrenderValue Number
Intake Nested in ResourceInfo

RealEstatePropertie

Real estate property.

Fields
Field Type Req Notes
propertyType Text
primaryPropertyUse Multi-select Options: primary home, rental income, business self employment, other
primaryPropertyUseOther Text
currentValue Number
Nested in SelfEmploymentRecord

OtherBusinessCost

Nested object within SelfEmploymentRecord.otherBusinessCosts (array item)

Fields
Field Type Req Notes
type Text
amount Number
Case Management Nested in Case

Member

A person associated with a case and their relationship to the primary applicant.

Fields
Field Type Req Notes
personId ID ✓ Reference to the Person record.
relationship Text ✓ Relationship to the primary applicant.
Intake Nested in Household

HomeAddress

Home address of the household.

Fields
Field Type Req Notes
addressLine1 Text ✓ Primary street address line.
addressLine2 Text Secondary address line such as apartment or unit.
city Text ✓ City or locality of residence.
stateProvince Text ✓ State, province, or region of residence.
postalCode Text ✓ Postal or ZIP code.
county Text County or equivalent administrative region.
Client Management Nested in Person

CitizenshipInfo

Citizenship and immigration status information.

Fields
Field Type Req Notes
status Dropdown Options: citizen, permanent resident, qualified non citizen, undocumented, other
certificateNumber Text Certificate number if naturalized or derived citizen.
Client Management Nested in Person

ContactInfo

Contact information and communication preferences.

Fields
Field Type Req Notes
otherPhoneNumber Phone Alternative phone number.
isHomeless Yes/No Whether the person is currently homeless.
preferredNoticeMethod Dropdown Options: paper, email, both
preferredContactMethod Dropdown Options: phone, email, mail, sms
Client Management Nested in Person

TribalInfo

American Indian or Alaska Native tribal information for this person.

Fields
Field Type Req Notes
tribeName Text
tribeState Text
hasReceivedServiceFromIndianHealthService Yes/No
isEligibleForIndianHealthService Yes/No
Intake Nested in EmploymentInfo

Job

Basic employment record (employer and dates only).

Fields
Field Type Req Notes
startDate Date Date employment started.
endDate Date Date employment ended (omit if current job).
Nested in Sponsor

Spouse

Basic identity and contact information for a person.

Fields
Field Type Req Notes
dateOfBirth Date Birth date of the person.
socialSecurityNumber SSN Social Security Number for identity verification.
phoneNumber Phone Phone number for the person.
email Email Email address of the person.
Nested in SearchResult

Attribute

A typed key-value pair for rendering search result details.

Fields
Field Type Req Notes
field Text ✓ Machine-readable field key (e.g., "dob", "status", "caseNumber").
label Text Human-readable display label (e.g., "Date of Birth", "Status", "Case Number").
value Text ✓ Display value, pre-formatted as a string regardless of type.
type Dropdown ✓ Options: string, date, currency
Nested in User

Roles

Role and permissions for authorization.

Fields
Field Type Req Notes
name Dropdown ✓ Options: applicant, case worker, supervisor, county admin, state admin, partner readonly
permissions List of Text Permission strings in the format {resource}:{action}. Examples: applications:read, persons:update, users:create
Workflow Nested in Task

SlaInfo

Engine-managed SLA tracking entry. Returned in resource responses. All fields except slaTypeCode are populated and managed by the engine.

Fields
Field Type Req Notes
slaTypeCode Text ✓ Identifies which SLA type applies. Valid values are injected at resolve time from the domain's *-sla-types.yaml.
status read-only Dropdown ✓ Options: active, warning, paused, breached, completed
clockStartedAt read-only Date & Time ✓ When the SLA clock started. Engine-managed.
deadline read-only Date & Time ✓ Computed deadline. Recalculated after a resume to exclude accumulated paused duration. Engine-managed.
Cross-cutting Nested in Metric

Target

A threshold or goal for the metric.

Fields
Field Type Req Notes
stat Text Statistic type (e.g., p50, ratio, trend).
operator Dropdown Options: <, <=, >, >=, ==
amount Number Machine-readable threshold value.
unit Dropdown Options: hours, minutes, days, percent, count
label Text Human-readable target label (e.g., "4h", "10%").
direction Dropdown Options: up, down
Nested in Programs

CashPrograms

Cash assistance programs.

Fields
Field Type Req Notes
tanfProgram Yes/No Whether applying for TANF (Temporary Assistance for Needy Families).
adultFinancial Yes/No Whether applying for Adult Financial Assistance.
Nested in Signatures

CoApplicantSignature

Spouse/co-applicant signature if applicable.

Fields
Field Type Req Notes
signature Text ✓ Signature or signature indicator.
signatureDate Date ✓ Date the signature was made.
Nested in Signatures

ApplicantAuthorizedRepresentativeSignature

Authorized representative signature for the applicant.

Fields
Field Type Req Notes
signature Text ✓ Signature or signature indicator.
signatureDate Date ✓ Date the signature was made.
Nested in Signatures

CoApplicantAuthorizedRepresentativeSignature

Authorized representative signature for the co-applicant.

Fields
Field Type Req Notes
signature Text ✓ Signature or signature indicator.
signatureDate Date ✓ Date the signature was made.