Por20349 - HSDS - US and UK

	A	B	C	D	E	F	G	H	I	J	K	L	M	N	O	P	Q	R	S	T	U	V	W	X
1	table	name	type	description	description_amended	format	constraints_required	constraints_unique	constraints_enum	example	core	Review Questions	Review Question Answers	Recommendation (Agreement with the 2.1 Core and 2.1 Full columns)	Open Data Coop	Mike, Skyler and Devin from original drafting session	Rob (211? profile)	Kate	Paul	Ian	Shelby	Sarah	Greg	Devin

2	organization	id	string	Each organization must have a unique identifier.		uuid	true	true		d9d5e0f5-d3ce-4f73-9a2f-4dd0ecc6c610	Y			Y
3	organization	name	string	The official or public name of the organization.			true	false		Example Organization Inc.	Y			Y
4	organization	alternate_name	string	Alternative or commonly used name for the organization.			false	false		Example Org	Y			Y
5	organization	description	string	A brief summary about the organization. It can contain markup such as HTML or Markdown.			true	false		Example Org is a non-profit organization dedicated to providing services to qualified beneficiaries	Y			Y
6	organization	email	string	The contact e-mail address for the organization.		email	false	false		email@example.com	Y			Y
7	organization	website	string	The URL (website address) of the organization.		uri	false	false		http://example.com	Y			Y. Keep this but rename to "website"							TBH i would rename this to website because url might be easilt confused with the below uri field. that might be out of scope though.
8	organization	tax_status	string	Government assigned tax designation for tax-exempt organizations.	DEPRECATED: Government assigned tax designation for tax-exempt organizations.		false	false		tax_status
9	organization	tax_id	string	A government issued identifier used for the purpose of tax administration.	DEPRECATED: A government issued identifier used for the purpose of tax administration.		false	false		tax_id
10	organization	year_incorporated	number	The year in which the organization was legally formed.		%Y	false	false		2011				Y		As above	Required	mandatory
11	organization	legal_status	string	The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.			false	false		legal_status				Y		As above	Required	mandatory
12	organization	logo	string	A URL to an image associated with the organization which can be presented alongside its name.			false	false		https://openreferral.org/wp-content/uploads/2018/02/OpenReferral_Logo_Green-4-1.png				Y				optional, inconistently used for us
13	organization	uri	string	A persistent identifier to uniquely identify the organization.	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.	uri	false	false		http://example.com		We need to decide name for this as the comments say this and the other field should be named website. Named uri for now.		Y. Keep this but rename to website	See note by Paul MacKay on this as well as URL		Note that org IDs are 1-to-many in US (and other) contexts	fine, not required			This is an API spec concern more than a data spec concern. A data record doens't necessarily have a URI but an API resource must. I would expect the URI to be generated at runtime by the API server and then passed in the API response.			Maybe need a topic: "How do we handle URIs and outside datasets."
14	organization	parent_organization_id	string	The identifier of the organization's parent organization			false	false		cd09a387-91f4-4555-94ec-e799c35344cd				Y		Add because it allows for a hierarchical organization structure					agree with supporting hierarchical org structure
15	program	id	string	Each program must have a unique identifier.	The identifier for the program. Each program must have a unique identifier.	uuid	true	true		e7ec2e57-4540-43fa-b2c7-6be5a0ef7f42				Y. Keep as as string (for internal identifiers), but recommend a UUID. Add guidance. for HSDS best practice (maybe even a best practice application profile). Guidance can say how internal IDs can be recored. This applies to ALL ids	Should this be UUID? Maybe we should allow the profiling mechanism to give extra contraint such as being a UUID if this is not explicit.
16	program	organization_id	string	Each program must belong to a single organization. The identifier of the organization should be given here.	The identifier for the organization which the program belongs to. Each program must belong to a single organization, and the identifier for that organization should be given here.		true	true		5978833f-21aa-4235-a56b-7d2f94ce8f35				Y
17	program	name	string	The name of the program			true	false		Community Mental Health Support				Y
18	program	alternate_name	string	An alternative name for the program	If the program has an alternative name it can be given here		false	false		MyCity Mental Health Group				Y
19	program	description	string	A brief summary of the program	A brief and clear summary of the program		true	false		Comprehensive Mental Health Services available to residents of MyCity including CBT and Counselling. This is not an emergency service and should not be used as an alternative to hospital and GP services.				Y
20	service	id	string	Each service must have a unique identifier.	The identifier for the service. Each service must have a unique identifier.	uuid	true	true		ac148810-d857-441c-9679-408f346de14b	Y			Could be a UUID?				ID types should be consistent (all uuid or all string)
21	service	organization_id	string	The identifier of the organization that provides this service.			true	false		0fdfb57f-c147-4cfb-864c-44788a335d8c	Y			Y	UUID?
22	service	program_id	string	The identifier of the program this service is delivered under.			false	false		24682fa0-3eda-4afc-a026-84a21c7a882e				Y	UUID?					If you introduce programs then a service may be part of several
23	service	name	string	The official or public name of the service.			true	false		Community Counselling	Y			Y
24	service	alternate_name	string	Alternative or commonly used name for a service.	If the service has an alternative or commonly used other name, it can be given here.		false	false		MyCity Counselling Servics				Y. Later accommodate multiple descriptions				We have former and alternative name fields, but fine with having just alternate		Is it worth adding several names here and simply suggest using it as part of a search based on name				Multiples could be useful
25	service	description	string	A description of the service.			false	false		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.	Y			Y. Later accommodate multiple descriptions		Consider allowing multiple descriptions so as to accommodate different audiences (e.g. managers and service users)		We do support "extra" descriptions when a record is put into a group / category that allows extra description, but don't care about this for exchange at this time. We also have specialized fields for internal use descriptions (manager's fields)		We definitely need the markup or a lot of quality in making it more readable disappears. I like Shelby's idea of description per audience.	i would support having a plaint ext description and a markup-ed description. i like the idea of having multiple descriptions for multiple audiences, but that sounds like it's getting into more complicated territory - like would we actually need a "description" model that has plain text, markup, audience, and maybe other fields?			Useful to have recommendation for how to include multiples using service_attributes or another table.
26	service	url	string	URL of the service		uri	false	false		http://example.com/counselling	Y			Y
27	service	email	string	Email address for the service	An email address which can be used by WHOM? to contact the service provider.	email	false	false		email@example.com	Y			Y				We often have to keep multiple emails per service (just FYI).
28	service	status	string	The current status of the service.	The current status of the service which can be active, inactive, defunct, or temporarily closed.		true	false	active,inactive,defunct,temporarily closed	active	Y			Y		Keep this as text. It can be an enumeration in a profile		We have multiple, purpose-specific status fields (e.g. deletion date, public status, and so on) that can operate together or independently.		This is needed in the UK. Much better to have enumerated values so that anybody consuming any OR data will know the state of it.
29	service	interpretation_services	string	A description of any interpretation services available for accessing this service.			false	false		Interpretation services are available in Urdu, Polish, and Slovak				Y				Part of language fieldset for us, this is fine			it's unclear to me how this is different than having the languages fields. is this saying that in addition to specific languages supported, you can ask for interpretations ervices for other langs?
30	service	application_process	string	The steps needed to access the service.	A description of the steps needed to access this service.		false	false		If you are an NHS patient please ask your GP for a referral letter, we will then be in touch with you directly. If you are not an NHS patient you should ring our reception to arrange an appointment				Y				mandatory
31	service	fees_description	string	Details of any charges for service users to access this service.			false	false		Non-NHS patients are expected to pay for their counselling sessions. We charge a flat rate per hour of counselling. The current rate is £50 per hour. Please see our website for up to date prices.				Y - should we call this fees_description		Keep but deprecate in favour of cost_option		mandatory for most we keep a seperate element of this fieldset that describes fee assistance programs
32	service	wait_time	string	Time a client may expect to wait before receiving a service.	DEPRECATED: Time a client may expect to wait before receiving a service.		false	false		wait_time
33	service	fees	string	Details of any charges for service users to access this service.	DEPRECATED: Details of any charges for service users to access this service.		false	false		fees_description
34	service	accreditations	string	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.			false	false		All of our practitioners are accredited by the BASC, UKCP, and the Professional Standards Body				Y		Keep but deprecate in favour of review		optional		Yes UK review
35	service	eligibility_description	string	A description of the type of person for whom this service is intended.			false	false		This service is intended for all people aged 12 and over who require counselling services in the MyCity area	Y
36	service	minimum_age	number	The minimum age required to meet this eligibility requirement.	The minimum age of a person required to meet this eligibility requirement.		false	false		12				Y. Not mandatory but recommed 0 or more	If this is required then what we do for age ranges that are for all ages? We could say you should put 0 for min and 999 for max, however that is ugly. A slightly nicer option is to make only mininum age required so that an empty max age will mean any age, so all ages will just be 0 for minimum age and nothing for max age. For 16 and over it will just be 16 in min age only. For under 16 it will be 0-16. We are also loosing the ability to do multiple age ranges which was possible before as you could have multiple eligibility criteria. So another option would be to keep the eligibility table but be called somthing like eligibility_age and just have min max ages in there, but that will add complexity for implenters.	Added (moved from eligibility) as a key attribute that needs to be consistently defined		yes, important, seperate from rest of eligibility info - need to allow fraction (decimal please); blank means no limit
37	service	maximum_age	number	The maximum age required to meet this eligibility requirement.	The maximum age of a person required to meet this eligibility requirement.		false	false		100				Y	Possibly make this not required as above	Added (moved from eligibility) as a key attribute that needs to be consistently defined	(non-211 point: need to be able to distinguish between "no limits" and "no data" without overloading null) Initial idea: min/max null/null = no data, min/max 0/null = no limits	yes, important, seperate from rest of eligibility info - need to allow fraction (decimal please); blank means no limit
38	service	assured_date	date	The date that the information about the service was last checked			false	false		2005-01-01				Defer to discussion on updates and metadata. Make date/time	Should this be datetime?	Wanted in the UK for confirmation as to when the sevice data was last assured, irrespective of any updates made				We need confidence on the data accuracy. The assured date says it met the data quality standards on this date. It gives the consumer a means to risk assess whether to present the data to its audience. e.g. we would not show anything that hadn't been assured in last 3 months.	Agree to keepign this (see assured field convo for orgs)	AIRS is very interested in ensuring these are included.	Should we check on the language? I usually say `verified` although I also put it in the context of "quality assurance" so `assured` might not be wrong per se. Just wondering what's more generally recognizable.
39	service	assurer_email	string	The contact e-mail address for the person or organization which last assured the service.		email	false	false		email@example.com				Defer to discussion on updates and metadata		Wanted in the UK so assurance can be traced back to a person or an organisation				Not bothered where it is held as long as it is for every service. Every service should have an accountable organisation/person. This gives confidence to a consumer and a contact to provide errors or complaints. It is important to the userfulness of OR.		AIRS is very interested in ensuring these are included.
40	service	licenses	string	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	DEPRECATED: An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.		false	false		licences
41	service	alert	string	Notice of any short term alerts concerning the service.	Notice of any short term alerts concerning the service. e.g.		false	false		Following COVID-19 we have moved most of our counselling sessions online. Please contact the reception if you require further information.
42	attribute	id	string	Each service_attribute entry should have a unique identifier.	The identifier of the service_attribute entry. Each service_attribute entry should have a unique identifier.	uuid	true	true		ae58cc39-8b70-4ab1-8aea-786882e5ac8e	Y			See service_attribute note	UUID?
43	attribute	link_id	string	The identifier of the service to which this taxonomy term applies.	The identifier of the entity to which this taxonomy term applies.		true	false		f28dd44b-0c4d-479f-8e90-4c52219a8b3c	Y	This was missed out of review sheet, but is needed?		See service_attribute note. Make link_id and required	UUID?
44	attribute	taxonomy_term_id	string	The identifier of this taxonomy term from the taxonomy table.			true	false		6bd624ce-8512-497a-bcb2-7ce1a5dc1680	Y			See service_attribute note. Make mandatory	Should this be required? as I thought without a taxonomy term an attribute will be meaningless.
45	attribute	link_type	string	What the taxonomy term describes, e.g. the service eligibility or the sevice intended audience. Populate from an enumeration (an open codelist)	A code taken from an enumerated open codelist to indicate what the taxonomy term describes e.g. the service eligibility or intended audience.		false	false		link_type	Y			See service_attribute note. We nedd link entity and link_type.		Add this field to denote what type of service attribute the taxonomy term relates to. Values to come form an enumeration (an open codelist)
46	attribute	link_entity	string	The table of the link_id			true	false		link_entity	Y	is an enumeration of tables needed?		ODSC to recommend how this can be used
47	attribute	value	string	The value (if any) of an attribute			false	false		value	Y			See service_attribute note		Add this field so attributes can optionally have values whose units are defined by the taxonomy term
48	service_at_location	id	string	Each entry must have a unique identifier.	The identifier of the entry. Each entry must have a unique identifier.	uuid	true	true		e94c9f38-1e8f-4564-91d4-d53501ab1765	Y			Y	UUID?
49	service_at_location	service_id	string	The identifier of the service at a given location.			true	false		ab231982-2106-4a55-80fc-b305560c5556	Y			Y	UUID?
50	service_at_location	location_id	string	The identifier of the location where this service operates.			true	false		2528e812-ccbb-43a7-b761-a90f27ea9ac4	Y			Y	UUID?
51	service_at_location	description	string	Any additional information that should be displayed to users about the service at this specific location.			false	false		description				Y		Added to the UK version in case it might be useful
52	location	id	string	Each location must have a unique identifier	The identifier of the location. Each location must have a unique identifier.	uuid	true	true		3a19ff88-4620-4d17-9830-ac1d859eb5d5	Y				UUID?
53	location	location_type	string	Enumeration of physical, postal, virtual	The type of location, which may be either physical, postal, or virtual.		true	false	physical,virtual	physical	Y	From notes it says we should delete this. Shall we?		We may need combinations of types. DEELETE THIS.	Do we have an intial list/recommended list of these types? Do we leave them to be extended by the profiles? Or, could this be handled taxonomincally?	Enumerated type to denote if a location is physical, postal only or virtual				This could replace attending type.
54	location	url	string	The URL of a virtual location	If location_type is virtual, then this field represents the URL of a virtual location.	uri	false	false		http://example.com	Y					Added to properly accommodate virtual locations				Should there not be a telephone number for a telephone service?
55	location	organization_id	string	Each location entry should be linked to a single organization. This is the organization that is responsible for maintaining information about this location. The identifier of the organization should be given here. Details of the services the organization delivers at this location should be provided in the services_at_location table.	The organization identifier for a location. This is the organization that is responsible for maintaining information about this location. The identifier of the organization should be given here. Details of the services the organization delivers at this location should be provided in the services_at_location table.		false	false		985e4a42-bd9f-4edc-911d-0243a4640aca					UUID?					Could consider differentiating location organisations from provider organisations (and review organisations)
56	location	name	string	The name of the location			false	false		MyCity Civic Center	Y
57	location	alternate_name	string	An alternative name for the location	If the location has an alternative name then it may be given here.		false	false		Civic Center
58	location	description	string	A description of this location.			false	false		MyCity Civic Center is located on Main Street and contains facilities for a number of civic and community services available.	Y
59	location	transportation	string	A description of the access to public or private transportation to and from the location.			false	false		MyCity Civic Center is serviced by the number 1 Bus and is a short walk from the Main Street Metro Station
60	location	latitude	number	Y coordinate of location expressed in decimal degrees in WGS84 datum.			false	false		100	Y
61	location	longitude	number	X coordinate of location expressed in decimal degrees in WGS84 datum.			false	false		101	Y
62	location	external_identifier	string	Third party identfier of a location e.g. UK UPRN or what3words	A third party identifier for a location which can be drawn from other services e.g. UK UPRN or what3words.		false	false		///cheer.parent.mole						UPRN is required by UK government. It's probably not relevant outside the UK, but other identifiers might be
63	location	external_identifier_type	string	Enumeration including UPRN, what3words and others	The scheme used for the location's external_identifier e.g. UK UPRN or what3words.		false	false		what3words						URPN should be used where available in the UK
64	phone	id	string	Each entry must have a unique identifier	The id for a phone number. Each entry must have a unique identifier.	uuid	true	true		1554f2e2-a373-45db-a3fa-9fc48a61c15e	Y			Y	UUID?
65	phone	location_id	string	The identifier of the location where this phone number is located			false	false		3133fbc3-469a-4ab7-9158-421acfe66229				Y	UUID?
66	phone	service_id	string	The identifier of the service for which this is the phone number			false	false		9d2104f3-b9b2-4719-a85d-743fc62714a6				Y	UUID?
67	phone	organization_id	string	The identifier of the organization for which this is the phone number			false	false		c1066581-4d59-45c7-9072-40e745e3c98c				Y	UUID?
68	phone	contact_id	string	The identifier of the contact for which this is the phone number			false	false		52fd7852-8f0e-4b5e-9d93-ff96386096c4	Y			Y	UUID?
69	phone	service_at_location_id	string	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.			false	false		a4edb74e-c262-4379-bf87-2bf90f6f4803				Y	UUID?
70	phone	number	string	The phone number			true	false		"+44 1234 234567"	Y			Y
71	phone	extension	number	The extension of the phone number			false	false		100				Y
72	phone	type	string	Indicates the type of phone service, drawing from the RFC6350 list of types (text (for SMS), voice, fax, cell, video, pager, textphone).			false	false		voice				Y
73	phone	description	string	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.			false	false		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.
74	contact	id	string	Each contact must have a unique identifier	The identifier for the contact. Each contact must have a unique identifier.	uuid	true	true		1e7efce3-639b-4880-940c-b95cd30cdb50	Y			Y	UUID?
75	contact	organization_id	string	The identifier of the organization for which this is a contact			false	false		ae67a707-5893-4225-b0b1-320ab9cb596b				Y	UUID?
76	contact	service_id	string	The identifier of the service for which this is a contact			false	false		46f31178-dbb7-45e4-be37-c69320e08c36	Y			Y	UUID?
77	contact	service_at_location_id	string	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.			false	false		93eaf18d-1cd2-4ec7-bffb-3c9172ee5070				Y	UUID?
78	contact	location_id	string	The identifier for the location_id when the location of the contact is relevant.	The identifier for the location_id when the location of the contact is relevant.		false	false		2226a1e5-7ff1-4c46-a5fb-955304b05917				Y	UUID?
79	contact	name	string	The name of the person	The name of the contact.		false	false		Ann Persona	Y			Y There may be a separate contact organisation, not linked to the organisation - done in a local extension
80	contact	title	string	The job title of the person	The job title of the contact.		false	false		Reception Manager	Y			Y
81	contact	department	string	The department that the person is part of	The department that the contact is a part of.		false	false		Reception				Y				not used
82	contact	email	string	The email address of the person	The email address of the contact.	email	false	false		email@example.com				Y
83	address	id	string	Each postal address must have a unique identifier	The id of the postal address. Each postal address must have a unique identifier.	uuid	true	true		74706e55-df26-4b84-80fe-ecc30b5befb4	Y			Y	UUID?
84	address	location_id	string	The identifier of the location for which this is the postal address.			false	false		d57b7ee4-9bcf-4351-858b-c42860beb869	Y			Y	UUID?
85	address	attention	string	The person or entity whose attention should be sought at the location (Often included as ‘care of’ component of an address.)	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.		false	false		A. Persona	Y			Y
86	address	address_1	string	The first line(s) of the address, including office, building number and street.			true	false		1-30 Main Street	Y			Y
87	address	address_2	string	A second (additional) line of address information.			false	false		address_2				Y
88	address	city	string	The city in which the address is located.			true	false		MyCity	Y			Y
89	address	region	string	The region in which the address is located (optional).			false	false		region	Y			Y
90	address	state_province	string	The state or province in which the address is located.			true	false			Y			Y
91	address	postal_code	string	The postal code for the address.			true	false		postal_code	Y			Y
92	address	country	string	The country in which the address is located. This should be given as an ISO 3361-1 country code (two letter abbreviation)			true	false		US	Y			Y
93	address	address_type	string	Enumeration of physical, postal, virtual	The type of address which may be physical, postal, or virtual.		true	false	physical,postal	postal	Y			Y. Recommend an enumeration. Consider how profiles work to extend enumerations or add them.	Is this a fixed enumeration or should we allow profiles to add more?
94	schedule	id	string	Each entry must have a unique identifier	The identifier for the schedule. Each entry must have a unique identifier.	uuid	true	true		48102e86-bb50-41c4-8f1e-e269368c41d1	Y			Y	UUID?
95	schedule	service_id	string	The identifier of the service for which this is the regular schedule			false	false		ae8b7eaf-7e7d-4128-a403-ae097f146356	Y			Y	UUID?
96	schedule	location_id	string	The identifier of the location for which this is the regular schedule			false	false		dd9e501b-4df9-4e71-85ac-29748e7e2d5a				Y	UUID?
97	schedule	service_at_location_id	string	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.			false	false		0a41a90a-b5a5-4541-87e2-5cc2fd72536b	Y			Y	UUID?
98	schedule	valid_from	date	The date from which the schedule information is valid.	The date from which the schedule information is valid. It must be in the ISO 8601 format of YYYY-MM-DD		false	false		2005-01-01	Y			Y
99	schedule	valid_to	date	The last date on which the schedule information is valid.	The last date on which the schedule information is valid. It must be in the ISO 8601 format of YYYY-MM-DD		false	false		2005-01-01	Y			Y
100	schedule	dtstart	date	iCal - The date of the first event is the schedule. Necessary when using the ‘interval’ feature, optional otherwise.			false	false		2005-01-01	Y			Y