<xs:element name="ServiceFAReferralID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the Services' unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="EnrollmentID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element>
In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 12 (v5.1 Contact Location 4.12.2): 1 = Place not meant for habitation 2 = Service setting, non-residential 3 = Service setting, residential 99 = Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 13 (v6.0 Contact Location 4.12.2): Staying on Streets, ES, or SH 0 = No 1 = Yes 2 = Worker unable to determine In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 141 (PATH Services P1): PATH Services 1 = Re-engagement 2 = Screening 3 = Habilitation/rehabilitation 4 = Community mental health 5 = Substance use treatment 6 = Case management 7 = Residential supportive services 8 = Housing minor renovation 9 = Housing moving assistance 10 = Housing eligibility determination 11 = Security deposits 12 = One-time rent for eviction prevention 14 = Clinical assessment 99 = Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 142 (RHY Services R14): 2 = Community service/service learning (CSL) 5 = Education 6 = Employment and/or training services 7 = Criminal justice /legal services 8 = Life skills training 10 = Parenting education for youth with children 12 = Post-natal care for mother 13 = Pre-natal care 14 = Health/medical care 17 = Substance abuse treatment 18 = Substance Abuse Ed/Prevention Services 26 = Home-based Services 27 = Post-natal newborn care (wellness exams; immunizations) 28 = STD Testing 29 = Street-based Services 99 = Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 143 (HOPWA Services W1): 1 Adult day care and personal assistance 2 Case management 3 Child care 4 Criminal justice/legal services 5 Education 6 Employment and training services 7 Food/meals/nutritional services 8 Health/medical care 9 Life skills training 10 Mental health care/counseling 11 Outreach and/or engagement 12 Substance abuse services/treatment 13 Transportation 14 Other HOPWA funded service 99 Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 144 (SSVF Services V2): 1 Outreach services 2 Case management services 3 Assistance obtaining VA benefits 4 Assistance obtaining/coordinating other public benefits 5 Direct provision of other public benefits 6 Other (non-TFA) supportive service approved by VA 99 Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 151 (Financial Assistance - HOPWA Services 4.15.A): 1 Rental assistance [collect for PHP and STRMU] 2 Security deposits [collect for PHP] 3 Utility deposits [collect for PHP] 4 Utility payments [collect for PHP and STRMU] 7 Mortgage assistance [collect for STRMU] 99 Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 152 (Financial Assistance – SSVF V3): 1 Rental assistance 4 Utility fee payment assistance 2 Security deposit 3 Utility deposit 5 Moving costs 8 Transportation services: tokens/vouchers 9 Transportation services: vehicle repair/maintenance 10 Child Care 11 General housing stability assistance - emergency supplies 12 General housing stability assistance - other 14 Emergency housing assistance 99 Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 161 (Referrals Provided – PATH P2): 1 Community Mental Health 2 Substance Use Treatment 3 Primary Health/ Dental Care 4 Job Training 5 Educational Services 6 Housing Services 11 Temporary Housing 7 Permanent Housing 8 Income Assistance 9 Employment Assistance 10 Medical Insurance 99 Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 200 (Services Provided - Bed-night Date 4.14E): 200 BedNight 99 Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 210 (Services Provided - HUD-VASH OTH voucher tracking 4.50.1): 4.50.1 VoucherTracking Value Text 1 Referral package forwarded to PHA 2 Voucher denied by PHA 3 Voucher issued by PHA 4 Voucher revoked or expired 5 Voucher in use – veteran moved into housing 6 Voucher was ported locally 7 Voucher was administratively absorbed by new PHA 8 Voucher was converted to Housing Choice Voucher 9 Veteran exited – voucher was returned 10 Veteran exited – family maintained the voucher 11 Veteran exited – prior to ever receiving a voucher 12 Other 99 = Data Not Collected
Diagram
Type
restriction of xs:integer
Properties
content
simple
Facets
pattern
([\-+]?[0-9]+) & ([0-9]{1,3})
Source
<xs:element name="TypeProvided"><xs:annotation><xs:documentation xml:lang="en">See June 2017 HMIS Data Dictionary v1.2,</xs:documentation><xs:documentation xml:lang="en">In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 12 (v5.1 Contact Location 4.12.2): 1 = Place not meant for habitation 2 = Service setting, non-residential 3 = Service setting, residential 99 = Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 13 (v6.0 Contact Location 4.12.2): Staying on Streets, ES, or SH 0 = No 1 = Yes 2 = Worker unable to determine In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 141 (PATH Services P1): PATH Services 1 = Re-engagement 2 = Screening 3 = Habilitation/rehabilitation 4 = Community mental health 5 = Substance use treatment 6 = Case management 7 = Residential supportive services 8 = Housing minor renovation 9 = Housing moving assistance 10 = Housing eligibility determination 11 = Security deposits 12 = One-time rent for eviction prevention 14 = Clinical assessment 99 = Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 142 (RHY Services R14): 2 = Community service/service learning (CSL) 5 = Education 6 = Employment and/or training services 7 = Criminal justice /legal services 8 = Life skills training 10 = Parenting education for youth with children 12 = Post-natal care for mother 13 = Pre-natal care 14 = Health/medical care 17 = Substance abuse treatment 18 = Substance Abuse Ed/Prevention Services 26 = Home-based Services 27 = Post-natal newborn care (wellness exams; immunizations) 28 = STD Testing 29 = Street-based Services 99 = Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 143 (HOPWA Services W1): 1 Adult day care and personal assistance 2 Case management 3 Child care 4 Criminal justice/legal services 5 Education 6 Employment and training services 7 Food/meals/nutritional services 8 Health/medical care 9 Life skills training 10 Mental health care/counseling 11 Outreach and/or engagement 12 Substance abuse services/treatment 13 Transportation 14 Other HOPWA funded service 99 Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 144 (SSVF Services V2): 1 Outreach services 2 Case management services 3 Assistance obtaining VA benefits 4 Assistance obtaining/coordinating other public benefits 5 Direct provision of other public benefits 6 Other (non-TFA) supportive service approved by VA 99 Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 151 (Financial Assistance - HOPWA Services 4.15.A): 1 Rental assistance [collect for PHP and STRMU] 2 Security deposits [collect for PHP] 3 Utility deposits [collect for PHP] 4 Utility payments [collect for PHP and STRMU] 7 Mortgage assistance [collect for STRMU] 99 Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 152 (Financial Assistance – SSVF V3): 1 Rental assistance 4 Utility fee payment assistance 2 Security deposit 3 Utility deposit 5 Moving costs 8 Transportation services: tokens/vouchers 9 Transportation services: vehicle repair/maintenance 10 Child Care 11 General housing stability assistance - emergency supplies 12 General housing stability assistance - other 14 Emergency housing assistance 99 Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 161 (Referrals Provided – PATH P2): 1 Community Mental Health 2 Substance Use Treatment 3 Primary Health/ Dental Care 4 Job Training 5 Educational Services 6 Housing Services 11 Temporary Housing 7 Permanent Housing 8 Income Assistance 9 Employment Assistance 10 Medical Insurance 99 Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 200 (Services Provided - Bed-night Date 4.14E): 200 BedNight 99 Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 210 (Services Provided - HUD-VASH OTH voucher tracking 4.50.1): 4.50.1 VoucherTracking Value Text 1 Referral package forwarded to PHA 2 Voucher denied by PHA 3 Voucher issued by PHA 4 Voucher revoked or expired 5 Voucher in use – veteran moved into housing 6 Voucher was ported locally 7 Voucher was administratively absorbed by new PHA 8 Voucher was converted to Housing Choice Voucher 9 Veteran exited – voucher was returned 10 Veteran exited – family maintained the voucher 11 Veteran exited – prior to ever receiving a voucher 12 Other 99 = Data Not Collected</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:integer"><xs:pattern value="[0-9]{1,3}"/></xs:restriction></xs:simpleType></xs:element>
<xs:element name="OtherTypeProvided" type="hmis:string50" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See June 2017 HMIS Data Dictionary v1.2, Section 4.12 and 4.14-4.16.2D (if it exists) .</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See June 2017 HMIS Data Dictionary v1.2, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (not (hmis:RecordType/text() ='144' and hmis:TypeProvided/text() ='6')) then not
(boolean(hmis:OtherTypeProvided)) else boolean(hmis:OtherTypeProvided)
if (not (hmis:RecordType/text() ='144' and (hmis:TypeProvided/text() ='3' or hmis:TypeProvided/text()
='4' or hmis:TypeProvided/text() ='5'))) then not (boolean(hmis:SubTypeProvided))
else boolean(hmis:TypeProvided)
if (not (hmis:RecordType/text() ='151') and not (hmis:RecordType/text() ='152')) then
(not (boolean(hmis:FAAmount))) else boolean(hmis:FAAmount)
Source
<xs:complexType name="serviceFAReferral"><xs:sequence><xs:element name="ServiceFAReferralID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the Services' unique ID</xs:documentation></xs:annotation></xs:element><xs:element name="EnrollmentID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element><xs:element name="DateProvided" type="xs:date"></xs:element><xs:element name="RecordType" type="hmis:recordType"><xs:annotation><xs:documentation xml:lang="en">Contact records collected under 2014 HMIS Data Standards v5.1 (RecordType 12) 4.12 Contact records collected under 2017 HMIS Data Standards (RecordType 13) 4.14 Bed Night (RecordType 200) P1 Services Provided – PATH (RecordType 141) P2 Referrals Provided – PATH (RecordType 161) R14 RHY Service Connections (RecordType 142) W1 Services Provided – HOPWA (RecordType 143) W2 Financial Assistance – HOPWA (RecordType 151) V2 Services Provided – SSVF (RecordType 144) V3 Financial Assistance – SSVF (RecordType 152) V8 HUD-VASH Voucher Tracking (RecordType 210)</xs:documentation></xs:annotation></xs:element><xs:element name="TypeProvided"><xs:annotation><xs:documentation xml:lang="en">See June 2017 HMIS Data Dictionary v1.2,</xs:documentation><xs:documentation xml:lang="en">In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 12 (v5.1 Contact Location 4.12.2): 1 = Place not meant for habitation 2 = Service setting, non-residential 3 = Service setting, residential 99 = Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 13 (v6.0 Contact Location 4.12.2): Staying on Streets, ES, or SH 0 = No 1 = Yes 2 = Worker unable to determine In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 141 (PATH Services P1): PATH Services 1 = Re-engagement 2 = Screening 3 = Habilitation/rehabilitation 4 = Community mental health 5 = Substance use treatment 6 = Case management 7 = Residential supportive services 8 = Housing minor renovation 9 = Housing moving assistance 10 = Housing eligibility determination 11 = Security deposits 12 = One-time rent for eviction prevention 14 = Clinical assessment 99 = Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 142 (RHY Services R14): 2 = Community service/service learning (CSL) 5 = Education 6 = Employment and/or training services 7 = Criminal justice /legal services 8 = Life skills training 10 = Parenting education for youth with children 12 = Post-natal care for mother 13 = Pre-natal care 14 = Health/medical care 17 = Substance abuse treatment 18 = Substance Abuse Ed/Prevention Services 26 = Home-based Services 27 = Post-natal newborn care (wellness exams; immunizations) 28 = STD Testing 29 = Street-based Services 99 = Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 143 (HOPWA Services W1): 1 Adult day care and personal assistance 2 Case management 3 Child care 4 Criminal justice/legal services 5 Education 6 Employment and training services 7 Food/meals/nutritional services 8 Health/medical care 9 Life skills training 10 Mental health care/counseling 11 Outreach and/or engagement 12 Substance abuse services/treatment 13 Transportation 14 Other HOPWA funded service 99 Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 144 (SSVF Services V2): 1 Outreach services 2 Case management services 3 Assistance obtaining VA benefits 4 Assistance obtaining/coordinating other public benefits 5 Direct provision of other public benefits 6 Other (non-TFA) supportive service approved by VA 99 Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 151 (Financial Assistance - HOPWA Services 4.15.A): 1 Rental assistance [collect for PHP and STRMU] 2 Security deposits [collect for PHP] 3 Utility deposits [collect for PHP] 4 Utility payments [collect for PHP and STRMU] 7 Mortgage assistance [collect for STRMU] 99 Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 152 (Financial Assistance – SSVF V3): 1 Rental assistance 4 Utility fee payment assistance 2 Security deposit 3 Utility deposit 5 Moving costs 8 Transportation services: tokens/vouchers 9 Transportation services: vehicle repair/maintenance 10 Child Care 11 General housing stability assistance - emergency supplies 12 General housing stability assistance - other 14 Emergency housing assistance 99 Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 161 (Referrals Provided – PATH P2): 1 Community Mental Health 2 Substance Use Treatment 3 Primary Health/ Dental Care 4 Job Training 5 Educational Services 6 Housing Services 11 Temporary Housing 7 Permanent Housing 8 Income Assistance 9 Employment Assistance 10 Medical Insurance 99 Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 200 (Services Provided - Bed-night Date 4.14E): 200 BedNight 99 Data Not Collected In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 210 (Services Provided - HUD-VASH OTH voucher tracking 4.50.1): 4.50.1 VoucherTracking Value Text 1 Referral package forwarded to PHA 2 Voucher denied by PHA 3 Voucher issued by PHA 4 Voucher revoked or expired 5 Voucher in use – veteran moved into housing 6 Voucher was ported locally 7 Voucher was administratively absorbed by new PHA 8 Voucher was converted to Housing Choice Voucher 9 Veteran exited – voucher was returned 10 Veteran exited – family maintained the voucher 11 Veteran exited – prior to ever receiving a voucher 12 Other 99 = Data Not Collected</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:integer"><xs:pattern value="[0-9]{1,3}"/></xs:restriction></xs:simpleType></xs:element><xs:element name="OtherTypeProvided" type="hmis:string50" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See June 2017 HMIS Data Dictionary v1.2, Section 4.12 and 4.14-4.16.2D (if it exists) .</xs:documentation></xs:annotation></xs:element><xs:element name="SubTypeProvided" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See June 2017 HMIS Data Dictionary v1.2, Section 4.12 and 4.14-4.16.3A, 4B, 5C (if it exists).</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:integer"><xs:pattern value="[0-9]{1,2}"/></xs:restriction></xs:simpleType></xs:element><xs:element name="FAAmount" type="hmis:money" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See June 2017 HMIS Data Dictionary v1.2, Section W2 #3 and V3 #2, Financial Assistance Amount.</xs:documentation></xs:annotation></xs:element><xs:element name="ReferralOutcome" type="hmis:referralOutcome" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See June 2017 HMIS Data Dictionary v1.2, Section 4.16A #2A.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attributeGroup ref="hmis:baseMetaData"/><!--Testing if the RecordType is '144' and the TypeProvided is '6' before requiring and even allowing the use of OtherTypeProvided --><xs:assert test="if (not (hmis:RecordType/text() ='144' and hmis:TypeProvided/text() ='6')) then not (boolean(hmis:OtherTypeProvided)) else boolean(hmis:OtherTypeProvided)"/><!--Testing if the RecordType is '144' and the TypeProvided is '3', '4', or '5' before requiring and even allowing the use of SubTypeProvided --><xs:assert test="if (not (hmis:RecordType/text() ='144' and (hmis:TypeProvided/text() ='3' or hmis:TypeProvided/text() ='4' or hmis:TypeProvided/text() ='5'))) then not (boolean(hmis:SubTypeProvided)) else boolean(hmis:TypeProvided)"/><!--Testing if the RecordType is '151' or '152' before requiring and even allowing the use of FAAmount --><xs:assert test="if (not (hmis:RecordType/text() ='151') and not (hmis:RecordType/text() ='152')) then (not (boolean(hmis:FAAmount))) else boolean(hmis:FAAmount)"/></xs:complexType>