Schema Reference

The Human Services Data Specification defines a set of objects and the relationships between them. The HSDS Schema provides the authoritative definition of these objects and their required and optional fields. It is used to validate the structure and format of HSDS data.

This page provides, for each object in HSDS:

• A reference table of required and optional field names, field descriptions and field formats

• A JSON schema

• Some example data.

For information on how to design API platforms to provide access to HSDS data, see the API Reference.

For information on how to format HSDS data, including how to publish a tabular Data Package of HSDS data, see the Publication Formats Reference.

Schema structure

HSDS data is not hierarchichal in the sense that it does not have a single top-level object. Rather, HSDS consists of a set of core objects or tables, with additional information held in separate objects or tables (see Logical Model for more details). For this reason, there is no single HSDS schema, but rather a separate schema for each object. In addition to being provided below, schema files for each object in HSDS are available as JSON schema from the HSDS GitHub repository.

Compiled schemas and example data, containing all HSDS objects, may be useful to publishers for a number of reasons. A number of compiled schema and example files are available from the schema and examples directories on the HSDS Github repository.

Objects and fields

service

service is defined as:

The details of the services provided by organizations to a range of different groups.

Each service object has the following fields:

Fields

Title	Description	Type	Format	Required
id		string	uuid	Required
Identifier	The identifier for the service. Each service must have a unique identifier.
name		string		Required
Name	The official or public name of the service.
alternate_name		string
Alternate Name	An (optional) alternative name for this service.
description		string
Description	A free text description of the service.
url		string	uri
URL	URL of the service
email		string	email
Email	An email address which can be used to contact the service provider.
status		string		Required
Status	The current status of the service which can be active, inactive, defunct, or temporarily closed.
interpretation_services		string
Interpretation Services	A free text description of any interpretation services available for accessing this service.
application_process		string
Application Process	A free text description of the steps needed to access this service.
fees_description		string
Fees Description	A free text description of any charges for service users to access this service.
wait_time		string
Wait Time	DEPRECATED: The time a client may expect to wait before receiving a service.
fees		string
Fees	DEPRECATED: Details of any charges for service users to access this service.
accreditations		string
Accreditations	A free text description of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.
eligibility_description		string
Eligibility Description	A free text description of the type of person for whom this service is intended.
minimum_age		number
Minimum Age	The minimum age of a person required to meet this eligibility requirement.
maximum_age		number
Maximum Age	The maximum age of a person required to meet this eligibility requirement.
assured_date		string
Assured Date	The date that the information about the service was last checked.
assurer_email		string	email
Assurer Email	The contact e-mail address for the person or organization which last assured the service.
licenses		string
Licenses	DEPRECATED: An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.
alert		string
Alert	A description of any short term alerts concerning the service.
last_modified		string	date-time
Last Modified	The datetime when the service, or any related information about the service, has changed. Should have millisecond accuracy.
phones		array[object]
Phones	The details of the telephone numbers used to contact organizations, services, and locations. See phone
schedules		array[object]
Schedules	The details of when a service or location is open. Entries are RFC 5545 RRULES. See schedule
service_areas		array[object]
Service Areas	The details of the geographic area for which a service is available. See service_area
service_at_locations		array[object]
Service At Locations	A link between a service and a specific location. See service_at_location
languages		array[object]
Languages	The details of the languages that are spoken at locations or services. This does not include languages which can only be used with interpretation. See language
organization		object
Organization	The details about each organization delivering services. Each service should be linked to the organization responsible for its delivery. One organization may deliver many services. See organization
funding		array[object]
Funding	The sources of funding for a service or organization. See funding
cost_options		array[object]
Cost Options	The costs of a service at certain points in time. This is an LGA Extension table. This table provides a structured version of the text information contained in the ‘fees’ field of the ‘service’ table. See cost_option
program		object
Program	The details of collections of related services. See program
required_documents		array[object]
Required Documents	The details of any documents that are required in order to access or use services. See required_document
contacts		array[object]
Contacts	The details of the named contacts for services and organizations. See contact
attributes		array[object]
Attributes	A link between a service and one or more classifications that describe the nature of the service provided. See attribute
metadata		array[object]
Metadata	A record of the changes that have been made to the data in order to maintain provenance information. See metadata

Schema

{
    "name": "service",
    "path": "services.csv",
    "description": "The details of the services provided by organizations to a range of different groups.",
    "datapackage_metadata": {
        "format": "csv",
        "mediatype": "text/csv",
        "profile": "tabular-data-resource",
        "order": 3
    },
    "type": "object",
    "properties": {
        "id": {
            "name": "id",
            "type": "string",
            "title": "Identifier",
            "description": "The identifier for the service. Each service must have a unique identifier.",
            "format": "uuid",
            "constraints": {
                "unique": true
            },
            "example": "ac148810-d857-441c-9679-408f346de14b",
            "core": "Y"
        },
        "organization_id": {
            "name": "organization_id",
            "type": "string",
            "title": "Organization Identifier",
            "description": "The identifier of the organization that provides this service.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "0fdfb57f-c147-4cfb-864c-44788a335d8c",
            "core": "Y"
        },
        "program_id": {
            "name": "program_id",
            "type": "string",
            "title": "Program Identifier",
            "description": "The identifier of the program this service is delivered under.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "24682fa0-3eda-4afc-a026-84a21c7a882e"
        },
        "name": {
            "name": "name",
            "type": "string",
            "title": "Name",
            "description": "The official or public name of the service.",
            "constraints": {
                "unique": false
            },
            "example": "Community Counselling",
            "core": "Y"
        },
        "alternate_name": {
            "name": "alternate_name",
            "type": "string",
            "title": "Alternate Name",
            "description": "An (optional) alternative name for this service.",
            "constraints": {
                "unique": false
            },
            "example": "MyCity Counselling Services"
        },
        "description": {
            "name": "description",
            "type": "string",
            "title": "Description",
            "description": "A free text description of the service.",
            "constraints": {
                "unique": false
            },
            "example": "Counselling Services provided by trained professionals. Suitable for people with mental health conditions such as anxiety, depression, or eating disorders as well as people experiencing difficult life events and circumstances. ",
            "core": "Y"
        },
        "url": {
            "name": "url",
            "type": "string",
            "title": "URL",
            "description": "URL of the service",
            "format": "uri",
            "constraints": {
                "unique": false
            },
            "example": "http://example.com/counselling",
            "core": "Y"
        },
        "email": {
            "name": "email",
            "type": "string",
            "title": "Email",
            "description": "An email address which can be used to contact the service provider.",
            "format": "email",
            "constraints": {
                "unique": false
            },
            "example": "[email protected]",
            "core": "Y"
        },
        "status": {
            "name": "status",
            "type": "string",
            "title": "Status",
            "description": "The current status of the service which can be active, inactive, defunct, or temporarily closed.",
            "constraints": {
                "unique": false
            },
            "example": "active",
            "core": "Y",
            "enum": [
                "active",
                "inactive",
                "defunct",
                "temporarily closed"
            ]
        },
        "interpretation_services": {
            "name": "interpretation_services",
            "type": "string",
            "title": "Interpretation Services",
            "description": "A free text description of any interpretation services available for accessing this service.",
            "constraints": {
                "unique": false
            },
            "example": "Interpretation services are available in Urdu, Polish, and Slovak"
        },
        "application_process": {
            "name": "application_process",
            "type": "string",
            "title": "Application Process",
            "description": "A free text description of the steps needed to access this service.",
            "constraints": {
                "unique": false
            },
            "example": "If you are an NHS patient please ask your GP for a referral letter, we will then be in touch with you directly. If you are not an NHS patient you should ring our reception to arrange an appointment"
        },
        "fees_description": {
            "name": "fees_description",
            "type": "string",
            "title": "Fees Description",
            "description": "A free text description of any charges for service users to access this service.",
            "constraints": {
                "unique": false
            },
            "example": "Non-NHS patients are expected to pay for their counselling sessions. We charge a flat rate per hour of counselling. The current rate is \u00a350 per hour. Please see our website for up to date prices."
        },
        "wait_time": {
            "name": "wait_time",
            "type": "string",
            "title": "Wait Time",
            "description": "DEPRECATED: The time a client may expect to wait before receiving a service.",
            "constraints": {
                "unique": false
            },
            "example": "wait_time"
        },
        "fees": {
            "name": "fees",
            "type": "string",
            "title": "Fees",
            "description": "DEPRECATED: Details of any charges for service users to access this service.",
            "constraints": {
                "unique": false
            },
            "example": "fees_description"
        },
        "accreditations": {
            "name": "accreditations",
            "type": "string",
            "title": "Accreditations",
            "description": "A free text description of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.",
            "constraints": {
                "unique": false
            },
            "example": "All of our practitioners are accredited by the BASC, UKCP, and the Professional Standards Body"
        },
        "eligibility_description": {
            "name": "eligibility_description",
            "type": "string",
            "title": "Eligibility Description",
            "description": "A free text description of the type of person for whom this service is intended.",
            "constraints": {
                "unique": false
            },
            "example": "This service is intended for all people aged 12 and over who require counselling services in the MyCity area",
            "core": "Y"
        },
        "minimum_age": {
            "name": "minimum_age",
            "type": "number",
            "title": "Minimum Age",
            "description": "The minimum age of a person required to meet this eligibility requirement.",
            "constraints": {
                "unique": false
            },
            "example": "12"
        },
        "maximum_age": {
            "name": "maximum_age",
            "type": "number",
            "title": "Maximum Age",
            "description": "The maximum age of a person required to meet this eligibility requirement.",
            "constraints": {
                "unique": false
            },
            "example": "100"
        },
        "assured_date": {
            "name": "assured_date",
            "type": "string",
            "title": "Assured Date",
            "description": "The date that the information about the service was last checked.",
            "constraints": {
                "unique": false
            },
            "example": "2005-01-01",
            "datapackage_type": "date"
        },
        "assurer_email": {
            "name": "assurer_email",
            "type": "string",
            "title": "Assurer Email",
            "description": "The contact e-mail address for the person or organization which last assured the service.",
            "format": "email",
            "constraints": {
                "unique": false
            },
            "example": "[email protected]"
        },
        "licenses": {
            "name": "licenses",
            "type": "string",
            "title": "Licenses",
            "description": "DEPRECATED: An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.",
            "constraints": {
                "unique": false
            },
            "example": "licences"
        },
        "alert": {
            "name": "alert",
            "type": "string",
            "title": "Alert",
            "description": "A description of any short term alerts concerning the service.",
            "constraints": {
                "unique": false
            },
            "example": "Following COVID-19 we have moved most of our counselling sessions online. Please contact the reception if you require further information."
        },
        "last_modified": {
            "name": "last_modified",
            "type": "string",
            "format": "date-time",
            "datapackage_type": "datetime",
            "title": "Last Modified",
            "description": "The datetime when the service, or any related information about the service, has changed. Should have millisecond accuracy.",
            "constraints": {
                "unique": false
            },
            "example": "2023-03-15T10:30:45.123Z"
        },
        "phones": {
            "name": "phones",
            "type": "array",
            "title": "Phones",
            "description": "The details of the telephone numbers used to contact organizations, services, and locations.",
            "items": {
                "$ref": "phone.json"
            }
        },
        "schedules": {
            "name": "schedules",
            "type": "array",
            "title": "Schedules",
            "description": "The details of when a service or location is open. Entries are RFC 5545 RRULES.",
            "items": {
                "$ref": "schedule.json"
            }
        },
        "service_areas": {
            "name": "service_areas",
            "type": "array",
            "title": "Service Areas",
            "description": "The details of the geographic area for which a service is available.",
            "items": {
                "$ref": "service_area.json"
            }
        },
        "service_at_locations": {
            "name": "service_at_locations",
            "type": "array",
            "title": "Service At Locations",
            "description": "A link between a service and a specific location.",
            "items": {
                "$ref": "service_at_location.json"
            }
        },
        "languages": {
            "name": "languages",
            "type": "array",
            "title": "Languages",
            "description": "The details of the languages that are spoken at locations or services. This does not include languages which can only be used with interpretation.",
            "items": {
                "$ref": "language.json"
            }
        },
        "organization": {
            "name": "organization",
            "title": "Organization",
            "description": "The details about each organization delivering services. Each service should be linked to the organization responsible for its delivery. One organization may deliver many services.",
            "$ref": "organization.json"
        },
        "funding": {
            "name": "funding",
            "type": "array",
            "title": "Funding",
            "description": "The sources of funding for a service or organization.",
            "items": {
                "$ref": "funding.json"
            }
        },
        "cost_options": {
            "name": "cost_options",
            "type": "array",
            "title": "Cost Options",
            "description": "The costs of a service at certain points in time. This is an LGA Extension table. This table provides a structured version of the text information contained in the 'fees' field of the 'service' table.",
            "items": {
                "$ref": "cost_option.json"
            }
        },
        "program": {
            "name": "program",
            "title": "Program",
            "description": "The details of collections of related services.",
            "$ref": "program.json"
        },
        "required_documents": {
            "name": "required_documents",
            "type": "array",
            "title": "Required Documents",
            "description": "The details of any documents that are required in order to access or use services.",
            "items": {
                "$ref": "required_document.json"
            }
        },
        "contacts": {
            "name": "contacts",
            "type": "array",
            "title": "Contacts",
            "description": "The details of the named contacts for services and organizations.",
            "items": {
                "$ref": "contact.json"
            }
        },
        "attributes": {
            "name": "attributes",
            "type": "array",
            "title": "Attributes",
            "description": "A link between a service and one or more classifications that describe the nature of the service provided.",
            "items": {
                "$ref": "attribute.json"
            }
        },
        "metadata": {
            "name": "metadata",
            "type": "array",
            "title": "Metadata",
            "description": "A record of the changes that have been made to the data in order to maintain provenance information.",
            "items": {
                "$ref": "metadata.json"
            }
        }
    },
    "required": [
        "id",
        "name",
        "status"
    ],
    "tabular_required": [
        "organization_id"
    ]
}

Example

{
    "id": "ac148810-d857-441c-9679-408f346de14b",
    "name": "Community Counselling",
    "alternate_name": "MyCity Counselling Services",
    "description": "Counselling Services provided by trained professionals. Suitable for people with mental health conditions such as anxiety, depression, or eating disorders as well as people experiencing difficult life events and circumstances. ",
    "url": "http://example.com/counselling",
    "email": "[email protected]",
    "status": "active",
    "interpretation_services": "Interpretation services are available in Urdu, Polish, and Slovak",
    "application_process": "If you are an NHS patient please ask your GP for a referral letter, we will then be in touch with you directly. If you are not an NHS patient you should ring our reception to arrange an appointment",
    "fees_description": "Non-NHS patients are expected to pay for their counselling sessions. We charge a flat rate per hour of counselling. The current rate is \u00a350 per hour. Please see our website for up to date prices.",
    "wait_time": "wait_time",
    "fees": "fees_description",
    "accreditations": "All of our practitioners are accredited by the BASC, UKCP, and the Professional Standards Body",
    "eligibility_description": "This service is intended for all people aged 12 and over who require counselling services in the MyCity area",
    "minimum_age": 12,
    "maximum_age": 100,
    "assured_date": "2005-01-01",
    "assurer_email": "[email protected]",
    "licenses": "licences",
    "alert": "Following COVID-19 we have moved most of our counselling sessions online. Please contact the reception if you require further information.",
    "last_modified": "2023-03-15T10:30:45.123Z",
    "phones": [
        {
            "id": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
            "number": "\"+44 1234 234567\"",
            "extension": 100,
            "type": "voice",
            "description": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy.",
            "languages": [
                {
                    "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                    "name": "Urdu",
                    "code": "ur",
                    "note": "Translation services provided via bilingual staff when they are available"
                }
            ]
        }
    ],
    "schedules": [
        {
            "id": "48102e86-bb50-41c4-8f1e-e269368c41d1",
            "valid_from": "2005-01-01",
            "valid_to": "2005-01-01",
            "dtstart": "2005-01-01",
            "timezone": 3,
            "until": "2005-01-01",
            "count": 3,
            "wkst": "TU",
            "freq": "WEEKLY",
            "interval": 1,
            "byday": "TH,FR",
            "byweekno": "41,42",
            "bymonthday": "2,3,4",
            "byyearday": "2,3,4",
            "description": "The service is available from 10 am to 6pm weekdays. The service is not available on public holidays.",
            "opens_at": "10:00",
            "closes_at": "18:00",
            "schedule_link": "http://example.com",
            "attending_type": "You can attend this service in-person or remotely via video conferencing",
            "notes": "Some of our staff will be unavailable during their lunch break which may be any 30 minute period between 1200 and 1400"
        }
    ],
    "service_areas": [
        {
            "id": "381c64f1-a724-4884-9c21-ac96c21cca3e",
            "name": "The service is available to all residents of the MyCity area. We provide the service in our offices or via video conferencing to any who can provide evidence of their residency.",
            "description": "The service is available to all residents of the MyCity area, including all postcodes starting with AB1, AB2, and AB3",
            "extent": "extent",
            "extent_type": "geojson",
            "uri": "http://example.com"
        }
    ],
    "service_at_locations": [
        {
            "id": "e94c9f38-1e8f-4564-91d4-d53501ab1765",
            "description": "Counselling Services provided by trained professionals in the MyCity area.",
            "contacts": [
                {
                    "id": "1e7efce3-639b-4880-940c-b95cd30cdb50",
                    "name": "Ann Persona",
                    "title": "Reception Manager",
                    "department": "Reception",
                    "email": "[email protected]",
                    "phones": [
                        {
                            "id": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
                            "number": "\"+44 1234 234567\"",
                            "extension": 100,
                            "type": "voice",
                            "description": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy.",
                            "languages": [
                                {
                                    "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                                    "name": "Urdu",
                                    "code": "ur",
                                    "note": "Translation services provided via bilingual staff when they are available"
                                }
                            ]
                        }
                    ]
                }
            ],
            "phones": [
                {
                    "id": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
                    "number": "\"+44 1234 234567\"",
                    "extension": 100,
                    "type": "voice",
                    "description": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy.",
                    "languages": [
                        {
                            "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                            "name": "Urdu",
                            "code": "ur",
                            "note": "Translation services provided via bilingual staff when they are available"
                        }
                    ]
                }
            ],
            "schedules": [
                {
                    "id": "48102e86-bb50-41c4-8f1e-e269368c41d1",
                    "valid_from": "2005-01-01",
                    "valid_to": "2005-01-01",
                    "dtstart": "2005-01-01",
                    "timezone": 3,
                    "until": "2005-01-01",
                    "count": 3,
                    "wkst": "TU",
                    "freq": "WEEKLY",
                    "interval": 1,
                    "byday": "TH,FR",
                    "byweekno": "41,42",
                    "bymonthday": "2,3,4",
                    "byyearday": "2,3,4",
                    "description": "The service is available from 10 am to 6pm weekdays. The service is not available on public holidays.",
                    "opens_at": "10:00",
                    "closes_at": "18:00",
                    "schedule_link": "http://example.com",
                    "attending_type": "You can attend this service in-person or remotely via video conferencing",
                    "notes": "Some of our staff will be unavailable during their lunch break which may be any 30 minute period between 1200 and 1400"
                }
            ],
            "location": {
                "id": "3a19ff88-4620-4d17-9830-ac1d859eb5d5",
                "location_type": "physical",
                "url": "http://example.com",
                "name": "MyCity Civic Center",
                "alternate_name": "Civic Center",
                "description": "MyCity Civic Center is located on Main Street and contains facilities for a number of civic and community services available.",
                "transportation": "MyCity Civic Center is serviced by the number 1 Bus and is a short walk from the Main Street Metro Station",
                "latitude": 100,
                "longitude": 101,
                "external_identifier": "///cheer.parent.mole",
                "external_identifier_type": "what3words",
                "languages": [
                    {
                        "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                        "name": "Urdu",
                        "code": "ur",
                        "note": "Translation services provided via bilingual staff when they are available"
                    }
                ],
                "addresses": [
                    {
                        "id": "74706e55-df26-4b84-80fe-ecc30b5befb4",
                        "attention": "A. Persona",
                        "address_1": "1-30 Main Street",
                        "address_2": "MyVillage",
                        "city": "MyCity",
                        "region": "MyRegion",
                        "state_province": "MyState",
                        "postal_code": "ABC 1234",
                        "country": "US",
                        "address_type": "postal"
                    }
                ],
                "contacts": [
                    {
                        "id": "1e7efce3-639b-4880-940c-b95cd30cdb50",
                        "name": "Ann Persona",
                        "title": "Reception Manager",
                        "department": "Reception",
                        "email": "[email protected]",
                        "phones": [
                            {
                                "id": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
                                "number": "\"+44 1234 234567\"",
                                "extension": 100,
                                "type": "voice",
                                "description": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy.",
                                "languages": [
                                    {
                                        "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                                        "name": "Urdu",
                                        "code": "ur",
                                        "note": "Translation services provided via bilingual staff when they are available"
                                    }
                                ]
                            }
                        ]
                    }
                ],
                "accessibility": [
                    {
                        "id": "afcf296e-1cb2-4139-9c88-33d587d1a50b",
                        "description": "The building is equipped with induction loops for hearing aids. Wheelchair access is possible on all levels.",
                        "details": "Switch hearing aid to T-coil to access the induction loop facility.",
                        "url": "http://example.com"
                    }
                ],
                "phones": [
                    {
                        "id": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
                        "number": "\"+44 1234 234567\"",
                        "extension": 100,
                        "type": "voice",
                        "description": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy.",
                        "languages": [
                            {
                                "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                                "name": "Urdu",
                                "code": "ur",
                                "note": "Translation services provided via bilingual staff when they are available"
                            }
                        ]
                    }
                ],
                "schedules": [
                    {
                        "id": "48102e86-bb50-41c4-8f1e-e269368c41d1",
                        "valid_from": "2005-01-01",
                        "valid_to": "2005-01-01",
                        "dtstart": "2005-01-01",
                        "timezone": 3,
                        "until": "2005-01-01",
                        "count": 3,
                        "wkst": "TU",
                        "freq": "WEEKLY",
                        "interval": 1,
                        "byday": "TH,FR",
                        "byweekno": "41,42",
                        "bymonthday": "2,3,4",
                        "byyearday": "2,3,4",
                        "description": "The service is available from 10 am to 6pm weekdays. The service is not available on public holidays.",
                        "opens_at": "10:00",
                        "closes_at": "18:00",
                        "schedule_link": "http://example.com",
                        "attending_type": "You can attend this service in-person or remotely via video conferencing",
                        "notes": "Some of our staff will be unavailable during their lunch break which may be any 30 minute period between 1200 and 1400"
                    }
                ]
            }
        }
    ],
    "languages": [
        {
            "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
            "name": "Urdu",
            "code": "ur",
            "note": "Translation services provided via bilingual staff when they are available"
        }
    ],
    "organization": {
        "id": "d9d5e0f5-d3ce-4f73-9a2f-4dd0ecc6c610",
        "name": "Example Organization Inc.",
        "alternate_name": "Example Org",
        "description": "Example Org is a non-profit organization dedicated to providing services to qualified beneficiaries",
        "email": "[email protected]",
        "website": "http://example.com",
        "tax_status": "tax_status",
        "year_incorporated": 2011,
        "legal_status": "Limited Company",
        "logo": "https://openreferral.org/wp-content/uploads/2018/02/OpenReferral_Logo_Green-4-1.png",
        "uri": "http://example.com",
        "parent_organization_id": "cd09a387-91f4-4555-94ec-e799c35344cd",
        "funding": [
            {
                "id": "1f2df32c-bf08-4b8e-bd6f-e834014b19bc",
                "source": "This service is funded partially by the MyCity local government and via grants made by charity funding bodies. We also operate a for-profit department which is used to partially cover the expense of the public service"
            }
        ],
        "contacts": [
            {
                "id": "1e7efce3-639b-4880-940c-b95cd30cdb50",
                "name": "Ann Persona",
                "title": "Reception Manager",
                "department": "Reception",
                "email": "[email protected]",
                "phones": [
                    {
                        "id": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
                        "number": "\"+44 1234 234567\"",
                        "extension": 100,
                        "type": "voice",
                        "description": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy.",
                        "languages": [
                            {
                                "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                                "name": "Urdu",
                                "code": "ur",
                                "note": "Translation services provided via bilingual staff when they are available"
                            }
                        ]
                    }
                ]
            }
        ],
        "phones": [
            {
                "id": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
                "number": "\"+44 1234 234567\"",
                "extension": 100,
                "type": "voice",
                "description": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy.",
                "languages": [
                    {
                        "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                        "name": "Urdu",
                        "code": "ur",
                        "note": "Translation services provided via bilingual staff when they are available"
                    }
                ]
            }
        ],
        "locations": [
            {
                "id": "3a19ff88-4620-4d17-9830-ac1d859eb5d5",
                "location_type": "physical",
                "url": "http://example.com",
                "name": "MyCity Civic Center",
                "alternate_name": "Civic Center",
                "description": "MyCity Civic Center is located on Main Street and contains facilities for a number of civic and community services available.",
                "transportation": "MyCity Civic Center is serviced by the number 1 Bus and is a short walk from the Main Street Metro Station",
                "latitude": 100,
                "longitude": 101,
                "external_identifier": "///cheer.parent.mole",
                "external_identifier_type": "what3words",
                "languages": [
                    {
                        "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                        "name": "Urdu",
                        "code": "ur",
                        "note": "Translation services provided via bilingual staff when they are available"
                    }
                ],
                "addresses": [
                    {
                        "id": "74706e55-df26-4b84-80fe-ecc30b5befb4",
                        "attention": "A. Persona",
                        "address_1": "1-30 Main Street",
                        "address_2": "MyVillage",
                        "city": "MyCity",
                        "region": "MyRegion",
                        "state_province": "MyState",
                        "postal_code": "ABC 1234",
                        "country": "US",
                        "address_type": "postal"
                    }
                ],
                "contacts": [
                    {
                        "id": "1e7efce3-639b-4880-940c-b95cd30cdb50",
                        "name": "Ann Persona",
                        "title": "Reception Manager",
                        "department": "Reception",
                        "email": "[email protected]",
                        "phones": [
                            {
                                "id": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
                                "number": "\"+44 1234 234567\"",
                                "extension": 100,
                                "type": "voice",
                                "description": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy.",
                                "languages": [
                                    {
                                        "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                                        "name": "Urdu",
                                        "code": "ur",
                                        "note": "Translation services provided via bilingual staff when they are available"
                                    }
                                ]
                            }
                        ]
                    }
                ],
                "accessibility": [
                    {
                        "id": "afcf296e-1cb2-4139-9c88-33d587d1a50b",
                        "description": "The building is equipped with induction loops for hearing aids. Wheelchair access is possible on all levels.",
                        "details": "Switch hearing aid to T-coil to access the induction loop facility.",
                        "url": "http://example.com"
                    }
                ],
                "phones": [
                    {
                        "id": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
                        "number": "\"+44 1234 234567\"",
                        "extension": 100,
                        "type": "voice",
                        "description": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy.",
                        "languages": [
                            {
                                "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                                "name": "Urdu",
                                "code": "ur",
                                "note": "Translation services provided via bilingual staff when they are available"
                            }
                        ]
                    }
                ],
                "schedules": [
                    {
                        "id": "48102e86-bb50-41c4-8f1e-e269368c41d1",
                        "valid_from": "2005-01-01",
                        "valid_to": "2005-01-01",
                        "dtstart": "2005-01-01",
                        "timezone": 3,
                        "until": "2005-01-01",
                        "count": 3,
                        "wkst": "TU",
                        "freq": "WEEKLY",
                        "interval": 1,
                        "byday": "TH,FR",
                        "byweekno": "41,42",
                        "bymonthday": "2,3,4",
                        "byyearday": "2,3,4",
                        "description": "The service is available from 10 am to 6pm weekdays. The service is not available on public holidays.",
                        "opens_at": "10:00",
                        "closes_at": "18:00",
                        "schedule_link": "http://example.com",
                        "attending_type": "You can attend this service in-person or remotely via video conferencing",
                        "notes": "Some of our staff will be unavailable during their lunch break which may be any 30 minute period between 1200 and 1400"
                    }
                ]
            }
        ],
        "programs": [
            {
                "id": "e7ec2e57-4540-43fa-b2c7-6be5a0ef7f42",
                "name": "Community Mental Health Support",
                "alternate_name": "MyCity Mental Health Group",
                "description": "Comprehensive Mental Health Services available to residents of MyCity including CBT and Counselling. This is not an emergency service and should not be used as an alternative to hospital and GP services."
            }
        ],
        "organization_identifiers": [
            {
                "id": "d4dbcebc-0802-47cb-8651-b937ac4f2f3e",
                "identifier_scheme": "GB-COH",
                "identifier_type": "Company number",
                "identifier": 1234567
            }
        ]
    },
    "funding": [
        {
            "id": "1f2df32c-bf08-4b8e-bd6f-e834014b19bc",
            "source": "This service is funded partially by the MyCity local government and via grants made by charity funding bodies. We also operate a for-profit department which is used to partially cover the expense of the public service"
        }
    ],
    "cost_options": [
        {
            "id": "1fdf4d39-3d80-484d-9f92-a8ffa08621e7",
            "valid_from": "2020-01-01",
            "valid_to": "2022-12-31",
            "option": "Under 18s and Over 60s",
            "currency": "gbp",
            "amount": 35,
            "amount_description": "per 1 hour session"
        }
    ],
    "program": {
        "id": "e7ec2e57-4540-43fa-b2c7-6be5a0ef7f42",
        "name": "Community Mental Health Support",
        "alternate_name": "MyCity Mental Health Group",
        "description": "Comprehensive Mental Health Services available to residents of MyCity including CBT and Counselling. This is not an emergency service and should not be used as an alternative to hospital and GP services."
    },
    "required_documents": [
        {
            "id": "f6ad7e69-b9c8-42ce-92db-92cedb4c05c0",
            "document": "Any official identification document (Passport, Driver's Licence, identity card) and evidence of address such as an official letter from local or national government. A driver's license which shows your name, photograph, and address can be used as a sole identification document.",
            "uri": "http://example.com"
        }
    ],
    "contacts": [
        {
            "id": "1e7efce3-639b-4880-940c-b95cd30cdb50",
            "name": "Ann Persona",
            "title": "Reception Manager",
            "department": "Reception",
            "email": "[email protected]",
            "phones": [
                {
                    "id": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
                    "number": "\"+44 1234 234567\"",
                    "extension": 100,
                    "type": "voice",
                    "description": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy.",
                    "languages": [
                        {
                            "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                            "name": "Urdu",
                            "code": "ur",
                            "note": "Translation services provided via bilingual staff when they are available"
                        }
                    ]
                }
            ]
        }
    ],
    "attributes": [
        {
            "id": "ae58cc39-8b70-4ab1-8aea-786882e5ac8e",
            "link_type": "link_type",
            "link_entity": "link_entity",
            "value": "value",
            "taxonomy_term": {
                "id": "3f7b145d-84af-42d7-8fae-eaca714b02b2",
                "code": "code",
                "name": "name",
                "description": "description",
                "parent_id": "0bc248fa-dc27-4650-9ba4-8f1a24ef16a2",
                "taxonomy": "taxonomy",
                "taxonomy_detail": {
                    "id": "5c4d79d7-cc55-470e-9f1f-8cad074e4892",
                    "name": "name",
                    "description": "description",
                    "uri": "http://example.com",
                    "version": "version"
                },
                "language": "eng",
                "term_uri": "http://example.com"
            }
        }
    ],
    "metadata": [
        {
            "id": "6cd71e9f-1013-49d9-8370-26b8f59d3e5a",
            "resource_type": "location",
            "last_action_date": "2011-01-01",
            "last_action_type": "update",
            "field_name": "name",
            "previous_value": "MyCity Civic Center",
            "replacement_value": "MyCity New Civic Center",
            "updated_by": "Ann Persona"
        }
    ]
}

phone

phone is defined as:

The details of the telephone numbers used to contact organizations, services, and locations.

Each phone object has the following fields:

Fields

Title	Description	Type	Format	Required
id		string	uuid	Required
Identifier	The identifier for the phone number. Each entry must have a unique identifier.
location_id		string	uuid
Location Identifier	The identifier of the location where this phone number is located.
service_id		string	uuid
Service Identifier	The identifier of the service for which this is the phone number.
organization_id		string	uuid
Organization Identifier	The identifier of the organization for which this is the phone number.
contact_id		string	uuid
Contact Identifier	The identifier of the contact for which this is the phone number.
service_at_location_id		string	uuid
Service At Location Identifier	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.
number		string		Required
Number	The phone number.
extension		number
Extension	The extension of the phone number.
type		string
Type	Indicates the type of phone service, drawing from the RFC6350 list of types (text (for SMS), voice, fax, cell, video, pager, textphone).
description		string
Description	A free text description providing extra information about the phone service
languages		array[object]
Languages	The details of the languages that are spoken at locations or services. This does not include languages which can only be used with interpretation. See language
attributes		array[object]
Attributes	A link between a service and one or more classifications that describe the nature of the service provided. See attribute
metadata		array[object]
Metadata	A record of the changes that have been made to the data in order to maintain provenance information. See metadata

Schema

{
    "name": "phone",
    "path": "phones.csv",
    "description": "The details of the telephone numbers used to contact organizations, services, and locations.",
    "datapackage_metadata": {
        "format": "csv",
        "mediatype": "text/csv",
        "profile": "tabular-data-resource",
        "order": 7
    },
    "type": "object",
    "properties": {
        "id": {
            "name": "id",
            "type": "string",
            "title": "Identifier",
            "description": "The identifier for the phone number. Each entry must have a unique identifier.",
            "format": "uuid",
            "constraints": {
                "unique": true
            },
            "example": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
            "core": "Y"
        },
        "location_id": {
            "name": "location_id",
            "type": "string",
            "title": "Location Identifier",
            "description": "The identifier of the location where this phone number is located.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "3133fbc3-469a-4ab7-9158-421acfe66229"
        },
        "service_id": {
            "name": "service_id",
            "type": "string",
            "title": "Service Identifier",
            "description": "The identifier of the service for which this is the phone number.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "9d2104f3-b9b2-4719-a85d-743fc62714a6"
        },
        "organization_id": {
            "name": "organization_id",
            "type": "string",
            "title": "Organization Identifier",
            "description": "The identifier of the organization for which this is the phone number.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "c1066581-4d59-45c7-9072-40e745e3c98c"
        },
        "contact_id": {
            "name": "contact_id",
            "type": "string",
            "title": "Contact Identifier",
            "description": "The identifier of the contact for which this is the phone number.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "52fd7852-8f0e-4b5e-9d93-ff96386096c4",
            "core": "Y"
        },
        "service_at_location_id": {
            "name": "service_at_location_id",
            "type": "string",
            "title": "Service At Location Identifier",
            "description": "The identifier of the \u2018service at location\u2019 table entry, when this phone number is specific to a service in a particular location.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "a4edb74e-c262-4379-bf87-2bf90f6f4803"
        },
        "number": {
            "name": "number",
            "type": "string",
            "title": "Number",
            "description": "The phone number.",
            "constraints": {
                "unique": false
            },
            "example": "\"+44 1234 234567\"",
            "core": "Y"
        },
        "extension": {
            "name": "extension",
            "type": "number",
            "title": "Extension",
            "description": "The extension of the phone number.",
            "constraints": {
                "unique": false
            },
            "example": "100"
        },
        "type": {
            "name": "type",
            "type": "string",
            "title": "Type",
            "description": "Indicates the type of phone service, drawing from the RFC6350 list of types (text (for SMS), voice, fax, cell, video, pager, textphone).",
            "constraints": {
                "unique": false
            },
            "example": "voice"
        },
        "description": {
            "name": "description",
            "type": "string",
            "title": "Description",
            "description": "A free text description providing extra information about the phone service",
            "constraints": {
                "unique": false
            },
            "example": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy."
        },
        "languages": {
            "name": "languages",
            "type": "array",
            "title": "Languages",
            "description": "The details of the languages that are spoken at locations or services. This does not include languages which can only be used with interpretation.",
            "items": {
                "$ref": "language.json"
            }
        },
        "attributes": {
            "name": "attributes",
            "type": "array",
            "title": "Attributes",
            "description": "A link between a service and one or more classifications that describe the nature of the service provided.",
            "items": {
                "$ref": "attribute.json"
            }
        },
        "metadata": {
            "name": "metadata",
            "type": "array",
            "title": "Metadata",
            "description": "A record of the changes that have been made to the data in order to maintain provenance information.",
            "items": {
                "$ref": "metadata.json"
            }
        }
    },
    "required": [
        "id",
        "number"
    ]
}

Example

[
    {
        "id": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
        "number": "\"+44 1234 234567\"",
        "extension": 100,
        "type": "voice",
        "description": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy.",
        "languages": [
            {
                "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                "name": "Urdu",
                "code": "ur",
                "note": "Translation services provided via bilingual staff when they are available"
            }
        ]
    }
]

schedule

schedule is defined as:

The details of when a service or location is open. Entries are RFC 5545 RRULES.

Each schedule object has the following fields:

Fields

Title	Description	Type	Format	Required
id		string	uuid	Required
Identifier	The identifier for the schedule. Each entry must have a unique identifier.
service_id		string	uuid
Service Identifier	The identifier of the service for which this is the regular schedule
location_id		string	uuid
Location Identifier	The identifier of the location for which this is the regular schedule
service_at_location_id		string	uuid
Service At Location Identifier	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.
valid_from		string
Valid From	The date from which the schedule information is valid. It must be in the ISO 8601 format of YYYY-MM-DD,
valid_to		string
Valid To	The last date on which the schedule information is valid. It must be in the ISO 8601 format of YYYY-MM-DD.
dtstart		string
Date Start	iCal - The date of the first event is the schedule. Necessary when using the ‘interval’ feature, optional otherwise.
timezone		number
Timezone	The timezone that all dates are expressed as, expressed as a UTC offset. Dates are assumed to be UTC otherwise.
until		string
Until	iCal - The date of the last occurrence of the recurring event.
count		number
Count	iCal - The number of times that the event occurs. Use this instead of ‘until’, if appropriate.
wkst		string
Week Start	iCal - The two-letter code for the day on which the week starts.
freq		string
Frequency	iCal - How often the frequency repeats.
interval		number
Interval	iCal - How often the frequency repeats. For example, and Interval of 2 for a WEEKLY Frequency would represent fortnightly.
byday		string
By Day	iCal - Comma separated days of the week. Where freq is MONTHLY each part can be preceded by a positive or negative integer to represent which occurrence in a month; e.g. 2MO is the second Monday in a month. -1FR is the last Friday
byweekno		string
By Week Number	iCal - Comma separated numeric weeks of the year, where freq is WEEKLY. Can be negative to represent weeks before the end of the year; e.g. -5 is the 5th to last week in a year.
bymonthday		string
By Month Day	iCal - Comma separated numeric days of the month, where frequency is MONTHLY. Can be negative to represent days before the end of the month; e.g. -5 is the 5th to last day in a month.
byyearday		string
By Year Day	iCal - Comma separated numeric days of the month, where frequency is YEARLY. Can be negative to represent days before the end of the year; e.g. -1 is the last day in a year.
description		string
Description	A free text description of the availability of the service.
opens_at		string
Opens At	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am EST.)
closes_at		string
Closes At	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am EST.).
schedule_link		string	uri
Schedule Link	URL of a link for the schedule which may show each individual session and may provide a booking facility.
attending_type		string
Attending Type	A free text description of how to attend this service.
notes		string
Notes	Free text notes on the schedule.
attributes		array[object]
Attributes	A link between a service and one or more classifications that describe the nature of the service provided. See attribute
metadata		array[object]
Metadata	A record of the changes that have been made to the data in order to maintain provenance information. See metadata

Schema

{
    "name": "schedule",
    "path": "schedules.csv",
    "description": "The details of when a service or location is open. Entries are RFC 5545 RRULES.",
    "datapackage_metadata": {
        "format": "csv",
        "mediatype": "text/csv",
        "profile": "tabular-data-resource",
        "order": 10
    },
    "type": "object",
    "properties": {
        "id": {
            "name": "id",
            "type": "string",
            "title": "Identifier",
            "description": "The identifier for the schedule. Each entry must have a unique identifier.",
            "format": "uuid",
            "constraints": {
                "unique": true
            },
            "example": "48102e86-bb50-41c4-8f1e-e269368c41d1",
            "core": "Y"
        },
        "service_id": {
            "name": "service_id",
            "type": "string",
            "title": "Service Identifier",
            "description": "The identifier of the service for which this is the regular schedule",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "ae8b7eaf-7e7d-4128-a403-ae097f146356",
            "core": "Y"
        },
        "location_id": {
            "name": "location_id",
            "type": "string",
            "title": "Location Identifier",
            "description": "The identifier of the location for which this is the regular schedule",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "dd9e501b-4df9-4e71-85ac-29748e7e2d5a"
        },
        "service_at_location_id": {
            "name": "service_at_location_id",
            "type": "string",
            "title": "Service At Location Identifier",
            "description": "The identifier of the \u2018service at location\u2019 table entry, when this schedule is specific to a service in a particular location.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "0a41a90a-b5a5-4541-87e2-5cc2fd72536b",
            "core": "Y"
        },
        "valid_from": {
            "name": "valid_from",
            "type": "string",
            "title": "Valid From",
            "description": "The date from which the schedule information is valid. It must be in the ISO 8601 format of YYYY-MM-DD,",
            "constraints": {
                "unique": false
            },
            "example": "2005-01-01",
            "core": "Y",
            "datapackage_type": "date"
        },
        "valid_to": {
            "name": "valid_to",
            "type": "string",
            "title": "Valid To",
            "description": "The last date on which the schedule information is valid. It must be in the ISO 8601 format of YYYY-MM-DD.",
            "constraints": {
                "unique": false
            },
            "example": "2005-01-01",
            "core": "Y",
            "datapackage_type": "date"
        },
        "dtstart": {
            "name": "dtstart",
            "type": "string",
            "title": "Date Start",
            "description": "iCal - The date of the first event is the schedule. Necessary when using the \u2018interval\u2019 feature, optional otherwise.",
            "constraints": {
                "unique": false
            },
            "example": "2005-01-01",
            "core": "Y",
            "datapackage_type": "date"
        },
        "timezone": {
            "name": "timezone",
            "type": "number",
            "title": "Timezone",
            "description": "The timezone that all dates are expressed as, expressed as a UTC offset. Dates are assumed to be UTC otherwise.",
            "constraints": {
                "unique": false
            },
            "example": "3"
        },
        "until": {
            "name": "until",
            "type": "string",
            "title": "Until",
            "description": "iCal - The date of the last occurrence of the recurring event.",
            "constraints": {
                "unique": false
            },
            "example": "2005-01-01",
            "datapackage_type": "date"
        },
        "count": {
            "name": "count",
            "type": "number",
            "title": "Count",
            "description": "iCal - The number of times that the event occurs. Use this instead of \u2018until\u2019, if appropriate.",
            "constraints": {
                "unique": false
            },
            "example": "3"
        },
        "wkst": {
            "name": "wkst",
            "type": "string",
            "title": "Week Start",
            "description": "iCal - The two-letter code for the day on which the week starts.",
            "constraints": {
                "unique": false
            },
            "example": "TU",
            "enum": [
                "MO",
                "TU",
                "WE",
                "TH",
                "FR",
                "SA",
                "SU"
            ]
        },
        "freq": {
            "name": "freq",
            "type": "string",
            "title": "Frequency",
            "description": "iCal - How often the frequency repeats.",
            "constraints": {
                "unique": false
            },
            "example": "WEEKLY",
            "core": "Y",
            "enum": [
                "WEEKLY",
                "MONTHLY"
            ]
        },
        "interval": {
            "name": "interval",
            "type": "number",
            "title": "Interval",
            "description": "iCal - How often the frequency repeats. For example, and Interval of 2 for a WEEKLY Frequency would represent fortnightly.",
            "constraints": {
                "unique": false
            },
            "example": "1",
            "core": "Y"
        },
        "byday": {
            "name": "byday",
            "type": "string",
            "title": "By Day",
            "description": "iCal - Comma separated days of the week. Where freq is MONTHLY each part can be preceded by a positive or negative integer to represent which occurrence in a month; e.g. 2MO is the second Monday in a month. -1FR is the last Friday",
            "constraints": {
                "unique": false
            },
            "example": "TH,FR",
            "core": "Y"
        },
        "byweekno": {
            "name": "byweekno",
            "type": "string",
            "title": "By Week Number",
            "description": "iCal - Comma separated numeric weeks of the year, where freq is WEEKLY. Can be negative to represent weeks before the end of the year; e.g. -5 is the 5th to last week in a year.",
            "constraints": {
                "unique": false
            },
            "example": "41,42"
        },
        "bymonthday": {
            "name": "bymonthday",
            "type": "string",
            "title": "By Month Day",
            "description": "iCal - Comma separated numeric days of the month, where frequency is MONTHLY. Can be negative to represent days before the end of the month; e.g. -5 is the 5th to last day in a month.",
            "constraints": {
                "unique": false
            },
            "example": "2,3,4",
            "core": "Y"
        },
        "byyearday": {
            "name": "byyearday",
            "type": "string",
            "title": "By Year Day",
            "description": "iCal - Comma separated numeric days of the month, where frequency is YEARLY. Can be negative to represent days before the end of the year; e.g. -1 is the last day in a year.",
            "constraints": {
                "unique": false
            },
            "example": "2,3,4"
        },
        "description": {
            "name": "description",
            "type": "string",
            "title": "Description",
            "description": "A free text description of the availability of the service.",
            "constraints": {
                "unique": false
            },
            "example": "The service is available from 10 am to 6pm weekdays. The service is not available on public holidays.",
            "core": "Y"
        },
        "opens_at": {
            "name": "opens_at",
            "type": "string",
            "title": "Opens At",
            "description": "The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix \u2018Z\u2019 when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am EST.)",
            "constraints": {
                "unique": false
            },
            "example": "10:00",
            "core": "Y",
            "datapackage_type": "time"
        },
        "closes_at": {
            "name": "closes_at",
            "type": "string",
            "title": "Closes At",
            "description": "The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix \u2018Z\u2019 when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am EST.).",
            "constraints": {
                "unique": false
            },
            "example": "18:00",
            "core": "Y",
            "datapackage_type": "time"
        },
        "schedule_link": {
            "name": "schedule_link",
            "type": "string",
            "title": "Schedule Link",
            "description": "URL of a link for the schedule which may show each individual session and may provide a booking facility.",
            "format": "uri",
            "constraints": {
                "unique": false
            },
            "example": "http://example.com"
        },
        "attending_type": {
            "name": "attending_type",
            "type": "string",
            "title": "Attending Type",
            "description": "A free text description of how to attend this service.",
            "constraints": {
                "unique": false
            },
            "example": "You can attend this service in-person or remotely via video conferencing"
        },
        "notes": {
            "name": "notes",
            "type": "string",
            "title": "Notes",
            "description": "Free text notes on the schedule.",
            "constraints": {
                "unique": false
            },
            "example": "Some of our staff will be unavailable during their lunch break which may be any 30 minute period between 1200 and 1400"
        },
        "attributes": {
            "name": "attributes",
            "type": "array",
            "title": "Attributes",
            "description": "A link between a service and one or more classifications that describe the nature of the service provided.",
            "items": {
                "$ref": "attribute.json"
            }
        },
        "metadata": {
            "name": "metadata",
            "type": "array",
            "title": "Metadata",
            "description": "A record of the changes that have been made to the data in order to maintain provenance information.",
            "items": {
                "$ref": "metadata.json"
            }
        }
    },
    "required": [
        "id"
    ]
}

Example

[
    {
        "id": "48102e86-bb50-41c4-8f1e-e269368c41d1",
        "valid_from": "2005-01-01",
        "valid_to": "2005-01-01",
        "dtstart": "2005-01-01",
        "timezone": 3,
        "until": "2005-01-01",
        "count": 3,
        "wkst": "TU",
        "freq": "WEEKLY",
        "interval": 1,
        "byday": "TH,FR",
        "byweekno": "41,42",
        "bymonthday": "2,3,4",
        "byyearday": "2,3,4",
        "description": "The service is available from 10 am to 6pm weekdays. The service is not available on public holidays.",
        "opens_at": "10:00",
        "closes_at": "18:00",
        "schedule_link": "http://example.com",
        "attending_type": "You can attend this service in-person or remotely via video conferencing",
        "notes": "Some of our staff will be unavailable during their lunch break which may be any 30 minute period between 1200 and 1400"
    }
]

service_area

service_area is defined as:

The details of the geographic area for which a service is available.

Each service_area object has the following fields:

Fields

Title	Description	Type	Format	Required
id		string	uuid	Required
Identifier	The identifier for the service area. Each service area must have a unique identifier.
service_id		string	uuid
Service Identifier	The identifier of the service for which this entry describes the service area
name		string
Name	A free text geographic area where a service is available.
description		string
Description	A more detailed free text description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.
extent		string
Extent	A definition of the polygon defining the area.
extent_type		string
Extent Type	The format of the extent field populated from an enum of “geojson”, “topojson”, “kml”,and (for legacy systems or early state during transformation) “text”.
uri		string
URI	A URI which acts as a persistent identifier to identify an area.
attributes		array[object]
Attributes	A link between a service and one or more classifications that describe the nature of the service provided. See attribute
metadata		array[object]
Metadata	A record of the changes that have been made to the data in order to maintain provenance information. See metadata

Schema

{
    "name": "service_area",
    "path": "service_areas.csv",
    "description": "The details of the geographic area for which a service is available.",
    "datapackage_metadata": {
        "format": "csv",
        "mediatype": "text/csv",
        "profile": "tabular-data-resource",
        "order": 12
    },
    "type": "object",
    "properties": {
        "id": {
            "name": "id",
            "type": "string",
            "title": "Identifier",
            "description": "The identifier for the service area. Each service area must have a unique identifier.",
            "format": "uuid",
            "constraints": {
                "unique": true
            },
            "example": "381c64f1-a724-4884-9c21-ac96c21cca3e",
            "core": "Y"
        },
        "service_id": {
            "name": "service_id",
            "type": "string",
            "title": "Service Identifier",
            "description": "The identifier of the service for which this entry describes the service area",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "146fbf18-d4a3-4bee-a8b0-2d4476478eea",
            "core": "Y"
        },
        "name": {
            "name": "name",
            "type": "string",
            "title": "Name",
            "description": "A free text geographic area where a service is available.",
            "constraints": {
                "unique": false
            },
            "example": "The service is available to all residents of the MyCity area. We provide the service in our offices or via video conferencing to any who can provide evidence of their residency.",
            "core": "Y"
        },
        "description": {
            "name": "description",
            "type": "string",
            "title": "Description",
            "description": "A more detailed free text description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.",
            "constraints": {
                "unique": false
            },
            "example": "The service is available to all residents of the MyCity area, including all postcodes starting with AB1, AB2, and AB3",
            "core": "Y"
        },
        "extent": {
            "name": "extent",
            "type": "string",
            "title": "Extent",
            "description": "A definition of the polygon defining the area.",
            "constraints": {
                "unique": false
            },
            "example": "extent"
        },
        "extent_type": {
            "name": "extent_type",
            "type": "string",
            "title": "Extent Type",
            "description": "The format of the extent field  populated from an enum of  \"geojson\", \"topojson\",  \"kml\",and (for legacy systems or early state during transformation) \"text\".",
            "constraints": {
                "unique": false
            },
            "example": "geojson"
        },
        "uri": {
            "name": "uri",
            "type": "string",
            "title": "URI",
            "description": "A URI which acts as a persistent identifier to identify an area.",
            "constraints": {
                "unique": false
            },
            "example": "http://example.com"
        },
        "attributes": {
            "name": "attributes",
            "type": "array",
            "title": "Attributes",
            "description": "A link between a service and one or more classifications that describe the nature of the service provided.",
            "items": {
                "$ref": "attribute.json"
            }
        },
        "metadata": {
            "name": "metadata",
            "type": "array",
            "title": "Metadata",
            "description": "A record of the changes that have been made to the data in order to maintain provenance information.",
            "items": {
                "$ref": "metadata.json"
            }
        }
    },
    "required": [
        "id"
    ]
}

Example

[
    {
        "id": "381c64f1-a724-4884-9c21-ac96c21cca3e",
        "name": "The service is available to all residents of the MyCity area. We provide the service in our offices or via video conferencing to any who can provide evidence of their residency.",
        "description": "The service is available to all residents of the MyCity area, including all postcodes starting with AB1, AB2, and AB3",
        "extent": "extent",
        "extent_type": "geojson",
        "uri": "http://example.com"
    }
]

service_at_location

service_at_location is defined as:

A link between a service and a specific location.

Each service_at_location object has the following fields:

Fields

Title	Description	Type	Format	Required
id		string	uuid	Required
Identifier	The identifier of the service at location entry. Each entry must have a unique identifier.
service_id		string	uuid
Service Identifier	The identifier of the service at a given location.
description		string
Description	A free text description of the service at this specific location.
contacts		array[object]
Contacts	The details of the named contacts for services and organizations. See contact
phones		array[object]
Phones	The details of the telephone numbers used to contact organizations, services, and locations. See phone
schedules		array[object]
Schedules	The details of when a service or location is open. Entries are RFC 5545 RRULES. See schedule
location		object
Location	The details of the locations where organizations operate. Locations may be virtual, and one organization may have many locations. See location
attributes		array[object]
Attributes	A link between a service and one or more classifications that describe the nature of the service provided. See attribute
metadata		array[object]
Metadata	A record of the changes that have been made to the data in order to maintain provenance information. See metadata

Schema

{
    "name": "service_at_location",
    "path": "service_at_location.csv",
    "description": "A link between a service and a specific location.",
    "datapackage_metadata": {
        "format": "csv",
        "mediatype": "text/csv",
        "profile": "tabular-data-resource",
        "order": 5
    },
    "type": "object",
    "properties": {
        "id": {
            "name": "id",
            "type": "string",
            "title": "Identifier",
            "description": "The identifier of the service at location entry. Each entry must have a unique identifier.",
            "format": "uuid",
            "constraints": {
                "unique": true
            },
            "example": "e94c9f38-1e8f-4564-91d4-d53501ab1765",
            "core": "Y"
        },
        "service_id": {
            "name": "service_id",
            "type": "string",
            "title": "Service Identifier",
            "description": "The identifier of the service at a given location.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "ab231982-2106-4a55-80fc-b305560c5556",
            "core": "Y"
        },
        "location_id": {
            "name": "location_id",
            "type": "string",
            "title": "Location Identifier",
            "description": "The identifier of the location where this service operates.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "2528e812-ccbb-43a7-b761-a90f27ea9ac4",
            "core": "Y"
        },
        "description": {
            "name": "description",
            "type": "string",
            "title": "Description",
            "description": "A free text description of the service at this specific location.",
            "constraints": {
                "unique": false
            },
            "example": "Counselling Services provided by trained professionals in the MyCity area."
        },
        "contacts": {
            "name": "contacts",
            "type": "array",
            "title": "Contacts",
            "description": "The details of the named contacts for services and organizations.",
            "items": {
                "$ref": "contact.json"
            }
        },
        "phones": {
            "name": "phones",
            "type": "array",
            "title": "Phones",
            "description": "The details of the telephone numbers used to contact organizations, services, and locations.",
            "items": {
                "$ref": "phone.json"
            }
        },
        "schedules": {
            "name": "schedules",
            "type": "array",
            "title": "Schedules",
            "description": "The details of when a service or location is open. Entries are RFC 5545 RRULES.",
            "items": {
                "$ref": "schedule.json"
            }
        },
        "location": {
            "name": "location",
            "title": "Location",
            "description": "The details of the locations where organizations operate. Locations may be virtual, and one organization may have many locations.",
            "$ref": "location.json"
        },
        "attributes": {
            "name": "attributes",
            "type": "array",
            "title": "Attributes",
            "description": "A link between a service and one or more classifications that describe the nature of the service provided.",
            "items": {
                "$ref": "attribute.json"
            }
        },
        "metadata": {
            "name": "metadata",
            "type": "array",
            "title": "Metadata",
            "description": "A record of the changes that have been made to the data in order to maintain provenance information.",
            "items": {
                "$ref": "metadata.json"
            }
        }
    },
    "required": [
        "id"
    ],
    "tabular_required": [
        "service_id",
        "location_id"
    ]
}

Example

[
    {
        "id": "e94c9f38-1e8f-4564-91d4-d53501ab1765",
        "description": "Counselling Services provided by trained professionals in the MyCity area.",
        "contacts": [
            {
                "id": "1e7efce3-639b-4880-940c-b95cd30cdb50",
                "name": "Ann Persona",
                "title": "Reception Manager",
                "department": "Reception",
                "email": "[email protected]",
                "phones": [
                    {
                        "id": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
                        "number": "\"+44 1234 234567\"",
                        "extension": 100,
                        "type": "voice",
                        "description": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy.",
                        "languages": [
                            {
                                "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                                "name": "Urdu",
                                "code": "ur",
                                "note": "Translation services provided via bilingual staff when they are available"
                            }
                        ]
                    }
                ]
            }
        ],
        "phones": [
            {
                "id": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
                "number": "\"+44 1234 234567\"",
                "extension": 100,
                "type": "voice",
                "description": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy.",
                "languages": [
                    {
                        "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                        "name": "Urdu",
                        "code": "ur",
                        "note": "Translation services provided via bilingual staff when they are available"
                    }
                ]
            }
        ],
        "schedules": [
            {
                "id": "48102e86-bb50-41c4-8f1e-e269368c41d1",
                "valid_from": "2005-01-01",
                "valid_to": "2005-01-01",
                "dtstart": "2005-01-01",
                "timezone": 3,
                "until": "2005-01-01",
                "count": 3,
                "wkst": "TU",
                "freq": "WEEKLY",
                "interval": 1,
                "byday": "TH,FR",
                "byweekno": "41,42",
                "bymonthday": "2,3,4",
                "byyearday": "2,3,4",
                "description": "The service is available from 10 am to 6pm weekdays. The service is not available on public holidays.",
                "opens_at": "10:00",
                "closes_at": "18:00",
                "schedule_link": "http://example.com",
                "attending_type": "You can attend this service in-person or remotely via video conferencing",
                "notes": "Some of our staff will be unavailable during their lunch break which may be any 30 minute period between 1200 and 1400"
            }
        ],
        "location": {
            "id": "3a19ff88-4620-4d17-9830-ac1d859eb5d5",
            "location_type": "physical",
            "url": "http://example.com",
            "name": "MyCity Civic Center",
            "alternate_name": "Civic Center",
            "description": "MyCity Civic Center is located on Main Street and contains facilities for a number of civic and community services available.",
            "transportation": "MyCity Civic Center is serviced by the number 1 Bus and is a short walk from the Main Street Metro Station",
            "latitude": 100,
            "longitude": 101,
            "external_identifier": "///cheer.parent.mole",
            "external_identifier_type": "what3words",
            "languages": [
                {
                    "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                    "name": "Urdu",
                    "code": "ur",
                    "note": "Translation services provided via bilingual staff when they are available"
                }
            ],
            "addresses": [
                {
                    "id": "74706e55-df26-4b84-80fe-ecc30b5befb4",
                    "attention": "A. Persona",
                    "address_1": "1-30 Main Street",
                    "address_2": "MyVillage",
                    "city": "MyCity",
                    "region": "MyRegion",
                    "state_province": "MyState",
                    "postal_code": "ABC 1234",
                    "country": "US",
                    "address_type": "postal"
                }
            ],
            "contacts": [
                {
                    "id": "1e7efce3-639b-4880-940c-b95cd30cdb50",
                    "name": "Ann Persona",
                    "title": "Reception Manager",
                    "department": "Reception",
                    "email": "[email protected]",
                    "phones": [
                        {
                            "id": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
                            "number": "\"+44 1234 234567\"",
                            "extension": 100,
                            "type": "voice",
                            "description": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy.",
                            "languages": [
                                {
                                    "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                                    "name": "Urdu",
                                    "code": "ur",
                                    "note": "Translation services provided via bilingual staff when they are available"
                                }
                            ]
                        }
                    ]
                }
            ],
            "accessibility": [
                {
                    "id": "afcf296e-1cb2-4139-9c88-33d587d1a50b",
                    "description": "The building is equipped with induction loops for hearing aids. Wheelchair access is possible on all levels.",
                    "details": "Switch hearing aid to T-coil to access the induction loop facility.",
                    "url": "http://example.com"
                }
            ],
            "phones": [
                {
                    "id": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
                    "number": "\"+44 1234 234567\"",
                    "extension": 100,
                    "type": "voice",
                    "description": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy.",
                    "languages": [
                        {
                            "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                            "name": "Urdu",
                            "code": "ur",
                            "note": "Translation services provided via bilingual staff when they are available"
                        }
                    ]
                }
            ],
            "schedules": [
                {
                    "id": "48102e86-bb50-41c4-8f1e-e269368c41d1",
                    "valid_from": "2005-01-01",
                    "valid_to": "2005-01-01",
                    "dtstart": "2005-01-01",
                    "timezone": 3,
                    "until": "2005-01-01",
                    "count": 3,
                    "wkst": "TU",
                    "freq": "WEEKLY",
                    "interval": 1,
                    "byday": "TH,FR",
                    "byweekno": "41,42",
                    "bymonthday": "2,3,4",
                    "byyearday": "2,3,4",
                    "description": "The service is available from 10 am to 6pm weekdays. The service is not available on public holidays.",
                    "opens_at": "10:00",
                    "closes_at": "18:00",
                    "schedule_link": "http://example.com",
                    "attending_type": "You can attend this service in-person or remotely via video conferencing",
                    "notes": "Some of our staff will be unavailable during their lunch break which may be any 30 minute period between 1200 and 1400"
                }
            ]
        }
    }
]

location

location is defined as:

The locations where organizations operate. Locations may be virtual, and one organization may have many locations.

Each location object has the following fields:

Fields

Title	Description	Type	Format	Required
id		string	uuid	Required
Identifier	The identifier of the location. Each location must have a unique identifier.
location_type		string		Required
Location Type	The type of location, which may be either physical, postal, or virtual.
url		string	uri
URL	If location_type is virtual, then this field represents the URL of a virtual location.
organization_id		string	uuid
Organization Identifier	The organization identifier for a location. 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 organization delivers at this location should be provided in the services_at_location table.
name		string
Name	The name of the location.
alternate_name		string
Alternate Name	An (optional) alternative name of the location.
description		string
Description	A free text description of the location.
transportation		string
Transportation	A free text description of the access to public or private transportation to and from the location.
latitude		number
Latitude	The latitude of the location expressed in decimal degrees in WGS84 datum.
longitude		number
Longitude	The longitude of the location expressed in decimal degrees in WGS84 datum.
external_identifier		string
External Identifier	A third party identifier for the location, which can be drawn from other services e.g. UK UPRN or what3words.
external_identifier_type		string
External Identifier Type	The scheme used for the location’s external_identifier e.g. UK UPRN or what3words.
languages		array[object]
Languages	The languages that are spoken at locations or services. This does not include languages which can only be used with interpretation. See language
addresses		array[object]
Addresses	The addresses of locations where organizations operate. See address
contacts		array[object]
Contacts	The details of the named contacts for services and organizations. Note that in the HSDS data package format, if an individual is the contact for multiple services, their details may be duplicated multiple times in this table, each time with a new identifier, and with the rows containing different service ids. See contact
accessibility		array[object]
Accessibility	The details of the arrangements for access to locations for people who have disabilities See accessibility
phones		array[object]
Phones	The details of the telephone numbers used to contact organizations, services, and locations. See phone
schedules		array[object]
Schedules	The details of when a service or location is open. Entries are RFC 5545 RRULES. See schedule
attributes		array[object]
Attributes	A link between a service and one or more classifications that describe the nature of the service provided. See attribute
metadata		array[object]
Metadata	The metadata table contains a record of the changes that have been made to the data in order to maintain provenance information. See metadata

Schema

{
    "name": "location",
    "path": "locations.csv",
    "description": "The locations where organizations operate. Locations may be virtual, and one organization may have many locations.",
    "datapackage_metadata": {
        "format": "csv",
        "mediatype": "text/csv",
        "profile": "tabular-data-resource",
        "order": 6
    },
    "type": "object",
    "properties": {
        "id": {
            "name": "id",
            "type": "string",
            "title": "Identifier",
            "description": "The identifier of the location. Each location must have a unique identifier.",
            "format": "uuid",
            "constraints": {
                "unique": true
            },
            "example": "3a19ff88-4620-4d17-9830-ac1d859eb5d5",
            "core": "Y"
        },
        "location_type": {
            "name": "location_type",
            "type": "string",
            "title": "Location Type",
            "description": "The type of location, which may be either physical, postal, or virtual.",
            "constraints": {
                "unique": false
            },
            "example": "physical",
            "core": "Y",
            "enum": [
                "physical",
                "postal",
                "virtual"
            ]
        },
        "url": {
            "name": "url",
            "type": "string",
            "title": "URL",
            "description": "If location_type is virtual, then this field represents the URL of a virtual location.",
            "format": "uri",
            "constraints": {
                "unique": false
            },
            "example": "http://example.com",
            "core": "Y"
        },
        "organization_id": {
            "name": "organization_id",
            "type": "string",
            "title": "Organization Identifier",
            "description": "The organization identifier for a location. 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 organization delivers at this location should be provided in the services_at_location table.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "985e4a42-bd9f-4edc-911d-0243a4640aca"
        },
        "name": {
            "name": "name",
            "type": "string",
            "title": "Name",
            "description": "The name of the location.",
            "constraints": {
                "unique": false
            },
            "example": "MyCity Civic Center",
            "core": "Y"
        },
        "alternate_name": {
            "name": "alternate_name",
            "type": "string",
            "title": "Alternate Name",
            "description": "An (optional) alternative name of the location.",
            "constraints": {
                "unique": false
            },
            "example": "Civic Center"
        },
        "description": {
            "name": "description",
            "type": "string",
            "title": "Description",
            "description": "A free text description of the location.",
            "constraints": {
                "unique": false
            },
            "example": "MyCity Civic Center is located on Main Street and contains facilities for a number of civic and community services available.",
            "core": "Y"
        },
        "transportation": {
            "name": "transportation",
            "type": "string",
            "title": "Transportation",
            "description": "A free text description of the access to public or private transportation to and from the location.",
            "constraints": {
                "unique": false
            },
            "example": "MyCity Civic Center is serviced by the number 1 Bus and is a short walk from the Main Street Metro Station"
        },
        "latitude": {
            "name": "latitude",
            "type": "number",
            "title": "Latitude",
            "description": "The latitude of the location expressed in decimal degrees in WGS84 datum.",
            "constraints": {
                "unique": false
            },
            "example": "100",
            "core": "Y"
        },
        "longitude": {
            "name": "longitude",
            "type": "number",
            "title": "Longitude",
            "description": "The longitude of the location expressed in decimal degrees in WGS84 datum.",
            "constraints": {
                "unique": false
            },
            "example": "101",
            "core": "Y"
        },
        "external_identifier": {
            "name": "external_identifier",
            "type": "string",
            "title": "External Identifier",
            "description": "A third party identifier for the location, which can be drawn from other services e.g. UK UPRN or what3words.",
            "constraints": {
                "unique": false
            },
            "example": "///cheer.parent.mole"
        },
        "external_identifier_type": {
            "name": "external_identifier_type",
            "type": "string",
            "title": "External Identifier Type",
            "description": "The scheme used for the location's external_identifier e.g. UK UPRN or what3words.",
            "constraints": {
                "unique": false
            },
            "example": "what3words"
        },
        "languages": {
            "name": "languages",
            "type": "array",
            "title": "Languages",
            "description": "The languages that are spoken at locations or services. This does not include languages which can only be used with interpretation.",
            "items": {
                "$ref": "language.json"
            }
        },
        "addresses": {
            "name": "addresses",
            "type": "array",
            "title": "Addresses",
            "description": "The addresses of locations where organizations operate.",
            "items": {
                "$ref": "address.json"
            }
        },
        "contacts": {
            "name": "contacts",
            "type": "array",
            "title": "Contacts",
            "description": "The details of the named contacts for services and organizations. Note that in the HSDS data package format, if an individual is the contact for multiple services, their details may be duplicated multiple times in this table, each time with a new identifier, and with the rows containing different service ids.",
            "items": {
                "$ref": "contact.json"
            }
        },
        "accessibility": {
            "name": "accessibility",
            "type": "array",
            "title": "Accessibility",
            "description": "The details of the arrangements for access to locations for people who have disabilities",
            "items": {
                "$ref": "accessibility.json"
            }
        },
        "phones": {
            "name": "phones",
            "type": "array",
            "title": "Phones",
            "description": "The details of the telephone numbers used to contact organizations, services, and locations.",
            "items": {
                "$ref": "phone.json"
            }
        },
        "schedules": {
            "name": "schedules",
            "type": "array",
            "title": "Schedules",
            "description": "The details of when a service or location is open. Entries are RFC 5545 RRULES.",
            "items": {
                "$ref": "schedule.json"
            }
        },
        "attributes": {
            "name": "attributes",
            "type": "array",
            "title": "Attributes",
            "description": "A link between a service and one or more classifications that describe the nature of the service provided.",
            "items": {
                "$ref": "attribute.json"
            }
        },
        "metadata": {
            "name": "metadata",
            "type": "array",
            "title": "Metadata",
            "description": "The metadata table contains a record of the changes that have been made to the data in order to maintain provenance information.",
            "items": {
                "$ref": "metadata.json"
            }
        }
    },
    "required": [
        "id",
        "location_type"
    ]
}

Example

[
    {
        "id": "3a19ff88-4620-4d17-9830-ac1d859eb5d5",
        "location_type": "physical",
        "url": "http://example.com",
        "name": "MyCity Civic Center",
        "alternate_name": "Civic Center",
        "description": "MyCity Civic Center is located on Main Street and contains facilities for a number of civic and community services available.",
        "transportation": "MyCity Civic Center is serviced by the number 1 Bus and is a short walk from the Main Street Metro Station",
        "latitude": 100,
        "longitude": 101,
        "external_identifier": "///cheer.parent.mole",
        "external_identifier_type": "what3words",
        "languages": [
            {
                "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                "name": "Urdu",
                "code": "ur",
                "note": "Translation services provided via bilingual staff when they are available"
            }
        ],
        "addresses": [
            {
                "id": "74706e55-df26-4b84-80fe-ecc30b5befb4",
                "attention": "A. Persona",
                "address_1": "1-30 Main Street",
                "address_2": "MyVillage",
                "city": "MyCity",
                "region": "MyRegion",
                "state_province": "MyState",
                "postal_code": "ABC 1234",
                "country": "US",
                "address_type": "postal"
            }
        ],
        "contacts": [
            {
                "id": "1e7efce3-639b-4880-940c-b95cd30cdb50",
                "name": "Ann Persona",
                "title": "Reception Manager",
                "department": "Reception",
                "email": "[email protected]",
                "phones": [
                    {
                        "id": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
                        "number": "\"+44 1234 234567\"",
                        "extension": 100,
                        "type": "voice",
                        "description": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy.",
                        "languages": [
                            {
                                "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                                "name": "Urdu",
                                "code": "ur",
                                "note": "Translation services provided via bilingual staff when they are available"
                            }
                        ]
                    }
                ]
            }
        ],
        "accessibility": [
            {
                "id": "afcf296e-1cb2-4139-9c88-33d587d1a50b",
                "description": "The building is equipped with induction loops for hearing aids. Wheelchair access is possible on all levels.",
                "details": "Switch hearing aid to T-coil to access the induction loop facility.",
                "url": "http://example.com"
            }
        ],
        "phones": [
            {
                "id": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
                "number": "\"+44 1234 234567\"",
                "extension": 100,
                "type": "voice",
                "description": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy.",
                "languages": [
                    {
                        "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                        "name": "Urdu",
                        "code": "ur",
                        "note": "Translation services provided via bilingual staff when they are available"
                    }
                ]
            }
        ],
        "schedules": [
            {
                "id": "48102e86-bb50-41c4-8f1e-e269368c41d1",
                "valid_from": "2005-01-01",
                "valid_to": "2005-01-01",
                "dtstart": "2005-01-01",
                "timezone": 3,
                "until": "2005-01-01",
                "count": 3,
                "wkst": "TU",
                "freq": "WEEKLY",
                "interval": 1,
                "byday": "TH,FR",
                "byweekno": "41,42",
                "bymonthday": "2,3,4",
                "byyearday": "2,3,4",
                "description": "The service is available from 10 am to 6pm weekdays. The service is not available on public holidays.",
                "opens_at": "10:00",
                "closes_at": "18:00",
                "schedule_link": "http://example.com",
                "attending_type": "You can attend this service in-person or remotely via video conferencing",
                "notes": "Some of our staff will be unavailable during their lunch break which may be any 30 minute period between 1200 and 1400"
            }
        ]
    }
]

language

language is defined as:

The languages that are spoken at locations or services. This does not include languages which can only be used with interpretation.

Each language object has the following fields:

Fields

Title	Description	Type	Format	Required
id		string	uuid	Required
Identifier	The identifier for the language. Each entry must have a unique identifier.
service_id		string	uuid
Service Identifier	The identifier of the service for which the entry describes the languages in which services are delivered.
location_id		string	uuid
Location Identifier	The identifier of the location for which the entry describes the languages in which services are delivered.
phone_id		string	uuid
Phone Identifier	The identifier of the phone for which the entry describes the languages in which services delivered.
name		string
Name	The name of the language in which the service is delivered.
code		string
Code	The ISO 639-1 or ISO 639-3 code for the language.
note		string
Note	A free text description of any additional context or services provided for this language.
attributes		array[object]
Attributes	A link between a service and one or more classifications that describe the nature of the service provided. See attribute
metadata		array[object]
Metadata	A record of the changes that have been made to the data in order to maintain provenance information. See metadata

Schema

{
    "name": "language",
    "path": "languages.csv",
    "description": "The languages that are spoken at locations or services. This does not include languages which can only be used with interpretation.",
    "datapackage_metadata": {
        "format": "csv",
        "mediatype": "text/csv",
        "profile": "tabular-data-resource",
        "order": 14
    },
    "type": "object",
    "properties": {
        "id": {
            "name": "id",
            "type": "string",
            "title": "Identifier",
            "description": "The identifier for the language. Each entry must have a unique identifier.",
            "format": "uuid",
            "constraints": {
                "unique": true
            },
            "example": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
            "core": "Y"
        },
        "service_id": {
            "name": "service_id",
            "type": "string",
            "title": "Service Identifier",
            "description": "The identifier of the service for which the entry describes the languages in which services are delivered.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "500ff16a-71c4-4e0e-9263-0bb8bbc9f4e5",
            "core": "Y"
        },
        "location_id": {
            "name": "location_id",
            "type": "string",
            "title": "Location Identifier",
            "description": "The identifier of the location for which the entry describes the languages in which services are delivered.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "2fcda859-99ad-4a9e-b912-7baf5e064df1"
        },
        "phone_id": {
            "name": "phone_id",
            "type": "string",
            "title": "Phone Identifier",
            "format": "uuid",
            "description": "The identifier of the phone for which the entry describes the languages in which services delivered.",
            "constraints": {
                "unique": false
            },
            "example": "df2d6c2f-89e7-4cae-aace-a23a0264d7e5"
        },
        "name": {
            "name": "name",
            "type": "string",
            "title": "Name",
            "description": "The name of the language in which the service is delivered.",
            "constraints": {
                "unique": false
            },
            "example": "Urdu",
            "core": "Y"
        },
        "code": {
            "name": "code",
            "type": "string",
            "title": "Code",
            "description": "The ISO 639-1 or ISO 639-3 code for the language.",
            "constraints": {
                "unique": false
            },
            "example": "ur"
        },
        "note": {
            "name": "note",
            "type": "string",
            "title": "Note",
            "description": "A free text description of any additional context or services provided for this language.",
            "constraints": {
                "unique": false
            },
            "example": "Translation services provided via bilingual staff when they are available"
        },
        "attributes": {
            "name": "attributes",
            "type": "array",
            "title": "Attributes",
            "description": "A link between a service and one or more classifications that describe the nature of the service provided.",
            "items": {
                "$ref": "attribute.json"
            }
        },
        "metadata": {
            "name": "metadata",
            "type": "array",
            "title": "Metadata",
            "description": "A record of the changes that have been made to the data in order to maintain provenance information.",
            "items": {
                "$ref": "metadata.json"
            }
        }
    },
    "required": [
        "id"
    ]
}

Example

[
    {
        "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
        "name": "Urdu",
        "code": "ur",
        "note": "Translation services provided via bilingual staff when they are available"
    }
]

organization

organization is defined as:

The details about each organization delivering services. Each service should be linked to the organization responsible for its delivery. One organization may deliver many services.

Each organization object has the following fields:

Fields

Title	Description	Type	Format	Required
id		string	uuid	Required
Identifier	The identifier for the organization. Each organization must have a unique identifier.
name		string		Required
Name	The official or public name of the organization.
alternate_name		string
Alternate Name	An (optional) alternative or commonly used name for the organization.
description		string		Required
Description	A free text description containing a brief summary about the organization. It can contain markup such as HTML or Markdown.
email		string	email
Email	The contact e-mail address for the organization.
website		string	uri
Website	The URL (website address) of the organization.
tax_status		string
Tax Status	DEPRECATED: Government assigned tax designation for tax-exempt organizations.
tax_id		string
Tax Identifier	DEPRECATED: A government issued identifier used for the purpose of tax administration.
year_incorporated		number
Year Incorporated	The year in which the organization was legally formed.
legal_status		string
Legal Status	The legal conditions that an organization is operating under.
logo		string
Logo	A URL to an image associated with the organization which can be presented alongside its name.
uri		string	uri
URI	A persistent identifier to uniquely identify the organization such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the website field of the Organization.
parent_organization_id		string	uuid
Parent Organization Identifier	The identifier of the organization’s parent organization.
funding		array[object]
Funding	The sources of funding for a service or organization. See funding
contacts		array[object]
Contacts	The details of the named contacts for services and organizations. See contact
phones		array[object]
Phones	The details of the telephone numbers are used to contact organizations, services, and locations. See phone
locations		array[object]
Locations	The details of the locations where organizations operate. Locations may be virtual, and one organization may have many locations. See location
programs		array[object]
Programs	The details of collection of related services. See program
organization_identifiers		array[object]
Organization Identifiers	The details of the third party identifiers for organizations, such as: company registration number, charity number, tax registration number. See organization_identifier
attributes		array[object]
Attributes	A link between a service and one or more classifications that describe the nature of the service provided. See attribute
metadata		array[object]
Metadata	A record of the changes that have been made to the data in order to maintain provenance information. See metadata

Schema

{
    "name": "organization",
    "path": "organizations.csv",
    "description": "The details about each organization delivering services. Each service should be linked to the organization responsible for its delivery. One organization may deliver many services.",
    "datapackage_metadata": {
        "format": "csv",
        "mediatype": "text/csv",
        "profile": "tabular-data-resource",
        "order": 1
    },
    "type": "object",
    "properties": {
        "id": {
            "name": "id",
            "type": "string",
            "title": "Identifier",
            "description": "The identifier for the organization. Each organization must have a unique identifier.",
            "format": "uuid",
            "constraints": {
                "unique": true
            },
            "example": "d9d5e0f5-d3ce-4f73-9a2f-4dd0ecc6c610",
            "core": "Y"
        },
        "name": {
            "name": "name",
            "type": "string",
            "title": "Name",
            "description": "The official or public name of the organization.",
            "constraints": {
                "unique": false
            },
            "example": "Example Organization Inc.",
            "core": "Y"
        },
        "alternate_name": {
            "name": "alternate_name",
            "type": "string",
            "title": "Alternate Name",
            "description": "An (optional) alternative or commonly used name for the organization.",
            "constraints": {
                "unique": false
            },
            "example": "Example Org",
            "core": "Y"
        },
        "description": {
            "name": "description",
            "type": "string",
            "title": "Description",
            "description": "A free text description containing a brief summary about the organization. It can contain markup such as HTML or Markdown.",
            "constraints": {
                "unique": false
            },
            "example": "Example Org is a non-profit organization dedicated to providing services to qualified beneficiaries",
            "core": "Y"
        },
        "email": {
            "name": "email",
            "type": "string",
            "title": "Email",
            "description": "The contact e-mail address for the organization.",
            "format": "email",
            "constraints": {
                "unique": false
            },
            "example": "[email protected]",
            "core": "Y"
        },
        "website": {
            "name": "website",
            "type": "string",
            "title": "Website",
            "description": "The URL (website address) of the organization.",
            "format": "uri",
            "constraints": {
                "unique": false
            },
            "example": "http://example.com",
            "core": "Y"
        },
        "tax_status": {
            "name": "tax_status",
            "type": "string",
            "title": "Tax Status",
            "description": "DEPRECATED: Government assigned tax designation for tax-exempt organizations.",
            "constraints": {
                "unique": false
            },
            "example": "tax_status"
        },
        "tax_id": {
            "name": "tax_id",
            "type": "string",
            "title": "Tax Identifier",
            "description": "DEPRECATED: A government issued identifier used for the purpose of tax administration.",
            "constraints": {
                "unique": false
            },
            "example": "tax_id"
        },
        "year_incorporated": {
            "name": "year_incorporated",
            "type": "number",
            "title": "Year Incorporated",
            "description": "The year in which the organization was legally formed.",
            "constraints": {
                "unique": false
            },
            "example": "2011"
        },
        "legal_status": {
            "name": "legal_status",
            "type": "string",
            "title": "Legal Status",
            "description": "The legal conditions that an organization is operating under.",
            "constraints": {
                "unique": false
            },
            "example": "Limited Company"
        },
        "logo": {
            "name": "logo",
            "type": "string",
            "title": "Logo",
            "description": "A URL to an image associated with the organization which can be presented alongside its name.",
            "constraints": {
                "unique": false
            },
            "example": "https://openreferral.org/wp-content/uploads/2018/02/OpenReferral_Logo_Green-4-1.png"
        },
        "uri": {
            "name": "uri",
            "type": "string",
            "title": "URI",
            "description": "A persistent identifier to uniquely identify the organization such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the website field of the Organization.",
            "format": "uri",
            "constraints": {
                "unique": false
            },
            "example": "http://example.com"
        },
        "parent_organization_id": {
            "name": "parent_organization_id",
            "type": "string",
            "title": "Parent Organization Identifier",
            "description": "The identifier of the organization's parent organization.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "cd09a387-91f4-4555-94ec-e799c35344cd"
        },
        "funding": {
            "name": "funding",
            "type": "array",
            "title": "Funding",
            "description": "The sources of funding for a service or organization.",
            "items": {
                "$ref": "funding.json"
            }
        },
        "contacts": {
            "name": "contacts",
            "type": "array",
            "title": "Contacts",
            "description": "The details of the named contacts for services and organizations.",
            "items": {
                "$ref": "contact.json"
            }
        },
        "phones": {
            "name": "phones",
            "type": "array",
            "title": "Phones",
            "description": "The details of the telephone numbers are used to contact organizations, services, and locations.",
            "items": {
                "$ref": "phone.json"
            }
        },
        "locations": {
            "name": "locations",
            "type": "array",
            "title": "Locations",
            "description": "The details of the locations where organizations operate. Locations may be virtual, and one organization may have many locations.",
            "items": {
                "$ref": "location.json"
            }
        },
        "programs": {
            "name": "programs",
            "type": "array",
            "title": "Programs",
            "description": "The details of collection of related services.",
            "items": {
                "$ref": "program.json"
            }
        },
        "organization_identifiers": {
            "name": "organization_identifiers",
            "type": "array",
            "title": "Organization Identifiers",
            "description": "The details of the third party identifiers for organizations, such as: company registration number, charity number, tax registration number.",
            "items": {
                "$ref": "organization_identifier.json"
            }
        },
        "attributes": {
            "name": "attributes",
            "type": "array",
            "title": "Attributes",
            "description": "A link between a service and one or more classifications that describe the nature of the service provided.",
            "items": {
                "$ref": "attribute.json"
            }
        },
        "metadata": {
            "name": "metadata",
            "type": "array",
            "title": "Metadata",
            "description": "A record of the changes that have been made to the data in order to maintain provenance information.",
            "items": {
                "$ref": "metadata.json"
            }
        }
    },
    "required": [
        "id",
        "name",
        "description"
    ]
}

Example

{
    "id": "d9d5e0f5-d3ce-4f73-9a2f-4dd0ecc6c610",
    "name": "Example Organization Inc.",
    "alternate_name": "Example Org",
    "description": "Example Org is a non-profit organization dedicated to providing services to qualified beneficiaries",
    "email": "[email protected]",
    "website": "http://example.com",
    "tax_status": "tax_status",
    "year_incorporated": 2011,
    "legal_status": "Limited Company",
    "logo": "https://openreferral.org/wp-content/uploads/2018/02/OpenReferral_Logo_Green-4-1.png",
    "uri": "http://example.com",
    "parent_organization_id": "cd09a387-91f4-4555-94ec-e799c35344cd",
    "funding": [
        {
            "id": "1f2df32c-bf08-4b8e-bd6f-e834014b19bc",
            "source": "This service is funded partially by the MyCity local government and via grants made by charity funding bodies. We also operate a for-profit department which is used to partially cover the expense of the public service"
        }
    ],
    "contacts": [
        {
            "id": "1e7efce3-639b-4880-940c-b95cd30cdb50",
            "name": "Ann Persona",
            "title": "Reception Manager",
            "department": "Reception",
            "email": "[email protected]",
            "phones": [
                {
                    "id": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
                    "number": "\"+44 1234 234567\"",
                    "extension": 100,
                    "type": "voice",
                    "description": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy.",
                    "languages": [
                        {
                            "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                            "name": "Urdu",
                            "code": "ur",
                            "note": "Translation services provided via bilingual staff when they are available"
                        }
                    ]
                }
            ]
        }
    ],
    "phones": [
        {
            "id": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
            "number": "\"+44 1234 234567\"",
            "extension": 100,
            "type": "voice",
            "description": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy.",
            "languages": [
                {
                    "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                    "name": "Urdu",
                    "code": "ur",
                    "note": "Translation services provided via bilingual staff when they are available"
                }
            ]
        }
    ],
    "locations": [
        {
            "id": "3a19ff88-4620-4d17-9830-ac1d859eb5d5",
            "location_type": "physical",
            "url": "http://example.com",
            "name": "MyCity Civic Center",
            "alternate_name": "Civic Center",
            "description": "MyCity Civic Center is located on Main Street and contains facilities for a number of civic and community services available.",
            "transportation": "MyCity Civic Center is serviced by the number 1 Bus and is a short walk from the Main Street Metro Station",
            "latitude": 100,
            "longitude": 101,
            "external_identifier": "///cheer.parent.mole",
            "external_identifier_type": "what3words",
            "languages": [
                {
                    "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                    "name": "Urdu",
                    "code": "ur",
                    "note": "Translation services provided via bilingual staff when they are available"
                }
            ],
            "addresses": [
                {
                    "id": "74706e55-df26-4b84-80fe-ecc30b5befb4",
                    "attention": "A. Persona",
                    "address_1": "1-30 Main Street",
                    "address_2": "MyVillage",
                    "city": "MyCity",
                    "region": "MyRegion",
                    "state_province": "MyState",
                    "postal_code": "ABC 1234",
                    "country": "US",
                    "address_type": "postal"
                }
            ],
            "contacts": [
                {
                    "id": "1e7efce3-639b-4880-940c-b95cd30cdb50",
                    "name": "Ann Persona",
                    "title": "Reception Manager",
                    "department": "Reception",
                    "email": "[email protected]",
                    "phones": [
                        {
                            "id": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
                            "number": "\"+44 1234 234567\"",
                            "extension": 100,
                            "type": "voice",
                            "description": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy.",
                            "languages": [
                                {
                                    "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                                    "name": "Urdu",
                                    "code": "ur",
                                    "note": "Translation services provided via bilingual staff when they are available"
                                }
                            ]
                        }
                    ]
                }
            ],
            "accessibility": [
                {
                    "id": "afcf296e-1cb2-4139-9c88-33d587d1a50b",
                    "description": "The building is equipped with induction loops for hearing aids. Wheelchair access is possible on all levels.",
                    "details": "Switch hearing aid to T-coil to access the induction loop facility.",
                    "url": "http://example.com"
                }
            ],
            "phones": [
                {
                    "id": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
                    "number": "\"+44 1234 234567\"",
                    "extension": 100,
                    "type": "voice",
                    "description": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy.",
                    "languages": [
                        {
                            "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                            "name": "Urdu",
                            "code": "ur",
                            "note": "Translation services provided via bilingual staff when they are available"
                        }
                    ]
                }
            ],
            "schedules": [
                {
                    "id": "48102e86-bb50-41c4-8f1e-e269368c41d1",
                    "valid_from": "2005-01-01",
                    "valid_to": "2005-01-01",
                    "dtstart": "2005-01-01",
                    "timezone": 3,
                    "until": "2005-01-01",
                    "count": 3,
                    "wkst": "TU",
                    "freq": "WEEKLY",
                    "interval": 1,
                    "byday": "TH,FR",
                    "byweekno": "41,42",
                    "bymonthday": "2,3,4",
                    "byyearday": "2,3,4",
                    "description": "The service is available from 10 am to 6pm weekdays. The service is not available on public holidays.",
                    "opens_at": "10:00",
                    "closes_at": "18:00",
                    "schedule_link": "http://example.com",
                    "attending_type": "You can attend this service in-person or remotely via video conferencing",
                    "notes": "Some of our staff will be unavailable during their lunch break which may be any 30 minute period between 1200 and 1400"
                }
            ]
        }
    ],
    "programs": [
        {
            "id": "e7ec2e57-4540-43fa-b2c7-6be5a0ef7f42",
            "name": "Community Mental Health Support",
            "alternate_name": "MyCity Mental Health Group",
            "description": "Comprehensive Mental Health Services available to residents of MyCity including CBT and Counselling. This is not an emergency service and should not be used as an alternative to hospital and GP services."
        }
    ],
    "organization_identifiers": [
        {
            "id": "d4dbcebc-0802-47cb-8651-b937ac4f2f3e",
            "identifier_scheme": "GB-COH",
            "identifier_type": "Company number",
            "identifier": 1234567
        }
    ]
}

funding

funding is defined as:

The sources of funding for a service or organization.

Each funding object has the following fields:

Fields

Title	Description	Type	Format	Required
id		string	uuid	Required
Identifier	The identifier for the funding. Each entry must have a unique identifier.
organization_id		string	uuid
Organization Identifier	The identifier of the organization in receipt of this funding.
service_id		string	uuid
Service Identifier	The identifier of the service in receipt of this funding.
source		string
Source	A free text description of the source of funds for this organization or service.
attributes		array[object]
Attributes	A link between a service and one or more classifications that describe the nature of the service provided. See attribute
metadata		array[object]
Metadata	A record of the changes that have been made to the data in order to maintain provenance information. See metadata

Schema

{
    "name": "funding",
    "path": "funding.csv",
    "description": "The sources of funding for a service or organization.",
    "datapackage_metadata": {
        "format": "csv",
        "mediatype": "text/csv",
        "profile": "tabular-data-resource",
        "order": 11
    },
    "type": "object",
    "properties": {
        "id": {
            "name": "id",
            "type": "string",
            "title": "Identifier",
            "description": "The identifier for the funding. Each entry must have a unique identifier.",
            "format": "uuid",
            "constraints": {
                "unique": true
            },
            "example": "1f2df32c-bf08-4b8e-bd6f-e834014b19bc"
        },
        "organization_id": {
            "name": "organization_id",
            "type": "string",
            "title": "Organization Identifier",
            "description": "The identifier of the organization in receipt of this funding.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "545c684b-4a24-4923-b7c9-6e10fcf8a5a3"
        },
        "service_id": {
            "name": "service_id",
            "type": "string",
            "title": "Service Identifier",
            "format": "uuid",
            "description": "The identifier of the service in receipt of this funding.",
            "constraints": {
                "unique": false
            },
            "example": "d20cedb8-b597-41cb-86b0-7034fb50c7a9"
        },
        "source": {
            "name": "source",
            "type": "string",
            "title": "Source",
            "description": "A free text description of the source of funds for this organization or service.",
            "constraints": {
                "unique": false
            },
            "example": "This service is funded partially by the MyCity local government and via grants made by charity funding bodies. We also operate a for-profit department which is used to partially cover the expense of the public service"
        },
        "attributes": {
            "name": "attributes",
            "type": "array",
            "title": "Attributes",
            "description": "A link between a service and one or more classifications that describe the nature of the service provided.",
            "items": {
                "$ref": "attribute.json"
            }
        },
        "metadata": {
            "name": "metadata",
            "type": "array",
            "title": "Metadata",
            "description": "A record of the changes that have been made to the data in order to maintain provenance information.",
            "items": {
                "$ref": "metadata.json"
            }
        }
    },
    "required": [
        "id"
    ]
}

Example

[
    {
        "id": "1f2df32c-bf08-4b8e-bd6f-e834014b19bc",
        "source": "This service is funded partially by the MyCity local government and via grants made by charity funding bodies. We also operate a for-profit department which is used to partially cover the expense of the public service"
    }
]

cost_option

cost_option is defined as:

The costs of a service at certain points in time. This is an LGA Extension. This object provides a structured version of the text information contained in the ‘fees’ field of the ‘service’ object.

Each cost_option object has the following fields:

Fields

Title	Description	Type	Format	Required
id		string	uuid	Required
Identifier	The identifier for the cost option. Each entry must have a unique identifier
service_id		string	uuid
Service Identifier	The identifier of the services for which the entry describes the cost.
valid_from		string
Valid From	The date when this price is valid from.
valid_to		string
Valid To	The date when this price is valid to.
option		string
Option	Conditions associated with the cost option.
currency		string
Currency	The 3 letter currency code of this cost option (expected to be gbp by Open Referral UK).
amount		number
Amount	The cost of the option, expressed as an amount.
amount_description		string
Amount Description	Specific details qualifying the cost amount.
attributes		array[object]
Attributes	A link between a service and one or more classifications that describe the nature of the service provided. See attribute
metadata		array[object]
Metadata	A record of the changes that have been made to the data in order to maintain provenance information. See metadata

Schema

{
    "name": "cost_option",
    "path": "cost_options.csv",
    "description": "The costs of a service at certain points in time. This is an LGA Extension. This object provides a structured version of the text information contained in the 'fees' field of the 'service' object.",
    "datapackage_metadata": {
        "format": "csv",
        "mediatype": "text/csv",
        "profile": "tabular-data-resource",
        "order": 19
    },
    "type": "object",
    "properties": {
        "id": {
            "name": "id",
            "type": "string",
            "title": "Identifier",
            "description": "The identifier for the cost option. Each entry must have a unique identifier",
            "format": "uuid",
            "constraints": {
                "unique": true
            },
            "example": "1fdf4d39-3d80-484d-9f92-a8ffa08621e7"
        },
        "service_id": {
            "name": "service_id",
            "type": "string",
            "title": "Service Identifier",
            "description": "The identifier of the services for which the entry describes the cost.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "a67ed14f-696d-45f1-8eaf-46b7f972425e"
        },
        "valid_from": {
            "name": "valid_from",
            "type": "string",
            "title": "Valid From",
            "description": "The date when this price is valid from.",
            "constraints": {
                "unique": false
            },
            "example": "2020-01-01",
            "datapackage_type": "date"
        },
        "valid_to": {
            "name": "valid_to",
            "type": "string",
            "title": "Valid To",
            "description": "The date when this price is valid to.",
            "constraints": {
                "unique": false
            },
            "example": "2022-12-31",
            "datapackage_type": "date"
        },
        "option": {
            "name": "option",
            "type": "string",
            "title": "Option",
            "description": "Conditions associated with the cost option.",
            "constraints": {
                "unique": false
            },
            "example": "Under 18s and Over 60s"
        },
        "currency": {
            "name": "currency",
            "type": "string",
            "title": "Currency",
            "description": "The 3 letter currency code of this cost option (expected to be gbp by Open Referral UK).",
            "constraints": {
                "unique": false
            },
            "example": "gbp"
        },
        "amount": {
            "name": "amount",
            "type": "number",
            "title": "Amount",
            "description": "The cost of the option, expressed as an amount.",
            "constraints": {
                "unique": false
            },
            "example": "35"
        },
        "amount_description": {
            "name": "amount_description",
            "type": "string",
            "title": "Amount Description",
            "description": "Specific details qualifying the cost amount.",
            "constraints": {
                "unique": false
            },
            "example": "per 1 hour session"
        },
        "attributes": {
            "name": "attributes",
            "type": "array",
            "title": "Attributes",
            "description": "A link between a service and one or more classifications that describe the nature of the service provided.",
            "items": {
                "$ref": "attribute.json"
            }
        },
        "metadata": {
            "name": "metadata",
            "type": "array",
            "title": "Metadata",
            "description": "A record of the changes that have been made to the data in order to maintain provenance information.",
            "items": {
                "$ref": "metadata.json"
            }
        }
    },
    "required": [
        "id"
    ],
    "tabular_required": [
        "service_id"
    ]
}

Example

[
    {
        "id": "1fdf4d39-3d80-484d-9f92-a8ffa08621e7",
        "valid_from": "2020-01-01",
        "valid_to": "2022-12-31",
        "option": "Under 18s and Over 60s",
        "currency": "gbp",
        "amount": 35,
        "amount_description": "per 1 hour session"
    }
]

program

program is defined as:

The details of collections of related services.

Each program object has the following fields:

Fields

Title	Description	Type	Format	Required
id		string	uuid	Required
Identifier	The identifier for the program. Each program must have a unique identifier.
organization_id		string	uuid
Organization Identifier	The identifier for the organization which the program belongs to. Each program must belong to a single organization, and the identifier for that organization should be given here.
name		string		Required
Name	The name of the program.
alternate_name		string
Alternate Name	The (optional) alternative name for the program.
description		string		Required
Description	A free text description of the program
attributes		array[object]
Attributes	A link between a service and one or more classifications that describe the nature of the service provided. See attribute
metadata		array[object]
Metadata	A record of the changes that have been made to the data in order to maintain provenance information. See metadata

Schema

{
    "name": "program",
    "path": "programs.csv",
    "description": "The details of collections of related services.",
    "datapackage_metadata": {
        "format": "csv",
        "mediatype": "text/csv",
        "profile": "tabular-data-resource",
        "order": 2
    },
    "type": "object",
    "properties": {
        "id": {
            "name": "id",
            "type": "string",
            "title": "Identifier",
            "description": "The identifier for the program. Each program must have a unique identifier.",
            "format": "uuid",
            "constraints": {
                "unique": true
            },
            "example": "e7ec2e57-4540-43fa-b2c7-6be5a0ef7f42"
        },
        "organization_id": {
            "name": "organization_id",
            "type": "string",
            "title": "Organization Identifier",
            "description": "The identifier for the organization which the program belongs to. Each program must belong to a single organization, and the identifier for that organization should be given here.",
            "format": "uuid",
            "constraints": {
                "unique": true
            },
            "example": "5978833f-21aa-4235-a56b-7d2f94ce8f35"
        },
        "name": {
            "name": "name",
            "type": "string",
            "title": "Name",
            "description": "The name of the program.",
            "constraints": {
                "unique": false
            },
            "example": "Community Mental Health Support"
        },
        "alternate_name": {
            "name": "alternate_name",
            "type": "string",
            "title": "Alternate Name",
            "description": "The (optional) alternative name for the program.",
            "constraints": {
                "unique": false
            },
            "example": "MyCity Mental Health Group"
        },
        "description": {
            "name": "description",
            "type": "string",
            "title": "Description",
            "description": "A free text description of the program",
            "constraints": {
                "unique": false
            },
            "example": "Comprehensive Mental Health Services available to residents of MyCity including CBT and Counselling. This is not an emergency service and should not be used as an alternative to hospital and GP services."
        },
        "attributes": {
            "name": "attributes",
            "type": "array",
            "title": "Attributes",
            "description": "A link between a service and one or more classifications that describe the nature of the service provided.",
            "items": {
                "$ref": "attribute.json"
            }
        },
        "metadata": {
            "name": "metadata",
            "type": "array",
            "title": "Metadata",
            "description": "A record of the changes that have been made to the data in order to maintain provenance information.",
            "items": {
                "$ref": "metadata.json"
            }
        }
    },
    "required": [
        "id",
        "name",
        "description"
    ],
    "tabular_required": [
        "organization_id"
    ]
}

Example

{
    "id": "e7ec2e57-4540-43fa-b2c7-6be5a0ef7f42",
    "name": "Community Mental Health Support",
    "alternate_name": "MyCity Mental Health Group",
    "description": "Comprehensive Mental Health Services available to residents of MyCity including CBT and Counselling. This is not an emergency service and should not be used as an alternative to hospital and GP services."
}

required_document

required_document is defined as:

The details of any documents that are required in order to access or use services.

Each required_document object has the following fields:

Fields

Title	Description	Type	Format	Required
id		string	uuid	Required
Identifier	The identifier for the document. Each document must have a unique identifier.
service_id		string	uuid
Service Identifier	The identifier of the service for which this entry describes the required document.
document		string
Document	A free text description of the document required to apply for or receive the service.
uri		string	uri
URI	A web link to the document.
attributes		array[object]
Attributes	A link between a service and one or more classifications that describe the nature of the service provided. See attribute
metadata		array[object]
Metadata	A record of the changes that have been made to the data in order to maintain provenance information. See metadata

Schema

{
    "name": "required_document",
    "path": "required_documents.csv",
    "description": "The details of any documents that are required in order to access or use services.",
    "datapackage_metadata": {
        "format": "csv",
        "mediatype": "text/csv",
        "profile": "tabular-data-resource",
        "order": 13
    },
    "type": "object",
    "properties": {
        "id": {
            "name": "id",
            "type": "string",
            "title": "Identifier",
            "description": "The identifier for the document. Each document must have a unique identifier.",
            "format": "uuid",
            "constraints": {
                "unique": true
            },
            "example": "f6ad7e69-b9c8-42ce-92db-92cedb4c05c0"
        },
        "service_id": {
            "name": "service_id",
            "type": "string",
            "title": "Service Identifier",
            "description": "The identifier of the service for which this entry describes the required document.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "bb0128fb-eeec-4179-a606-a8fb06648994"
        },
        "document": {
            "name": "document",
            "type": "string",
            "title": "Document",
            "description": "A free text description of the document required to apply for or receive the service.",
            "constraints": {
                "unique": false
            },
            "example": "Any official identification document (Passport, Driver's Licence, identity card) and evidence of address such as an official letter from local or national government. A driver's license which shows your name, photograph, and address can be used as a sole identification document."
        },
        "uri": {
            "name": "uri",
            "type": "string",
            "title": "URI",
            "description": "A web link to the document.",
            "format": "uri",
            "constraints": {
                "unique": false
            },
            "example": "http://example.com"
        },
        "attributes": {
            "name": "attributes",
            "type": "array",
            "title": "Attributes",
            "description": "A link between a service and one or more classifications that describe the nature of the service provided.",
            "items": {
                "$ref": "attribute.json"
            }
        },
        "metadata": {
            "name": "metadata",
            "type": "array",
            "title": "Metadata",
            "description": "A record of the changes that have been made to the data in order to maintain provenance information.",
            "items": {
                "$ref": "metadata.json"
            }
        }
    },
    "required": [
        "id"
    ]
}

Example

[
    {
        "id": "f6ad7e69-b9c8-42ce-92db-92cedb4c05c0",
        "document": "Any official identification document (Passport, Driver's Licence, identity card) and evidence of address such as an official letter from local or national government. A driver's license which shows your name, photograph, and address can be used as a sole identification document.",
        "uri": "http://example.com"
    }
]

contact

contact is defined as:

The details of the named contacts for services and organizations.

Each contact object has the following fields:

Fields

Title	Description	Type	Format	Required
id		string	uuid	Required
Identifier	The identifier for the contact. Each contact must have a unique identifier.
organization_id		string	uuid
Organization Identifier	The identifier of the organization for which this is a contact.
service_id		string	uuid
Service Identifier	The identifier of the service for which this is a contact.
service_at_location_id		string	uuid
Service At Location Identifier	The identifier of the ‘service at location’ entry, when this contact is specific to a service in a particular location.
location_id		string	uuid
Location Identifier	The identifier for the location of the contact.
name		string
Name	The name of the contact.
title		string
Title	The job title of the contact.
department		string
Department	The department that the contact is a part of.
email		string	email
Email	The email address of the contact.
phones		array[object]
Phones	The details of the telephone numbers used to contact organizations, services, and locations. See phone
attributes		array[object]
Attributes	A link between a service and one or more classifications that describe the nature of the service provided. See attribute
metadata		array[object]
Metadata	A record of the changes that have been made to the data in order to maintain provenance information. See metadata

Schema

{
    "name": "contact",
    "path": "contacts.csv",
    "description": "The details of the named contacts for services and organizations.",
    "datapackage_metadata": {
        "format": "csv",
        "mediatype": "text/csv",
        "profile": "tabular-data-resource",
        "order": 8
    },
    "type": "object",
    "properties": {
        "id": {
            "name": "id",
            "type": "string",
            "title": "Identifier",
            "description": "The identifier for the contact. Each contact must have a unique identifier.",
            "format": "uuid",
            "constraints": {
                "unique": true
            },
            "example": "1e7efce3-639b-4880-940c-b95cd30cdb50",
            "core": "Y"
        },
        "organization_id": {
            "name": "organization_id",
            "type": "string",
            "title": "Organization Identifier",
            "description": "The identifier of the organization for which this is a contact.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "ae67a707-5893-4225-b0b1-320ab9cb596b"
        },
        "service_id": {
            "name": "service_id",
            "type": "string",
            "title": "Service Identifier",
            "description": "The identifier of the service for which this is a contact.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "46f31178-dbb7-45e4-be37-c69320e08c36",
            "core": "Y"
        },
        "service_at_location_id": {
            "name": "service_at_location_id",
            "type": "string",
            "title": "Service At Location Identifier",
            "format": "uuid",
            "description": "The identifier of the \u2018service at location\u2019 entry, when this contact is specific to a service in a particular location.",
            "constraints": {
                "unique": false
            },
            "example": "93eaf18d-1cd2-4ec7-bffb-3c9172ee5070"
        },
        "location_id": {
            "name": "location_id",
            "type": "string",
            "title": "Location Identifier",
            "format": "uuid",
            "description": "The identifier for the location of the contact.",
            "constraints": {
                "unique": false
            },
            "example": "2226a1e5-7ff1-4c46-a5fb-955304b05917"
        },
        "name": {
            "name": "name",
            "type": "string",
            "title": "Name",
            "description": "The name of the contact.",
            "constraints": {
                "unique": false
            },
            "example": "Ann Persona",
            "core": "Y"
        },
        "title": {
            "name": "title",
            "type": "string",
            "title": "Title",
            "description": "The job title of the contact.",
            "constraints": {
                "unique": false
            },
            "example": "Reception Manager",
            "core": "Y"
        },
        "department": {
            "name": "department",
            "type": "string",
            "title": "Department",
            "description": "The department that the contact is a part of.",
            "constraints": {
                "unique": false
            },
            "example": "Reception"
        },
        "email": {
            "name": "email",
            "type": "string",
            "title": "Email",
            "description": "The email address of the contact.",
            "format": "email",
            "constraints": {
                "unique": false
            },
            "example": "[email protected]"
        },
        "phones": {
            "name": "phones",
            "type": "array",
            "title": "Phones",
            "description": "The details of the telephone numbers used to contact organizations, services, and locations.",
            "items": {
                "$ref": "phone.json"
            }
        },
        "attributes": {
            "name": "attributes",
            "type": "array",
            "title": "Attributes",
            "description": "A link between a service and one or more classifications that describe the nature of the service provided.",
            "items": {
                "$ref": "attribute.json"
            }
        },
        "metadata": {
            "name": "metadata",
            "type": "array",
            "title": "Metadata",
            "description": "A record of the changes that have been made to the data in order to maintain provenance information.",
            "items": {
                "$ref": "metadata.json"
            }
        }
    },
    "required": [
        "id"
    ]
}

Example

[
    {
        "id": "1e7efce3-639b-4880-940c-b95cd30cdb50",
        "name": "Ann Persona",
        "title": "Reception Manager",
        "department": "Reception",
        "email": "[email protected]",
        "phones": [
            {
                "id": "1554f2e2-a373-45db-a3fa-9fc48a61c15e",
                "number": "\"+44 1234 234567\"",
                "extension": 100,
                "type": "voice",
                "description": "Our main reception phone number. The phones will be available from 0800 (8am) until 1800 (6pm) local time. There may be some slight delays in answering your call if we are busy.",
                "languages": [
                    {
                        "id": "2989d3ed-c547-48f8-8f9d-432d81c7892e",
                        "name": "Urdu",
                        "code": "ur",
                        "note": "Translation services provided via bilingual staff when they are available"
                    }
                ]
            }
        ]
    }
]

organization_identifier

organization_identifier is defined as:

The details of the third party identifiers for organizations, such as: company registration number, charity number, tax registration number.

Each organization_identifier object has the following fields:

Fields

Title	Description	Type	Format	Required
id		string	uuid	Required
Identifier	The identifier for this organization identifier entry. Each entry must have a unique identifier.
organization_id		string	uuid
Organization Identifier	The identifier of the organization.
identifier_scheme		string
Identifier Scheme	The scheme of the third party identifier, according to http://org-id.guide/.
identifier_type		string		Required
Identifier Type	The type of the third party identifier.
identifier		string		Required
Third Party Identifier	The third-party identifier value
attributes		array[object]
Attributes	A link between a service and one or more classifications that describe the nature of the service provided. See attribute
metadata		array[object]
Metadata	A record of the changes that have been made to the data in order to maintain provenance information. See metadata

Schema

{
    "name": "organization_identifier",
    "path": "organization_identifiers.csv",
    "description": "The details of the third party identifiers for organizations, such as: company registration number, charity number, tax registration number.",
    "datapackage_metadata": {
        "format": "csv",
        "mediatype": "text/csv",
        "profile": "tabular-data-resource",
        "order": 20
    },
    "type": "object",
    "properties": {
        "id": {
            "name": "id",
            "type": "string",
            "title": "Identifier",
            "description": "The identifier for this organization identifier entry. Each entry must have a unique identifier.",
            "format": "uuid",
            "constraints": {
                "unique": true
            },
            "example": "d4dbcebc-0802-47cb-8651-b937ac4f2f3e"
        },
        "organization_id": {
            "name": "organization_id",
            "type": "string",
            "title": "Organization Identifier",
            "description": "The identifier of the organization.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "58341b4f-4f21-47f0-affb-1a2f9162472b"
        },
        "identifier_scheme": {
            "name": "identifier_scheme",
            "type": "string",
            "title": "Identifier Scheme",
            "description": "The scheme of the third party identifier, according to http://org-id.guide/.",
            "constraints": {
                "unique": false
            },
            "example": "GB-COH"
        },
        "identifier_type": {
            "name": "identifier_type",
            "type": "string",
            "title": "Identifier Type",
            "description": "The type of the third party identifier.",
            "constraints": {
                "unique": false
            },
            "example": "Company number"
        },
        "identifier": {
            "name": "identifier",
            "type": "string",
            "title": "Third Party Identifier",
            "description": "The third-party identifier value",
            "constraints": {
                "unique": false
            },
            "example": "1234567"
        },
        "attributes": {
            "name": "attributes",
            "type": "array",
            "title": "Attributes",
            "description": "A link between a service and one or more classifications that describe the nature of the service provided.",
            "items": {
                "$ref": "attribute.json"
            }
        },
        "metadata": {
            "name": "metadata",
            "type": "array",
            "title": "Metadata",
            "description": "A record of the changes that have been made to the data in order to maintain provenance information.",
            "items": {
                "$ref": "metadata.json"
            }
        }
    },
    "required": [
        "id",
        "identifier_type",
        "identifier"
    ],
    "tabular_required": [
        "organization_id"
    ]
}

Example

[
    {
        "id": "d4dbcebc-0802-47cb-8651-b937ac4f2f3e",
        "identifier_scheme": "GB-COH",
        "identifier_type": "Company number",
        "identifier": 1234567
    }
]

attribute

attribute is defined as:

A link between a service and one or more classifications that describe the nature of the service provided.

Each attribute object has the following fields:

Fields

Title	Description	Type	Format	Required
id		string	uuid	Required
Identifier	The identifier of the attribute entry. Each attribute entry should have a unique identifier.
link_id		string	uuid
Link Identifier	The identifier of the entity to which this taxonomy term applies.
link_type		string
Link Type	A code taken from an enumerated open codelist to indicate what the taxonomy term describes, e.g. the service eligibility or intended audience.
link_entity		string
Link Entity	The table of the Link Identifier.
value		string
Value	The value (if any) of an attribute.
taxonomy_term		object
Taxonomy Term	Each service can be categorized according to one or more taxonomy terms. The taxonomy_term object contains a list of taxonomy terms, their names, and, for hierarchical taxonomies, their structure. See taxonomy_term
metadata		array[object]
Metadata	A record of the changes that have been made to the data in order to maintain provenance information. See metadata

Schema

{
    "name": "attribute",
    "path": "attributes.csv",
    "description": "A link between a service and one or more classifications that describe the nature of the service provided.",
    "datapackage_metadata": {
        "format": "csv",
        "mediatype": "text/csv",
        "profile": "tabular-data-resource",
        "order": 4
    },
    "type": "object",
    "properties": {
        "id": {
            "name": "id",
            "type": "string",
            "title": "Identifier",
            "description": "The identifier of the attribute entry. Each attribute entry should have a unique identifier.",
            "format": "uuid",
            "constraints": {
                "unique": true
            },
            "example": "ae58cc39-8b70-4ab1-8aea-786882e5ac8e",
            "core": "Y"
        },
        "link_id": {
            "name": "link_id",
            "type": "string",
            "title": "Link Identifier",
            "description": "The identifier of the entity to which this taxonomy term applies.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "f28dd44b-0c4d-479f-8e90-4c52219a8b3c",
            "core": "Y"
        },
        "taxonomy_term_id": {
            "name": "taxonomy_term_id",
            "type": "string",
            "title": "Taxonomy Term Identifier",
            "description": "The identifier of this taxonomy term from the taxonomy table.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "6bd624ce-8512-497a-bcb2-7ce1a5dc1680",
            "core": "Y"
        },
        "link_type": {
            "name": "link_type",
            "type": "string",
            "title": "Link Type",
            "description": "A code taken from an enumerated open codelist to indicate what the taxonomy term describes, e.g. the service eligibility or intended audience.",
            "constraints": {
                "unique": false
            },
            "example": "link_type",
            "core": "Y"
        },
        "link_entity": {
            "name": "link_entity",
            "type": "string",
            "title": "Link Entity",
            "description": "The table of the Link Identifier.",
            "constraints": {
                "unique": false
            },
            "example": "link_entity",
            "core": "Y"
        },
        "value": {
            "name": "value",
            "type": "string",
            "title": "Value",
            "description": "The value (if any) of an attribute.",
            "constraints": {
                "unique": false
            },
            "example": "value",
            "core": "Y"
        },
        "taxonomy_term": {
            "name": "taxonomy_term",
            "title": "Taxonomy Term",
            "description": "Each service can be categorized according to one or more taxonomy terms. The taxonomy_term object contains a list of taxonomy terms, their names, and, for hierarchical taxonomies, their structure.",
            "$ref": "taxonomy_term.json"
        },
        "metadata": {
            "name": "metadata",
            "type": "array",
            "title": "Metadata",
            "description": "A record of the changes that have been made to the data in order to maintain provenance information.",
            "items": {
                "$ref": "metadata.json"
            }
        }
    },
    "required": [
        "id"
    ],
    "tabular_required": [
        "link_id",
        "taxonomy_term_id",
        "link_entity"
    ]
}

Example

[
    {
        "id": "ae58cc39-8b70-4ab1-8aea-786882e5ac8e",
        "link_type": "link_type",
        "link_entity": "link_entity",
        "value": "value",
        "taxonomy_term": {
            "id": "3f7b145d-84af-42d7-8fae-eaca714b02b2",
            "code": "code",
            "name": "name",
            "description": "description",
            "parent_id": "0bc248fa-dc27-4650-9ba4-8f1a24ef16a2",
            "taxonomy": "taxonomy",
            "taxonomy_detail": {
                "id": "5c4d79d7-cc55-470e-9f1f-8cad074e4892",
                "name": "name",
                "description": "description",
                "uri": "http://example.com",
                "version": "version"
            },
            "language": "eng",
            "term_uri": "http://example.com"
        }
    }
]

metadata

metadata is defined as:

A record of the changes that have been made to the data in order to maintain provenance information.

Each metadata object has the following fields:

Fields

Title	Description	Type	Format	Required
id		string	uuid	Required
Identifier	The identifier for this metadata. Each entry must have a unique identifier.
resource_id		string	uuid
Resource Identifier	The identifier of the resource (service, program, location, address, or contact) that this metadata describes.
resource_type		string
Resource Type	The type of entity being referenced.
last_action_date		string		Required
Last Action Date	The date when data was changed.
last_action_type		string		Required
Last Action Type	The kind of change made to the data.
field_name		string		Required
Field Name	The name of field that has been modified.
previous_value		string		Required
Previous Value	The previous value of the field that has been modified.
replacement_value		string		Required
Replacement Value	The new value of the field that has been modified.
updated_by		string		Required
Updated By	The name of the person who modified the field.

Schema

{
    "name": "metadata",
    "path": "metadata.csv",
    "description": "A record of the changes that have been made to the data in order to maintain provenance information.",
    "datapackage_metadata": {
        "format": "csv",
        "mediatype": "text/csv",
        "profile": "tabular-data-resource",
        "order": 17
    },
    "type": "object",
    "properties": {
        "id": {
            "name": "id",
            "type": "string",
            "title": "Identifier",
            "description": "The identifier for this metadata. Each entry must have a unique identifier.",
            "format": "uuid",
            "constraints": {
                "unique": true
            },
            "example": "6cd71e9f-1013-49d9-8370-26b8f59d3e5a"
        },
        "resource_id": {
            "name": "resource_id",
            "type": "string",
            "title": "Resource Identifier",
            "description": "The identifier of the resource (service, program, location, address, or contact) that this metadata describes.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "38960354-e7d2-4cfa-a368-820f729d6ccf"
        },
        "resource_type": {
            "name": "resource_type",
            "type": "string",
            "title": "Resource Type",
            "description": "The type of entity being referenced.",
            "constraints": {
                "unique": false
            },
            "example": "location"
        },
        "last_action_date": {
            "name": "last_action_date",
            "type": "string",
            "title": "Last Action Date",
            "description": "The date when data was changed.",
            "constraints": {
                "unique": false
            },
            "example": "2011-01-01",
            "datapackage_type": "date"
        },
        "last_action_type": {
            "name": "last_action_type",
            "type": "string",
            "title": "Last Action Type",
            "description": "The kind of change made to the data.",
            "constraints": {
                "unique": false
            },
            "example": "update"
        },
        "field_name": {
            "name": "field_name",
            "type": "string",
            "title": "Field Name",
            "description": "The name of field that has been modified.",
            "constraints": {
                "unique": false
            },
            "example": "name"
        },
        "previous_value": {
            "name": "previous_value",
            "type": "string",
            "title": "Previous Value",
            "description": "The previous value of the field that has been modified.",
            "constraints": {
                "unique": false
            },
            "example": "MyCity Civic Center"
        },
        "replacement_value": {
            "name": "replacement_value",
            "type": "string",
            "title": "Replacement Value",
            "description": "The new value of the field that has been modified.",
            "constraints": {
                "unique": false
            },
            "example": "MyCity New Civic Center"
        },
        "updated_by": {
            "name": "updated_by",
            "type": "string",
            "title": "Updated By",
            "description": "The name of the person who modified the field.",
            "constraints": {
                "unique": false
            },
            "example": "Ann Persona"
        }
    },
    "required": [
        "id",
        "last_action_date",
        "last_action_type",
        "field_name",
        "previous_value",
        "replacement_value",
        "updated_by"
    ],
    "tabular_required": [
        "resource_id",
        "resource_type"
    ]
}

Example

[
    {
        "id": "6cd71e9f-1013-49d9-8370-26b8f59d3e5a",
        "resource_type": "location",
        "last_action_date": "2011-01-01",
        "last_action_type": "update",
        "field_name": "name",
        "previous_value": "MyCity Civic Center",
        "replacement_value": "MyCity New Civic Center",
        "updated_by": "Ann Persona"
    }
]

meta_table_description

meta_table_description is defined as:

Metadata about individual tables.

Each meta_table_description object has the following fields:

Fields

Title	Description	Type	Format	Required
id		string	uuid	Required
Identifier	The identifier for the metadata description. Each entry must have a unique identifier.
name		string
Name	The name for the metadata description.
language		string
Language	The ISO 639-1 or ISO 639-3 code for the language of the metadata description.
character_set		string
Character Set	The character set of the metadata description.
attributes		array[object]
Attributes	A link between a service and one or more classifications that describe the nature of the service provided. See attribute
metadata		array[object]
Metadata	A record of the changes that have been made to the data in order to maintain provenance information. See metadata

Schema

{
    "name": "meta_table_description",
    "path": "meta_table_descriptions.csv",
    "description": "Metadata about individual tables.",
    "datapackage_metadata": {
        "format": "csv",
        "mediatype": "text/csv",
        "profile": "tabular-data-resource",
        "order": 18
    },
    "type": "object",
    "properties": {
        "id": {
            "name": "id",
            "type": "string",
            "title": "Identifier",
            "description": "The identifier for the metadata description. Each entry must have a unique identifier.",
            "format": "uuid",
            "constraints": {
                "unique": true
            },
            "example": "c11af60b-a394-4e53-9943-324dda2d17a1"
        },
        "name": {
            "name": "name",
            "type": "string",
            "title": "Name",
            "description": "The name for the metadata description.",
            "constraints": {
                "unique": false
            },
            "example": "Example name"
        },
        "language": {
            "name": "language",
            "type": "string",
            "title": "Language",
            "description": "The ISO 639-1 or ISO 639-3 code for the language of the metadata description.",
            "constraints": {
                "unique": false
            },
            "example": "ur"
        },
        "character_set": {
            "name": "character_set",
            "type": "string",
            "title": "Character Set",
            "description": "The character set of the metadata description.",
            "constraints": {
                "unique": false
            },
            "example": "ASCII"
        },
        "attributes": {
            "name": "attributes",
            "type": "array",
            "title": "Attributes",
            "description": "A link between a service and one or more classifications that describe the nature of the service provided.",
            "items": {
                "$ref": "attribute.json"
            }
        },
        "metadata": {
            "name": "metadata",
            "type": "array",
            "title": "Metadata",
            "description": "A record of the changes that have been made to the data in order to maintain provenance information.",
            "items": {
                "$ref": "metadata.json"
            }
        }
    },
    "required": [
        "id"
    ]
}

Example

In development

taxonomy

taxonomy is defined as:

The taxonomies from which taxonomy terms are taken.

Each taxonomy object has the following fields:

Fields

Title	Description	Type	Format	Required
id		string	uuid	Required
Identifier	The identifier of the taxonomy. Each entry must have a unique identifier
name		string		Required
Name	The name of the taxonomy from which terms are sourced.
description		string		Required
Description	A free text description of the taxonomy.
uri		string	uri
URI	The URI of the taxonomy.
version		string
Version	The version of the taxonomy.
metadata		array[object]
Metadata	A record of the changes that have been made to the data in order to maintain provenance information. See metadata

Schema

{
    "name": "taxonomy",
    "path": "taxonomies.csv",
    "description": "The taxonomies from which taxonomy terms are taken.",
    "datapackage_metadata": {
        "format": "csv",
        "mediatype": "text/csv",
        "profile": "tabular-data-resource",
        "order": 21
    },
    "type": "object",
    "properties": {
        "id": {
            "name": "id",
            "type": "string",
            "title": "Identifier",
            "description": "The identifier of the taxonomy. Each entry must have a unique identifier",
            "format": "uuid",
            "constraints": {
                "unique": true
            },
            "example": "5c4d79d7-cc55-470e-9f1f-8cad074e4892"
        },
        "name": {
            "name": "name",
            "type": "string",
            "title": "Name",
            "description": "The name of the taxonomy from which terms are sourced.",
            "constraints": {
                "unique": false
            },
            "example": "name"
        },
        "description": {
            "name": "description",
            "type": "string",
            "title": "Description",
            "description": "A free text description of the taxonomy.",
            "constraints": {
                "unique": false
            },
            "example": "description"
        },
        "uri": {
            "name": "uri",
            "type": "string",
            "title": "URI",
            "description": "The URI of the taxonomy.",
            "format": "uri",
            "constraints": {
                "unique": false
            },
            "example": "http://example.com"
        },
        "version": {
            "name": "version",
            "type": "string",
            "title": "Version",
            "description": "The version of the taxonomy.",
            "constraints": {
                "unique": false
            },
            "example": "version"
        },
        "metadata": {
            "name": "metadata",
            "type": "array",
            "title": "Metadata",
            "description": "A record of the changes that have been made to the data in order to maintain provenance information.",
            "items": {
                "$ref": "metadata.json"
            }
        }
    },
    "required": [
        "id",
        "name",
        "description"
    ]
}

Example

In development

taxonomy_term

taxonomy_term is defined as:

Each service can be categorized according to one or more taxonomy terms. The taxonomy_term object contains a list of taxonomy terms, their names, and, for hierarchical taxonomies, their structure.

Each taxonomy_term object has the following fields:

Fields

Title	Description	Type	Format	Required
id		string	uuid	Required
Identifier	The identifier for this taxonomy term. Each taxonomy term must have a unique identifier, within the scope of the dataset.
code		string
Code	The term identfier as used in the taxonomy. This and the taxonomy_id combined define the term.
name		string		Required
Name	The taxonomy term itself.
description		string		Required
Description	A free text description of the term.
parent_id		string	uuid
Parent Identifier	If this is a child term in a hierarchical taxonomy, give the identifier of the parent category. For top-level categories, this is not required.
taxonomy		string
Taxonomy	If this is an established taxonomy, a free text description of which taxonomy is in use. If possible, provide a URI.
taxonomy_detail		object
Taxonomy	Taxonomies from which taxonomy terms are taken See taxonomy
language		string
Language	An ISO 639-1, or ISO 639-2 [language code](available at http://www.loc.gov/standards/iso639-2/php/code_list.php) to represent the language of the term. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.
taxonomy_id		string	uuid
Taxonomy Identifier	The identifier of the taxonomy containing the term.
term_uri		string	uri
Term URI	URI of the term.
metadata		array[object]
Metadata	A record of the changes that have been made to the data in order to maintain provenance information. See metadata

Schema

{
    "name": "taxonomy_term",
    "path": "taxonomy_terms.csv",
    "description": "Each service can be categorized according to one or more taxonomy terms. The taxonomy_term object contains a list of taxonomy terms, their names, and, for hierarchical taxonomies, their structure.",
    "datapackage_metadata": {
        "format": "csv",
        "mediatype": "text/csv",
        "profile": "tabular-data-resource",
        "order": 16
    },
    "type": "object",
    "properties": {
        "id": {
            "name": "id",
            "type": "string",
            "title": "Identifier",
            "description": "The identifier for this taxonomy term. Each taxonomy term must have a unique identifier, within the scope of the dataset.",
            "format": "uuid",
            "constraints": {
                "unique": true
            },
            "example": "3f7b145d-84af-42d7-8fae-eaca714b02b2",
            "core": "Y"
        },
        "code": {
            "name": "code",
            "type": "string",
            "title": "Code",
            "description": "The term identfier as used in the taxonomy. This and the taxonomy_id combined define the term.",
            "constraints": {
                "unique": true
            },
            "example": "code"
        },
        "name": {
            "name": "name",
            "type": "string",
            "title": "Name",
            "description": "The taxonomy term itself.",
            "constraints": {
                "unique": false
            },
            "example": "name",
            "core": "Y"
        },
        "description": {
            "name": "description",
            "type": "string",
            "title": "Description",
            "description": "A free text description of the term.",
            "constraints": {
                "unique": false
            },
            "example": "description"
        },
        "parent_id": {
            "name": "parent_id",
            "type": "string",
            "title": "Parent Identifier",
            "description": "If this is a child term in a hierarchical taxonomy, give the identifier of the parent category. For top-level categories, this is not required.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "0bc248fa-dc27-4650-9ba4-8f1a24ef16a2",
            "core": "Y"
        },
        "taxonomy": {
            "name": "taxonomy",
            "type": "string",
            "title": "Taxonomy",
            "description": "If this is an established taxonomy, a free text description of which taxonomy is in use. If possible, provide a URI.",
            "constraints": {
                "unique": false
            },
            "example": "taxonomy",
            "core": "Y"
        },
        "taxonomy_detail": {
            "name": "taxonomy",
            "title": "Taxonomy",
            "description": "Taxonomies from which taxonomy terms are taken",
            "$ref": "taxonomy.json"
        },
        "language": {
            "name": "language",
            "type": "string",
            "title": "Language",
            "description": "An ISO 639-1, or ISO 639-2 [language code](available at http://www.loc.gov/standards/iso639-2/php/code_list.php) to represent the language of the term. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.",
            "constraints": {
                "unique": false
            },
            "example": "eng"
        },
        "taxonomy_id": {
            "name": "taxonomy_id",
            "type": "string",
            "title": "Taxonomy Identifier",
            "description": "The identifier of the taxonomy containing the term.",
            "format": "uuid",
            "constraints": {
                "unique": false
            },
            "example": "07ff6aee-a219-438c-b694-d2fcb6c5373b"
        },
        "term_uri": {
            "name": "term_uri",
            "type": "string",
            "title": "Term URI",
            "description": "URI of the term.",
            "format": "uri",
            "constraints": {
                "unique": false
            },
            "example": "http://example.com"
        },
        "metadata": {
            "name": "metadata",
            "type": "array",
            "title": "Metadata",
            "description": "A record of the changes that have been made to the data in order to maintain provenance information.",
            "items": {
                "$ref": "metadata.json"
            }
        }
    },
    "required": [
        "id",
        "name",
        "description"
    ]
}

Example

In development