XML Root element. A description of what software provider and organization are sending this XML information. Many sources can be grouped together into one XML file.
<xs:element name="Sources" type="hmis:sources"><xs:annotation><xs:documentation xml:lang="en">XML Root element. A description of what software provider and organization are sending this XML information. Many sources can be grouped together into one XML file.</xs:documentation></xs:annotation></xs:element>
if (hmis:SourceType/text()!='1') then boolean(hmis:SourceName) else true()
if (hmis:SourceType/text()='1') then boolean(hmis:SourceID) else true()
Source
<xs:element name="Source" type="hmis:source" minOccurs="1" maxOccurs="unbounded"><xs:annotation><xs:documentation xml:lang="en">A description of what software provider and organization are sending this XML information. Many sources can be grouped together into one XML file.</xs:documentation></xs:annotation></xs:element>
Reference to the Source's unique ID. If SourceType = 1, this field may not be null and must identify the HUD CoC Code of the HMIS implementation from which data are being exported in the format of two letters, a dash, and 3 numbers. ^[a-zA-Z]{2}-[0-9]{3}$ . If SourceType !=1, this field may be null or used to specify other characteristics, as agreed upon by sender and receiver.
<xs:element name="SourceID" type="hmis:string32" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">Reference to the Source's unique ID. If SourceType = 1, this field may not be null and must identify the HUD CoC Code of the HMIS implementation from which data are being exported in the format of two letters, a dash, and 3 numbers. ^[a-zA-Z]{2}-[0-9]{3}$ . If SourceType !=1, this field may be null or used to specify other characteristics, as agreed upon by sender and receiver.</xs:documentation></xs:annotation></xs:element>
Identifies whether the source database is a continuum-operated HMIS (1), an agency-specific database (2), a data warehouse (3), or other (4). An HMIS implementation operated jointly by more than one continuum should be identified as a data warehouse.
<xs:element name="SourceType" type="hmis:sourceType"><xs:annotation><xs:documentation xml:lang="en">Identifies whether the source database is a continuum-operated HMIS (1), an agency-specific database (2), a data warehouse (3), or other (4). An HMIS implementation operated jointly by more than one continuum should be identified as a data warehouse.</xs:documentation></xs:annotation></xs:element>
If the source database is not an HMIS implementation (if SourceType != 1), this field may not be null and must identify the organization responsible for the database.
<xs:element name="SourceName" type="hmis:string50" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">If the source database is not an HMIS implementation (if SourceType != 1), this field may not be null and must identify the organization responsible for the database.</xs:documentation></xs:annotation></xs:element>
<xs:element name="SoftwareName" type="hmis:string50"><xs:annotation><xs:documentation xml:lang="en">The name of the software provider generating this XML.</xs:documentation></xs:annotation></xs:element>
Version number of the software being used by the software provider.
Diagram
Type
xs:string
Properties
content
simple
Source
<xs:element name="SoftwareVersion" type="xs:string"><xs:annotation><xs:documentation xml:lang="en">Version number of the software being used by the software provider.</xs:documentation></xs:annotation></xs:element>
<xs:element name="SourceContactEmail" type="hmis:email" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">Email address of the person to contact about this XML data.</xs:documentation></xs:annotation></xs:element>
<xs:element name="SourceContactExtension" type="hmis:extension" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">Used with SourceContactPhone to contact the person who can answer questions about this XML.</xs:documentation></xs:annotation></xs:element>
<xs:element name="SourceContactFirst" type="hmis:string50" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">First name of the person to contact about this XML data.</xs:documentation></xs:annotation></xs:element>
<xs:element name="SourceContactLast" type="hmis:string50" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">Last name of the person to contact about this XML data.</xs:documentation></xs:annotation></xs:element>
<xs:element name="SourceContactPhone" type="hmis:phoneNumber" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">Phone number of the person to contact about this XML data; used with SourceContactExtension.</xs:documentation></xs:annotation></xs:element>
An export is a set of data being transmitted for a specific purpose (see ExportType). A single XML file can have many different Exports of different types and date ranges.
every $id in hmis:Client/hmis:PersonalID satisfies (fn:count(hmis:ClientVeteranInfo[hmis:PersonalID
= $id]) le 1)
every $id in hmis:Client/hmis:PersonalID satisfies (fn:count(hmis:Enrollment[hmis:PersonalID
= $id]) ge 1)
every $id in hmis:CoC/hmis:CoCCode satisfies (fn:count(hmis:EnrollmentCoC[hmis:CoCCode
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:EnrollmentID satisfies (fn:count(hmis:ConnectionWithSOAR[hmis:EnrollmentID
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:EnrollmentID satisfies (fn:count(hmis:DateOfEngagement[hmis:EnrollmentID
= $id]) le 1)
every $id in hmis:Enrollment/hmis:EnrollmentID satisfies (fn:count(hmis:Disabilities[hmis:EnrollmentID
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:EnrollmentID satisfies (fn:count(hmis:DomesticViolence[hmis:EnrollmentID
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:EnrollmentID satisfies (fn:count(hmis:Employment[hmis:EnrollmentID
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:EnrollmentID satisfies (fn:count(hmis:EnrollmentCoC[hmis:EnrollmentID
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:EnrollmentID satisfies (fn:count(hmis:EntryRHY[hmis:EnrollmentID
= $id]) le 1)
every $id in hmis:Enrollment/hmis:EnrollmentID satisfies (fn:count(hmis:EntrySSVF[hmis:EnrollmentID
= $id]) le 1)
every $id in hmis:Enrollment/hmis:EnrollmentID satisfies (fn:count(hmis:Exit[hmis:EnrollmentID
= $id]) le 1)
every $id in hmis:Enrollment/hmis:EnrollmentID satisfies (fn:count(hmis:HealthInsurance[hmis:EnrollmentID
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:EnrollmentID satisfies (fn:count(hmis:HealthStatus[hmis:EnrollmentID
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:EnrollmentID satisfies (fn:count(hmis:IncomeAndSources[hmis:EnrollmentID
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:EnrollmentID satisfies (fn:count(hmis:MedicalAssistance[hmis:EnrollmentID
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:EnrollmentID satisfies (fn:count(hmis:NonCashBenefits[hmis:EnrollmentID
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:EnrollmentID satisfies (fn:count(hmis:PathStatus[hmis:EnrollmentID
= $id]) le 1)
every $id in hmis:Enrollment/hmis:EnrollmentID satisfies (fn:count(hmis:EntryRHSP[hmis:EnrollmentID
= $id]) le 1)
every $id in hmis:Enrollment/hmis:EnrollmentID satisfies (fn:count(hmis:MoveInDate[hmis:EnrollmentID
= $id]) le 1)
every $id in hmis:Enrollment/hmis:EnrollmentID satisfies (fn:count(hmis:RHYBCPStatus[hmis:EnrollmentID
= $id]) le 1)
every $id in hmis:Enrollment/hmis:EnrollmentID satisfies (fn:count(hmis:ServiceFAReferral[hmis:EnrollmentID
= $id]) ge 0)
every $id in hmis:Exit/hmis:ExitID satisfies (fn:count(hmis:ExitHousingAssessment[hmis:ExitID
= $id]) le 1)
every $id in hmis:Exit/hmis:ExitID satisfies (fn:count(hmis:ExitRHY[hmis:ExitID =
$id]) le 1)
every $id in hmis:Exit/hmis:ExitID satisfies (fn:count(hmis:HousingAssessmentDisposition[hmis:ExitID
= $id]) le 1)
every $id in hmis:Organization/hmis:OrganizationID satisfies (fn:count(hmis:Project[hmis:OrganizationID
= $id]) ge 0)
every $id in hmis:Project/hmis:ProjectID satisfies (fn:count(hmis:Affiliation[hmis:ProjectID
= $id]) ge 0)
every $id in hmis:Project/hmis:ProjectID satisfies (fn:count(hmis:CoC[hmis:ProjectID
= $id]) ge 1)
every $id in hmis:Project/hmis:ProjectID satisfies (fn:count(hmis:Funder[hmis:ProjectID
= $id]) ge 1)
every $id in hmis:Exit/hmis:ExitID satisfies (fn:count(hmis:RHYAftercare[hmis:ExitID
= $id]) le 1)
every $inventory in hmis:Inventory satisfies (if (boolean($inventory/hmis:Availability)
or boolean($inventory/hmis:BedType)) then (if (every $id in $inventory/hmis:ProjectID
satisfies (hmis:Project[hmis:ProjectID = $id]/hmis:ProjectType/text()='1')) then (true())
else false()) else (true()))
every $inventory in hmis:Inventory satisfies (if (boolean($inventory/hmis:CHBedInventory))
then (if (every $id in $inventory/hmis:ProjectID satisfies (hmis:Project[hmis:ProjectID
= $id]/hmis:ProjectType/text()='3')) then (true()) else false()) else (true()))
every $id in hmis:Enrollment/hmis:HouseholdID satisfies (fn:count(hmis:Enrollment/hmis:RelationshipToHoH[text()=
'1'][../hmis:HouseholdID = $id] ) eq 1)
Identity constraints
QName
Type
Refer
Selector
Field(s)
clientKey
key
hmis:Client
hmis:PersonalID
cocKey
key
hmis:CoC
hmis:CoCCode
enrollmentKey
key
hmis:Enrollment
hmis:EnrollmentID
exitKey
key
hmis:Exit
hmis:ExitID
organizationKey
key
hmis:Organization
hmis:OrganizationID
projectKey
key
hmis:Project
hmis:ProjectID
affiliationProjectKeyRef
keyref
projectKey
hmis:Affiliation
hmis:ProjectID
affiliationResProjectKeyRef
keyref
projectKey
hmis:Affiliation
hmis:ResProjectID
enrollmentClientKeyRef
keyref
clientKey
hmis:Enrollment
hmis:PersonalID
enrollmentCoCCoCKeyRef
keyref
cocKey
hmis:EnrollmentCoC
hmis:CoCCode
enrollmentCoCEnrollmentKeyRef
keyref
enrollmentKey
hmis:EnrollmentCoC
hmis:EnrollmentID
enrollmentDateOfEngagementKeyRef
keyref
enrollmentKey
hmis:DateOfEngagement
hmis:EnrollmentID
enrollmentDisabilitiesKeyRef
keyref
enrollmentKey
hmis:Disabilities
hmis:EnrollmentID
enrollmentDomesticViolenceKeyRef
keyref
enrollmentKey
hmis:DomesticViolence
hmis:EnrollmentID
enrollmentEducationKeyRef
keyref
enrollmentKey
hmis:Education
hmis:EnrollmentID
enrollmentEmploymentKeyRef
keyref
enrollmentKey
hmis:Employment
hmis:EnrollmentID
enrollmentEnrollmentCoCKeyRef
keyref
enrollmentKey
hmis:EnrollmentCoC
hmis:EnrollmentID
enrollmentExitKeyRef
keyref
enrollmentKey
hmis:Exit
hmis:EnrollmentID
enrollmentHealthInsuranceKeyRef
keyref
enrollmentKey
hmis:HealthInsurance
hmis:EnrollmentID
enrollmentHealthStatusKeyRef
keyref
enrollmentKey
hmis:HealthStatus
hmis:EnrollmentID
enrollmentIncomeAndSourcesKeyRef
keyref
enrollmentKey
hmis:IncomeAndSources
hmis:EnrollmentID
enrollmentMedicalAssistanceKeyRef
keyref
enrollmentKey
hmis:MedicalAssistance
hmis:EnrollmentID
enrollmentNonCashBenefitsKeyRef
keyref
enrollmentKey
hmis:NonCashBenefits
hmis:EnrollmentID
enrollmentPATHStatusKeyRef
keyref
enrollmentKey
hmis:PATHStatus
hmis:EnrollmentID
enrollmentEntrySSVFKeyRef
keyref
enrollmentKey
hmis:EntrySSVF
hmis:EnrollmentID
enrollmentReferralSourceKeyRef
keyref
enrollmentKey
hmis:ReferralSource
hmis:EnrollmentID
enrollmentMoveInDateKeyRef
keyref
enrollmentKey
hmis:MoveInDate
hmis:EnrollmentID
enrollmentRHYBCPStatusKeyRef
keyref
enrollmentKey
hmis:NonCashBenefits
hmis:EnrollmentID
enrollmentServiceFAReferralKeyRef
keyref
enrollmentKey
hmis:ServiceFAReferral
hmis:EnrollmentID
enrollmentSexualOrientationKeyRef
keyref
enrollmentKey
hmis:SexualOrientation
hmis:EnrollmentID
enrollmentEntryRHSPKeyRef
keyref
enrollmentKey
hmis:EntryRHSP
hmis:EnrollmentID
enrollmentEntryRHYKeyRef
keyref
enrollmentKey
hmis:EntryRHY
hmis:EnrollmentID
exitExitHousingAssessmentKeyRef
keyref
exitKey
hmis:ExitHousingAssessment
hmis:ExitID
exitExitRHYKeyRef
keyref
exitKey
hmis:ExitRHY
hmis:ExitID
exitHousingAssessmentDispositionKeyRef
keyref
exitKey
hmis:HousingAssessmentDisposition
hmis:ExitID
exitRHYAftercareKeyRef
keyref
exitKey
hmis:RHYAftercare
hmis:ExitID
inventoryCoCKeyRef
keyref
cocKey
hmis:Inventory
hmis:CoCCode
projectOrganizationKeyRef
keyref
organizationKey
hmis:Project
hmis:OrganizationID
cocProjectKeyRef
keyref
projectKey
hmis:CoC
hmis:ProjectID
projectEnrollmentKeyRef
keyref
projectKey
hmis:Enrollment
hmis:ProjectID
projectFunderKeyRef
keyref
projectKey
hmis:Funder
hmis:ProjectID
geographyCoCKeyRef
keyref
cocKey
hmis:Geography
hmis:CoCCode
clientVeteranInfoClientKeyRef
keyref
clientKey
hmis:ClientVeteranInfo
hmis:PersonalID
Source
<xs:element name="Export" type="hmis:export" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation xml:lang="en">An export is a set of data being transmitted for a specific purpose (see ExportType). A single XML file can have many different Exports of different types and date ranges.</xs:documentation></xs:annotation><xs:key name="clientKey"><xs:selector xpath="hmis:Client"/><xs:field xpath="hmis:PersonalID"/></xs:key><xs:key name="cocKey"><xs:selector xpath="hmis:CoC"/><xs:field xpath="hmis:CoCCode"/></xs:key><xs:key name="enrollmentKey"><xs:selector xpath="hmis:Enrollment"/><xs:field xpath="hmis:EnrollmentID"/></xs:key><xs:key name="exitKey"><xs:selector xpath="hmis:Exit"/><xs:field xpath="hmis:ExitID"/></xs:key><xs:key name="organizationKey"><xs:selector xpath="hmis:Organization"/><xs:field xpath="hmis:OrganizationID"/></xs:key><xs:key name="projectKey"><xs:selector xpath="hmis:Project"/><xs:field xpath="hmis:ProjectID"/></xs:key><xs:keyref name="affiliationProjectKeyRef" refer="projectKey"><xs:selector xpath="hmis:Affiliation"/><xs:field xpath="hmis:ProjectID"/></xs:keyref><xs:keyref name="affiliationResProjectKeyRef" refer="projectKey"><xs:selector xpath="hmis:Affiliation"/><xs:field xpath="hmis:ResProjectID"/></xs:keyref><xs:keyref name="enrollmentClientKeyRef" refer="clientKey"><xs:selector xpath="hmis:Enrollment"/><xs:field xpath="hmis:PersonalID"/></xs:keyref><xs:keyref name="enrollmentCoCCoCKeyRef" refer="cocKey"><xs:selector xpath="hmis:EnrollmentCoC"/><xs:field xpath="hmis:CoCCode"/></xs:keyref><xs:keyref name="enrollmentCoCEnrollmentKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:EnrollmentCoC"/><xs:field xpath="hmis:EnrollmentID"/></xs:keyref><xs:keyref name="enrollmentDateOfEngagementKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:DateOfEngagement"/><xs:field xpath="hmis:EnrollmentID"/></xs:keyref><xs:keyref name="enrollmentDisabilitiesKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:Disabilities"/><xs:field xpath="hmis:EnrollmentID"/></xs:keyref><xs:keyref name="enrollmentDomesticViolenceKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:DomesticViolence"/><xs:field xpath="hmis:EnrollmentID"/></xs:keyref><xs:keyref name="enrollmentEducationKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:Education"/><xs:field xpath="hmis:EnrollmentID"/></xs:keyref><xs:keyref name="enrollmentEmploymentKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:Employment"/><xs:field xpath="hmis:EnrollmentID"/></xs:keyref><xs:keyref name="enrollmentEnrollmentCoCKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:EnrollmentCoC"/><xs:field xpath="hmis:EnrollmentID"/></xs:keyref><xs:keyref name="enrollmentExitKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:Exit"/><xs:field xpath="hmis:EnrollmentID"/></xs:keyref><xs:keyref name="enrollmentHealthInsuranceKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:HealthInsurance"/><xs:field xpath="hmis:EnrollmentID"/></xs:keyref><xs:keyref name="enrollmentHealthStatusKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:HealthStatus"/><xs:field xpath="hmis:EnrollmentID"/></xs:keyref><xs:keyref name="enrollmentIncomeAndSourcesKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:IncomeAndSources"/><xs:field xpath="hmis:EnrollmentID"/></xs:keyref><xs:keyref name="enrollmentMedicalAssistanceKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:MedicalAssistance"/><xs:field xpath="hmis:EnrollmentID"/></xs:keyref><xs:keyref name="enrollmentNonCashBenefitsKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:NonCashBenefits"/><xs:field xpath="hmis:EnrollmentID"/></xs:keyref><xs:keyref name="enrollmentPATHStatusKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:PATHStatus"/><xs:field xpath="hmis:EnrollmentID"/></xs:keyref><xs:keyref name="enrollmentEntrySSVFKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:EntrySSVF"/><xs:field xpath="hmis:EnrollmentID"/></xs:keyref><xs:keyref name="enrollmentReferralSourceKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:ReferralSource"/><xs:field xpath="hmis:EnrollmentID"/></xs:keyref><xs:keyref name="enrollmentMoveInDateKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:MoveInDate"/><xs:field xpath="hmis:EnrollmentID"/></xs:keyref><xs:keyref name="enrollmentRHYBCPStatusKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:NonCashBenefits"/><xs:field xpath="hmis:EnrollmentID"/></xs:keyref><xs:keyref name="enrollmentServiceFAReferralKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:ServiceFAReferral"/><xs:field xpath="hmis:EnrollmentID"/></xs:keyref><xs:keyref name="enrollmentSexualOrientationKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:SexualOrientation"/><xs:field xpath="hmis:EnrollmentID"/></xs:keyref><xs:keyref name="enrollmentEntryRHSPKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:EntryRHSP"/><xs:field xpath="hmis:EnrollmentID"/></xs:keyref><xs:keyref name="enrollmentEntryRHYKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:EntryRHY"/><xs:field xpath="hmis:EnrollmentID"/></xs:keyref><xs:keyref name="exitExitHousingAssessmentKeyRef" refer="exitKey"><xs:selector xpath="hmis:ExitHousingAssessment"/><xs:field xpath="hmis:ExitID"/></xs:keyref><xs:keyref name="exitExitRHYKeyRef" refer="exitKey"><xs:selector xpath="hmis:ExitRHY"/><xs:field xpath="hmis:ExitID"/></xs:keyref><xs:keyref name="exitHousingAssessmentDispositionKeyRef" refer="exitKey"><xs:selector xpath="hmis:HousingAssessmentDisposition"/><xs:field xpath="hmis:ExitID"/></xs:keyref><xs:keyref name="exitRHYAftercareKeyRef" refer="exitKey"><xs:selector xpath="hmis:RHYAftercare"/><xs:field xpath="hmis:ExitID"/></xs:keyref><xs:keyref name="inventoryCoCKeyRef" refer="cocKey"><xs:selector xpath="hmis:Inventory"/><xs:field xpath="hmis:CoCCode"/></xs:keyref><xs:keyref name="projectOrganizationKeyRef" refer="organizationKey"><xs:selector xpath="hmis:Project"/><xs:field xpath="hmis:OrganizationID"/></xs:keyref><xs:keyref name="cocProjectKeyRef" refer="projectKey"><xs:selector xpath="hmis:CoC"/><xs:field xpath="hmis:ProjectID"/></xs:keyref><xs:keyref name="projectEnrollmentKeyRef" refer="projectKey"><xs:selector xpath="hmis:Enrollment"/><xs:field xpath="hmis:ProjectID"/></xs:keyref><xs:keyref name="projectFunderKeyRef" refer="projectKey"><xs:selector xpath="hmis:Funder"/><xs:field xpath="hmis:ProjectID"/></xs:keyref><xs:keyref name="geographyCoCKeyRef" refer="cocKey"><xs:selector xpath="hmis:Geography"/><xs:field xpath="hmis:CoCCode"/></xs:keyref><xs:keyref name="clientVeteranInfoClientKeyRef" refer="clientKey"><xs:selector xpath="hmis:ClientVeteranInfo"/><xs:field xpath="hmis:PersonalID"/></xs:keyref></xs:element>
<xs:element name="ExportID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the Export's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ExportDate" type="xs:dateTime"><xs:annotation><xs:documentation xml:lang="en">Time the export was performed.</xs:documentation></xs:annotation></xs:element>
<xs:element name="ExportPeriod" type="hmis:dateRangeCapped"><xs:annotation><xs:documentation xml:lang="en">The date range bounding the data set being transmitted. Used with ExportPeriodType to clarify what the date range represents.</xs:documentation></xs:annotation></xs:element>
Exported data sets with an ExportPeriodType of ‘updated’ will include all records with a dateCreated, dateUpdated, or a dateDeleted that falls between the Export.StartDate and the Export.EndDate.
enumeration
effective
Exported data sets with an ExportPeriod type of ‘effective’ will include all enrollment data, along with associated client and project descriptor data, where the informationDate (or other effective date such as Project.EntryDate, Project.ExitDate, etc.) falls between the Export.StartDate and the Export.EndDate.
enumeration
reportingPeriod
‘reportingPeriod’ exports include all records needed for reporting on clients and enrollments active in the export period. This will include all records in Enrollments (regardless of informationDate, dateCreated, dateUpdated, etc.), client files, and project descriptor files associated with a EnrollmentID where: EnrollmentDate is on or before the Export.EndDate; Project.ExitDate is null OR Project.ExitDate is on or after the Export.StartDate; ProjectID is associated with a project selected by a user for export OR the user did not choose to filter the export by Project; A CoCCode associated with the EnrollmentID matches a CoCCode selected by a user for export OR the user did not choose to filter the export by CoCCode.
enumeration
other
The ‘other’ type of ExportPeriodType is used to identify exports in which records were selected based upon parameters mutually agreed upon by the sender and recipient of the XML data."
Source
<xs:element name="ExportPeriodType" type="hmis:exportPeriodType"><xs:annotation><xs:documentation xml:lang="en">Pick one of the types to specify the definition of export period being used in ExportPeriod.</xs:documentation></xs:annotation></xs:element>
The data contained in this file is meant to be synchronized with an existing data set.
enumeration
fullRefresh
The data contained in this file is meant to replace an existing data set for the export period.
enumeration
other
The data contained in this file were selected based upon parameters mutually agreed upon by the sender and recipient of the XML data.
Source
<xs:element name="ExportDirective" type="hmis:exportDirective"><xs:annotation><xs:documentation xml:lang="en">Select one of the ExportDirective choices to instruct the target as to how the data being transmitted should be handled.</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.
<xs:element name="AffiliationID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the Affiliation's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to a Project element. ProjectType must equal "6".</xs:documentation></xs:annotation></xs:element>
<xs:element name="ResProjectID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">See 2017 HMIS Data Dictionary v1.3, Section 2.4.B. Must match a ProjectID of a Project with ProjectType =1,2, 3, 8, 10, or 13.</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.
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.
<xs:element name="ClientVeteranInfoID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the ClientVeteranInfo's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="PersonalID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Refers to a Client element</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.
<xs:element name="ConnectionWithSOARID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the connectionWithSOAR's 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>
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.
<xs:element name="CoCCode" type="hmis:cocCode"><xs:annotation><xs:documentation xml:lang="en">Key reference to the CoCCode ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Project ID</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.
<xs:element name="DateOfEngagementID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the DateOfEngagement's 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>
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.
if (hmis:TCellCountAvailable) then boolean(hmis:DisabilityType/text()='8') else true()
if (string(hmis:DisabilityResponse/@xsi:type) eq'hmis:disabilityResponseSubstanceAbuse')
then boolean(hmis:DisabilityType/text()='10') else true()
if (hmis:TCellCountAvailable/text()='1') then boolean(hmis:TCellCount) else (if (not(hmis:TCellCountAvailable/text()='1'))
then (not(boolean(hmis:TCellCount))) else false())
if (hmis:TCellCount) then boolean(hmis:TCellSource) else (if (not(hmis:TCellCount))
then (not(boolean(hmis:TCellSource))) else false())
if (hmis:ViralLoadAvailable) then boolean(hmis:DisabilityType/text()='8') else true()
if (hmis:ViralLoadAvailable/text()='1') then boolean(hmis:ViralLoad) else (if (not(hmis:ViralLoadAvailable/text()='1'))
then (not(boolean(hmis:ViralLoad))) else false())
if (hmis:ViralLoad) then boolean(hmis:ViralLoadSource) else (if (not(hmis:ViralLoad))
then (not(boolean(hmis:ViralLoadSource))) else false())
<xs:element name="DisabilitiesID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the Exit's 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>
The permissible values correspond to the decimal values of the corresponding disability types. 4.5 Physical Disability is "5" and 4.10 Substance Abuse is "10".
<xs:element name="DisabilityType" type="hmis:disabilityType"><xs:annotation><xs:documentation xml:lang="en">The permissible values correspond to the decimal values of the corresponding disability types. 4.5 Physical Disability is "5" and 4.10 Substance Abuse is "10".</xs:documentation></xs:annotation></xs:element>
See 2017 HMIS Data Dictionary v1.3, Section 4.5-4.10, Response #2. Permissable values vary depending on which disability type is declared. The values are contined with "Field and Response(s) 2" within 4.5 through 4.10.
In the instance document, the xsi:type of this element must be declared, and the type depends on the value within the sibling hmis:DisabilityType element. See the example HUD_HMIS_Instance.xml file to see how this should appear. Either xsi:type="hmis:disabilityResponseNoYesDoesntKnowRefused" or xsi:type="hmis:disabilityResponseSubstanceAbuse"can be used.
<xs:element name="DisabilityResponse" type="hmis:disabilityResponseBase"><xs:annotation><xs:documentation xml:lang="en">See 2017 HMIS Data Dictionary v1.3, Section 4.5-4.10, Response #2. Permissable values vary depending on which disability type is declared. The values are contined with "Field and Response(s) 2" within 4.5 through 4.10.</xs:documentation><xs:documentation xml:lang="en">In the instance document, the xsi:type of this element must be declared, and the type depends on the value within the sibling hmis:DisabilityType element. See the example HUD_HMIS_Instance.xml file to see how this should appear. Either xsi:type="hmis:disabilityResponseNoYesDoesntKnowRefused" or xsi:type="hmis:disabilityResponseSubstanceAbuse"can be used.</xs:documentation></xs:annotation></xs:element>
Element disabilities / IndefiniteAndImpairsIndependence