Skip to content

Commit

Permalink
Merge branch '3.1-dev' into PATCH-add-enums-to-field-descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
mrshll1001 authored Sep 5, 2024
2 parents 69ad74d + 2117655 commit c000d1e
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 8 deletions.
6 changes: 6 additions & 0 deletions docs/about/license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
License
===============

The content of this documentation site, the HSDS schema files, and associated artefacts found in the [specification repository](https://github.com/openreferral/specification) are released under the [CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) license.

Other artifacts produced by Open Referral such as software, literature, or graphics (among other things) may be released under different licenses more appropriate for that domain. Open Referral strives to embody our [core values](https://openreferral.org/about/our-values-and-principles/) of *Accessibility*, *Interoperability*, *Reliability*, and *Sustainability* through the licensing we choose for our projects.
16 changes: 8 additions & 8 deletions docs/hsds/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,12 +123,12 @@ TODO: update link to this
* Bug fixes to schema and documentation
* Removed redundant documentation pages

## [v1.0](https://docs.google.com/document/d/1dkipRm_YL3K28oTSG-NFZRMHYiv10ZZJzJlakZglOyc/edit?usp=sharing)
## [v1.0](https://github.com/openreferral/specification/releases/tag/1.0)

* Final version
* Changed relationship between location and service from 1:n to n:m

## [v0.9](https://docs.google.com/document/d/1jbgO92cPAUygQI-0_DtLXrdPQKbPNNIkxDr-3WvdFNE/edit?usp=sharing)
## v0.9

* Changes based on public comments in v0.8 include:
- revising revising schedule entities and attributes as recommended,
Expand All @@ -138,11 +138,11 @@ TODO: update link to this
* Released on github as a markdown document
* Added a datapackage.json example on github

## [v0.8](https://docs.google.com/document/d/1gmNS4pBvkX4cI2wtH3Qco3uGF4LLTq1OJ0Pb_CLuxlk/edit?usp=sharing)
## v0.8

* Added formatting specification for address, phone, description

## [v0.4 - v0.7](https://docs.google.com/document/d/1xTqNm3ShgL6vQtknMmkCNJeWapekrLxd1qpEa8WiEIk/edit?usp=sharing)
## v0.4 - v0.7

* Updated data model based on reviewer comments
* Tested logical model by importing data from iCarol database
Expand All @@ -151,15 +151,15 @@ TODO: update link to this
* Tested OE taxonomy by querying the service_taxonomy to return the related service
* Provided test scripts and example data

## [v0.3](https://docs.google.com/document/d/1RH89UY7FDndivWNmtQkql4tdRTwYnCZluyu8itp5nTw/edit?usp=sharing)
## v0.3

* Refined logical model to conform to Boyce-Codd third normal form
* Updated datapackage.json to match logical model
* Included enumerations for entities in datapackage.json
* Added section on NIEM and relation to specification
* Made changes based on reviewer comments

## [v0.2](https://docs.google.com/document/d/1z4jSLCoDIqvkKnazZVH_7qP_5HkcgKhnPJLu1mUZBgA/edit?usp=sharing)
## v0.2

* Added related standards
* Added use cases based on persona
Expand All @@ -168,11 +168,11 @@ TODO: update link to this
* Made changes from [comments](https://docs.google.com/spreadsheets/d/19Sf7DPMooO6edEm8FcIjSv6VeC1Ar55YDBvLTl-S4dE/edit?usp=sharing) collected during the second RFC period
* Added Appendix C: Tabular Data Package description

## [v0.1](https://docs.google.com/document/d/18vdB0DUvBfp6UcYQ78KaMmN3Ei2riThJL48V7TTOHHQ/edit?usp=sharing)
## v0.1

* Changes from comment period, workshop comments, and a running [summary of comments](https://docs.google.com/spreadsheets/d/19Sf7DPMooO6edEm8FcIjSv6VeC1Ar55YDBvLTl-S4dE/edit?usp=sharing)
* Directly references [RFC4180](http://tools.ietf.org/html/rfc4180) for CSV formatting

## [v0.0](https://docs.google.com/document/d/1RwHkuPeG5cztk-gcofuqsXRxWaTYZeHa8mLjC2doCwk/edit?usp=sharing)
## v0.0

No changes.
14 changes: 14 additions & 0 deletions docs/hsds/database_schemas.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Database Schemas
=================

```{note}
This page is *non-normative*, which means that it doesn't form part of the standard; if there is any ambiguity, the standard takes precedence. This page may be updated at any time in response to community demand.
```

HSDS is an exchange format designed to standardise the format for outputting machine-readable data about human services. Therefore systems which output HSDS are not expected to maintain a particular internal database or storage schema. As long as your published data matches HSDS – you can design your systems to operate however you wish.

This being established, we provide some pre-rolled database schemas in order to support people and organizations bootstrapping systems which will work with HSDS data. We provide these in the form of `.sql` query files which — when executed in an appropriate environment — will generate database schemas with tables useful for storing and retrieving HSDS data. We geneate these files directly from the HSDS schema files, so they update as we release new versions of the specification.

You can find the latest version of these files in the `/database` directory of the HSDS Specification Github repository. We provide versions for each SQL and PostgreSQL format databases. The files for HSDS version 3.1 are linked below:

* [Database schemas for HSDS 3.1](https://github.com/openreferral/specification/tree/3.1/database)
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ Contents:
hsds/extending
hsds/using_profiles
hsds/field_guidance
hsds/database_schemas
.. toctree::
:maxdepth: 1
Expand All @@ -96,5 +97,6 @@ Contents:
about/specification-governance
about/credits
about/privacy-notice
about/license
```

0 comments on commit c000d1e

Please sign in to comment.