--- published: true layout: post title: Making All Sub-Resources Available Within The Core Set Of Human Service APIs date: 2017-07-17T09:00:00.000Z tags: - API Evangelist - HSDS - HSDA - Cities - Definitions - Schema image: >- https://s3.amazonaws.com/kinlane-productions2/3D-Printing/regions/api-regions-global-map-from-google.png ---

Organization
| Field Name | Type (Format) | Description | Required? | Unique? |
|---|---|---|---|---|
| id | string (uuid) | Each organization must have a unique identifier. | True | True |
| name | string | The official or public name of the organization. | True | False |
| alternate_name | string | Alternative or commonly used name for the organization. | False | False |
| description | string | A brief summary about the organization. It can contain markup such as HTML or Markdown. | True | False |
| string (email) | The contact e-mail address for the organization. | False | False | |
| url | string (url) | The URL (website address) of the organization. | False | False |
| tax_status | string | Government assigned tax designation for for tax-exempt organizations. | False | False |
| tax_id | string | A government issued identifier used for the purpose of tax administration. | False | False |
| year_incorporated | date (%Y) | The year in which the organization was legally formed. | False | False |
| legal_status | string | The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization. | False | False |
Service
| Field Name | Type (Format) | Description | Required? | Unique? |
|---|---|---|---|---|
| id | string | Each service must have a unique identifier. | True | True |
| organization_id | string | The identifier of the organization that provides this service. | True | False |
| program_id | string | The identifier of the program this service is delivered under. | False | False |
| name | string | The official or public name of the service. | True | False |
| alternate_name | string | Alternative or commonly used name for a service. | False | False |
| description | string | A description of the service. | False | False |
| url | string (url) | URL of the service | False | False |
| string (email) | Email address for the service | False | False | |
| status | string | The current status of the service. | True | False |
| interpretation_services | string | A description of any interpretation services available for accessing this service. | False | False |
| application_process | string | The steps needed to access the service. | False | False |
| wait_time | string | Time a client may expect to wait before receiving a service. | False | False |
| fees | string | Details of any charges for service users to access this service. | False | False |
| accreditations | string | Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization. | False | False |
| licenses | string | An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here. | False | False |
| taxonomy_ids | string | (Deprecated) A comma separated list of identifiers from the taxonomy table. This field is deprecated in favour of using the service_taxonomy table. | False | False |
Location
| Field Name | Type (Format) | Description | Required? | Unique? |
|---|---|---|---|---|
| id | string | Each location must have a unique identifier | True | False |
| organization_id | string | Each location entry should be linked to a single organization. This is the organization that is responsible for maintaining information about this location. The identifier of the organization should be given here. Details of the services the organisation delivers at this location should be provided in the services_at_location table. | False | False |
| name | string | The name of the location | False | False |
| alternate_name | string | An alternative name for the location | False | False |
| description | string | A description of this location. | False | False |
| transportation | string | A description of the access to public or private transportation to and from the location. | False | False |
| latitude | number | Y coordinate of location expressed in decimal degrees in WGS84 datum. | False | False |
| longitude | number | X coordinate of location expressed in decimal degrees in WGS84 datum. | False | False |
Contact
| Field Name | Type (Format) | Description | Required? | Unique? |
|---|---|---|---|---|
| id | string | Each contact must have a unique identifier | True | False |
| organization_id | string | The identifier of the organization for which this is a contact | False | False |
| service_id | string | The identifier of the service for which this is a contact | False | False |
| service_at_location_id | string | The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location. | False | False |
| name | string | The name of the person | False | False |
| title | string | The job title of the person | False | False |
| department | string | The department that the person is part of | False | False |
| string (email) | The email address of the person | False | False |
Organization
| Field Name | Type (Format) | Description | Required? | Unique? |
|---|---|---|---|---|
| id | string (uuid) | Each organization must have a unique identifier. | True | True |
| name | string | The official or public name of the organization. | True | False |
| alternate_name | string | Alternative or commonly used name for the organization. | False | False |
| description | string | A brief summary about the organization. It can contain markup such as HTML or Markdown. | True | False |
| string (email) | The contact e-mail address for the organization. | False | False | |
| url | string (url) | The URL (website address) of the organization. | False | False |
| tax_status | string | Government assigned tax designation for for tax-exempt organizations. | False | False |
| tax_id | string | A government issued identifier used for the purpose of tax administration. | False | False |
| year_incorporated | date (%Y) | The year in which the organization was legally formed. | False | False |
| legal_status | string | The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization. | False | False |
| services | array | Returns a collection of services for each organization | False | False |
| locations | array | Returns a collection of locations for each organization | False | False |
| contacts | array | Returns a collection of contacts for each organization | False | False |
| phones | array | Returns a collection of phones for each organization | False | False |
| programs | array | Returns a collection of programs for each organization | False | False |
| fundings | array | Returns a collection of fundings for each organization | False | False |
Service
| Field Name | Type (Format) | Description | Required? | Unique? |
|---|---|---|---|---|
| id | string | Each service must have a unique identifier. | True | True |
| organization_id | string | The identifier of the organization that provides this service. | True | False |
| program_id | string | The identifier of the program this service is delivered under. | False | False |
| name | string | The official or public name of the service. | True | False |
| alternate_name | string | Alternative or commonly used name for a service. | False | False |
| description | string | A description of the service. | False | False |
| url | string (url) | URL of the service | False | False |
| string (email) | Email address for the service | False | False | |
| status | string | The current status of the service. | True | False |
| interpretation_services | string | A description of any interpretation services available for accessing this service. | False | False |
| application_process | string | The steps needed to access the service. | False | False |
| wait_time | string | Time a client may expect to wait before receiving a service. | False | False |
| fees | string | Details of any charges for service users to access this service. | False | False |
| accreditations | string | Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization. | False | False |
| licenses | string | An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here. | False | False |
| taxonomy_ids | string | (Deprecated) A comma separated list of identifiers from the taxonomy table. This field is deprecated in favour of using the service_taxonomy table. | False | False |
| contacts | array | Returns a collection of contacts for each service. | False | False |
| phones | array | Returns a collection of phones for each service. | False | False |
| regular_schedules | array | Returns a collection of regular schedules for each service. | False | False |
| holiday_schedules | array | Returns a collection of holiday schedules for each service. | False | False |
| fundings | array | Returns a collection of fundings for each service. | False | False |
| eligibilities | array | Returns a collection of eligibilities for each service. | False | False |
| service_areas | array | Returns a collection of service areas for each service. | False | False |
| required_documents | array | Returns a collection of required documents for each service. | False | False |
| payments_accepted | array | Returns a collection of payments accepted for each service. | False | False |
| languages | array | Returns a collection of languages for each service. | False | False |
Location
| Field Name | Type (Format) | Description | Required? | Unique? |
|---|---|---|---|---|
| id | string | Each location must have a unique identifier | True | False |
| organization_id | string | Each location entry should be linked to a single organization. This is the organization that is responsible for maintaining information about this location. The identifier of the organization should be given here. Details of the services the organisation delivers at this location should be provided in the services_at_location table. | False | False |
| name | string | The name of the location | False | False |
| alternate_name | string | An alternative name for the location | False | False |
| description | string | A description of this location. | False | False |
| transportation | string | A description of the access to public or private transportation to and from the location. | False | False |
| latitude | number | Y coordinate of location expressed in decimal degrees in WGS84 datum. | False | False |
| longitude | number | X coordinate of location expressed in decimal degrees in WGS84 datum. | False | False |
| phones | array | Returns a collection of phones for each location. | False | False |
| physical_addresses | array | Returns a collection of physical addresses for each location. | False | False |
| postal_addresses | array | Returns a collection of postal addresses for each location. | False | False |
| regular_schedules | array | Returns a collection of regular schedules for each location. | False | False |
| holiday_schedules | array | Returns a collection of holiday schedules for each location. | False | False |
| languages | array | Returns a collection of languages for each location. | False | False |
| accessiblity_for_disabilities | array | Returns a collection of accessiblity_for_disabilities for each location. | False | False |
Contact
| Field Name | Type (Format) | Description | Required? | Unique? |
|---|---|---|---|---|
| id | string | Each contact must have a unique identifier | True | False |
| organization_id | string | The identifier of the organization for which this is a contact | False | False |
| service_id | string | The identifier of the service for which this is a contact | False | False |
| service_at_location_id | string | The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location. | False | False |
| name | string | The name of the person | False | False |
| title | string | The job title of the person | False | False |
| department | string | The department that the person is part of | False | False |
| string (email) | The email address of the person | False | False | |
| phones | array | Returns a collection of phones for each contact | False | False |