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 descriptionurl: string - Agency website URLdirectorName: string - Director's namedirectorTitle: string - Director's titleyearIncorporated: number - Year of incorporationannualBudget: number - Annual budget amountirsTaxCode: string - IRS tax codefederalEIN: number - Federal Employer Identification Numberstatus: string - Agency status (e.g., "active", "inactive")surveyType: string - Survey typelegalStatus: string - Legal statusisArchived: boolean - Whether agency is archivedagencyType: string - Type of agencyalias: string - Array of alternative namesorganizationId: string - Parent organization IDparentAgency: string - Parent agency ID (for hierarchies)metadata.adminDescription: string (optional) - Administrative description
Related Arrays AKA nested fields
addresses: Physical addressesemails: Email addressesphones: Phone numberscontactPersons: Contact personsreferences: External referenceshour: Operating hoursfundingSources: Funding sourcesagencyGroups: Agency group membershipsservices: Services offeredsites: 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 URLdescription: string - Site descriptionstatus: string - Site status (e.g., "active", "inactive")alias: string - Array of alternative namesorganizationId: string - Parent organization IDagencyId: string - Parent agency ID (required)metadata.inactiveReason: string (optional) - Reason for inactivity
Related Arrays AKA nested fields
addresses: Physical addressesemails: Email addressesphones: Phone numberscontactPersons: Contact personsreferences: External referenceshour: 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 descriptionstatus: string - Service status (e.g., "active", "inactive")airsTaxonomyId: string - AIRS taxonomy classification IDorganizationId: string - Parent organization IDagencyId: string - Parent agency ID (required)alias: string - Array of alternative namesmetadata.serviceNeed.code: string (optional, deprecated) - Organization service need codemetadata.serviceNeed.name: string (optional, deprecated) - Organization service need namemetadata.airsTaxonomy.taxonomyTerm.code: string - AIRS taxonomy term codemetadata.airsTaxonomy.taxonomyTerm.name: string - AIRS taxonomy term namemetadata.inactiveReason: string (optional) - Reason for inactivity
Related Arrays AKA nested fields
addresses: Physical addresses (inherited from agency/site)emails: Email addressesphones: Phone numberscontactPersons: Contact personsreferences: External referenceshour: 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 IDserviceId: string - Associated service ID (required)siteId: string - Associated site ID (required)agencyId: string - Associated agency ID (required)status: 'active' | 'inactive' | string - Resource statusvisibility: 'public' | 'private' - Visibility leveldescription: string - Resource descriptionalias: string - Array of alternative namesgeoArea: Geographic area (currently not supported)limitedAvailability: boolean - Whether resource has limited availabilitymetadata.fees: string - Fee informationmetadata.applicationProcedure: string - Application process descriptionmetadata.serviceAreaName: string - Service area names (subareas)metadata.serviceAreaRegion: string - Service area regionsmetadata.serviceAreaZipCodes: string - Service area zip codesmetadata.serviceExclusions: string - Service exclusionsmetadata.serviceRequirements: string - Service requirementsmetadata.serviceConditions: {[key: string]: string[]} - Service conditions by type
Related Arrays AKA nested fields
addresses: Physical addressesemails: Email addressesphones: Phone numberscontactPersons: Contact personsreferences: External referenceshour: Operating hoursnetworks: Network affiliationsarea: Area feature (not yet supported)
Last updated
Was this helpful?