Requirements - servinglynk/hslynk-open-source-docs GitHub Wiki
Table of Contents
Overall System Requirements
HMIS Requirements
HMIS Reporting Requirements
Coordinated Housing Entry System (CES) Requirements
General Human Services Requirements
HIPAA Compliance
HSLynk stores and shares out client and project data using the APIs. The Data Warehouse is a subproject of the overall HSLynk project, whereby the client and project data are published in a deidentified/obfuscated fashion, so client confidentiality is not compromised.
Overall System Requirements
- general non-official recommendations from HUD Technical Assistance
- unduplication
- SOA matching code we can use: http://www.openempi.org/ "OpenEMPI provides multiple alternative implementations of some key services, such as offering both a deterministic and a probabilistic implementation of the matching services. This allows each site that chooses to implement an instance of OpenEMPI to choose the most appropriate implementation based on the preferences and data characteristics of the site."
- Use of Big Data
- HSLynk APIs
HMIS Requirements
- handy table of all formats/versions of HMIS: https://github.com/hmis-interop/logical-model/wiki/HMIS-Data-Standard-Versions
- a detailed spreadsheet of all the data element changes throughout all the years. Check out the "master" tab.
- On-the-fly Version Mapping Utility
2020 (June 2019 v1.3) HMIS Data Standards
- HMIS Data Standards
- HMIS Data Dictionary
- Mapping 2017->2020
- HMIS CSV 7.x? / 2020
- HMIS XML 7.x? / 2020 - Coming soon!
- HMIS 2020 Glossary
2017(2017-v1.3) HMIS Data Standards
- HMIS Data Dictionary / 2017 (HMIS Data Standard 2017-v1.3)
- HMIS 2017 Mapping to Previous Versions
- HMIS June 2017 (v1) Glossary
- Mapping 2016->2017
- HMIS XML 6.1.2 / 2017
- HMIS CSV 6.11 / 2017
- HMIS CSV 6.12 / 2017
2016(v5) HMIS Data Standards
- HMIS Data Dictionary / 2016 (HMIS Data Standard v5.1, XML v5.1 (there is no 5.0 XML))
- HMIS Logical Model / 2016
- HMIS CSV 5.1 / 2016
- HMIS CSV 5.0 / 2016
- Mapping 2015->2016
2015(v3) HMIS Data Standards
- HMIS Logical Model / 2015
- HMIS XSD 4.1 / 2015
- HMIS CSV 4.1 / 2015
- HMIS Data Dictionary/ Sept. 1, 2015 HMIS Data Standard 2014 v3.1, XML 4.1
- Logical Model 2014->2015 changes
- Mapping 2014->2015
2014(v2) HMIS Data Standards
- HMIS Logical Model / 2014
- HMIS Data Dictionary / May 2014 (HMIS Data Standard 2014 v1, XML v 4.0
- HMIS XSD 4.0 / 2014
- HMIS CSV 4.0 / 2014
- Unduplication
- Release of Information (not a HUD Requirement, but that comes from the community, when service providers want to share records with each other to improve service delivery, or for analysis/research purposes)
- Example form
- Glossary of HMIS Terms - (permanent HUD link)
HMIS Reporting Requirements
Critical HUD Reports
APR Report
- CoC APR and ESG CAPER Report
- 2020 report programming specs
- 2018 v1.4 report programming specs, v1.4 updated August, 2018
- to be submitted via the new Sage HMIS Reporting Repository in CSV beginning April 1, 2017)
- sage demo site: https://demo.sagehmis.info/
- 2018 v1.3 updated April, 2018)
- 2017 v1.0 updated June, 2017)
- 2016 v1.5 [out of sequence, right?] updated Jan 2016
- APR Test Data
- Definition of Chronic Homelessness
AHAR LSA Report
- 2020 LSA
- 2018 LSA
AHAR HIC and AHAR PIT Reports (new 2018 release in draft version now; expected release March 2018, due September 2018)
- PIT and APR alignment/overlap doc, released in January 2016
- HIC and PIT Guidance, March 2015
- Housing Inventory Chart(HIC) and Point In Time (PIT) Survey Requirements Received 3/9/2015 from HUD: "PIT and HIC counts have guidance, but HUD does not anticipate releasing programming specifications on those as there is no requirement to generate them from the HMIS."
SSVF Export VA Data Guide
Other Reports
- Runaway and Homeless Youth - Performance Progress Report (RHYMIS PPR) Received 3/3/2015: "From a conversation this morning with Javier, communities are still waiting on the requirements from HUD/FYSB. RHYMIS reporting won't be done until October 2015. Family and Youth Services Bureau will start testing this summer and have the requirements and hopefully report ready for October." November 4, 2015 update. This is a CSV export format that uses hashing. Details are here.
- Bed Inventory Tracking see Google Requirements Doc on this topic
- System Performance Measures Report
- Length of Time Homeless Report - Suggested Report for Community Management
- HHS PATH Report
- [HUD HMIS Data Quality Report]
Coordinated Entry System (CES) Service Requirements
- Assessment and Custom Survey Builder Requirements
- Housing Matching Service Requirements
- Housing Inventory Service Requirements
General Human Services Requirements
- Entity Support to track anything as Linked Open Data (RDF/JSON-LD)
- case management (notes, plans, etc.)
- human services needs and service transactions to taxonomy
- HMIS point-in-time-count
- [HMIS GUI Requirements - To add ServingLynk Supported HMIS functionality to HOME App](HMIS GUI Requirements)
HIPAA Compliance
- for customers that require it