{
"name": "human_services_data",
"title": "Open Referral UK Application Profile for Human Services Data",
"description": "A specification of the Open Referral standard for Human Services as extended by OpenCommunity and Local Government Association work in the UK. Includes an Application Profile for use with English services.",
"license": {
"url": "https://creativecommons.org/licenses/by-sa/4.0/",
"type": "CC-BY-SA-4.0",
"name": "Creative Commons Attribution-ShareAlike 4.0"
},
"version": "1.0",
"homepage": "http://docs.openreferraluk.org",
"resources": [
{
"name": "organization",
"path": "organizations.csv",
"description": "The organization record is used to provide basic description and details about each organization delivering or reviewing services. Each service should be linked to the organization responsible for its delivery. One organization may deliver many services. Note that the LGA extension table 'link_taxonomy' enables many taxonomy terms to associated with an organization. These can define the type of organization e.g.- charity
- voluntary group
- local authority
",
"format": "csv",
"source": "openReferral",
"applicationProfile": [ { "name": "openReferral" } ],
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"type": "string",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"source": "openReferral",
"description": "Each organization must have a unique identifier.",
"format": "uuid",
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "name",
"type": "string",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"source": "openReferral",
"description": "The official or public name of the organization.",
"constraints": {
"required": true
}
},
{
"name": "alternate_name",
"type": "string",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "could"
}
],
"source": "openReferral",
"description": "Alternative or commonly used name for the organization.",
"constraints": {
"required": false
}
},
{
"name": "description",
"type": "string",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"source": "openReferral",
"description": "A brief summary about the organization. It can contain markup such as HTML or Markdown.",
"constraints": {
"required": true
}
},
{
"name": "email",
"type": "string",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"source": "openReferral",
"description": "The contact e-mail address for the organization.",
"format": "email",
"constraints": {
"required": false
}
},
{
"name": "url",
"type": "string",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"source": "openReferral",
"format": "url",
"description": "The URL (website address) of the organization.",
"constraints": {
"required": false
}
},
{
"name": "tax_status",
"type": "string",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "won't"
}
],
"source": "openReferral",
"description": "Government assigned tax designation for tax-exempt organizations.",
"constraints": {
"required": false
}
},
{
"name": "tax_id",
"type": "string",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "won't"
}
],
"source": "openReferral",
"description": "A government issued identifier used for the purpose of tax administration.",
"constraints": {
"required": false
}
},
{
"name": "year_incorporated",
"type": "date",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "won't"
}
],
"format": "%Y",
"description": "The year in which the organization was legally formed.",
"constraints": {
"required": false
}
},
{
"name": "legal_status",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "must"
}
],
"description": "The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.",
"constraints": {
"required": false
}
},
{
"name": "logo",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
},
{
"name": "openCommunity",
"moscow": "won't"
}
],
"description": "A URL to an image associated with the organization which can be presented alongside its name.",
"constraints": {
"required": false
}
},
{
"name": "uri",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
}
],
"description": "A persistent identifier to uniquely identify the organization.",
"format": "url",
"constraints": {
"required": false
}
},
{
"name": "assured_date",
"type": "date",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "must"
}
],
"description": "The date that the information about the organization was last checked as up to date and accurate.",
"constraints": {
"required": false
}
}
],
"primaryKey": "id"
}
},
{
"name": "identifier",
"path": "identifiers.csv",
"description": "A list of commonly used registers could be provided for the user to select from to cut down number of steps in this process.",
"format": "csv",
"source": "openCommunity",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "must"
}
],
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"type": "string",
"source": "openCommunity",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "must"
}
],
"description": "Each entry must have a unique identifier.",
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "organization_id",
"type": "string",
"source": "openCommunity",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "must"
}
],
"description": "The id of the organization for which this entry describes the registration.",
"format": "uuid"
},
{
"name": "service_area_id",
"description": "The id of the servcie_area for which this entry describes the identifier.",
"type": "string",
"source": "openCommunity",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true
}
},
{
"name": "identification_body",
"description": "The name of the body that uses or issued the identifier e.g. Companies House.",
"type": "string",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "won't"
}
],
"source": "openCommunity",
"constraints": {
"required": false
}
},
{
"name": "register",
"description": "A name to identify the register (e.g. the identifier scheme) that the code has come from.",
"type": "string",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "must"
}
],
"source": "openCommunity",
"constraints": {
"required": false
}
},
{
"name": "identifier",
"description": "The registration code or identifier issued by the body.",
"type": "string",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "must"
}
],
"source": "openCommunity",
"constraints": {
"required": false
}
},
{
"name": "uri",
"description": "A persistent resolvable identifier as defined by UK Government Standards.",
"type": "string",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "should"
}
],
"source": "openCommunity",
"constraints": {
"required": false
}
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "organization_id",
"reference": {
"resource": "organization",
"fields": "id"
}
},
{
"fields": "service_area_id",
"reference": {
"resource": "service_area",
"fields": "id"
}
}
]
}
},
{
"name": "program",
"path": "programs.csv",
"description": "Some organizations organise their services into programs. A program brings together a number of related services.",
"format": "csv",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "won't"
}
],
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"type": "string",
"source": "openReferral",
"description": "Each program must have a unique identifier.",
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "organization_id",
"type": "string",
"source": "openReferral",
"description": "Each program must belong to a single organization. The identifier of the organization should be given here.",
"format": "uuid",
"constraints": {
"required": true
}
},
{
"name": "name",
"description": "The name of the program",
"type": "string",
"source": "openReferral",
"constraints": {
"required": true
}
},
{
"name": "alternate_name",
"description": "An alternative name for the program",
"type": "string",
"source": "openReferral",
"constraints": {
"required": false
}
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "organization_id",
"reference": {
"resource": "organization",
"fields": "id"
}
}
]
}
},
{
"name": "service",
"description": "Services are provided by organizations to a range of different groups. Details on where each service is delivered are contained in the services_at_location table.",
"path": "services.csv",
"source": "openReferral",
"format": "csv",
"applicationProfile": [
{
"name": "openReferral"
}
],
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"type": "string",
"format": "uuid",
"source": "openReferral",
"description": "Each service must have a unique identifier.",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "organization_id",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"description": "The identifier of the organization that provides this service.",
"constraints": {
"required": true
}
},
{
"name": "program_id",
"description": "The identifier of the program this service is delivered under.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "won't"
}
],
"constraints": {
"required": false
}
},
{
"name": "name",
"description": "The official or public name of the service.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true
}
},
{
"name": "alternate_name",
"description": "Alternative or commonly used name for a service.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "could"
}
],
"constraints": {
"required": false
}
},
{
"name": "description",
"description": "A description of the service. It can contain markup such as HTML or Markdown.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": false
}
},
{
"name": "url",
"description": "URL of the service",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"format": "url",
"constraints": {
"required": false
}
},
{
"name": "email",
"description": "Email address for the service",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"format": "email",
"constraints": {
"required": false
}
},
{
"name": "status",
"description": "The current status of the service.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"enum": [ "active", "inactive", "defunct", "temporarily closed" ],
"required": false
}
},
{
"name": "interpretation_services",
"description": "A description of any interpretation services available for accessing this service.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "could"
}
],
"constraints": {
"required": false
}
},
{
"name": "application_process",
"description": "The steps needed to access the service.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": false
}
},
{
"name": "wait_time",
"description": "Time a client may expect to wait before receiving a service.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "could"
}
],
"constraints": {
"required": false
}
},
{
"name": "fees",
"description": "Details of any charges for service users to access this service.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"notes": "Use structured information where available in preference to this text field. LGA defines an extension table for 'cost_option'. This 'fees' field can contain a single human-readable description of costs. The 'cost_option' table can optionally add a further breakdown that can be filtered on."
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": false
}
},
{
"name": "accreditations",
"description": "Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "LGA",
"notes": "Use structured information where available in preference to this text field. LGA defines an extension table for 'review'. This 'accreditations' field can contain a single human-readable description of reviews. The 'review' table can optionally add a further breakdown that can be filtered on."
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": false
}
},
{
"name": "licenses",
"description": "An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "won't"
}
],
"constraints": {
"required": false
}
},
{
"name": "taxonomy_ids",
"description": "(Deprecated) A comma separated list of identifiers from the taxonomy table. This field is deprecated in favour of using the service_taxonomy table.",
"type": "string",
"deprecated": true,
"source": "openReferral",
"constraints": {
"required": false
}
},
{
"name": "deliverable_type",
"description": "A categorisation of the nature of the output of the Service.",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"notes": "Expected to reference a taxonomy rather than an enumeration in future versions",
"name": "LGA"
},
{
"name": "openCommunity",
"moscow": "won't"
}
],
"constraints": {
"enum": [ "Advice", "Assessment", "Counselling", "Equipment", "Financial Support", "Information", "Permission", "Training" ]
}
},
{
"name": "assured_date",
"description": "The date that the information about the service was last checked",
"type": "string",
"source": "openCommunity",
"applicationProfile": [
{
"name": "LGA"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": false
}
},
{
"name": "attending_type",
"description": "How to attend this service.",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"notes": "Expected to reference a taxonomy ratehr than an enumeration in future versions",
"name": "LGA"
}
],
"constraints": {
"enum": [ "phone", "online", "venue", "home visit" ]
}
},
{
"name": "attending_access",
"description": "Access restrictions for this service.",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"notes": "Expected to reference a taxonomy ratehr than an enumeration in future versions",
"name": "LGA"
}
],
"constraints": {
"enum": [ "referral", "appointment", "membership", "drop-in" ]
}
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "organization_id",
"reference": {
"resource": "organization",
"fields": "id"
}
},
{
"fields": "program_id",
"reference": {
"resource": "program",
"fields": "id"
}
}
]
}
},
{
"name": "service_taxonomy",
"path": "services_taxonomy.csv",
"description": "The service taxonomy creates a link between a service and one or more classifications that describe the nature of the service provided.",
"format": "csv",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
}
],
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"description": "Each service must have a unique identifier.",
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "service_id",
"description": "The identifier of the service at a given location.",
"type": "string",
"format": "uuid",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true
}
},
{
"name": "eligibility_id",
"description": "The eligibility item that the taxonomy entry applies to.",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true
}
},
{
"name": "taxonomy_id",
"description": "The identifier of this classification from the taxonomy table.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must",
"schemes": [
{
"name": "Services",
"uri": "http://id.esd.org.uk/list/services",
"required": true
},
{
"name": "Circumstances",
"uri": "http://id.esd.org.uk/list/circumstances",
"required": false
}
]
}
],
"constraints": {
"required": true
}
},
{
"name": "taxonomy_detail",
"description": "For advanced uses, this field can indicate a constraint on this classification, using * to combine two taxonomy terms. For example: 'Food Pantry*Homeless' (where 'Food Pantry' and 'Homeless' are identifiers in the taxonomy table) to indicate a food pantry service for homeless clients, but not available to other client groups. In this example, there would be two entries in service_taxonomy, one with 'Food Pantry' and one for 'Homeless' in the taxonomy_id field, but both with the same 'Food Pantry*Homeless' value in the taxonomy_detail field.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "won't"
}
]
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "service_id",
"reference": {
"resource": "service",
"fields": "id"
}
},
{
"fields": "taxonomy_id",
"reference": {
"resource": "taxonomy",
"fields": "id"
}
}
]
}
},
{
"name": "service_at_location",
"path": "services_at_location.csv",
"description": "The services at location table creates a link between a service and a specific location.",
"format": "csv",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
}
],
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each entry must have a unique identifier.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "service_id",
"description": "The identifier of the service at a given location.",
"type": "string",
"format": "uuid",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true
}
},
{
"name": "location_id",
"description": "The identifier of the location where this service operates.",
"type": "string",
"format": "uuid",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "must"
},
{
"name": "openReferral",
"schemes": [
{
"name": "Statistical Geography",
"location_id": null,
"uri": "http://statistics.data.gov.uk/id/statistical-geography",
"required": false
},
{
"name": "Neighbourhoods",
"location_id": null,
"uri": "http://id.esd.org.uk/neighbourhood/",
"required": false
}
]
}
],
"constraints": {
"required": true
}
},
{
"name": "description",
"description": "Any additional information that should be displayed to users about the service at this specific location.",
"type": "string",
"source": "openReferral"
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "service_id",
"reference": {
"resource": "service",
"fields": "id"
}
},
{
"fields": "location_id",
"reference": {
"resource": "location",
"fields": "id"
}
}
]
}
},
{
"name": "location",
"path": "locations.csv",
"description": "The location tables provides details of the locations where organizations operate. Locations may be virtual, and one organization may have many locations.",
"format": "csv",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
}
],
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each location must have a unique identifier",
"type": "string",
"format": "uuid",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "organization_id",
"description": "Each location entry should be linked to a single organization. This is the organization that is responsible for maintaining information about this location. The identifier of the organization should be given here. Details of the services the organisation delivers at this location should be provided in the services_at_location table.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "could"
}
]
},
{
"name": "name",
"description": "The name of the location",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
]
},
{
"name": "alternate_name",
"description": "An alternative name for the location",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "could"
}
]
},
{
"name": "description",
"description": "A description of this location.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": false
}
},
{
"name": "transportation",
"description": "A description of the access to public or private transportation to and from the location.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "won't"
}
]
},
{
"name": "latitude",
"description": "Y coordinate of location expressed in decimal degrees in WGS84 datum.",
"type": "number",
"numberType": "double",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
]
},
{
"name": "longitude",
"description": "X coordinate of location expressed in decimal degrees in WGS84 datum.",
"type": "number",
"numberType": "double",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
]
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "organization_id",
"reference": {
"resource": "organization",
"fields": "id"
}
}
]
}
},
{
"name": "phone",
"path": "phones.csv",
"description": "The phone table contains details of the telephone numbers are used to contact organizations, services, and locations.",
"applicationProfile": [
{
"name": "openReferral"
}
],
"format": "csv",
"source": "openReferral",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each entry must have a unique identifier",
"type": "string",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"source": "openReferral",
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "location_id",
"description": "The identifier of the location where this phone number is located",
"type": "string",
"format": "uuid",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "could"
}
]
},
{
"name": "service_id",
"description": "The identifier of the service for which this is the phone number",
"type": "string",
"format": "uuid",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "could"
}
]
},
{
"name": "organization_id",
"description": "The identifier of the organisation for which this is the phone number",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "could"
}
]
},
{
"name": "contact_id",
"description": "The identifier of the contact for which this is the phone number",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true
}
},
{
"name": "service_at_location_id",
"description": "The identifier of the 'service at location' table entry, when this phone number is specific to a service in a particular location.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "could"
}
]
},
{
"name": "number",
"description": "The phone number",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true
}
},
{
"name": "extension",
"description": "The extension of the phone number",
"type": "number",
"numberType": "integer",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "should"
}
]
},
{
"name": "type",
"description": "Indicates the type of phone service, drawing from the RFC6350 list of types (text (for SMS), voice, fax, cell, video, pager, textphone).",
"type": "string",
"source": "openReferral",
"constraints": {
"enum": [ "text", "voice", "fax", "cell", "video", "pager", "textphone" ]
},
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "won't"
}
]
},
{
"name": "language",
"description": "A comma separated list of ISO 639-1, or ISO 639-2 [language codes](available at http://www.loc.gov/standards/iso639-2/php/code_list.php) to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral",
"notes": "'en' for english"
},
{
"name": "openCommunity",
"moscow": "must"
}
]
},
{
"name": "description",
"description": "A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "should"
}
]
},
{
"name": "department",
"description": "(Deprecated) The department for which this is the phone number. This field is deprecated and will be removed in a future version of HSDS.",
"type": "string",
"deprecated": true,
"source": "openReferral"
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "organization_id",
"reference": {
"resource": "organization",
"fields": "id"
}
},
{
"fields": "location_id",
"reference": {
"resource": "location",
"fields": "id"
}
},
{
"fields": "service_id",
"reference": {
"resource": "service",
"fields": "id"
}
},
{
"fields": "contact_id",
"reference": {
"resource": "contact",
"fields": "id"
}
},
{
"fields": "service_at_location_id",
"reference": {
"resource": "service_at_location",
"fields": "id"
}
}
]
}
},
{
"name": "contact",
"path": "contacts.csv",
"description": "The contact table contains 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.",
"format": "csv",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
}
],
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each contact must have a unique identifier",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "organization_id",
"description": "The identifier of the organization for which this is a contact",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "could"
}
]
},
{
"name": "service_id",
"description": "The identifier of the service for which this is a contact",
"type": "string",
"format": "uuid",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true
}
},
{
"name": "service_at_location_id",
"description": "The identifier of the 'service at location' table entry, when this contact is specific to a service in a particular location.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "could"
}
]
},
{
"name": "name",
"description": "The name of the person",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
]
},
{
"name": "title",
"description": "The job title of the person",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
]
},
{
"name": "department",
"description": "The department that the person is part of",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "should"
}
]
},
{
"name": "email",
"description": "The email address of the person",
"type": "string",
"source": "openReferral",
"format": "email",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "must"
}
]
},
{
"name": "personal_data",
"description": "Whether the record contains personal data to assist compliance with data protection and GDPR purposes.",
"type": "boolean",
"source": "openCommunity",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "must"
}
]
},
{
"name": "sensitive_data",
"description": "A flag to identify the contact as containing sensitive information that should not be made publicly available.",
"type": "boolean",
"source": "openCommunity",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "must"
}
]
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "organization_id",
"reference": {
"resource": "organization",
"fields": "id"
}
},
{
"fields": "service_id",
"reference": {
"resource": "service",
"fields": "id"
}
},
{
"fields": "service_at_location_id",
"reference": {
"resource": "service_at_location",
"fields": "id"
}
}
]
}
},
{
"name": "physical_address",
"path": "physical_addresses.csv",
"description": "The addresses table contains the physical addresses for locations. The address fields are in a US form, and some fields are mandatory e.g. city.",
"format": "csv",
"source": "openReferral",
"mediatype": "text/csv",
"applicationProfile": [
{
"name": "openReferral"
}
],
"schema": {
"fields": [
{
"name": "id",
"description": "Each physical address must have a unique identifier.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "location_id",
"description": "The identifier of the location for which this is the address.",
"type": "string",
"format": "uuid",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true
}
},
{
"name": "attention",
"description": "The person or entity whose attention should be sought at the location (Often included as 'care of' component of an address.)",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "could"
}
]
},
{
"name": "address_1",
"description": "The first line(s) of the address, including office, building number and street.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": false
}
},
{
"name": "address_2",
"description": "(Deprecated) A second (additional) line of address information. (This field is deprecated: we recommend including all address information before 'city' as a comma separated list in address_1. There is no guarantee that systems will read this line of address information.)",
"type": "string",
"source": "openReferral",
"deprecated": true
},
{
"name": "address_3",
"description": "(Deprecated) A third (additional) line of address information. (This field is deprecated: we recommend including all address information before 'city' as a comma separated list in address_1. There is no guarantee that systems will read this line of address information.)",
"type": "string",
"source": "openReferral",
"deprecated": true
},
{
"name": "address_4",
"description": "(Deprecated) The fourth (additional) line of address information. (This field is deprecated: we recommend including all address information before 'city' as a comma separated list in address_1. There is no guarantee that systems will read this line of address information.)",
"type": "string",
"source": "openReferral",
"deprecated": true
},
{
"name": "city",
"description": "The city in which the address is located.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true
}
},
{
"name": "region",
"description": "The region in which the address is located (optional).",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "could"
}
],
"constraints": {
"required": false
}
},
{
"name": "state_province",
"description": "The state or province in which the address is located.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true
}
},
{
"name": "postal_code",
"description": "The postal code for the address.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true
}
},
{
"name": "country",
"description": "The country in which the address is located. This should be given as an ISO 3361-1 country code (two letter abbreviation).",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral",
"notes": "Use 'GB'"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true
}
},
{
"name": "uprn",
"description": "A Unique Property Reference Number (UPRN) is a unique alphanumeric identifier for every spatial address in Great Britain and can be found in OS's Address products.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "should"
}
]
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "location_id",
"reference": {
"resource": "location",
"fields": "id"
}
}
]
}
},
{
"name": "postal_address",
"path": "postal_addresses.csv",
"description": "The postal_address table contains the postal addresses for mail to a certain location. This may differ from the physical location.",
"format": "csv",
"source": "openReferral",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each postal address must have a unique identifier",
"source": "openReferral",
"type": "string",
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "location_id",
"description": "The identifier of the location for which this is the postal address.",
"source": "openReferral",
"type": "string",
"format": "uuid"
},
{
"name": "attention",
"description": "The person or entity whose attention should be sought at the location (Often included as 'care of' component of an address.)",
"source": "openReferral",
"type": "string"
},
{
"name": "address_1",
"description": "The first line(s) of the address, including office, building number and street.",
"source": "openReferral",
"type": "string",
"constraints": {
"required": true
}
},
{
"name": "address_2",
"description": "(Deprecated) A second (additional) line of address information. (This field is deprecated: we recommend including all address information before 'city' as a comma separated list in address_1. There is no guarantee that systems will read this line of address information.)",
"source": "openReferral",
"type": "string",
"deprecated": true
},
{
"name": "address_3",
"description": "(Deprecated) A third (additional) line of address information. (This field is deprecated: we recommend including all address information before 'city' as a comma separated list in address_1. There is no guarantee that systems will read this line of address information.)",
"source": "openReferral",
"type": "string",
"deprecated": true
},
{
"name": "address_4",
"description": "(Deprecated) The fourth (additional) line of address information. (This field is deprecated: we recommend including all address information before 'city' as a comma separated list in address_1. There is no guarantee that systems will read this line of address information.)",
"source": "openReferral",
"type": "string",
"deprecated": true
},
{
"name": "city",
"description": "The city in which the address is located.",
"source": "openReferral",
"type": "string",
"constraints": {
"required": true
}
},
{
"name": "region",
"description": "The region in which the address is located (optional).",
"source": "openReferral",
"type": "string",
"constraints": {
"required": false
}
},
{
"name": "state_province",
"description": "The state or province in which the address is located.",
"source": "openReferral",
"type": "string",
"constraints": {
"required": true
}
},
{
"name": "postal_code",
"description": "The postal code for the address.",
"source": "openReferral",
"type": "string",
"constraints": {
"required": true
}
},
{
"name": "country",
"description": "The country in which the address is located. This should be given as an ISO 3361-1 country code (two letter abbreviation)",
"source": "openReferral",
"type": "string",
"constraints": {
"required": true
}
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "location_id",
"reference": {
"resource": "location",
"fields": "id"
}
}
]
}
},
{
"name": "regular_schedule",
"path": "regular_schedules.csv",
"description": "The regular_schedule table contains details of when a service or location is open under normal circumstances. Each entry in the table can relate to one and only one day of the week. Open Referral UK extends this table to add extra fields used in the iCal standard to allow for more flexible scheduling.",
"applicationProfile": [
{
"name": "openReferral"
}
],
"format": "csv",
"source": "openReferral",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each entry must have a unique identifier",
"source": "openReferral",
"type": "string",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "service_id",
"description": "The identifier of the service for which this is the regular schedule",
"source": "openReferral",
"type": "string",
"format": "uuid",
"applicationProfile": [
{
"name": "openReferral",
"notes": "Use either service_id or service_at_location_id. Use service_id to give opening times for accessing the service with no location. Use service_at_location_id to give opening times for a location for the service."
},
{
"name": "openCommunity",
"moscow": "must"
}
]
},
{
"name": "location_id",
"description": "The identifier of the location for which this is the regular schedule",
"source": "openReferral",
"type": "string",
"format": "uuid",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "could"
}
]
},
{
"name": "service_at_location_id",
"description": "The identifier of the 'service at location' table entry, when this schedule is specific to a service in a particular location.",
"source": "openReferral",
"type": "string",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
]
},
{
"name": "weekday",
"description": "The day of the week that this entry relates to",
"type": "integer",
"source": "openReferral",
"applicationProfile": [
{
"name": "LGA",
"notes": "Although this is required in the base Open Referral UK schema, it may not be suitable for an iCal schedule record."
},
{
"name": "openCommunity",
"moscow": "won't"
}
],
"constraints": {
"required": true
}
},
{
"name": "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 'Z' when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. ",
"type": "time",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
]
},
{
"name": "closes_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 'Z' when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.",
"type": "time",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
]
},
{
"name": "valid_from",
"description": "The date from which the schedule information is valid.",
"type": "date",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
},
{
"name": "openCommunity",
"moscow": "should"
}
]
},
{
"name": "valid_to",
"description": "The last date on which the schedule information is valid.",
"type": "date",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
},
{
"name": "openCommunity",
"moscow": "should"
}
]
},
{
"name": "dtstart",
"description": "iCal - The date of the first event is the schedule. Necessary when using the 'interval' feature",
"type": "date",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA",
"notes": "Necessary when using the 'interval' feature."
},
{
"name": "openCommunity",
"moscow": "must"
}
]
},
{
"name": "freq",
"description": "iCal - How often the frequency repeats. E.g. Frequency use one of WEEKLY or MONTHLY.",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA",
"notes": "See the 'interval' field for combinations to make other frequencies."
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"enum": [
"WEEKLY",
"MONTHLY"
]
}
},
{
"name": "interval",
"description": "iCal - How often the frequency repeats. E.g. Interval 2 for Frequency WEEKLY gives Fortnightly",
"type": "number",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA",
"notes": "For example - interval 2 for freq WEEKLY gives Fortnightly"
},
{
"name": "openCommunity",
"moscow": "must"
}
]
},
{
"name": "byday",
"description": "iCal - Comma seperated days of the week. E.g. SU,MO,TU,WE,TH,FR,SA. 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",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
},
{
"name": "openCommunity",
"moscow": "must"
}
]
},
{
"name": "bymonthday",
"description": "iCal - Day number in a month if frequency is MONTHLY ",
"type": "number",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA",
"notes": "if freq is MONTHLY"
},
{
"name": "openCommunity",
"moscow": "must"
}
]
},
{
"name": "description",
"description": "Human readable description of the availability of the service.",
"type": "string",
"source": "openCommunity",
"applicationProfile": [
{
"name": "LGA",
"notes": "Should match up with the iCAL field. E.g. 'The 2nd Monday of every month from 8:00pm till 12:00pm'"
},
{
"name": "openCommunity",
"moscow": "should"
}
]
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "location_id",
"reference": {
"resource": "location",
"fields": "id"
}
},
{
"fields": "service_id",
"reference": {
"resource": "service",
"fields": "id"
}
},
{
"fields": "service_at_location_id",
"reference": {
"resource": "service_at_location",
"fields": "id"
}
}
]
}
},
{
"name": "holiday_schedule",
"path": "holiday_schedules.csv",
"description": "The holiday_schedule table contains details of when a service or location is open during holidays. Each entry in the table describes a period of one or more days, and the operating times on those days. there is potential for this table to be deprecated if iCal rules are adopted in regular_schedule.",
"applicationProfile": [
{
"name": "openReferral"
}
],
"format": "csv",
"source": "openReferral",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each entry must have a unique identifier",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "should"
}
],
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "service_id",
"description": "The identifier of the service for which this is the holiday schedule",
"type": "string",
"format": "uuid",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral",
"notes": "Use either service_id or service_at_location_id. Use service_id to give opening times for accessing the service with no location. Use service_at_location_id to give opening times for a location for the service."
},
{
"name": "openCommunity",
"moscow": "should"
}
]
},
{
"name": "location_id",
"description": "The identifier of the location for which this is the holiday schedule",
"type": "string",
"format": "uuid",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "could"
}
]
},
{
"name": "service_at_location_id",
"description": "The identifier of the 'service at location' table entry, when this schedule is specific to a service in a particular location.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "should"
}
]
},
{
"name": "closed",
"description": "Indicates if a service or location is closed during a public holiday",
"type": "boolean",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "should"
}
],
"constraints": {
"required": true
}
},
{
"name": "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 'Z' when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.",
"type": "time",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "should"
}
]
},
{
"name": "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 'Z' when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.",
"type": "time",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "should"
}
]
},
{
"name": "start_date",
"description": "The first day that a service or location is closed during a public or private holiday",
"type": "date",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "should"
}
],
"constraints": {
"required": true
}
},
{
"name": "end_date",
"description": "The last day that a service or location is closed during a public or private holiday",
"type": "date",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "should"
}
],
"constraints": {
"required": true
}
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "location_id",
"reference": {
"resource": "location",
"fields": "id"
}
},
{
"fields": "service_id",
"reference": {
"resource": "service",
"fields": "id"
}
},
{
"fields": "service_at_location_id",
"reference": {
"resource": "service_at_location",
"fields": "id"
}
}
]
}
},
{
"name": "funding",
"path": "funding.csv",
"description": "The funding table describes the sources of funding for a service or organisation",
"format": "csv",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "could"
}
],
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each entry must have a unique identifier",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "could"
}
],
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "organization_id",
"description": "The identifier of the organization in receipt of this funding.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "could"
}
]
},
{
"name": "service_id",
"description": "The identifier of the service in receipt of this funding",
"type": "string",
"format": "uuid",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "could"
}
],
"constraints": {
"required": true
}
},
{
"name": "source",
"description": "A free text description of the source of funds for this organization or service.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "could"
}
]
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "service_id",
"reference": {
"resource": "service",
"fields": "id"
}
},
{
"fields": "organization_id",
"reference": {
"resource": "organization",
"fields": "id"
}
}
]
}
},
{
"name": "eligibility",
"path": "eligibility.csv",
"description": "The eligibility tables contains details of the eligibility criteria for particular services. Note that the LGA extension table 'link_taxonomy' enables many taxonomy terms to associated with an eligibility. A design principle for the standard is to “to be able to identify a small target set of services that closely meet the needs of a prospective service user”. The approach to eligibility has been designed to enable a complex set of criteria to be coded so that services can be effectively filtered by a user’s needs and circumstances.
The design allows for one entry on this table for each set of qualifying conditions - for example- Over 60, AND Male
OR- In receipt of Universal Credit
Each set of AND conditions is then coded into this eligibility structure so that- Age ranges use the minimum_age and maximum_age fields
- Other circumstances are defined as taxonomy entries using the link_taxonony table.
A ‘human-readable’ version of the coded conditions can also be provided in the ‘eligibility’ field.",
"applicationProfile": [
{
"name": "openReferral"
}
],
"format": "csv",
"source": "openReferral",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each entry must have a unique identifier",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "service_id",
"description": "The identifier of the service for which this entry describes the eligibility criteria",
"type": "string",
"format": "uuid",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true
}
},
{
"name": "eligibility",
"description": "The rules or guidelines that determine who can receive the service.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "LGA",
"notes": "Use structured information where available in preference to this text field. OR permitted values should be removed from the LGA Application Profile."
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"enum": [
"adult",
"child",
"teen",
"family",
"female",
"male",
"Transgender",
"Transgender - M to F",
"Transgender - F to M"
]
}
},
{
"name": "minimum_age",
"description": "The minimum age required to meet this eligibility requirement.",
"type": "number",
"source": "openCommunity",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "must"
},
{
"name": "LGA"
}
],
"constraints": {
"required": true
}
},
{
"name": "maximum_age",
"description": "The maximum age required to meet this eligibility requirement.",
"type": "number",
"source": "openCommunity",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "must"
},
{
"name": "LGA"
}
],
"constraints": {
"required": true
}
},
{
"name": "gender",
"description": "Gender restriction required to meet this eligibility requirement.",
"type": "string",
"source": "openCommunity",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "won't"
}
],
"constraints": {
"required": true
}
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "service_id",
"reference": {
"resource": "service",
"fields": "id"
}
}
]
}
},
{
"name": "service_area",
"path": "service_areas.csv",
"description": "The service_area table contains details of the geographic area for which a service is available. Note that the LGA extension table 'link_taxonomy' enables many taxonomy terms to associated with a service_area. These can define the type of area e.g.- administrative geography
- natural neighbourhood
- town
UK geographies can be referenced in ONS statistical geographies and in Natural Neighbourhoods.",
"applicationProfile": [
{
"name": "openReferral"
}
],
"format": "csv",
"source": "openReferral",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each service area must have a unique identifier",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "service_id",
"description": "The identifier of the service for which this entry describes the service area",
"type": "string",
"format": "uuid",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"source": "openReferral",
"constraints": {
"required": true
}
},
{
"name": "service_area",
"description": "The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.",
"type": "string",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"source": "openReferral"
},
{
"name": "description",
"description": "A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "could"
}
]
},
{
"name": "name",
"description": "A name for a geographic area.",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "could"
}
]
},
{
"name": "identifier",
"description": "",
"type": "string",
"source": "openCommunity",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "won't"
}
]
},
{
"name": "type",
"description": "A categorisation of the type of geographic area.",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "won't"
}
]
},
{
"name": "extent",
"description": "A definition of the polygon defining the area, in geojson.",
"type": "string",
"geoType": "geometry",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
},
{
"name": "openCommunity",
"moscow": "must"
}
]
},
{
"name": "uri",
"description": "A persistent identifier to identify an area.",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
}
]
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "service_id",
"reference": {
"resource": "service",
"fields": "id"
}
}
]
}
},
{
"name": "required_document",
"path": "required_documents.csv",
"description": "The required_document table contains details of any documents that are required in order to access or use services.",
"format": "csv",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "could"
}
],
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each document must have a unique identifier",
"type": "string",
"source": "openReferral",
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "service_id",
"description": "The identifier of the service for which this entry describes the required document",
"type": "string",
"format": "uuid",
"source": "openReferral"
},
{
"name": "document",
"description": "The document required to apply for or receive the service. e.g. 'Government-issued ID', 'EU Passport'",
"type": "string",
"source": "openReferral"
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "service_id",
"reference": {
"resource": "service",
"fields": "id"
}
}
]
}
},
{
"name": "payment_accepted",
"path": "payments_accepted.csv",
"description": "The payment_accepted table contains details of the methods of payment that can be used in order to pay for services",
"format": "csv",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "won't"
}
],
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each entry must have a unique identifier",
"type": "string",
"source": "openReferral",
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "service_id",
"description": "The identifier of the services for which the entry describes the accepted payment methods",
"type": "string",
"format": "uuid",
"source": "openReferral"
},
{
"name": "payment",
"description": "The methods of payment accepted for the service",
"type": "string",
"source": "openReferral",
"constraints": {
"enum": [ "cash", "check", "money order", "credit card", "medicare", "SNAP", "WIC", "EBT" ]
}
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "service_id",
"reference": {
"resource": "service",
"fields": "id"
}
}
]
}
},
{
"name": "language",
"path": "languages.csv",
"description": "The language table contains details of the languages that are spoken at locations or services. This does not include languages which can only be used with intepretation.",
"format": "csv",
"source": "openReferral",
"applicationProfile": [ { "name": "openReferral" } ],
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each language must have a unique identifier",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "should"
}
],
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "service_id",
"description": "The identifier of the service for which the entry describes the languages in which services are delivered",
"type": "string",
"format": "uuid",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "should"
}
],
"constraints": {
"required": true
}
},
{
"name": "location_id",
"description": "The identifier of the location for which the entry describes the languages in which services are delivered",
"type": "string",
"format": "uuid",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "could"
}
]
},
{
"name": "language",
"description": "Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "should"
}
]
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "service_id",
"reference": {
"resource": "service",
"fields": "id"
}
},
{
"fields": "location_id",
"reference": {
"resource": "location",
"fields": "id"
}
}
]
}
},
{
"name": "accessibility_for_disabilities",
"path": "accessibility_for_disabilities.csv",
"description": "The accessibility_for_disabilities table contains details of the arrangements for access to locations for people who have disabilities",
"format": "csv",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
}
],
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each entry must have a unique identifier",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "location_id",
"description": "The identifier of the location for which the entry describes the accessibility provision",
"type": "string",
"format": "uuid",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true
}
},
{
"name": "accessibility",
"description": "Description of assistance or infrastructure that facilitate access to clients with disabilities.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral",
"notes": "A suitable list of enumerated values needs to be agreed on. OR permitted values should be removed from the LGA Application Profile."
},
{
"name": "openCommunity",
"moscow": "must",
"notes": "A suitable list of enumerated values needs to be agreed on."
}
]
},
{
"name": "details",
"description": "Any further details relating to the relevant accessibility arrangements at this location. E.g. whether advance notice is required to use an accessibility facility.",
"type": "string",
"source": "openReferral",
"constraints": {
"required": false
}
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "location_id",
"reference": {
"resource": "location",
"fields": "id"
}
}
]
}
},
{
"name": "taxonomy",
"path": "taxonomy.csv",
"description": "Each service can be categorized according to one or more taxonomy terms. The taxonomy table contains a list of taxonomy identifiers, their names, and, for hierarchical taxonomies, their structure.",
"format": "csv",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
}
],
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each taxonomy entry must have a unique identifier. If combining multiple taxonomies with overlapping identifiers, use a prefix to distinguish them. The prefix can be a CURIE which must be resolvable by all software consuming the data.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "name",
"description": "The name of this taxonomy term or category.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": true
}
},
{
"name": "parent_id",
"description": "If this is a child category in a hierarchical taxonomy, give the identifier of the parent category. For top-level categories, this should be left blank.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "should"
},
{
"name": "LGA"
}
],
"constraints": {
"required": false
}
},
{
"name": "parent_name",
"description": "If this is a child category in a hierarchical taxonomy, give the name of the parent category. For top-level categories, this should be left blank.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openCommunity",
"moscow": "could"
}
],
"constraints": {
"required": false
}
},
{
"name": "vocabulary",
"description": "If this is an established taxonomy, detail which taxonomy is in use. For example, AIRS or Open Eligibility.",
"type": "string",
"source": "openReferral",
"applicationProfile": [
{
"name": "openReferral"
},
{
"name": "openCommunity",
"moscow": "must"
}
],
"constraints": {
"required": false
}
}
],
"primaryKey": "id"
}
},
{
"name": "metadata",
"path": "metadata.csv",
"description": "The metadata table contains a record of the changes that have been made to the data in order to maintain provenance information.",
"format": "csv",
"source": "openReferral",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each entry must have a unique identifier",
"type": "string",
"source": "openReferral",
"constraints": {
"required": true
}
},
{
"name": "resource_id",
"description": "Each service, program. location, address, or contact will have a unique identifier. Unique ids are UUIDs.",
"type": "string",
"source": "openReferral",
"constraints": {
"required": true
}
},
{
"name": "last_action_date",
"description": "The date when data was changed.",
"type": "datetime",
"source": "openReferral",
"constraints": {
"required": true
}
},
{
"name": "last_action_type",
"description": "The kind of change made to the data; eg create, update, delete",
"type": "string",
"source": "openReferral",
"constraints": {
"required": true
}
},
{
"name": "field_name",
"description": "The name of field that has been modified",
"type": "string",
"source": "openReferral",
"constraints": {
"required": true
}
},
{
"name": "previous_value",
"description": "The previous value of a field that has been updated",
"type": "string",
"source": "openReferral",
"constraints": {
"required": true
}
},
{
"name": "replacement_value",
"description": "The new value of a field that has been updated",
"type": "string",
"source": "openReferral",
"constraints": {
"required": true
}
},
{
"name": "updated_by",
"description": "The name of the person who updated a value",
"type": "string",
"source": "openReferral",
"constraints": {
"required": true
}
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "resource_id",
"reference": {
"resource": "location",
"fields": "id"
}
},
{
"fields": "resource_id",
"reference": {
"resource": "service",
"fields": "id"
}
},
{
"fields": "resource_id",
"reference": {
"resource": "organization",
"fields": "id"
}
},
{
"fields": "resource_id",
"reference": {
"resource": "program",
"fields": "id"
}
},
{
"fields": "resource_id",
"reference": {
"resource": "postal_address",
"fields": "id"
}
},
{
"fields": "resource_id",
"reference": {
"resource": "physical_address",
"fields": "id"
}
},
{
"fields": "resource_id",
"reference": {
"resource": "contact",
"fields": "id"
}
},
{
"fields": "resource_id",
"reference": {
"resource": "holiday_schedule",
"fields": "id"
}
},
{
"fields": "resource_id",
"reference": {
"resource": "regular_schedule",
"fields": "id"
}
},
{
"fields": "resource_id",
"reference": {
"resource": "phone",
"fields": "id"
}
}
]
}
},
{
"name": "meta_table_description",
"path": "meta_table_descriptions.csv",
"description": "The meta_table_description table contains metadata about individual tables.",
"format": "csv",
"source": "openReferral",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each entry must have a unique identifier",
"type": "string",
"source": "openReferral",
"constraints": {
"required": true
}
},
{
"name": "name",
"description": "",
"type": "string",
"source": "openReferral"
},
{
"name": "language",
"description": "",
"type": "string",
"source": "openReferral"
},
{
"name": "character_set",
"description": "",
"type": "string",
"source": "openReferral"
}
],
"primaryKey": "id"
}
},
{
"name": "cost_option",
"path": "cost_option.csv",
"description": "The cost option table contains 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.",
"applicationProfile": [
{
"name": "LGA"
},
{
"name": "openCommunity",
"moscow": "won't"
}
],
"format": "csv",
"source": "LGA",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each entry must have a unique identifier",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
}
],
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "service_id",
"description": "The identifier of the services for which the entry describes the cost",
"type": "string",
"format": "uuid",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
}
],
"constraints": {
"required": true
}
},
{
"name": "valid_from",
"description": "When this price is valid from",
"type": "date",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
}
]
},
{
"name": "valid_to",
"description": "When this price is valid to",
"type": "date",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
}
]
},
{
"name": "option",
"description": "Conditions associated with the cost option.",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA",
"notes": "e.g.- For the over 60's
- 1st session
"
}
]
},
{
"name": "amount",
"description": "The cost of the option, expresssed as an amount in a currency (expected to be GBP by Open Referral UK).",
"type": "number",
"format": "currency",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
}
]
},
{
"name": "amount_description",
"description": "Specific details qualifying the cost amount, e.g. 'per session'",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
}
]
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "service_id",
"reference": {
"resource": "service",
"fields": "id"
}
}
]
}
},
{
"name": "review",
"path": "reviews.csv",
"description": "The review table contains service reviews made by organizations. This is an LGA Extension table. This table provides a structured version of the text information contained in the 'accreditations' field of the 'service' table.",
"format": "csv",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
}
],
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each entry must have a unique identifier",
"type": "string",
"source": "LGA",
"applicationProfile": [
{ "name": "LGA" },
{
"name": "openCommunity",
"moscow": "could"
}
],
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "service_id",
"description": "The identifier of the services for which the entry describes a review",
"type": "string",
"format": "uuid",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
},
{
"name": "openCommunity",
"moscow": "could"
}
],
"constraints": {
"required": true
}
},
{
"name": "reviewer_organization_id",
"description": "The id to an entry on the 'organization' table to identify the organization that has provided the review",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
},
{
"name": "openCommunity",
"moscow": "could"
}
]
},
{
"name": "title",
"description": "The title of the review",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
},
{
"name": "openCommunity",
"moscow": "could"
}
]
},
{
"name": "description",
"description": "A detailed description of this review",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
},
{
"name": "openCommunity",
"moscow": "could"
}
]
},
{
"name": "date",
"description": "The date of the review",
"type": "date",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
},
{
"name": "openCommunity",
"moscow": "could"
}
]
},
{
"name": "score",
"description": "The review score",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA",
"notes": "e.g. '3 star'"
},
{
"name": "openCommunity",
"moscow": "could"
}
]
},
{
"name": "url",
"description": "A URL were the review can be read",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
},
{
"name": "openCommunity",
"moscow": "could"
}
]
},
{
"name": "widget",
"description": "Code that can be embedded into a web page to give more information about a review.",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
},
{
"name": "openCommunity",
"moscow": "could"
}
]
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "service_id",
"reference": {
"resource": "service",
"fields": "id"
}
},
{
"fields": "reviewer_organization_id",
"reference": {
"resource": "organization",
"fields": "id"
}
}
]
}
},
{
"name": "link_taxonomy",
"path": "link_taxonomy.csv",
"description": "This table enables a taxonomy item to be associated with other classes in the model. This is an LGA Extension table. This table enables a taxonomy item to be associated with other classes in the model.",
"applicationProfile": [
{
"name": "LGA"
},
{
"name": "openCommunity",
"moscow": "won't"
}
],
"format": "csv",
"source": "LGA",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "A unique identifier for the link taxonomy",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
}
],
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "link_type",
"description": "The class that the taxonomy applies to",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
}
],
"constraints": {
"enum": [ "organization", "eligibility", "cost_option", "service_area" ],
"required": true
}
},
{
"name": "eligibility_id",
"description": "",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
}
],
"hidden": true
},
{
"name": "service_area_id",
"description": "",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
}
],
"hidden": true
},
{
"name": "cost_option_id",
"description": "",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
}
],
"hidden": true
},
{
"name": "organization_id",
"description": "",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
}
],
"hidden": true
},
{
"name": "link_id",
"description": "The identifier of the class",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA",
"schemes": [
{
"name": "Organisations",
"uri": "http://id.esd.org.uk/list/organisationTypes",
"required": false
}
]
}
],
"constraints": {
"required": true
}
},
{
"name": "taxonomy_id",
"description": "The identifier of this classification from the taxonomy table.",
"type": "string",
"source": "LGA",
"applicationProfile": [
{
"name": "LGA"
}
],
"constraints": {
"required": true
}
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "eligibility_id",
"reference": {
"resource": "eligibility",
"fields": "id"
}
},
{
"fields": "service_area_id",
"reference": {
"resource": "service_area",
"fields": "id"
}
},
{
"fields": "cost_option_id",
"reference": {
"resource": "cost_option",
"fields": "id"
}
},
{
"fields": "organization_id",
"reference": {
"resource": "organization",
"fields": "id"
}
},
{
"fields": "taxonomy_id",
"reference": {
"resource": "taxonomy",
"fields": "id"
}
}
]
}
}
]
}