Entity Definitions & Fields

A comprehensive list of all fields within CS resource at each entity level

Agency

  • Purpose: A community resource service provider (e.g., non-profit, government agency)

  • Relationships:

    • Belongs to Organization

    • Has many Sites (locations)

    • Has many Services

Agency-Specific Fields

  • name: string - Agency name (required)

  • description: string - Agency description

  • url: string - Agency website URL

  • directorName: string - Director's name

  • directorTitle: string - Director's title

  • yearIncorporated: number - Year of incorporation

  • annualBudget: number - Annual budget amount

  • irsTaxCode: string - IRS tax code

  • federalEIN: number - Federal Employer Identification Number

  • status: string - Agency status (e.g., "active", "inactive")

  • surveyType: string - Survey type

  • legalStatus: string - Legal status

  • isArchived: boolean - Whether agency is archived

  • agencyType: string - Type of agency

  • alias: string - Array of alternative names

  • organizationId: string - Parent organization ID

  • parentAgency: string - Parent agency ID (for hierarchies)

  • metadata.adminDescription: string (optional) - Administrative description

Related Arrays AKA nested fields

  • addresses: Physical addresses

  • emails: Email addresses

  • phones: Phone numbers

  • contactPersons: Contact persons

  • references: External references

  • hour: Operating hours

  • fundingSources: Funding sources

  • agencyGroups: Agency group memberships

  • services: Services offered

  • sites: Physical locations

Site

  • Purpose: Physical or virtual location where services are delivered

  • Relationships:

    • Belongs to Agency

    • Has many Services

Site-Specific Fields

  • name: string - Site name (required)

  • url: string - Site website URL

  • description: string - Site description

  • status: string - Site status (e.g., "active", "inactive")

  • alias: string - Array of alternative names

  • organizationId: string - Parent organization ID

  • agencyId: string - Parent agency ID (required)

  • metadata.inactiveReason: string (optional) - Reason for inactivity

Related Arrays AKA nested fields

  • addresses: Physical addresses

  • emails: Email addresses

  • phones: Phone numbers

  • contactPersons: Contact persons

  • references: External references

  • hour: Operating hours

Service

  • Purpose: Specific service offered (e.g., "Emergency Shelter", "Food Assistance")

  • Relationships:

    • Belongs to Agency

    • Belongs to Site

    • Has many Resources

    • Has AIRS Taxonomy classification

    • Can map to organization Service Need (optional)

Service-Specific Fields

  • name: string - Service name (required)

  • description: string - Service description

  • status: string - Service status (e.g., "active", "inactive")

  • airsTaxonomyId: string - AIRS taxonomy classification ID

  • organizationId: string - Parent organization ID

  • agencyId: string - Parent agency ID (required)

  • alias: string - Array of alternative names

  • metadata.serviceNeed.code: string (optional, deprecated) - Organization service need code

  • metadata.serviceNeed.name: string (optional, deprecated) - Organization service need name

  • metadata.airsTaxonomy.taxonomyTerm.code: string - AIRS taxonomy term code

  • metadata.airsTaxonomy.taxonomyTerm.name: string - AIRS taxonomy term name

  • metadata.inactiveReason: string (optional) - Reason for inactivity

Related Arrays AKA nested fields

  • addresses: Physical addresses (inherited from agency/site)

  • emails: Email addresses

  • phones: Phone numbers

  • contactPersons: Contact persons

  • references: External references

  • hour: Operating hours

Resource

  • Purpose: Represents the intersection of Site + Service = actual available service

  • Relationships:

    • Belongs to Organization

    • References Agency (agencyId)

    • References Site (siteId)

    • References Service (serviceId)

Resource-Specific Fields

  • organizationId: string - Parent organization ID

  • serviceId: string - Associated service ID (required)

  • siteId: string - Associated site ID (required)

  • agencyId: string - Associated agency ID (required)

  • status: 'active' | 'inactive' | string - Resource status

  • visibility: 'public' | 'private' - Visibility level

  • description: string - Resource description

  • alias: string - Array of alternative names

  • geoArea: Geographic area (currently not supported)

  • limitedAvailability: boolean - Whether resource has limited availability

  • metadata.fees: string - Fee information

  • metadata.applicationProcedure: string - Application process description

  • metadata.serviceAreaName: string - Service area names (subareas)

  • metadata.serviceAreaRegion: string - Service area regions

  • metadata.serviceAreaZipCodes: string - Service area zip codes

  • metadata.serviceExclusions: string - Service exclusions

  • metadata.serviceRequirements: string - Service requirements

  • metadata.serviceConditions: {[key: string]: string[]} - Service conditions by type

Related Arrays AKA nested fields

  • addresses: Physical addresses

  • emails: Email addresses

  • phones: Phone numbers

  • contactPersons: Contact persons

  • references: External references

  • hour: Operating hours

  • networks: Network affiliations

  • area: Area feature (not yet supported)

Last updated

Was this helpful?