Client Documents Report - greenriver/hmis-warehouse GitHub Wiki

Description

The Client Document Report details the number of required or optional documents by client configured in the Universe Selection. This report can be used to track:

  • If a group of clients have or are missing required or optional documents.
  • If a group of clients have or are missing documents that are current.

Universe

The Client Documents Report uses the Live Universe Selection. In addition to choosing the HMIS universe you can specify two sets of files or documents you would like to know more about:

  • Required Files - Select the documents a client must have.
  • Optional Files - Select the documents a client should have.

Figure 1. Example of Universe Selection Files

Results

1. Viewing Reports

The report populates after you choose at least one document type. The total number of Unique Clients in the chosen universe is displayed at the top of the report. The results are displayed as a table in the report and an expanded view is available in the Excel download.

2. Summary Table

The report displays the results alphabetically by client in a table view with the following:

  • Client - Name of client with link to client profile.
  • Required Documents - The number of required documents a client has as specified in the Universe Selection.
  • Optional Documents - The number of optional documents a client has as specified in the Universe Selection.
  • All Documents - The total number of required and optional documents.

Figure 2. Example of Results

3. Download

The report can be downloaded into Excel and includes additional document details. Each of the documents selected as required or optional will be displayed as separate columns in the report. The date displayed for each document is the effective date set upon original upload, or the date the document was uploaded, if no effective date was specified. If there is no date visible in the column, the client does not have that document.

  • Warehouse ID
  • Last Name
  • First Name
  • Required Documents - The number of required documents a client has as specified in the Universe Selection.
  • Optional Documents - The number of optional documents a client has as specified in the Universe Selection.
  • All Documents - The total number of required and optional documents.
  • Document Section Title - Each document is grouped by type into a specific section. The download displays the name of each specific section with a list of the number of documents in that section and if they are optional or required. The date displayed in the section column is the most-recent date of the document grouped within that section.
    • Example: Photo ID (1 tags - required) indicates that in the Photo ID section there is one required document. The name of the required document type, Passport, is listed as a column next to the section name.
  • Document Name - Name of the document type.
    • Example: Passport

Figure 3. Example of Document details in Excel Download

Revision History

  • 8/2023 - Initially developed in conjunction with the City of Boston, Tarrant County and MA EOHLC.

Calculation Notes

  • Report results are based on the enrollment criteria in the Universe Selection, not the effective dates of the documents.
  • A document type must be selected in order for the report to run.