You can choose which version of the standard this page describes.

This is the latest version of the standard and is recommended for all users.

Data model (v3.0)

The ORUK specification defines the following data entities.

This information is also available as an entitiy relation diagram [SVG, 132k].

accessibility

The details of the arrangements for access to locations for people who have disabilities.
Details

Schema

id
Identifier
required
unique
The identifier for this accessibility information. Each entry must have a unique identifier.
string: uuid e.g.: afcf296e-1cb2-4139-9c88-33d587d1a50b
location_id
Location Identifier
The identifier for the location of the accessibility provision.
string: uuid of locatione.g.: 3a19ff88-4620-4d17-9830-ac1d859eb5d5
description
Description
A free text description of the assistance or infrastructure that facilitates access to clients with disabilities.
stringe.g.: The building is equipped with induction loops for hearing aids. Wheelchair access is possible on all levels.
details
Details
Any further details relating to the relevant accessibility arrangements at this location.
stringe.g.: Switch hearing aid to T-coil to access the induction loop facility.
url
URL
The URL of a page giving more information about the accessibility of the location.
string: urie.g.: http://example.com
attributes
Attributes
A link between a service and one or more classifications that describe the nature of the service provided.
array: of instances of attribute
accessibility
Accessibility
Description of assistance or infrastructure that facilitate access to clients with disabilities.
stringe.g.: The building is equipped with induction loops for hearing aids. Wheelchair access is possible on all levels.

address

The addresses table contains the physical addresses for locations
Details

Schema

id
Identifier
required
unique
The identifier of the postal address. Each postal address must have a unique identifier.
string: uuid e.g.: 74706e55-df26-4b84-80fe-ecc30b5befb4
location_id
Location Identifier
The identifier of the location for this postal address.
string: uuid of locatione.g.: 3a19ff88-4620-4d17-9830-ac1d859eb5d5
attention
Attention
The name of the person or entity whose attention should be sought at the location. These are often included as a "care of" component of an address.
stringe.g.: A. Persona
address_1
Address line 1
required
The first line(s) of the address, including office, building number and street.
stringe.g.: 1-30 Main Street
city
City
required
The city in which the address is located.
stringe.g.: MyCity
region
Region
The region in which the address is located (optional).
stringe.g.: MyRegion
state_province
State Or Province
required
The state or province in which the address is located.
stringe.g.: MyState
postal_code
Postal Code
required
The postal code for the address.
stringe.g.: ABC 1234
country
Country
required
The country in which the address is located. This should be given as an ISO 3361-1 country code (two letter abbreviation).
stringe.g.: US
address_type
Address Type
required
The type of address which may be physical, postal, or virtual.
string: physical | postal | virtuale.g.: postal
attributes
Attributes
A link between a service and one or more classifications that describe the nature of the service provided.
array: of instances of attribute

attribute

The other_attributes table creates a link between entities other than service and one or more classifications that describe the entity.
Details

Schema

id
Identifier
required
unique
The identifier of the attribute entry. Each attribute entry should have a unique identifier.
string: uuid e.g.: ae58cc39-8b70-4ab1-8aea-786882e5ac8e
link_id
Link Identifier
required
The identifier of the entity to which this taxonomy term applies.
string: uuid e.g.: f28dd44b-0c4d-479f-8e90-4c52219a8b3c
taxonomy_term_id
Taxonomy Term Identifier
required
The identifier of this taxonomy term from the taxonomy table.
string: uuid of taxonomy_terme.g.: 3f7b145d-84af-42d7-8fae-eaca714b02b2
link_type
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.
stringe.g.: link_type
taxonomy_term
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.
object: taxonomy_term

contact

The details of the named contacts for services and organizations.
Details

Schema

id
Identifier
required
unique
The identifier for the contact. Each contact must have a unique identifier.
string: uuid e.g.: 1e7efce3-639b-4880-940c-b95cd30cdb50
service_id
Service Identifier
The identifier of the service for which this is a contact.
string: uuid of servicee.g.: ac148810-d857-441c-9679-408f346de14b
name
Name
The name of the contact.
stringe.g.: Ann Persona
title
Title
The job title of the contact.
stringe.g.: Reception Manager
attributes
Attributes
A link between a service and one or more classifications that describe the nature of the service provided.
array: of instances of attribute

cost_option

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.
Details

Schema

id
Identifier
required
unique
The identifier for the cost option. Each entry must have a unique identifier
string: uuid e.g.: 1fdf4d39-3d80-484d-9f92-a8ffa08621e7
service_id
Service Identifier
required
The identifier of the services for which the entry describes the cost.
string: uuid of servicee.g.: ac148810-d857-441c-9679-408f346de14b
valid_from
Valid From
The date when this price is valid from.
stringe.g.: 2020-01-01
valid_to
Valid To
The date when this price is valid to.
stringe.g.: 2022-12-31
option
Option
Conditions associated with the cost option.
stringe.g.: Under 18s and Over 60s
amount
Amount
The cost of the option, expressed as an amount.
numbere.g.: 35
amount_description
Amount Description
Specific details qualifying the cost amount.
stringe.g.: per 1 hour session

funding

The sources of funding for a service or organization.
Details

Schema

id
Identifier
required
unique
The identifier for the funding. Each entry must have a unique identifier.
string: uuid e.g.: 1f2df32c-bf08-4b8e-bd6f-e834014b19bc
service_id
Service Identifier
The identifier of the service in receipt of this funding.
string: uuid of servicee.g.: ac148810-d857-441c-9679-408f346de14b
source
Source
A free text description of the source of funds for this organization or service.
stringe.g.: 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

language

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

Schema

id
Identifier
required
unique
The identifier for the language. Each entry must have a unique identifier.
string: uuid e.g.: 2989d3ed-c547-48f8-8f9d-432d81c7892e
service_id
Service Identifier
The identifier of the service for which the entry describes the languages in which services are delivered.
string: uuid of servicee.g.: ac148810-d857-441c-9679-408f346de14b
phone_id
Phone Identifier
The identifier of the phone for which the entry describes the languages in which services delivered.
string: uuid of phonee.g.: 1554f2e2-a373-45db-a3fa-9fc48a61c15e

location

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

Schema

id
Identifier
required
unique
The identifier of the location. Each location must have a unique identifier.
string: uuid e.g.: 3a19ff88-4620-4d17-9830-ac1d859eb5d5
location_type
Location Type
required
The type of location, which may be either physical, postal, or virtual.
string: physical | postal | virtuale.g.: physical
name
Name
The name of the location.
stringe.g.: MyCity Civic Center
description
Description
A free text description of the location.
stringe.g.: MyCity Civic Center is located on Main Street and contains facilities for a number of civic and community services available.
latitude
Latitude
The latitude of the location expressed in decimal degrees in WGS84 datum.
numbere.g.: 100
longitude
Longitude
The longitude of the location expressed in decimal degrees in WGS84 datum.
numbere.g.: 101
external_identifier
External Identifier
A third party identifier for the location, which can be drawn from other services e.g. UK UPRN.
stringe.g.: 10092008082
external_identifier_type
External Identifier Type
The scheme used for the location's external_identifier e.g. UK UPRN.
stringe.g.: UPRN
addresses
Addresses
The addresses of locations where organizations operate.
array: of instances of address
accessibility
Accessibility
The details of the arrangements for access to locations for people who have disabilities
array: of instances of accessibility
attributes
Attributes
A link between a service and one or more classifications that describe the nature of the service provided.
array: of instances of attribute

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.
Details

Schema

id
Identifier
required
unique
The identifier for the organization. Each organization must have a unique identifier.
string: uuid e.g.: d9d5e0f5-d3ce-4f73-9a2f-4dd0ecc6c610
name
Name
required
The official or public name of the organization.
stringe.g.: Example Organization Inc.
description
Description
required
A free text description containing a brief summary about the organization. It can contain markup such as HTML or Markdown.
stringe.g.: Example Org is a non-profit organization dedicated to providing services to qualified beneficiaries
email
Email
The contact e-mail address for the organization.
string: emaile.g.: email@example.com
website
Website
The URL (website address) of the organization.
string: urie.g.: http://example.com
logo
Logo
A URL to an image associated with the organization which can be presented alongside its name.
stringe.g.: https://openreferral.org/wp-content/uploads/2018/02/OpenReferral_Logo_Green-4-1.png
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.
string: urie.g.: http://example.com
parent_organization_id
Parent Organization Identifier
The identifier of the organization's parent organization.
string: uuid e.g.: cd09a387-91f4-4555-94ec-e799c35344cd
organization_identifiers
Organization Identifiers
The details of the third party identifiers for organizations, such as: company registration number, charity number, tax registration number.
array: of instances of organization_identifier
attributes
Attributes
A link between a service and one or more classifications that describe the nature of the service provided.
array: of instances of attribute

organization_identifier

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

Schema

id
Identifier
required
unique
The identifier for this organization identifier entry. Each entry must have a unique identifier.
string: uuid e.g.: d4dbcebc-0802-47cb-8651-b937ac4f2f3e
organization_id
Organization Identifier
required
The identifier of the organization. This should match the uuid of an organization object.
string: uuid of organizatione.g.: d9d5e0f5-d3ce-4f73-9a2f-4dd0ecc6c610
identifier_scheme
Identifier Scheme
The scheme of the third party identifier, according to http://org-id.guide/.
stringe.g.: GB-COH
identifier_type
Identifier Type
required
A human-readable equivalent of the identifier_scheme. This may be used in cases where org-id.guide does not list an appropriate identifier scheme.
stringe.g.: Company number
identifier
Third Party Identifier
required
The third-party identifier value.
stringe.g.: 1234567
attributes
Attributes
A link between a service and one or more classifications that describe the nature of the service provided.
array: of instances of attribute

phone

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

Schema

id
Identifier
required
unique
The identifier for the phone number. Each entry must have a unique identifier.
string: uuid e.g.: 1554f2e2-a373-45db-a3fa-9fc48a61c15e
contact_id
Contact Identifier
The identifier of the contact for which this is the phone number.
string: uuid of contacte.g.: 1e7efce3-639b-4880-940c-b95cd30cdb50
number
Number
required
The phone number.
stringe.g.: "+44 1234 234567"
description
Description
A free text description providing extra information about the phone service
stringe.g.: 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
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.
array: of instances of language

schedule

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

Schema

id
Identifier
required
unique
The identifier for the schedule. Each entry must have a unique identifier.
string: uuid e.g.: 48102e86-bb50-41c4-8f1e-e269368c41d1
service_id
Service Identifier
The identifier of the service for which this is the regular schedule
string: uuid of servicee.g.: ac148810-d857-441c-9679-408f346de14b
service_at_location_id
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.
string: uuid of service_at_locatione.g.: e94c9f38-1e8f-4564-91d4-d53501ab1765
valid_from
Valid From
The date from which the schedule information is valid. It must be in the ISO 8601 format of YYYY-MM-DD,
stringe.g.: 2005-01-01
valid_to
Valid To
The last date on which the schedule information is valid. It must be in the ISO 8601 format of YYYY-MM-DD.
stringe.g.: 2005-01-01
dtstart
Date Start
iCal - The date of the first event is the schedule. Necessary when using the ‘interval’ feature, optional otherwise.
stringe.g.: 2005-01-01
freq
Frequency
iCal - How often the frequency repeats.
string: WEEKLY | MONTHLYe.g.: WEEKLY
interval
Interval
iCal - How often the frequency repeats. For example, and Interval of 2 for a WEEKLY Frequency would represent fortnightly.
numbere.g.: 1
byday
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
stringe.g.: TH,FR
bymonthday
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.
stringe.g.: 2,3,4
description
Description
A free text description of the availability of the service.
stringe.g.: The service is available from 10 am to 6pm weekdays. The service is not available on public holidays.
opens_at
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.)
stringe.g.: 10:00:00
closes_at
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.).
stringe.g.: 18:00:00
schedule_link
Schedule Link
URL of a link for the schedule which may show each individual session and may provide a booking facility.
string: urie.g.: http://example.com
attending_type
Attending Type
A free text description of how to attend this service.
stringe.g.: You can attend this service in-person or remotely via video conferencing
notes
Notes
Free text notes on the schedule.
stringe.g.: Some of our staff will be unavailable during their lunch break which may be any 30 minute period between 1200 and 1400

service

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

Schema

id
Identifier
required
unique
The identifier for the service. Each service must have a unique identifier.
string: uuid e.g.: ac148810-d857-441c-9679-408f346de14b
organization_id
Organization Identifier
required
The identifier of the organization that provides this service.
string: uuid of organizatione.g.: d9d5e0f5-d3ce-4f73-9a2f-4dd0ecc6c610
name
Name
required
The official or public name of the service.
stringe.g.: Community Counselling
description
Description
A free text description of the service.
stringe.g.: 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
URL
URL of the service
string: urie.g.: http://example.com/counselling
email
Email
An email address which can be used to contact the service provider.
string: emaile.g.: email@example.com
status
Status
required
The current status of the service which can be active, inactive, defunct, or temporarily closed.
string: active | inactive | defunct | temporarily closede.g.: active
fees
Fees
DEPRECATED: Details of any charges for service users to access this service.
stringe.g.: fees_description
accreditations
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.
stringe.g.: All of our practitioners are accredited by the BASC, UKCP, and the Professional Standards Body
minimum_age
Minimum Age
The minimum age of a person required to meet this eligibility requirement.
numbere.g.: 12
maximum_age
Maximum Age
The maximum age of a person required to meet this eligibility requirement.
numbere.g.: 100
assured_date
Assured Date
The date that the information about the service was last checked.
stringe.g.: 2005-01-01
assurer_email
Assurer Email
The contact e-mail address for the person or organization which last assured the service.
string: emaile.g.: email@example.com
alert
Alert
A description of any short term alerts concerning the service.
stringe.g.: Following COVID-19 we have moved most of our counselling sessions online. Please contact the reception if you require further information.
last_modified
Last Modified
The datetime when the service, or any related information about the service, has changed. Should have millisecond accuracy.
string: date-timee.g.: 2023-03-15T10:30:45.123Z
schedules
Schedules
The details of when a service or location is open. Entries are RFC 5545 RRULES.
array: of instances of schedule
service_areas
Service Areas
The details of the geographic area for which a service is available.
array: of instances of service_area
service_at_locations
Service At Locations
A link between a service and a specific location.
array: of instances of service_at_location
languages
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.
array: of instances of language
organization
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.
object: organization
funding
Funding
The sources of funding for a service or organization.
array: of instances of funding
cost_options
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.
array: of instances of cost_option
contacts
Contacts
The details of the named contacts for services and organizations.
array: of instances of contact
attributes
Attributes
A link between a service and one or more classifications that describe the nature of the service provided.
array: of instances of attribute

service_area

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

Schema

id
Identifier
required
unique
The identifier for the service area. Each service area must have a unique identifier.
string: uuid e.g.: 381c64f1-a724-4884-9c21-ac96c21cca3e
service_id
Service Identifier
The identifier of the service for which this entry describes the service area
string: uuid of servicee.g.: ac148810-d857-441c-9679-408f346de14b
name
Name
A free text geographic area where a service is available.
stringe.g.: 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.
extent
Extent
A definition of the polygon defining the area.
stringe.g.: extent
extent_type
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".
stringe.g.: geojson
uri
URI
A URI which acts as a persistent identifier to identify an area.
stringe.g.: http://example.com
service_area
Service Area
A free text geographic area where a service is available.
stringe.g.: 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.

service_at_location

A link between a service and a specific location.
Details

Schema

id
Identifier
required
unique
The identifier of the service at location entry. Each entry must have a unique identifier.
string: uuid e.g.: e94c9f38-1e8f-4564-91d4-d53501ab1765
service_id
Service Identifier
required
The identifier of the service at a given location.
string: uuid of servicee.g.: ac148810-d857-441c-9679-408f346de14b
location_id
Location Identifier
required
The identifier of the location where this service operates.
string: uuid of locatione.g.: 3a19ff88-4620-4d17-9830-ac1d859eb5d5
location
Location
The details of the locations where organizations operate. Locations may be virtual, and one organization may have many locations.
object: location

taxonomy

The taxonomies from which taxonomy terms are taken.
Details

Schema

id
Identifier
required
unique
The identifier of the taxonomy. Each entry must have a unique identifier
string: uuid e.g.: 5c4d79d7-cc55-470e-9f1f-8cad074e4892
name
Name
required
The name of the taxonomy from which terms are sourced.
stringe.g.: name
description
Description
required
A free text description of the taxonomy.
stringe.g.: description
uri
URI
The URI of the taxonomy.
string: urie.g.: http://example.com
version
Version
The version of the taxonomy.
stringe.g.: version
taxonomy_terms
Taxonomy Terms
A link between a taxonomy and one or more taxonomy terms.
array: of instances of taxonomy_term

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.
Details

Schema

id
Identifier
required
unique
The identifier for this taxonomy term. Each taxonomy term must have a unique identifier, within the scope of the dataset.
string: uuid e.g.: 3f7b145d-84af-42d7-8fae-eaca714b02b2
name
Name
required
The taxonomy term itself.
stringe.g.: name
description
Description
required
A free text description of the term.
stringe.g.: description
parent_id
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.
string: uuid e.g.: 0bc248fa-dc27-4650-9ba4-8f1a24ef16a2
taxonomy
Taxonomy
If this is an established taxonomy, a free text description of which taxonomy is in use. If possible, provide a URI.
stringe.g.: taxonomy
taxonomy_id
Taxonomy Identifier
The identifier of the taxonomy containing the term.
string: uuid of taxonomye.g.: 07ff6aee-a219-438c-b694-d2fcb6c5373b
term_uri
Term URI
URI of the term.
string: urie.g.: http://example.com
term
Term
The taxonomy term itself.
stringe.g.: name
Classes
  1. accessibility
  2. address
  3. attribute
  4. contact
  5. cost_option
  6. funding
  7. language
  8. location
  9. organization
  10. organization_identifier
  11. phone
  12. schedule
  13. service
  14. service_area
  15. service_at_location
  16. taxonomy
  17. taxonomy_term