openreferral / specification

The Human Services Data Specification - a data exchange format developed by the Open Referral Initiative
https://openreferral.org
Other
117 stars 49 forks source link

tables in repo specification but can't find it in the specification, docs describe # Version 1.1 but the github page has # Version 1.2; #217

Closed japrogramer closed 10 months ago

japrogramer commented 4 years ago

In there is no "categories" table mentioned http://docs.openreferral.org/en/latest/hsds/reference/

but https://github.com/openreferral/specification/blob/master/database/hsda_core.sql has such a table that isn't referenced by other tables.

There also seems to be a Fee table that is not in the spec .. ill edit this comment if I find others.

Edit: so Far

japrogramer commented 4 years ago

also some tables have id must be unique, some say uuid but others don't .. is it ok to use all as UUID?

Edit: also note this link http://docs.openreferral.org/en/latest/hsds/about/reference.md is referenced in http://docs.openreferral.org/en/latest/hsds/about/ as the reference impl but it is broken

japrogramer commented 4 years ago

It seems that the docs describe # Version 1.1 but the github sql file has # Version 1.2 of HSDS and github datapackage.json is "version":"1.1.1",

greggish commented 4 years ago

@japrogramer thanks for the sharp eye, and for the issues.

First off, I fixed the link to the reference implementation, appreciate the heads up.

Next, I think the ID issue has been flagged at #199, in which case it's slated to be patched in the current upgrade cycle by @robredpath. please take a look to confirm. I also assume we'd clean up the versioning confusion that you mention in the current cycle.

Finally, we should look into those inconsistencies w/r/t the tables you mentioned. I think categories is misnamed from taxonomy but I'm not sure. We do have fees and interpretation_services in the spec as fields, not tables. Users may be specific to HSDA (the API protocols) and not HSDS. We'll have to ask @kinlane for this.

I appreciate the input and thank you in advance for your patience!

kinlane commented 4 years ago

HSDA is all taxonomy - http://docs.openreferral.org/en/latest/hsda/hsda-taxonomy/

greggish commented 4 years ago

@kinlane can you clarify the Categories table?

And, it seems like the API specs refer to fee and interpretation_service as tables, when in the spec they're fields. (I know some implementations have expanded these into tables, but I don't think we'd made that change to HSDS...)

kinlane commented 4 years ago

The hsda_core.sql referenced above appears to be a MySQL dump from an older specific implementation. The HSDS spec should dictate the data structure, and the HSDA spec should dictate the API access to that schema. We should clean that up to reduce confusion, and add to list of work to maintain specific table dumps for MySQL, PostGres, and SQL Server.

MikeThacker1 commented 4 years ago

In the UK our SchemaGenerator code (see https://github.com/OpenReferralUK/human-services/blob/master/SchemaGenerator/README.md ) will generate the SQL from a tabular data package.

This may also exist elsewhere. We use MySQL. I'm not sure if/how it differs for PostGres and SQL Server

kinlane commented 4 years ago

I can generate an update to MySQL package once I get a fresh view of the current version. I will try to make sure it doesn't get lost in the shuffle like the one you came across did.

mrshll1001 commented 10 months ago

I am closing this because I believe that HSDS has moved on in its modelling and the discussion no longer is directly relevant to 3.0 and beyond. Please reopen if this is a mistake on my part!